/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Frank Aspell
  • Date: 2009-02-22 16:54:02 UTC
  • mto: This revision was merged to the branch mainline in revision 4256.
  • Revision ID: frankaspell@googlemail.com-20090222165402-2myrucnu7er5w4ha
Fixing various typos

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
34
 
    directory_service,
35
34
    delta,
36
35
    config,
37
36
    errors,
38
37
    globbing,
39
 
    hooks,
40
38
    log,
41
39
    merge as _mod_merge,
42
40
    merge_directive,
43
41
    osutils,
44
42
    reconfigure,
45
 
    rename_map,
46
43
    revision as _mod_revision,
47
 
    static_tuple,
48
44
    symbol_versioning,
49
 
    timestamp,
50
45
    transport,
 
46
    tree as _mod_tree,
51
47
    ui,
52
48
    urlutils,
53
49
    views,
54
50
    )
55
51
from bzrlib.branch import Branch
56
52
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
53
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
59
54
from bzrlib.smtp_connection import SMTPConnection
60
55
from bzrlib.workingtree import WorkingTree
61
56
""")
62
57
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
58
from bzrlib.commands import Command, display_command
68
59
from bzrlib.option import (
69
60
    ListOption,
70
61
    Option,
86
77
 
87
78
 
88
79
def tree_files_for_add(file_list):
89
 
    """
90
 
    Return a tree and list of absolute paths from a file list.
91
 
 
92
 
    Similar to tree_files, but add handles files a bit differently, so it a
93
 
    custom implementation.  In particular, MutableTreeTree.smart_add expects
94
 
    absolute paths, which it immediately converts to relative paths.
95
 
    """
96
 
    # FIXME Would be nice to just return the relative paths like
97
 
    # internal_tree_files does, but there are a large number of unit tests
98
 
    # that assume the current interface to mutabletree.smart_add
 
80
    """Add handles files a bit differently so it a custom implementation."""
99
81
    if file_list:
100
 
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
82
        tree = WorkingTree.open_containing(file_list[0])[0]
101
83
        if tree.supports_views():
102
84
            view_files = tree.views.lookup_view()
103
 
            if view_files:
104
 
                for filename in file_list:
105
 
                    if not osutils.is_inside_any(view_files, filename):
106
 
                        raise errors.FileOutsideView(filename, view_files)
107
 
        file_list = file_list[:]
108
 
        file_list[0] = tree.abspath(relpath)
 
85
            for filename in file_list:
 
86
                if not osutils.is_inside_any(view_files, filename):
 
87
                    raise errors.FileOutsideView(filename, view_files)
109
88
    else:
110
89
        tree = WorkingTree.open_containing(u'.')[0]
111
90
        if tree.supports_views():
113
92
            if view_files:
114
93
                file_list = view_files
115
94
                view_str = views.view_display_str(view_files)
116
 
                note("Ignoring files outside view. View is %s" % view_str)
 
95
                note("ignoring files outside view: %s" % view_str)
117
96
    return tree, file_list
118
97
 
119
98
 
128
107
 
129
108
 
130
109
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
110
    if branch is None:
141
111
        branch = tree.branch
142
112
    if revisions is None:
161
131
 
162
132
    The filenames given are not required to exist.
163
133
 
164
 
    :param file_list: Filenames to convert.
 
134
    :param file_list: Filenames to convert.  
165
135
 
166
136
    :param default_branch: Fallback tree path to use if file_list is empty or
167
137
        None.
178
148
            if view_files:
179
149
                file_list = view_files
180
150
                view_str = views.view_display_str(view_files)
181
 
                note("Ignoring files outside view. View is %s" % view_str)
 
151
                note("ignoring files outside view: %s" % view_str)
182
152
        return tree, file_list
183
153
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
154
    return tree, safe_relpath_files(tree, file_list, canonicalize,
239
209
# opens the branch?)
240
210
 
241
211
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
212
    """Display status summary.
243
213
 
244
214
    This reports on versioned and unknown files, reporting them
245
215
    grouped by state.  Possible states are:
265
235
    unknown
266
236
        Not versioned and not matching an ignore pattern.
267
237
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
238
    To see ignored files use 'bzr ignored'.  For details on the
273
239
    changes to file texts, use 'bzr diff'.
274
 
 
 
240
    
275
241
    Note that --short or -S gives status flags for each item, similar
276
242
    to Subversion's status command. To get output similar to svn -q,
277
243
    use bzr status -SV.
289
255
    If a revision argument is given, the status is calculated against
290
256
    that revision, or between two revisions if two are provided.
291
257
    """
292
 
 
 
258
    
293
259
    # TODO: --no-recurse, --recurse options
294
 
 
 
260
    
295
261
    takes_args = ['file*']
296
262
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
297
263
                     Option('short', help='Use short status indicators.',
305
271
 
306
272
    encoding_type = 'replace'
307
273
    _see_also = ['diff', 'revert', 'status-flags']
308
 
 
 
274
    
309
275
    @display_command
310
276
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
277
            versioned=False, no_pending=False, verbose=False):
332
298
 
333
299
 
334
300
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
336
 
 
 
301
    """Write out metadata for a revision.
 
302
    
337
303
    The revision to print can either be specified by a specific
338
304
    revision identifier, or you can use --revision.
339
305
    """
343
309
    takes_options = ['revision']
344
310
    # cat-revision is more for frontends so should be exact
345
311
    encoding = 'strict'
346
 
 
347
 
    def print_revision(self, revisions, revid):
348
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
349
 
        record = stream.next()
350
 
        if record.storage_kind == 'absent':
351
 
            raise errors.NoSuchRevision(revisions, revid)
352
 
        revtext = record.get_bytes_as('fulltext')
353
 
        self.outf.write(revtext.decode('utf-8'))
354
 
 
 
312
    
355
313
    @display_command
356
314
    def run(self, revision_id=None, revision=None):
357
315
        if revision_id is not None and revision is not None:
362
320
                                         ' --revision or a revision_id')
363
321
        b = WorkingTree.open_containing(u'.')[0].branch
364
322
 
365
 
        revisions = b.repository.revisions
366
 
        if revisions is None:
367
 
            raise errors.BzrCommandError('Repository %r does not support '
368
 
                'access to raw revision texts')
 
323
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
324
        if revision_id is not None:
 
325
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
326
            try:
 
327
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
328
            except errors.NoSuchRevision:
 
329
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
330
                    revision_id)
 
331
                raise errors.BzrCommandError(msg)
 
332
        elif revision is not None:
 
333
            for rev in revision:
 
334
                if rev is None:
 
335
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
336
                                                 ' revision.')
 
337
                rev_id = rev.as_revision_id(b)
 
338
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
369
339
 
370
 
        b.repository.lock_read()
371
 
        try:
372
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
373
 
            if revision_id is not None:
374
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
375
 
                try:
376
 
                    self.print_revision(revisions, revision_id)
377
 
                except errors.NoSuchRevision:
378
 
                    msg = "The repository %s contains no revision %s." % (
379
 
                        b.repository.base, revision_id)
380
 
                    raise errors.BzrCommandError(msg)
381
 
            elif revision is not None:
382
 
                for rev in revision:
383
 
                    if rev is None:
384
 
                        raise errors.BzrCommandError(
385
 
                            'You cannot specify a NULL revision.')
386
 
                    rev_id = rev.as_revision_id(b)
387
 
                    self.print_revision(revisions, rev_id)
388
 
        finally:
389
 
            b.repository.unlock()
390
 
        
391
340
 
392
341
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
342
    """Dump the contents of a btree index file to stdout.
394
343
 
395
344
    PATH is a btree index file, it can be any URL. This includes things like
396
345
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
460
409
        for node in bt.iter_all_entries():
461
410
            # Node is made up of:
462
411
            # (index, key, value, [references])
463
 
            try:
464
 
                refs = node[3]
465
 
            except IndexError:
466
 
                refs_as_tuples = None
467
 
            else:
468
 
                refs_as_tuples = static_tuple.as_tuples(refs)
469
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
470
 
            self.outf.write('%s\n' % (as_tuple,))
 
412
            self.outf.write('%s\n' % (node[1:],))
471
413
 
472
414
 
473
415
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
416
    """Remove the working tree from a given branch/checkout.
475
417
 
476
418
    Since a lightweight checkout is little more than a working tree
477
419
    this will refuse to run against one.
479
421
    To re-create the working tree, use "bzr checkout".
480
422
    """
481
423
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
424
    takes_args = ['location?']
483
425
    takes_options = [
484
426
        Option('force',
485
427
               help='Remove the working tree even if it has '
486
428
                    'uncommitted changes.'),
487
429
        ]
488
430
 
489
 
    def run(self, location_list, force=False):
490
 
        if not location_list:
491
 
            location_list=['.']
492
 
 
493
 
        for location in location_list:
494
 
            d = bzrdir.BzrDir.open(location)
495
 
            
496
 
            try:
497
 
                working = d.open_workingtree()
498
 
            except errors.NoWorkingTree:
499
 
                raise errors.BzrCommandError("No working tree to remove")
500
 
            except errors.NotLocalUrl:
501
 
                raise errors.BzrCommandError("You cannot remove the working tree"
502
 
                                             " of a remote path")
503
 
            if not force:
504
 
                if (working.has_changes()):
505
 
                    raise errors.UncommittedChanges(working)
506
 
 
507
 
            if working.user_url != working.branch.user_url:
508
 
                raise errors.BzrCommandError("You cannot remove the working tree"
509
 
                                             " from a lightweight checkout")
510
 
 
511
 
            d.destroy_workingtree()
512
 
 
 
431
    def run(self, location='.', force=False):
 
432
        d = bzrdir.BzrDir.open(location)
 
433
        
 
434
        try:
 
435
            working = d.open_workingtree()
 
436
        except errors.NoWorkingTree:
 
437
            raise errors.BzrCommandError("No working tree to remove")
 
438
        except errors.NotLocalUrl:
 
439
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
440
                                         "remote path")
 
441
        if not force:
 
442
            changes = working.changes_from(working.basis_tree())
 
443
            if changes.has_changed():
 
444
                raise errors.UncommittedChanges(working)
 
445
 
 
446
        working_path = working.bzrdir.root_transport.base
 
447
        branch_path = working.branch.bzrdir.root_transport.base
 
448
        if working_path != branch_path:
 
449
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
450
                                         "a lightweight checkout")
 
451
        
 
452
        d.destroy_workingtree()
 
453
        
513
454
 
514
455
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
456
    """Show current revision number.
516
457
 
517
458
    This is equal to the number of revisions on this branch.
518
459
    """
519
460
 
520
461
    _see_also = ['info']
521
462
    takes_args = ['location?']
522
 
    takes_options = [
523
 
        Option('tree', help='Show revno of working tree'),
524
 
        ]
525
463
 
526
464
    @display_command
527
 
    def run(self, tree=False, location=u'.'):
528
 
        if tree:
529
 
            try:
530
 
                wt = WorkingTree.open_containing(location)[0]
531
 
                self.add_cleanup(wt.lock_read().unlock)
532
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
 
                raise errors.NoWorkingTree(location)
534
 
            revid = wt.last_revision()
535
 
            try:
536
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
537
 
            except errors.NoSuchRevision:
538
 
                revno_t = ('???',)
539
 
            revno = ".".join(str(n) for n in revno_t)
540
 
        else:
541
 
            b = Branch.open_containing(location)[0]
542
 
            self.add_cleanup(b.lock_read().unlock)
543
 
            revno = b.revno()
544
 
        self.cleanup_now()
545
 
        self.outf.write(str(revno) + '\n')
 
465
    def run(self, location=u'.'):
 
466
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
467
        self.outf.write('\n')
546
468
 
547
469
 
548
470
class cmd_revision_info(Command):
549
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
471
    """Show revision number and revision id for a given revision identifier.
550
472
    """
551
473
    hidden = True
552
474
    takes_args = ['revision_info*']
558
480
            short_name='d',
559
481
            type=unicode,
560
482
            ),
561
 
        Option('tree', help='Show revno of working tree'),
562
483
        ]
563
484
 
564
485
    @display_command
565
 
    def run(self, revision=None, directory=u'.', tree=False,
566
 
            revision_info_list=[]):
 
486
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
567
487
 
568
 
        try:
569
 
            wt = WorkingTree.open_containing(directory)[0]
570
 
            b = wt.branch
571
 
            self.add_cleanup(wt.lock_read().unlock)
572
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
573
 
            wt = None
574
 
            b = Branch.open_containing(directory)[0]
575
 
            self.add_cleanup(b.lock_read().unlock)
576
 
        revision_ids = []
 
488
        revs = []
577
489
        if revision is not None:
578
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
490
            revs.extend(revision)
579
491
        if revision_info_list is not None:
580
 
            for rev_str in revision_info_list:
581
 
                rev_spec = RevisionSpec.from_string(rev_str)
582
 
                revision_ids.append(rev_spec.as_revision_id(b))
583
 
        # No arguments supplied, default to the last revision
584
 
        if len(revision_ids) == 0:
585
 
            if tree:
586
 
                if wt is None:
587
 
                    raise errors.NoWorkingTree(directory)
588
 
                revision_ids.append(wt.last_revision())
589
 
            else:
590
 
                revision_ids.append(b.last_revision())
591
 
 
592
 
        revinfos = []
593
 
        maxlen = 0
594
 
        for revision_id in revision_ids:
 
492
            for rev in revision_info_list:
 
493
                revs.append(RevisionSpec.from_string(rev))
 
494
 
 
495
        b = Branch.open_containing(directory)[0]
 
496
 
 
497
        if len(revs) == 0:
 
498
            revs.append(RevisionSpec.from_string('-1'))
 
499
 
 
500
        for rev in revs:
 
501
            revision_id = rev.as_revision_id(b)
595
502
            try:
596
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
597
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
503
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
598
504
            except errors.NoSuchRevision:
599
 
                revno = '???'
600
 
            maxlen = max(maxlen, len(revno))
601
 
            revinfos.append([revno, revision_id])
602
 
 
603
 
        self.cleanup_now()
604
 
        for ri in revinfos:
605
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
606
 
 
607
 
 
 
505
                dotted_map = b.get_revision_id_to_revno_map()
 
506
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
507
            print '%s %s' % (revno, revision_id)
 
508
 
 
509
    
608
510
class cmd_add(Command):
609
 
    __doc__ = """Add specified files or directories.
 
511
    """Add specified files or directories.
610
512
 
611
513
    In non-recursive mode, all the named items are added, regardless
612
514
    of whether they were previously ignored.  A warning is given if
628
530
    you should never need to explicitly add a directory, they'll just
629
531
    get added when you add a file in the directory.
630
532
 
631
 
    --dry-run will show which files would be added, but not actually
 
533
    --dry-run will show which files would be added, but not actually 
632
534
    add them.
633
535
 
634
536
    --file-ids-from will try to use the file ids from the supplied path.
638
540
    branches that will be merged later (without showing the two different
639
541
    adds as a conflict). It is also useful when merging another project
640
542
    into a subdirectory of this one.
641
 
    
642
 
    Any files matching patterns in the ignore list will not be added
643
 
    unless they are explicitly mentioned.
644
543
    """
645
544
    takes_args = ['file*']
646
545
    takes_options = [
654
553
               help='Lookup file ids from this tree.'),
655
554
        ]
656
555
    encoding_type = 'replace'
657
 
    _see_also = ['remove', 'ignore']
 
556
    _see_also = ['remove']
658
557
 
659
558
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
660
559
            file_ids_from=None):
677
576
                should_print=(not is_quiet()))
678
577
 
679
578
        if base_tree:
680
 
            self.add_cleanup(base_tree.lock_read().unlock)
681
 
        tree, file_list = tree_files_for_add(file_list)
682
 
        added, ignored = tree.smart_add(file_list, not
683
 
            no_recurse, action=action, save=not dry_run)
684
 
        self.cleanup_now()
 
579
            base_tree.lock_read()
 
580
        try:
 
581
            file_list = self._maybe_expand_globs(file_list)
 
582
            tree, file_list = tree_files_for_add(file_list)
 
583
            added, ignored = tree.smart_add(file_list, not
 
584
                no_recurse, action=action, save=not dry_run)
 
585
        finally:
 
586
            if base_tree is not None:
 
587
                base_tree.unlock()
 
588
        if not is_quiet() and len(added) > 0:
 
589
            self.outf.write('add completed\n')
685
590
        if len(ignored) > 0:
686
591
            if verbose:
687
592
                for glob in sorted(ignored.keys()):
688
593
                    for path in ignored[glob]:
689
 
                        self.outf.write("ignored %s matching \"%s\"\n"
 
594
                        self.outf.write("ignored %s matching \"%s\"\n" 
690
595
                                        % (path, glob))
 
596
            else:
 
597
                match_len = 0
 
598
                for glob, paths in ignored.items():
 
599
                    match_len += len(paths)
 
600
                self.outf.write("ignored %d file(s).\n" % match_len)
 
601
            self.outf.write("If you wish to add some of these files,"
 
602
                            " please add them by name.\n")
691
603
 
692
604
 
693
605
class cmd_mkdir(Command):
694
 
    __doc__ = """Create a new versioned directory.
 
606
    """Create a new versioned directory.
695
607
 
696
608
    This is equivalent to creating the directory and then adding it.
697
609
    """
701
613
 
702
614
    def run(self, dir_list):
703
615
        for d in dir_list:
 
616
            os.mkdir(d)
704
617
            wt, dd = WorkingTree.open_containing(d)
705
 
            base = os.path.dirname(dd)
706
 
            id = wt.path2id(base)
707
 
            if id != None:
708
 
                os.mkdir(d)
709
 
                wt.add([dd])
710
 
                self.outf.write('added %s\n' % d)
711
 
            else:
712
 
                raise errors.NotVersionedError(path=base)
 
618
            wt.add([dd])
 
619
            self.outf.write('added %s\n' % d)
713
620
 
714
621
 
715
622
class cmd_relpath(Command):
716
 
    __doc__ = """Show path of a file relative to root"""
 
623
    """Show path of a file relative to root"""
717
624
 
718
625
    takes_args = ['filename']
719
626
    hidden = True
720
 
 
 
627
    
721
628
    @display_command
722
629
    def run(self, filename):
723
630
        # TODO: jam 20050106 Can relpath return a munged path if
728
635
 
729
636
 
730
637
class cmd_inventory(Command):
731
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
638
    """Show inventory of the current working copy or a revision.
732
639
 
733
640
    It is possible to limit the output to a particular entry
734
641
    type using the --kind option.  For example: --kind file.
755
662
 
756
663
        revision = _get_one_revision('inventory', revision)
757
664
        work_tree, file_list = tree_files(file_list)
758
 
        self.add_cleanup(work_tree.lock_read().unlock)
759
 
        if revision is not None:
760
 
            tree = revision.as_tree(work_tree.branch)
761
 
 
762
 
            extra_trees = [work_tree]
763
 
            self.add_cleanup(tree.lock_read().unlock)
764
 
        else:
765
 
            tree = work_tree
766
 
            extra_trees = []
767
 
 
768
 
        if file_list is not None:
769
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
770
 
                                      require_versioned=True)
771
 
            # find_ids_across_trees may include some paths that don't
772
 
            # exist in 'tree'.
773
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
774
 
                             for file_id in file_ids if file_id in tree)
775
 
        else:
776
 
            entries = tree.inventory.entries()
777
 
 
778
 
        self.cleanup_now()
 
665
        work_tree.lock_read()
 
666
        try:
 
667
            if revision is not None:
 
668
                tree = revision.as_tree(work_tree.branch)
 
669
 
 
670
                extra_trees = [work_tree]
 
671
                tree.lock_read()
 
672
            else:
 
673
                tree = work_tree
 
674
                extra_trees = []
 
675
 
 
676
            if file_list is not None:
 
677
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
678
                                          require_versioned=True)
 
679
                # find_ids_across_trees may include some paths that don't
 
680
                # exist in 'tree'.
 
681
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
682
                                 for file_id in file_ids if file_id in tree)
 
683
            else:
 
684
                entries = tree.inventory.entries()
 
685
        finally:
 
686
            tree.unlock()
 
687
            if tree is not work_tree:
 
688
                work_tree.unlock()
 
689
 
779
690
        for path, entry in entries:
780
691
            if kind and kind != entry.kind:
781
692
                continue
787
698
 
788
699
 
789
700
class cmd_mv(Command):
790
 
    __doc__ = """Move or rename a file.
 
701
    """Move or rename a file.
791
702
 
792
703
    :Usage:
793
704
        bzr mv OLDNAME NEWNAME
810
721
    takes_args = ['names*']
811
722
    takes_options = [Option("after", help="Move only the bzr identifier"
812
723
        " of the file, because the file has already been moved."),
813
 
        Option('auto', help='Automatically guess renames.'),
814
 
        Option('dry-run', help='Avoid making changes when guessing renames.'),
815
724
        ]
816
725
    aliases = ['move', 'rename']
817
726
    encoding_type = 'replace'
818
727
 
819
 
    def run(self, names_list, after=False, auto=False, dry_run=False):
820
 
        if auto:
821
 
            return self.run_auto(names_list, after, dry_run)
822
 
        elif dry_run:
823
 
            raise errors.BzrCommandError('--dry-run requires --auto.')
 
728
    def run(self, names_list, after=False):
824
729
        if names_list is None:
825
730
            names_list = []
 
731
 
826
732
        if len(names_list) < 2:
827
733
            raise errors.BzrCommandError("missing file argument")
828
734
        tree, rel_names = tree_files(names_list, canonicalize=False)
829
 
        self.add_cleanup(tree.lock_tree_write().unlock)
830
 
        self._run(tree, names_list, rel_names, after)
831
 
 
832
 
    def run_auto(self, names_list, after, dry_run):
833
 
        if names_list is not None and len(names_list) > 1:
834
 
            raise errors.BzrCommandError('Only one path may be specified to'
835
 
                                         ' --auto.')
836
 
        if after:
837
 
            raise errors.BzrCommandError('--after cannot be specified with'
838
 
                                         ' --auto.')
839
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
840
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
841
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
735
        tree.lock_write()
 
736
        try:
 
737
            self._run(tree, names_list, rel_names, after)
 
738
        finally:
 
739
            tree.unlock()
842
740
 
843
741
    def _run(self, tree, names_list, rel_names, after):
844
742
        into_existing = osutils.isdir(names_list[-1])
865
763
            # All entries reference existing inventory items, so fix them up
866
764
            # for cicp file-systems.
867
765
            rel_names = tree.get_canonical_inventory_paths(rel_names)
868
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
869
 
                if not is_quiet():
870
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
766
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
767
                self.outf.write("%s => %s\n" % pair)
871
768
        else:
872
769
            if len(names_list) != 2:
873
770
                raise errors.BzrCommandError('to mv multiple files the'
904
801
                        # pathjoin with an empty tail adds a slash, which breaks
905
802
                        # relpath :(
906
803
                        dest_parent_fq = tree.basedir
907
 
 
 
804
    
908
805
                    dest_tail = osutils.canonical_relpath(
909
806
                                    dest_parent_fq,
910
807
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
917
814
            dest = osutils.pathjoin(dest_parent, dest_tail)
918
815
            mutter("attempting to move %s => %s", src, dest)
919
816
            tree.rename_one(src, dest, after=after)
920
 
            if not is_quiet():
921
 
                self.outf.write("%s => %s\n" % (src, dest))
 
817
            self.outf.write("%s => %s\n" % (src, dest))
922
818
 
923
819
 
924
820
class cmd_pull(Command):
925
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
821
    """Turn this branch into a mirror of another branch.
926
822
 
927
 
    By default, this command only works on branches that have not diverged.
928
 
    Branches are considered diverged if the destination branch's most recent 
929
 
    commit is one that has not been merged (directly or indirectly) into the 
930
 
    parent.
 
823
    This command only works on branches that have not diverged.  Branches are
 
824
    considered diverged if the destination branch's most recent commit is one
 
825
    that has not been merged (directly or indirectly) into the parent.
931
826
 
932
827
    If branches have diverged, you can use 'bzr merge' to integrate the changes
933
828
    from one into the other.  Once one branch has merged, the other should
934
829
    be able to pull it again.
935
830
 
936
 
    If you want to replace your local changes and just want your branch to
937
 
    match the remote one, use pull --overwrite. This will work even if the two
938
 
    branches have diverged.
 
831
    If you want to forget your local changes and just update your branch to
 
832
    match the remote one, use pull --overwrite.
939
833
 
940
834
    If there is no default location set, the first pull will set it.  After
941
835
    that, you can omit the location to use the default.  To change the
947
841
    with bzr send.
948
842
    """
949
843
 
950
 
    _see_also = ['push', 'update', 'status-flags', 'send']
 
844
    _see_also = ['push', 'update', 'status-flags']
951
845
    takes_options = ['remember', 'overwrite', 'revision',
952
846
        custom_help('verbose',
953
847
            help='Show logs of pulled revisions.'),
957
851
            short_name='d',
958
852
            type=unicode,
959
853
            ),
960
 
        Option('local',
961
 
            help="Perform a local pull in a bound "
962
 
                 "branch.  Local pulls are not applied to "
963
 
                 "the master branch."
964
 
            ),
965
854
        ]
966
855
    takes_args = ['location?']
967
856
    encoding_type = 'replace'
968
857
 
969
858
    def run(self, location=None, remember=False, overwrite=False,
970
859
            revision=None, verbose=False,
971
 
            directory=None, local=False):
 
860
            directory=None):
972
861
        # FIXME: too much stuff is in the command class
973
862
        revision_id = None
974
863
        mergeable = None
977
866
        try:
978
867
            tree_to = WorkingTree.open_containing(directory)[0]
979
868
            branch_to = tree_to.branch
980
 
            self.add_cleanup(tree_to.lock_write().unlock)
981
869
        except errors.NoWorkingTree:
982
870
            tree_to = None
983
871
            branch_to = Branch.open_containing(directory)[0]
984
 
            self.add_cleanup(branch_to.lock_write().unlock)
985
 
 
986
 
        if local and not branch_to.get_bound_location():
987
 
            raise errors.LocalRequiresBoundBranch()
988
872
 
989
873
        possible_transports = []
990
874
        if location is not None:
1018
902
        else:
1019
903
            branch_from = Branch.open(location,
1020
904
                possible_transports=possible_transports)
1021
 
            self.add_cleanup(branch_from.lock_read().unlock)
1022
905
 
1023
906
            if branch_to.get_parent() is None or remember:
1024
907
                branch_to.set_parent(branch_from.base)
1026
909
        if revision is not None:
1027
910
            revision_id = revision.as_revision_id(branch_from)
1028
911
 
1029
 
        if tree_to is not None:
1030
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1031
 
            change_reporter = delta._ChangeReporter(
1032
 
                unversioned_filter=tree_to.is_ignored,
1033
 
                view_info=view_info)
1034
 
            result = tree_to.pull(
1035
 
                branch_from, overwrite, revision_id, change_reporter,
1036
 
                possible_transports=possible_transports, local=local)
1037
 
        else:
1038
 
            result = branch_to.pull(
1039
 
                branch_from, overwrite, revision_id, local=local)
 
912
        branch_to.lock_write()
 
913
        try:
 
914
            if tree_to is not None:
 
915
                view_info = _get_view_info_for_change_reporter(tree_to)
 
916
                change_reporter = delta._ChangeReporter(
 
917
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
918
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
919
                                      change_reporter,
 
920
                                      possible_transports=possible_transports)
 
921
            else:
 
922
                result = branch_to.pull(branch_from, overwrite, revision_id)
1040
923
 
1041
 
        result.report(self.outf)
1042
 
        if verbose and result.old_revid != result.new_revid:
1043
 
            log.show_branch_change(
1044
 
                branch_to, self.outf, result.old_revno,
1045
 
                result.old_revid)
 
924
            result.report(self.outf)
 
925
            if verbose and result.old_revid != result.new_revid:
 
926
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
927
                                       result.old_revid)
 
928
        finally:
 
929
            branch_to.unlock()
1046
930
 
1047
931
 
1048
932
class cmd_push(Command):
1049
 
    __doc__ = """Update a mirror of this branch.
1050
 
 
 
933
    """Update a mirror of this branch.
 
934
    
1051
935
    The target branch will not have its working tree populated because this
1052
936
    is both expensive, and is not supported on remote file systems.
1053
 
 
 
937
    
1054
938
    Some smart servers or protocols *may* put the working tree in place in
1055
939
    the future.
1056
940
 
1060
944
 
1061
945
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1062
946
    the other branch completely, discarding its unmerged changes.
1063
 
 
 
947
    
1064
948
    If you want to ensure you have the different changes in the other branch,
1065
949
    do a merge (see bzr help merge) from the other branch, and commit that.
1066
950
    After that you will be able to do a push without '--overwrite'.
1095
979
                'for the commit history. Only the work not present in the '
1096
980
                'referenced branch is included in the branch created.',
1097
981
            type=unicode),
1098
 
        Option('strict',
1099
 
               help='Refuse to push if there are uncommitted changes in'
1100
 
               ' the working tree, --no-strict disables the check.'),
1101
982
        ]
1102
983
    takes_args = ['location?']
1103
984
    encoding_type = 'replace'
1105
986
    def run(self, location=None, remember=False, overwrite=False,
1106
987
        create_prefix=False, verbose=False, revision=None,
1107
988
        use_existing_dir=False, directory=None, stacked_on=None,
1108
 
        stacked=False, strict=None):
 
989
        stacked=False):
1109
990
        from bzrlib.push import _show_push_branch
1110
991
 
 
992
        # Get the source branch and revision_id
1111
993
        if directory is None:
1112
994
            directory = '.'
1113
 
        # Get the source branch
1114
 
        (tree, br_from,
1115
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1116
 
        # Get the tip's revision_id
 
995
        br_from = Branch.open_containing(directory)[0]
1117
996
        revision = _get_one_revision('push', revision)
1118
997
        if revision is not None:
1119
998
            revision_id = revision.in_history(br_from).rev_id
1120
999
        else:
1121
 
            revision_id = None
1122
 
        if tree is not None and revision_id is None:
1123
 
            tree.check_changed_or_out_of_date(
1124
 
                strict, 'push_strict',
1125
 
                more_error='Use --no-strict to force the push.',
1126
 
                more_warning='Uncommitted changes will not be pushed.')
 
1000
            revision_id = br_from.last_revision()
 
1001
 
1127
1002
        # Get the stacked_on branch, if any
1128
1003
        if stacked_on is not None:
1129
1004
            stacked_on = urlutils.normalize_url(stacked_on)
1161
1036
 
1162
1037
 
1163
1038
class cmd_branch(Command):
1164
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1039
    """Create a new copy of a branch.
1165
1040
 
1166
1041
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1167
1042
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1180
1055
        help='Hard-link working tree files where possible.'),
1181
1056
        Option('no-tree',
1182
1057
            help="Create a branch without a working-tree."),
1183
 
        Option('switch',
1184
 
            help="Switch the checkout in the current directory "
1185
 
                 "to the new branch."),
1186
1058
        Option('stacked',
1187
1059
            help='Create a stacked branch referring to the source branch. '
1188
1060
                'The new branch will depend on the availability of the source '
1189
1061
                'branch for all operations.'),
1190
1062
        Option('standalone',
1191
1063
               help='Do not use a shared repository, even if available.'),
1192
 
        Option('use-existing-dir',
1193
 
               help='By default branch will fail if the target'
1194
 
                    ' directory exists, but does not already'
1195
 
                    ' have a control directory.  This flag will'
1196
 
                    ' allow branch to proceed.'),
1197
 
        Option('bind',
1198
 
            help="Bind new branch to from location."),
1199
1064
        ]
1200
1065
    aliases = ['get', 'clone']
1201
1066
 
1202
1067
    def run(self, from_location, to_location=None, revision=None,
1203
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1204
 
            use_existing_dir=False, switch=False, bind=False):
1205
 
        from bzrlib import switch as _mod_switch
 
1068
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1206
1069
        from bzrlib.tag import _merge_tags_if_possible
 
1070
 
1207
1071
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1208
1072
            from_location)
1209
1073
        revision = _get_one_revision('branch', revision)
1210
 
        self.add_cleanup(br_from.lock_read().unlock)
1211
 
        if revision is not None:
1212
 
            revision_id = revision.as_revision_id(br_from)
1213
 
        else:
1214
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1215
 
            # None or perhaps NULL_REVISION to mean copy nothing
1216
 
            # RBC 20060209
1217
 
            revision_id = br_from.last_revision()
1218
 
        if to_location is None:
1219
 
            to_location = urlutils.derive_to_location(from_location)
1220
 
        to_transport = transport.get_transport(to_location)
 
1074
        br_from.lock_read()
1221
1075
        try:
1222
 
            to_transport.mkdir('.')
1223
 
        except errors.FileExists:
1224
 
            if not use_existing_dir:
1225
 
                raise errors.BzrCommandError('Target directory "%s" '
1226
 
                    'already exists.' % to_location)
 
1076
            if revision is not None:
 
1077
                revision_id = revision.as_revision_id(br_from)
1227
1078
            else:
1228
 
                try:
1229
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1230
 
                except errors.NotBranchError:
1231
 
                    pass
1232
 
                else:
1233
 
                    raise errors.AlreadyBranchError(to_location)
1234
 
        except errors.NoSuchFile:
1235
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1236
 
                                         % to_location)
1237
 
        try:
1238
 
            # preserve whatever source format we have.
1239
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1240
 
                                        possible_transports=[to_transport],
1241
 
                                        accelerator_tree=accelerator_tree,
1242
 
                                        hardlink=hardlink, stacked=stacked,
1243
 
                                        force_new_repo=standalone,
1244
 
                                        create_tree_if_local=not no_tree,
1245
 
                                        source_branch=br_from)
1246
 
            branch = dir.open_branch()
1247
 
        except errors.NoSuchRevision:
1248
 
            to_transport.delete_tree('.')
1249
 
            msg = "The branch %s has no revision %s." % (from_location,
1250
 
                revision)
1251
 
            raise errors.BzrCommandError(msg)
1252
 
        _merge_tags_if_possible(br_from, branch)
1253
 
        # If the source branch is stacked, the new branch may
1254
 
        # be stacked whether we asked for that explicitly or not.
1255
 
        # We therefore need a try/except here and not just 'if stacked:'
1256
 
        try:
1257
 
            note('Created new stacked branch referring to %s.' %
1258
 
                branch.get_stacked_on_url())
1259
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1260
 
            errors.UnstackableRepositoryFormat), e:
1261
 
            note('Branched %d revision(s).' % branch.revno())
1262
 
        if bind:
1263
 
            # Bind to the parent
1264
 
            parent_branch = Branch.open(from_location)
1265
 
            branch.bind(parent_branch)
1266
 
            note('New branch bound to %s' % from_location)
1267
 
        if switch:
1268
 
            # Switch to the new branch
1269
 
            wt, _ = WorkingTree.open_containing('.')
1270
 
            _mod_switch.switch(wt.bzrdir, branch)
1271
 
            note('Switched to branch: %s',
1272
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1079
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1080
                # None or perhaps NULL_REVISION to mean copy nothing
 
1081
                # RBC 20060209
 
1082
                revision_id = br_from.last_revision()
 
1083
            if to_location is None:
 
1084
                to_location = urlutils.derive_to_location(from_location)
 
1085
            to_transport = transport.get_transport(to_location)
 
1086
            try:
 
1087
                to_transport.mkdir('.')
 
1088
            except errors.FileExists:
 
1089
                raise errors.BzrCommandError('Target directory "%s" already'
 
1090
                                             ' exists.' % to_location)
 
1091
            except errors.NoSuchFile:
 
1092
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1093
                                             % to_location)
 
1094
            try:
 
1095
                # preserve whatever source format we have.
 
1096
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1097
                                            possible_transports=[to_transport],
 
1098
                                            accelerator_tree=accelerator_tree,
 
1099
                                            hardlink=hardlink, stacked=stacked,
 
1100
                                            force_new_repo=standalone,
 
1101
                                            create_tree_if_local=not no_tree,
 
1102
                                            source_branch=br_from)
 
1103
                branch = dir.open_branch()
 
1104
            except errors.NoSuchRevision:
 
1105
                to_transport.delete_tree('.')
 
1106
                msg = "The branch %s has no revision %s." % (from_location,
 
1107
                    revision)
 
1108
                raise errors.BzrCommandError(msg)
 
1109
            _merge_tags_if_possible(br_from, branch)
 
1110
            # If the source branch is stacked, the new branch may
 
1111
            # be stacked whether we asked for that explicitly or not.
 
1112
            # We therefore need a try/except here and not just 'if stacked:'
 
1113
            try:
 
1114
                note('Created new stacked branch referring to %s.' %
 
1115
                    branch.get_stacked_on_url())
 
1116
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1117
                errors.UnstackableRepositoryFormat), e:
 
1118
                note('Branched %d revision(s).' % branch.revno())
 
1119
        finally:
 
1120
            br_from.unlock()
1273
1121
 
1274
1122
 
1275
1123
class cmd_checkout(Command):
1276
 
    __doc__ = """Create a new checkout of an existing branch.
 
1124
    """Create a new checkout of an existing branch.
1277
1125
 
1278
1126
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1279
1127
    the branch found in '.'. This is useful if you have removed the working tree
1280
1128
    or if it was never created - i.e. if you pushed the branch to its current
1281
1129
    location using SFTP.
1282
 
 
 
1130
    
1283
1131
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1284
1132
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1285
1133
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1327
1175
            revision_id = None
1328
1176
        if to_location is None:
1329
1177
            to_location = urlutils.derive_to_location(branch_location)
1330
 
        # if the source and to_location are the same,
 
1178
        # if the source and to_location are the same, 
1331
1179
        # and there is no working tree,
1332
1180
        # then reconstitute a branch
1333
1181
        if (osutils.abspath(to_location) ==
1342
1190
 
1343
1191
 
1344
1192
class cmd_renames(Command):
1345
 
    __doc__ = """Show list of renamed files.
 
1193
    """Show list of renamed files.
1346
1194
    """
1347
1195
    # TODO: Option to show renames between two historical versions.
1348
1196
 
1353
1201
    @display_command
1354
1202
    def run(self, dir=u'.'):
1355
1203
        tree = WorkingTree.open_containing(dir)[0]
1356
 
        self.add_cleanup(tree.lock_read().unlock)
1357
 
        new_inv = tree.inventory
1358
 
        old_tree = tree.basis_tree()
1359
 
        self.add_cleanup(old_tree.lock_read().unlock)
1360
 
        old_inv = old_tree.inventory
1361
 
        renames = []
1362
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1363
 
        for f, paths, c, v, p, n, k, e in iterator:
1364
 
            if paths[0] == paths[1]:
1365
 
                continue
1366
 
            if None in (paths):
1367
 
                continue
1368
 
            renames.append(paths)
1369
 
        renames.sort()
1370
 
        for old_name, new_name in renames:
1371
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1204
        tree.lock_read()
 
1205
        try:
 
1206
            new_inv = tree.inventory
 
1207
            old_tree = tree.basis_tree()
 
1208
            old_tree.lock_read()
 
1209
            try:
 
1210
                old_inv = old_tree.inventory
 
1211
                renames = []
 
1212
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1213
                for f, paths, c, v, p, n, k, e in iterator:
 
1214
                    if paths[0] == paths[1]:
 
1215
                        continue
 
1216
                    if None in (paths):
 
1217
                        continue
 
1218
                    renames.append(paths)
 
1219
                renames.sort()
 
1220
                for old_name, new_name in renames:
 
1221
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1222
            finally:
 
1223
                old_tree.unlock()
 
1224
        finally:
 
1225
            tree.unlock()
1372
1226
 
1373
1227
 
1374
1228
class cmd_update(Command):
1375
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
1376
 
 
 
1229
    """Update a tree to have the latest code committed to its branch.
 
1230
    
1377
1231
    This will perform a merge into the working tree, and may generate
1378
 
    conflicts. If you have any local changes, you will still
 
1232
    conflicts. If you have any local changes, you will still 
1379
1233
    need to commit them after the update for the update to be complete.
1380
 
 
1381
 
    If you want to discard your local changes, you can just do a
 
1234
    
 
1235
    If you want to discard your local changes, you can just do a 
1382
1236
    'bzr revert' instead of 'bzr commit' after the update.
1383
 
 
1384
 
    If the tree's branch is bound to a master branch, it will also update
1385
 
    the branch from the master.
1386
1237
    """
1387
1238
 
1388
1239
    _see_also = ['pull', 'working-trees', 'status-flags']
1389
1240
    takes_args = ['dir?']
1390
 
    takes_options = ['revision']
1391
1241
    aliases = ['up']
1392
1242
 
1393
 
    def run(self, dir='.', revision=None):
1394
 
        if revision is not None and len(revision) != 1:
1395
 
            raise errors.BzrCommandError(
1396
 
                        "bzr update --revision takes exactly one revision")
 
1243
    def run(self, dir='.'):
1397
1244
        tree = WorkingTree.open_containing(dir)[0]
1398
 
        branch = tree.branch
1399
1245
        possible_transports = []
1400
 
        master = branch.get_master_branch(
 
1246
        master = tree.branch.get_master_branch(
1401
1247
            possible_transports=possible_transports)
1402
1248
        if master is not None:
1403
 
            branch_location = master.base
1404
1249
            tree.lock_write()
1405
1250
        else:
1406
 
            branch_location = tree.branch.base
1407
1251
            tree.lock_tree_write()
1408
 
        self.add_cleanup(tree.unlock)
1409
 
        # get rid of the final '/' and be ready for display
1410
 
        branch_location = urlutils.unescape_for_display(
1411
 
            branch_location.rstrip('/'),
1412
 
            self.outf.encoding)
1413
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1414
 
        if master is None:
1415
 
            old_tip = None
1416
 
        else:
1417
 
            # may need to fetch data into a heavyweight checkout
1418
 
            # XXX: this may take some time, maybe we should display a
1419
 
            # message
1420
 
            old_tip = branch.update(possible_transports)
1421
 
        if revision is not None:
1422
 
            revision_id = revision[0].as_revision_id(branch)
1423
 
        else:
1424
 
            revision_id = branch.last_revision()
1425
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1426
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1427
 
            note("Tree is up to date at revision %s of branch %s" %
1428
 
                ('.'.join(map(str, revno)), branch_location))
1429
 
            return 0
1430
 
        view_info = _get_view_info_for_change_reporter(tree)
1431
 
        change_reporter = delta._ChangeReporter(
1432
 
            unversioned_filter=tree.is_ignored,
1433
 
            view_info=view_info)
1434
1252
        try:
 
1253
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1254
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1255
            if last_rev == _mod_revision.ensure_null(
 
1256
                tree.branch.last_revision()):
 
1257
                # may be up to date, check master too.
 
1258
                if master is None or last_rev == _mod_revision.ensure_null(
 
1259
                    master.last_revision()):
 
1260
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1261
                    note("Tree is up to date at revision %d." % (revno,))
 
1262
                    return 0
 
1263
            view_info = _get_view_info_for_change_reporter(tree)
1435
1264
            conflicts = tree.update(
1436
 
                change_reporter,
1437
 
                possible_transports=possible_transports,
1438
 
                revision=revision_id,
1439
 
                old_tip=old_tip)
1440
 
        except errors.NoSuchRevision, e:
1441
 
            raise errors.BzrCommandError(
1442
 
                                  "branch has no revision %s\n"
1443
 
                                  "bzr update --revision only works"
1444
 
                                  " for a revision in the branch history"
1445
 
                                  % (e.revision))
1446
 
        revno = tree.branch.revision_id_to_dotted_revno(
1447
 
            _mod_revision.ensure_null(tree.last_revision()))
1448
 
        note('Updated to revision %s of branch %s' %
1449
 
             ('.'.join(map(str, revno)), branch_location))
1450
 
        parent_ids = tree.get_parent_ids()
1451
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1452
 
            note('Your local commits will now show as pending merges with '
1453
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1454
 
        if conflicts != 0:
1455
 
            return 1
1456
 
        else:
1457
 
            return 0
 
1265
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1266
                view_info=view_info), possible_transports=possible_transports)
 
1267
            revno = tree.branch.revision_id_to_revno(
 
1268
                _mod_revision.ensure_null(tree.last_revision()))
 
1269
            note('Updated to revision %d.' % (revno,))
 
1270
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1271
                note('Your local commits will now show as pending merges with '
 
1272
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1273
            if conflicts != 0:
 
1274
                return 1
 
1275
            else:
 
1276
                return 0
 
1277
        finally:
 
1278
            tree.unlock()
1458
1279
 
1459
1280
 
1460
1281
class cmd_info(Command):
1461
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1282
    """Show information about a working tree, branch or repository.
1462
1283
 
1463
1284
    This command will show all known locations and formats associated to the
1464
 
    tree, branch or repository.
1465
 
 
1466
 
    In verbose mode, statistical information is included with each report.
1467
 
    To see extended statistic information, use a verbosity level of 2 or
1468
 
    higher by specifying the verbose option multiple times, e.g. -vv.
 
1285
    tree, branch or repository.  Statistical information is included with
 
1286
    each report.
1469
1287
 
1470
1288
    Branches and working trees will also report any missing revisions.
1471
 
 
1472
 
    :Examples:
1473
 
 
1474
 
      Display information on the format and related locations:
1475
 
 
1476
 
        bzr info
1477
 
 
1478
 
      Display the above together with extended format information and
1479
 
      basic statistics (like the number of files in the working tree and
1480
 
      number of revisions in the branch and repository):
1481
 
 
1482
 
        bzr info -v
1483
 
 
1484
 
      Display the above together with number of committers to the branch:
1485
 
 
1486
 
        bzr info -vv
1487
1289
    """
1488
1290
    _see_also = ['revno', 'working-trees', 'repositories']
1489
1291
    takes_args = ['location?']
1493
1295
    @display_command
1494
1296
    def run(self, location=None, verbose=False):
1495
1297
        if verbose:
1496
 
            noise_level = get_verbosity_level()
 
1298
            noise_level = 2
1497
1299
        else:
1498
1300
            noise_level = 0
1499
1301
        from bzrlib.info import show_bzrdir_info
1502
1304
 
1503
1305
 
1504
1306
class cmd_remove(Command):
1505
 
    __doc__ = """Remove files or directories.
 
1307
    """Remove files or directories.
1506
1308
 
1507
1309
    This makes bzr stop tracking changes to the specified files. bzr will delete
1508
1310
    them if they can easily be recovered using revert. If no options or
1517
1319
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1518
1320
            safe='Only delete files if they can be'
1519
1321
                 ' safely recovered (default).',
1520
 
            keep='Delete from bzr but leave the working copy.',
 
1322
            keep="Don't delete any files.",
1521
1323
            force='Delete all the specified files, even if they can not be '
1522
1324
                'recovered and even if they are non-empty directories.')]
1523
1325
    aliases = ['rm', 'del']
1530
1332
        if file_list is not None:
1531
1333
            file_list = [f for f in file_list]
1532
1334
 
1533
 
        self.add_cleanup(tree.lock_write().unlock)
1534
 
        # Heuristics should probably all move into tree.remove_smart or
1535
 
        # some such?
1536
 
        if new:
1537
 
            added = tree.changes_from(tree.basis_tree(),
1538
 
                specific_files=file_list).added
1539
 
            file_list = sorted([f[0] for f in added], reverse=True)
1540
 
            if len(file_list) == 0:
1541
 
                raise errors.BzrCommandError('No matching files.')
1542
 
        elif file_list is None:
1543
 
            # missing files show up in iter_changes(basis) as
1544
 
            # versioned-with-no-kind.
1545
 
            missing = []
1546
 
            for change in tree.iter_changes(tree.basis_tree()):
1547
 
                # Find paths in the working tree that have no kind:
1548
 
                if change[1][1] is not None and change[6][1] is None:
1549
 
                    missing.append(change[1][1])
1550
 
            file_list = sorted(missing, reverse=True)
1551
 
            file_deletion_strategy = 'keep'
1552
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1553
 
            keep_files=file_deletion_strategy=='keep',
1554
 
            force=file_deletion_strategy=='force')
 
1335
        tree.lock_write()
 
1336
        try:
 
1337
            # Heuristics should probably all move into tree.remove_smart or
 
1338
            # some such?
 
1339
            if new:
 
1340
                added = tree.changes_from(tree.basis_tree(),
 
1341
                    specific_files=file_list).added
 
1342
                file_list = sorted([f[0] for f in added], reverse=True)
 
1343
                if len(file_list) == 0:
 
1344
                    raise errors.BzrCommandError('No matching files.')
 
1345
            elif file_list is None:
 
1346
                # missing files show up in iter_changes(basis) as
 
1347
                # versioned-with-no-kind.
 
1348
                missing = []
 
1349
                for change in tree.iter_changes(tree.basis_tree()):
 
1350
                    # Find paths in the working tree that have no kind:
 
1351
                    if change[1][1] is not None and change[6][1] is None:
 
1352
                        missing.append(change[1][1])
 
1353
                file_list = sorted(missing, reverse=True)
 
1354
                file_deletion_strategy = 'keep'
 
1355
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1356
                keep_files=file_deletion_strategy=='keep',
 
1357
                force=file_deletion_strategy=='force')
 
1358
        finally:
 
1359
            tree.unlock()
1555
1360
 
1556
1361
 
1557
1362
class cmd_file_id(Command):
1558
 
    __doc__ = """Print file_id of a particular file or directory.
 
1363
    """Print file_id of a particular file or directory.
1559
1364
 
1560
1365
    The file_id is assigned when the file is first added and remains the
1561
1366
    same through all revisions where the file exists, even when it is
1577
1382
 
1578
1383
 
1579
1384
class cmd_file_path(Command):
1580
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1385
    """Print path of file_ids to a file or directory.
1581
1386
 
1582
1387
    This prints one line for each directory down to the target,
1583
1388
    starting at the branch root.
1599
1404
 
1600
1405
 
1601
1406
class cmd_reconcile(Command):
1602
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1407
    """Reconcile bzr metadata in a branch.
1603
1408
 
1604
1409
    This can correct data mismatches that may have been caused by
1605
1410
    previous ghost operations or bzr upgrades. You should only
1606
 
    need to run this command if 'bzr check' or a bzr developer
 
1411
    need to run this command if 'bzr check' or a bzr developer 
1607
1412
    advises you to run it.
1608
1413
 
1609
1414
    If a second branch is provided, cross-branch reconciliation is
1611
1416
    id which was not present in very early bzr versions is represented
1612
1417
    correctly in both branches.
1613
1418
 
1614
 
    At the same time it is run it may recompress data resulting in
 
1419
    At the same time it is run it may recompress data resulting in 
1615
1420
    a potential saving in disk space or performance gain.
1616
1421
 
1617
1422
    The branch *MUST* be on a listable system such as local disk or sftp.
1627
1432
 
1628
1433
 
1629
1434
class cmd_revision_history(Command):
1630
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1435
    """Display the list of revision ids on a branch."""
1631
1436
 
1632
1437
    _see_also = ['log']
1633
1438
    takes_args = ['location?']
1643
1448
 
1644
1449
 
1645
1450
class cmd_ancestry(Command):
1646
 
    __doc__ = """List all revisions merged into this branch."""
 
1451
    """List all revisions merged into this branch."""
1647
1452
 
1648
1453
    _see_also = ['log', 'revision-history']
1649
1454
    takes_args = ['location?']
1668
1473
 
1669
1474
 
1670
1475
class cmd_init(Command):
1671
 
    __doc__ = """Make a directory into a versioned branch.
 
1476
    """Make a directory into a versioned branch.
1672
1477
 
1673
1478
    Use this to create an empty branch, or before importing an
1674
1479
    existing project.
1675
1480
 
1676
 
    If there is a repository in a parent directory of the location, then
 
1481
    If there is a repository in a parent directory of the location, then 
1677
1482
    the history of the branch will be stored in the repository.  Otherwise
1678
1483
    init creates a standalone branch which carries its own history
1679
1484
    in the .bzr directory.
1702
1507
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1703
1508
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1704
1509
                value_switches=True,
1705
 
                title="Branch format",
 
1510
                title="Branch Format",
1706
1511
                ),
1707
1512
         Option('append-revisions-only',
1708
1513
                help='Never change revnos or the existing log.'
1731
1536
                    "\nYou may supply --create-prefix to create all"
1732
1537
                    " leading parent directories."
1733
1538
                    % location)
1734
 
            to_transport.create_prefix()
 
1539
            _create_prefix(to_transport)
1735
1540
 
1736
1541
        try:
1737
1542
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1755
1560
                branch.set_append_revisions_only(True)
1756
1561
            except errors.UpgradeRequired:
1757
1562
                raise errors.BzrCommandError('This branch format cannot be set'
1758
 
                    ' to append-revisions-only.  Try --default.')
 
1563
                    ' to append-revisions-only.  Try --experimental-branch6')
1759
1564
        if not is_quiet():
1760
1565
            from bzrlib.info import describe_layout, describe_format
1761
1566
            try:
1777
1582
 
1778
1583
 
1779
1584
class cmd_init_repository(Command):
1780
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1585
    """Create a shared repository to hold branches.
1781
1586
 
1782
1587
    New branches created under the repository directory will store their
1783
 
    revisions in the repository, not in the branch directory.  For branches
1784
 
    with shared history, this reduces the amount of storage needed and 
1785
 
    speeds up the creation of new branches.
 
1588
    revisions in the repository, not in the branch directory.
1786
1589
 
1787
 
    If the --no-trees option is given then the branches in the repository
1788
 
    will not have working trees by default.  They will still exist as 
1789
 
    directories on disk, but they will not have separate copies of the 
1790
 
    files at a certain revision.  This can be useful for repositories that
1791
 
    store branches which are interacted with through checkouts or remote
1792
 
    branches, such as on a server.
 
1590
    If the --no-trees option is used then the branches in the repository
 
1591
    will not have working trees by default.
1793
1592
 
1794
1593
    :Examples:
1795
 
        Create a shared repository holding just branches::
 
1594
        Create a shared repositories holding just branches::
1796
1595
 
1797
1596
            bzr init-repo --no-trees repo
1798
1597
            bzr init repo/trunk
1837
1636
 
1838
1637
 
1839
1638
class cmd_diff(Command):
1840
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
1841
 
 
 
1639
    """Show differences in the working tree, between revisions or branches.
 
1640
    
1842
1641
    If no arguments are given, all changes for the current tree are listed.
1843
1642
    If files are given, only the changes in those files are listed.
1844
1643
    Remote and multiple branches can be compared by using the --old and
1864
1663
 
1865
1664
            bzr diff -r1
1866
1665
 
1867
 
        Difference between revision 3 and revision 1::
1868
 
 
1869
 
            bzr diff -r1..3
1870
 
 
1871
 
        Difference between revision 3 and revision 1 for branch xxx::
1872
 
 
1873
 
            bzr diff -r1..3 xxx
1874
 
 
1875
 
        To see the changes introduced in revision X::
1876
 
        
1877
 
            bzr diff -cX
1878
 
 
1879
 
        Note that in the case of a merge, the -c option shows the changes
1880
 
        compared to the left hand parent. To see the changes against
1881
 
        another parent, use::
1882
 
 
1883
 
            bzr diff -r<chosen_parent>..X
1884
 
 
1885
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1886
 
 
1887
 
            bzr diff -c2
 
1666
        Difference between revision 2 and revision 1::
 
1667
 
 
1668
            bzr diff -r1..2
 
1669
 
 
1670
        Difference between revision 2 and revision 1 for branch xxx::
 
1671
 
 
1672
            bzr diff -r1..2 xxx
1888
1673
 
1889
1674
        Show just the differences for file NEWS::
1890
1675
 
1929
1714
            help='Use this command to compare files.',
1930
1715
            type=unicode,
1931
1716
            ),
1932
 
        RegistryOption('format',
1933
 
            help='Diff format to use.',
1934
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1935
 
            value_switches=False, title='Diff format'),
1936
1717
        ]
1937
1718
    aliases = ['di', 'dif']
1938
1719
    encoding_type = 'exact'
1939
1720
 
1940
1721
    @display_command
1941
1722
    def run(self, revision=None, file_list=None, diff_options=None,
1942
 
            prefix=None, old=None, new=None, using=None, format=None):
1943
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1944
 
            show_diff_trees)
 
1723
            prefix=None, old=None, new=None, using=None):
 
1724
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1945
1725
 
1946
1726
        if (prefix is None) or (prefix == '0'):
1947
1727
            # diff -p0 format
1961
1741
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1962
1742
                                         ' one or two revision specifiers')
1963
1743
 
1964
 
        if using is not None and format is not None:
1965
 
            raise errors.BzrCommandError('--using and --format are mutually '
1966
 
                'exclusive.')
1967
 
 
1968
 
        (old_tree, new_tree,
1969
 
         old_branch, new_branch,
1970
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1971
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1972
 
        return show_diff_trees(old_tree, new_tree, sys.stdout,
 
1744
        old_tree, new_tree, specific_files, extra_trees = \
 
1745
                _get_trees_to_diff(file_list, revision, old, new,
 
1746
                apply_view=True)
 
1747
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
1973
1748
                               specific_files=specific_files,
1974
1749
                               external_diff_options=diff_options,
1975
1750
                               old_label=old_label, new_label=new_label,
1976
 
                               extra_trees=extra_trees, using=using,
1977
 
                               format_cls=format)
 
1751
                               extra_trees=extra_trees, using=using)
1978
1752
 
1979
1753
 
1980
1754
class cmd_deleted(Command):
1981
 
    __doc__ = """List files deleted in the working tree.
 
1755
    """List files deleted in the working tree.
1982
1756
    """
1983
1757
    # TODO: Show files deleted since a previous revision, or
1984
1758
    # between two revisions.
1992
1766
    @display_command
1993
1767
    def run(self, show_ids=False):
1994
1768
        tree = WorkingTree.open_containing(u'.')[0]
1995
 
        self.add_cleanup(tree.lock_read().unlock)
1996
 
        old = tree.basis_tree()
1997
 
        self.add_cleanup(old.lock_read().unlock)
1998
 
        for path, ie in old.inventory.iter_entries():
1999
 
            if not tree.has_id(ie.file_id):
2000
 
                self.outf.write(path)
2001
 
                if show_ids:
2002
 
                    self.outf.write(' ')
2003
 
                    self.outf.write(ie.file_id)
2004
 
                self.outf.write('\n')
 
1769
        tree.lock_read()
 
1770
        try:
 
1771
            old = tree.basis_tree()
 
1772
            old.lock_read()
 
1773
            try:
 
1774
                for path, ie in old.inventory.iter_entries():
 
1775
                    if not tree.has_id(ie.file_id):
 
1776
                        self.outf.write(path)
 
1777
                        if show_ids:
 
1778
                            self.outf.write(' ')
 
1779
                            self.outf.write(ie.file_id)
 
1780
                        self.outf.write('\n')
 
1781
            finally:
 
1782
                old.unlock()
 
1783
        finally:
 
1784
            tree.unlock()
2005
1785
 
2006
1786
 
2007
1787
class cmd_modified(Command):
2008
 
    __doc__ = """List files modified in working tree.
 
1788
    """List files modified in working tree.
2009
1789
    """
2010
1790
 
2011
1791
    hidden = True
2028
1808
 
2029
1809
 
2030
1810
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1811
    """List files added in working tree.
2032
1812
    """
2033
1813
 
2034
1814
    hidden = True
2042
1822
    @display_command
2043
1823
    def run(self, null=False):
2044
1824
        wt = WorkingTree.open_containing(u'.')[0]
2045
 
        self.add_cleanup(wt.lock_read().unlock)
2046
 
        basis = wt.basis_tree()
2047
 
        self.add_cleanup(basis.lock_read().unlock)
2048
 
        basis_inv = basis.inventory
2049
 
        inv = wt.inventory
2050
 
        for file_id in inv:
2051
 
            if file_id in basis_inv:
2052
 
                continue
2053
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2054
 
                continue
2055
 
            path = inv.id2path(file_id)
2056
 
            if not os.access(osutils.abspath(path), os.F_OK):
2057
 
                continue
2058
 
            if null:
2059
 
                self.outf.write(path + '\0')
2060
 
            else:
2061
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1825
        wt.lock_read()
 
1826
        try:
 
1827
            basis = wt.basis_tree()
 
1828
            basis.lock_read()
 
1829
            try:
 
1830
                basis_inv = basis.inventory
 
1831
                inv = wt.inventory
 
1832
                for file_id in inv:
 
1833
                    if file_id in basis_inv:
 
1834
                        continue
 
1835
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1836
                        continue
 
1837
                    path = inv.id2path(file_id)
 
1838
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1839
                        continue
 
1840
                    if null:
 
1841
                        self.outf.write(path + '\0')
 
1842
                    else:
 
1843
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1844
            finally:
 
1845
                basis.unlock()
 
1846
        finally:
 
1847
            wt.unlock()
2062
1848
 
2063
1849
 
2064
1850
class cmd_root(Command):
2065
 
    __doc__ = """Show the tree root directory.
 
1851
    """Show the tree root directory.
2066
1852
 
2067
1853
    The root is the nearest enclosing directory with a .bzr control
2068
1854
    directory."""
2092
1878
 
2093
1879
 
2094
1880
class cmd_log(Command):
2095
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1881
    """Show historical log for a branch or subset of a branch.
2096
1882
 
2097
1883
    log is bzr's default tool for exploring the history of a branch.
2098
1884
    The branch to use is taken from the first parameter. If no parameters
2111
1897
    were merged.
2112
1898
 
2113
1899
    :Output control:
2114
 
 
 
1900
 
2115
1901
      The log format controls how information about each revision is
2116
1902
      displayed. The standard log formats are called ``long``, ``short``
2117
1903
      and ``line``. The default is long. See ``bzr help log-formats``
2119
1905
 
2120
1906
      The following options can be used to control what information is
2121
1907
      displayed::
2122
 
 
 
1908
  
2123
1909
        -l N        display a maximum of N revisions
2124
1910
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
2125
1911
        -v          display a status summary (delta) for each revision
2126
1912
        -p          display a diff (patch) for each revision
2127
1913
        --show-ids  display revision-ids (and file-ids), not just revnos
2128
 
 
 
1914
  
2129
1915
      Note that the default number of levels to display is a function of the
2130
 
      log format. If the -n option is not used, the standard log formats show
2131
 
      just the top level (mainline).
2132
 
 
 
1916
      log format. If the -n option is not used, ``short`` and ``line`` show
 
1917
      just the top level (mainline) while ``long`` shows all levels of merged
 
1918
      revisions.
 
1919
  
2133
1920
      Status summaries are shown using status flags like A, M, etc. To see
2134
1921
      the changes explained using words like ``added`` and ``modified``
2135
1922
      instead, use the -vv option.
2136
 
 
 
1923
  
2137
1924
    :Ordering control:
2138
 
 
 
1925
  
2139
1926
      To display revisions from oldest to newest, use the --forward option.
2140
1927
      In most cases, using this option will have little impact on the total
2141
1928
      time taken to produce a log, though --forward does not incrementally
2142
1929
      display revisions like --reverse does when it can.
2143
 
 
 
1930
  
2144
1931
    :Revision filtering:
2145
 
 
 
1932
  
2146
1933
      The -r option can be used to specify what revision or range of revisions
2147
1934
      to filter against. The various forms are shown below::
2148
 
 
 
1935
  
2149
1936
        -rX      display revision X
2150
1937
        -rX..    display revision X and later
2151
1938
        -r..Y    display up to and including revision Y
2152
1939
        -rX..Y   display from X to Y inclusive
2153
 
 
 
1940
  
2154
1941
      See ``bzr help revisionspec`` for details on how to specify X and Y.
2155
1942
      Some common examples are given below::
2156
 
 
 
1943
  
2157
1944
        -r-1                show just the tip
2158
1945
        -r-10..             show the last 10 mainline revisions
2159
1946
        -rsubmit:..         show what's new on this branch
2160
1947
        -rancestor:path..   show changes since the common ancestor of this
2161
1948
                            branch and the one at location path
2162
1949
        -rdate:yesterday..  show changes since yesterday
2163
 
 
 
1950
  
2164
1951
      When logging a range of revisions using -rX..Y, log starts at
2165
1952
      revision Y and searches back in history through the primary
2166
1953
      ("left-hand") parents until it finds X. When logging just the
2169
1956
      a nested merge revision and the log will be truncated accordingly.
2170
1957
 
2171
1958
    :Path filtering:
2172
 
 
2173
 
      If parameters are given and the first one is not a branch, the log
2174
 
      will be filtered to show only those revisions that changed the
2175
 
      nominated files or directories.
2176
 
 
 
1959
  
 
1960
      If a parameter is given and it's not a branch, the log will be filtered
 
1961
      to show only those revisions that changed the nominated file or
 
1962
      directory.
 
1963
  
2177
1964
      Filenames are interpreted within their historical context. To log a
2178
1965
      deleted file, specify a revision range so that the file existed at
2179
1966
      the end or start of the range.
2180
 
 
 
1967
  
2181
1968
      Historical context is also important when interpreting pathnames of
2182
1969
      renamed files/directories. Consider the following example:
2183
 
 
 
1970
  
2184
1971
      * revision 1: add tutorial.txt
2185
1972
      * revision 2: modify tutorial.txt
2186
1973
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2187
 
 
 
1974
  
2188
1975
      In this case:
2189
 
 
 
1976
  
2190
1977
      * ``bzr log guide.txt`` will log the file added in revision 1
2191
 
 
 
1978
  
2192
1979
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
2193
 
 
 
1980
  
2194
1981
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2195
1982
        the original file in revision 2.
2196
 
 
 
1983
  
2197
1984
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
2198
1985
        was no file called guide.txt in revision 2.
2199
 
 
 
1986
  
2200
1987
      Renames are always followed by log. By design, there is no need to
2201
1988
      explicitly ask for this (and no way to stop logging a file back
2202
1989
      until it was last renamed).
2203
 
 
 
1990
  
 
1991
      Note: If the path is a directory, only revisions that directly changed
 
1992
      that directory object are currently shown. This is considered a bug.
 
1993
      (Support for filtering against multiple files and for files within a
 
1994
      directory is under development.)
 
1995
  
2204
1996
    :Other filtering:
2205
 
 
 
1997
  
2206
1998
      The --message option can be used for finding revisions that match a
2207
1999
      regular expression in a commit message.
2208
 
 
 
2000
  
2209
2001
    :Tips & tricks:
2210
 
 
 
2002
  
2211
2003
      GUI tools and IDEs are often better at exploring history than command
2212
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2213
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2214
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2215
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2216
 
 
 
2004
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2005
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2006
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2007
  
 
2008
      Web interfaces are often better at exploring history than command line
 
2009
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2010
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2011
  
2217
2012
      You may find it useful to add the aliases below to ``bazaar.conf``::
2218
 
 
 
2013
  
2219
2014
        [ALIASES]
2220
 
        tip = log -r-1
2221
 
        top = log -l10 --line
2222
 
        show = log -v -p
2223
 
 
 
2015
        tip = log -r-1 -n1
 
2016
        top = log -r-10.. --short --forward
 
2017
        show = log -v -p -n1 --long
 
2018
  
2224
2019
      ``bzr tip`` will then show the latest revision while ``bzr top``
2225
2020
      will show the last 10 mainline revisions. To see the details of a
2226
2021
      particular revision X,  ``bzr show -rX``.
2227
 
 
2228
 
      If you are interested in looking deeper into a particular merge X,
2229
 
      use ``bzr log -n0 -rX``.
2230
 
 
 
2022
  
 
2023
      As many GUI tools and Web interfaces do, you may prefer viewing
 
2024
      history collapsed initially. If you are interested in looking deeper
 
2025
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
 
2026
      working this way, you may wish to either:
 
2027
  
 
2028
      * change your default log format to short (or line)
 
2029
      * add this alias: log = log -n1
 
2030
  
2231
2031
      ``bzr log -v`` on a branch with lots of history is currently
2232
2032
      very slow. A fix for this issue is currently under development.
2233
2033
      With or without that fix, it is recommended that a revision range
2234
2034
      be given when using the -v option.
2235
 
 
 
2035
  
2236
2036
      bzr has a generic full-text matching plugin, bzr-search, that can be
2237
2037
      used to find revisions matching user names, commit messages, etc.
2238
2038
      Among other features, this plugin can find all revisions containing
2239
2039
      a list of words but not others.
2240
 
 
 
2040
  
2241
2041
      When exploring non-mainline history on large projects with deep
2242
2042
      history, the performance of log can be greatly improved by installing
2243
 
      the historycache plugin. This plugin buffers historical information
 
2043
      the revnocache plugin. This plugin buffers historical information
2244
2044
      trading disk space for faster speed.
2245
2045
    """
2246
 
    takes_args = ['file*']
 
2046
    takes_args = ['location?']
2247
2047
    _see_also = ['log-formats', 'revisionspec']
2248
2048
    takes_options = [
2249
2049
            Option('forward',
2277
2077
            Option('show-diff',
2278
2078
                   short_name='p',
2279
2079
                   help='Show changes made in each revision as a patch.'),
2280
 
            Option('include-merges',
2281
 
                   help='Show merged revisions like --levels 0 does.'),
2282
 
            Option('exclude-common-ancestry',
2283
 
                   help='Display only the revisions that are not part'
2284
 
                   ' of both ancestries (require -rX..Y)'
2285
 
                   )
2286
2080
            ]
2287
2081
    encoding_type = 'replace'
2288
2082
 
2289
2083
    @display_command
2290
 
    def run(self, file_list=None, timezone='original',
 
2084
    def run(self, location=None, timezone='original',
2291
2085
            verbose=False,
2292
2086
            show_ids=False,
2293
2087
            forward=False,
2297
2091
            levels=None,
2298
2092
            message=None,
2299
2093
            limit=None,
2300
 
            show_diff=False,
2301
 
            include_merges=False,
2302
 
            exclude_common_ancestry=False,
2303
 
            ):
2304
 
        from bzrlib.log import (
2305
 
            Logger,
2306
 
            make_log_request_dict,
2307
 
            _get_info_for_log_files,
2308
 
            )
 
2094
            show_diff=False):
 
2095
        from bzrlib.log import show_log, _get_fileid_to_log
2309
2096
        direction = (forward and 'forward') or 'reverse'
2310
 
        if (exclude_common_ancestry
2311
 
            and (revision is None or len(revision) != 2)):
2312
 
            raise errors.BzrCommandError(
2313
 
                '--exclude-common-ancestry requires -r with two revisions')
2314
 
        if include_merges:
2315
 
            if levels is None:
2316
 
                levels = 0
2317
 
            else:
2318
 
                raise errors.BzrCommandError(
2319
 
                    '--levels and --include-merges are mutually exclusive')
2320
2097
 
2321
2098
        if change is not None:
2322
2099
            if len(change) > 1:
2327
2104
            else:
2328
2105
                revision = change
2329
2106
 
2330
 
        file_ids = []
2331
 
        filter_by_dir = False
2332
 
        if file_list:
2333
 
            # find the file ids to log and check for directory filtering
2334
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2335
 
                revision, file_list, self.add_cleanup)
2336
 
            for relpath, file_id, kind in file_info_list:
 
2107
        # log everything
 
2108
        file_id = None
 
2109
        if location:
 
2110
            # find the file id to log:
 
2111
 
 
2112
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2113
                location)
 
2114
            if fp != '':
 
2115
                file_id = _get_fileid_to_log(revision, tree, b, fp)
2337
2116
                if file_id is None:
2338
2117
                    raise errors.BzrCommandError(
2339
2118
                        "Path unknown at end or start of revision range: %s" %
2340
 
                        relpath)
2341
 
                # If the relpath is the top of the tree, we log everything
2342
 
                if relpath == '':
2343
 
                    file_ids = []
2344
 
                    break
2345
 
                else:
2346
 
                    file_ids.append(file_id)
2347
 
                filter_by_dir = filter_by_dir or (
2348
 
                    kind in ['directory', 'tree-reference'])
 
2119
                        location)
2349
2120
        else:
2350
 
            # log everything
2351
 
            # FIXME ? log the current subdir only RBC 20060203
 
2121
            # local dir only
 
2122
            # FIXME ? log the current subdir only RBC 20060203 
2352
2123
            if revision is not None \
2353
2124
                    and len(revision) > 0 and revision[0].get_branch():
2354
2125
                location = revision[0].get_branch()
2356
2127
                location = '.'
2357
2128
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2358
2129
            b = dir.open_branch()
2359
 
            self.add_cleanup(b.lock_read().unlock)
 
2130
 
 
2131
        b.lock_read()
 
2132
        try:
2360
2133
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2361
 
 
2362
 
        # Decide on the type of delta & diff filtering to use
2363
 
        # TODO: add an --all-files option to make this configurable & consistent
2364
 
        if not verbose:
2365
 
            delta_type = None
2366
 
        else:
2367
 
            delta_type = 'full'
2368
 
        if not show_diff:
2369
 
            diff_type = None
2370
 
        elif file_ids:
2371
 
            diff_type = 'partial'
2372
 
        else:
2373
 
            diff_type = 'full'
2374
 
 
2375
 
        # Build the log formatter
2376
 
        if log_format is None:
2377
 
            log_format = log.log_formatter_registry.get_default(b)
2378
 
        # Make a non-encoding output to include the diffs - bug 328007
2379
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2380
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2381
 
                        to_exact_file=unencoded_output,
2382
 
                        show_timezone=timezone,
2383
 
                        delta_format=get_verbosity_level(),
2384
 
                        levels=levels,
2385
 
                        show_advice=levels is None)
2386
 
 
2387
 
        # Choose the algorithm for doing the logging. It's annoying
2388
 
        # having multiple code paths like this but necessary until
2389
 
        # the underlying repository format is faster at generating
2390
 
        # deltas or can provide everything we need from the indices.
2391
 
        # The default algorithm - match-using-deltas - works for
2392
 
        # multiple files and directories and is faster for small
2393
 
        # amounts of history (200 revisions say). However, it's too
2394
 
        # slow for logging a single file in a repository with deep
2395
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2396
 
        # evil when adding features", we continue to use the
2397
 
        # original algorithm - per-file-graph - for the "single
2398
 
        # file that isn't a directory without showing a delta" case.
2399
 
        partial_history = revision and b.repository._format.supports_chks
2400
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2401
 
            or delta_type or partial_history)
2402
 
 
2403
 
        # Build the LogRequest and execute it
2404
 
        if len(file_ids) == 0:
2405
 
            file_ids = None
2406
 
        rqst = make_log_request_dict(
2407
 
            direction=direction, specific_fileids=file_ids,
2408
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2409
 
            message_search=message, delta_type=delta_type,
2410
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2411
 
            exclude_common_ancestry=exclude_common_ancestry,
2412
 
            )
2413
 
        Logger(b, rqst).show(lf)
 
2134
            if log_format is None:
 
2135
                log_format = log.log_formatter_registry.get_default(b)
 
2136
 
 
2137
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2138
                            show_timezone=timezone,
 
2139
                            delta_format=get_verbosity_level(),
 
2140
                            levels=levels)
 
2141
 
 
2142
            show_log(b,
 
2143
                     lf,
 
2144
                     file_id,
 
2145
                     verbose=verbose,
 
2146
                     direction=direction,
 
2147
                     start_revision=rev1,
 
2148
                     end_revision=rev2,
 
2149
                     search=message,
 
2150
                     limit=limit,
 
2151
                     show_diff=show_diff)
 
2152
        finally:
 
2153
            b.unlock()
2414
2154
 
2415
2155
 
2416
2156
def _get_revision_range(revisionspec_list, branch, command_name):
2417
2157
    """Take the input of a revision option and turn it into a revision range.
2418
2158
 
2419
2159
    It returns RevisionInfo objects which can be used to obtain the rev_id's
2420
 
    of the desired revisions. It does some user input validations.
 
2160
    of the desired revisons. It does some user input validations.
2421
2161
    """
2422
2162
    if revisionspec_list is None:
2423
2163
        rev1 = None
2434
2174
            raise errors.BzrCommandError(
2435
2175
                "bzr %s doesn't accept two revisions in different"
2436
2176
                " branches." % command_name)
2437
 
        if start_spec.spec is None:
2438
 
            # Avoid loading all the history.
2439
 
            rev1 = RevisionInfo(branch, None, None)
2440
 
        else:
2441
 
            rev1 = start_spec.in_history(branch)
 
2177
        rev1 = start_spec.in_history(branch)
2442
2178
        # Avoid loading all of history when we know a missing
2443
2179
        # end of range means the last revision ...
2444
2180
        if end_spec.spec is None:
2473
2209
 
2474
2210
 
2475
2211
class cmd_touching_revisions(Command):
2476
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2212
    """Return revision-ids which affected a particular file.
2477
2213
 
2478
2214
    A more user-friendly interface is "bzr log FILE".
2479
2215
    """
2484
2220
    @display_command
2485
2221
    def run(self, filename):
2486
2222
        tree, relpath = WorkingTree.open_containing(filename)
 
2223
        b = tree.branch
2487
2224
        file_id = tree.path2id(relpath)
2488
 
        b = tree.branch
2489
 
        self.add_cleanup(b.lock_read().unlock)
2490
 
        touching_revs = log.find_touching_revisions(b, file_id)
2491
 
        for revno, revision_id, what in touching_revs:
 
2225
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2492
2226
            self.outf.write("%6d %s\n" % (revno, what))
2493
2227
 
2494
2228
 
2495
2229
class cmd_ls(Command):
2496
 
    __doc__ = """List files in a tree.
 
2230
    """List files in a tree.
2497
2231
    """
2498
2232
 
2499
2233
    _see_also = ['status', 'cat']
2500
2234
    takes_args = ['path?']
 
2235
    # TODO: Take a revision or remote path and list that tree instead.
2501
2236
    takes_options = [
2502
2237
            'verbose',
2503
2238
            'revision',
2504
 
            Option('recursive', short_name='R',
2505
 
                   help='Recurse into subdirectories.'),
 
2239
            Option('non-recursive',
 
2240
                   help='Don\'t recurse into subdirectories.'),
2506
2241
            Option('from-root',
2507
2242
                   help='Print paths relative to the root of the branch.'),
2508
2243
            Option('unknown', help='Print unknown files.'),
2519
2254
            ]
2520
2255
    @display_command
2521
2256
    def run(self, revision=None, verbose=False,
2522
 
            recursive=False, from_root=False,
 
2257
            non_recursive=False, from_root=False,
2523
2258
            unknown=False, versioned=False, ignored=False,
2524
2259
            null=False, kind=None, show_ids=False, path=None):
2525
2260
 
2534
2269
 
2535
2270
        if path is None:
2536
2271
            fs_path = '.'
 
2272
            prefix = ''
2537
2273
        else:
2538
2274
            if from_root:
2539
2275
                raise errors.BzrCommandError('cannot specify both --from-root'
2540
2276
                                             ' and PATH')
2541
2277
            fs_path = path
 
2278
            prefix = path
2542
2279
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2543
2280
            fs_path)
2544
 
 
2545
 
        # Calculate the prefix to use
2546
 
        prefix = None
2547
2281
        if from_root:
2548
 
            if relpath:
2549
 
                prefix = relpath + '/'
2550
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2551
 
            prefix = fs_path + '/'
2552
 
 
 
2282
            relpath = u''
 
2283
        elif relpath:
 
2284
            relpath += '/'
2553
2285
        if revision is not None or tree is None:
2554
2286
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2555
2287
 
2556
 
        apply_view = False
2557
 
        if isinstance(tree, WorkingTree) and tree.supports_views():
2558
 
            view_files = tree.views.lookup_view()
2559
 
            if view_files:
2560
 
                apply_view = True
2561
 
                view_str = views.view_display_str(view_files)
2562
 
                note("Ignoring files outside view. View is %s" % view_str)
2563
 
 
2564
 
        self.add_cleanup(tree.lock_read().unlock)
2565
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2566
 
            from_dir=relpath, recursive=recursive):
2567
 
            # Apply additional masking
2568
 
            if not all and not selection[fc]:
2569
 
                continue
2570
 
            if kind is not None and fkind != kind:
2571
 
                continue
2572
 
            if apply_view:
2573
 
                try:
2574
 
                    if relpath:
2575
 
                        fullpath = osutils.pathjoin(relpath, fp)
2576
 
                    else:
2577
 
                        fullpath = fp
2578
 
                    views.check_path_in_view(tree, fullpath)
2579
 
                except errors.FileOutsideView:
2580
 
                    continue
2581
 
 
2582
 
            # Output the entry
2583
 
            if prefix:
2584
 
                fp = osutils.pathjoin(prefix, fp)
2585
 
            kindch = entry.kind_character()
2586
 
            outstring = fp + kindch
2587
 
            ui.ui_factory.clear_term()
2588
 
            if verbose:
2589
 
                outstring = '%-8s %s' % (fc, outstring)
2590
 
                if show_ids and fid is not None:
2591
 
                    outstring = "%-50s %s" % (outstring, fid)
2592
 
                self.outf.write(outstring + '\n')
2593
 
            elif null:
2594
 
                self.outf.write(fp + '\0')
2595
 
                if show_ids:
2596
 
                    if fid is not None:
2597
 
                        self.outf.write(fid)
2598
 
                    self.outf.write('\0')
2599
 
                self.outf.flush()
2600
 
            else:
2601
 
                if show_ids:
2602
 
                    if fid is not None:
2603
 
                        my_id = fid
2604
 
                    else:
2605
 
                        my_id = ''
2606
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2607
 
                else:
2608
 
                    self.outf.write(outstring + '\n')
 
2288
        tree.lock_read()
 
2289
        try:
 
2290
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2291
                if fp.startswith(relpath):
 
2292
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2293
                    if non_recursive and '/' in fp:
 
2294
                        continue
 
2295
                    if not all and not selection[fc]:
 
2296
                        continue
 
2297
                    if kind is not None and fkind != kind:
 
2298
                        continue
 
2299
                    kindch = entry.kind_character()
 
2300
                    outstring = fp + kindch
 
2301
                    if verbose:
 
2302
                        outstring = '%-8s %s' % (fc, outstring)
 
2303
                        if show_ids and fid is not None:
 
2304
                            outstring = "%-50s %s" % (outstring, fid)
 
2305
                        self.outf.write(outstring + '\n')
 
2306
                    elif null:
 
2307
                        self.outf.write(fp + '\0')
 
2308
                        if show_ids:
 
2309
                            if fid is not None:
 
2310
                                self.outf.write(fid)
 
2311
                            self.outf.write('\0')
 
2312
                        self.outf.flush()
 
2313
                    else:
 
2314
                        if fid is not None:
 
2315
                            my_id = fid
 
2316
                        else:
 
2317
                            my_id = ''
 
2318
                        if show_ids:
 
2319
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2320
                        else:
 
2321
                            self.outf.write(outstring + '\n')
 
2322
        finally:
 
2323
            tree.unlock()
2609
2324
 
2610
2325
 
2611
2326
class cmd_unknowns(Command):
2612
 
    __doc__ = """List unknown files.
 
2327
    """List unknown files.
2613
2328
    """
2614
2329
 
2615
2330
    hidden = True
2622
2337
 
2623
2338
 
2624
2339
class cmd_ignore(Command):
2625
 
    __doc__ = """Ignore specified files or patterns.
 
2340
    """Ignore specified files or patterns.
2626
2341
 
2627
2342
    See ``bzr help patterns`` for details on the syntax of patterns.
2628
2343
 
2629
 
    If a .bzrignore file does not exist, the ignore command
2630
 
    will create one and add the specified files or patterns to the newly
2631
 
    created file. The ignore command will also automatically add the 
2632
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2633
 
    the use of the ignore command will require an explicit add command.
2634
 
 
2635
2344
    To remove patterns from the ignore list, edit the .bzrignore file.
2636
2345
    After adding, editing or deleting that file either indirectly by
2637
2346
    using this command or directly by using an editor, be sure to commit
2638
2347
    it.
2639
 
    
2640
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2641
 
    the global ignore file can be found in the application data directory as
2642
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2643
 
    Global ignores are not touched by this command. The global ignore file
2644
 
    can be edited directly using an editor.
2645
 
 
2646
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2647
 
    precedence over regular ignores.  Such exceptions are used to specify
2648
 
    files that should be versioned which would otherwise be ignored.
2649
 
    
2650
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2651
 
    precedence over the '!' exception patterns.
2652
 
 
2653
 
    Note: ignore patterns containing shell wildcards must be quoted from
 
2348
 
 
2349
    Note: ignore patterns containing shell wildcards must be quoted from 
2654
2350
    the shell on Unix.
2655
2351
 
2656
2352
    :Examples:
2658
2354
 
2659
2355
            bzr ignore ./Makefile
2660
2356
 
2661
 
        Ignore .class files in all directories...::
 
2357
        Ignore class files in all directories::
2662
2358
 
2663
2359
            bzr ignore "*.class"
2664
2360
 
2665
 
        ...but do not ignore "special.class"::
2666
 
 
2667
 
            bzr ignore "!special.class"
2668
 
 
2669
2361
        Ignore .o files under the lib directory::
2670
2362
 
2671
2363
            bzr ignore "lib/**/*.o"
2677
2369
        Ignore everything but the "debian" toplevel directory::
2678
2370
 
2679
2371
            bzr ignore "RE:(?!debian/).*"
2680
 
        
2681
 
        Ignore everything except the "local" toplevel directory,
2682
 
        but always ignore "*~" autosave files, even under local/::
2683
 
        
2684
 
            bzr ignore "*"
2685
 
            bzr ignore "!./local"
2686
 
            bzr ignore "!!*~"
2687
2372
    """
2688
2373
 
2689
2374
    _see_also = ['status', 'ignored', 'patterns']
2690
2375
    takes_args = ['name_pattern*']
2691
2376
    takes_options = [
2692
 
        Option('default-rules',
2693
 
               help='Display the default ignore rules that bzr uses.')
 
2377
        Option('old-default-rules',
 
2378
               help='Write out the ignore rules bzr < 0.9 always used.')
2694
2379
        ]
2695
 
 
2696
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2380
    
 
2381
    def run(self, name_pattern_list=None, old_default_rules=None):
2697
2382
        from bzrlib import ignores
2698
 
        if default_rules is not None:
2699
 
            # dump the default rules and exit
2700
 
            for pattern in ignores.USER_DEFAULTS:
2701
 
                self.outf.write("%s\n" % pattern)
 
2383
        if old_default_rules is not None:
 
2384
            # dump the rules and exit
 
2385
            for pattern in ignores.OLD_DEFAULTS:
 
2386
                print pattern
2702
2387
            return
2703
2388
        if not name_pattern_list:
2704
2389
            raise errors.BzrCommandError("ignore requires at least one "
2705
 
                "NAME_PATTERN or --default-rules.")
2706
 
        name_pattern_list = [globbing.normalize_pattern(p)
 
2390
                                  "NAME_PATTERN or --old-default-rules")
 
2391
        name_pattern_list = [globbing.normalize_pattern(p) 
2707
2392
                             for p in name_pattern_list]
2708
2393
        for name_pattern in name_pattern_list:
2709
 
            if (name_pattern[0] == '/' or
 
2394
            if (name_pattern[0] == '/' or 
2710
2395
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2711
2396
                raise errors.BzrCommandError(
2712
2397
                    "NAME_PATTERN should not be an absolute path")
2720
2405
            if id is not None:
2721
2406
                filename = entry[0]
2722
2407
                if ignored.match(filename):
2723
 
                    matches.append(filename)
 
2408
                    matches.append(filename.encode('utf-8'))
2724
2409
        tree.unlock()
2725
2410
        if len(matches) > 0:
2726
 
            self.outf.write("Warning: the following files are version controlled and"
2727
 
                  " match your ignore pattern:\n%s"
2728
 
                  "\nThese files will continue to be version controlled"
2729
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2411
            print "Warning: the following files are version controlled and" \
 
2412
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
2730
2413
 
2731
2414
 
2732
2415
class cmd_ignored(Command):
2733
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2416
    """List ignored files and the patterns that matched them.
2734
2417
 
2735
2418
    List all the ignored files and the ignore pattern that caused the file to
2736
2419
    be ignored.
2746
2429
    @display_command
2747
2430
    def run(self):
2748
2431
        tree = WorkingTree.open_containing(u'.')[0]
2749
 
        self.add_cleanup(tree.lock_read().unlock)
2750
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2751
 
            if file_class != 'I':
2752
 
                continue
2753
 
            ## XXX: Slightly inefficient since this was already calculated
2754
 
            pat = tree.is_ignored(path)
2755
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2432
        tree.lock_read()
 
2433
        try:
 
2434
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2435
                if file_class != 'I':
 
2436
                    continue
 
2437
                ## XXX: Slightly inefficient since this was already calculated
 
2438
                pat = tree.is_ignored(path)
 
2439
                self.outf.write('%-50s %s\n' % (path, pat))
 
2440
        finally:
 
2441
            tree.unlock()
2756
2442
 
2757
2443
 
2758
2444
class cmd_lookup_revision(Command):
2759
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2445
    """Lookup the revision-id from a revision-number
2760
2446
 
2761
2447
    :Examples:
2762
2448
        bzr lookup-revision 33
2763
2449
    """
2764
2450
    hidden = True
2765
2451
    takes_args = ['revno']
2766
 
 
 
2452
    
2767
2453
    @display_command
2768
2454
    def run(self, revno):
2769
2455
        try:
2770
2456
            revno = int(revno)
2771
2457
        except ValueError:
2772
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2773
 
                                         % revno)
2774
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2775
 
        self.outf.write("%s\n" % revid)
 
2458
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2459
 
 
2460
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2776
2461
 
2777
2462
 
2778
2463
class cmd_export(Command):
2779
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2464
    """Export current or past revision to a destination directory or archive.
2780
2465
 
2781
2466
    If no revision is specified this exports the last committed revision.
2782
2467
 
2809
2494
               help="Type of file to export to.",
2810
2495
               type=unicode),
2811
2496
        'revision',
2812
 
        Option('filters', help='Apply content filters to export the '
2813
 
                'convenient form.'),
2814
2497
        Option('root',
2815
2498
               type=str,
2816
2499
               help="Name of the root directory inside the exported file."),
2817
 
        Option('per-file-timestamps',
2818
 
               help='Set modification time of files to that of the last '
2819
 
                    'revision in which it was changed.'),
2820
2500
        ]
2821
2501
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2822
 
        root=None, filters=False, per_file_timestamps=False):
 
2502
        root=None):
2823
2503
        from bzrlib.export import export
2824
2504
 
2825
2505
        if branch_or_subdir is None:
2832
2512
 
2833
2513
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2834
2514
        try:
2835
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2836
 
                   per_file_timestamps=per_file_timestamps)
 
2515
            export(rev_tree, dest, format, root, subdir)
2837
2516
        except errors.NoSuchExportFormat, e:
2838
2517
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2839
2518
 
2840
2519
 
2841
2520
class cmd_cat(Command):
2842
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2521
    """Write the contents of a file as of a given revision to standard output.
2843
2522
 
2844
2523
    If no revision is nominated, the last revision is used.
2845
2524
 
2846
2525
    Note: Take care to redirect standard output when using this command on a
2847
 
    binary file.
 
2526
    binary file. 
2848
2527
    """
2849
2528
 
2850
2529
    _see_also = ['ls']
2851
2530
    takes_options = [
2852
2531
        Option('name-from-revision', help='The path name in the old tree.'),
2853
 
        Option('filters', help='Apply content filters to display the '
2854
 
                'convenience form.'),
2855
2532
        'revision',
2856
2533
        ]
2857
2534
    takes_args = ['filename']
2858
2535
    encoding_type = 'exact'
2859
2536
 
2860
2537
    @display_command
2861
 
    def run(self, filename, revision=None, name_from_revision=False,
2862
 
            filters=False):
 
2538
    def run(self, filename, revision=None, name_from_revision=False):
2863
2539
        if revision is not None and len(revision) != 1:
2864
2540
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2865
2541
                                         " one revision specifier")
2866
2542
        tree, branch, relpath = \
2867
2543
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2868
 
        self.add_cleanup(branch.lock_read().unlock)
2869
 
        return self._run(tree, branch, relpath, filename, revision,
2870
 
                         name_from_revision, filters)
 
2544
        branch.lock_read()
 
2545
        try:
 
2546
            return self._run(tree, branch, relpath, filename, revision,
 
2547
                             name_from_revision)
 
2548
        finally:
 
2549
            branch.unlock()
2871
2550
 
2872
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2873
 
        filtered):
 
2551
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2874
2552
        if tree is None:
2875
2553
            tree = b.basis_tree()
2876
2554
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2877
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2878
2555
 
 
2556
        cur_file_id = tree.path2id(relpath)
2879
2557
        old_file_id = rev_tree.path2id(relpath)
2880
2558
 
2881
2559
        if name_from_revision:
2882
 
            # Try in revision if requested
2883
2560
            if old_file_id is None:
2884
2561
                raise errors.BzrCommandError(
2885
2562
                    "%r is not present in revision %s" % (
2886
2563
                        filename, rev_tree.get_revision_id()))
2887
2564
            else:
2888
2565
                content = rev_tree.get_file_text(old_file_id)
2889
 
        else:
2890
 
            cur_file_id = tree.path2id(relpath)
2891
 
            found = False
2892
 
            if cur_file_id is not None:
2893
 
                # Then try with the actual file id
2894
 
                try:
2895
 
                    content = rev_tree.get_file_text(cur_file_id)
2896
 
                    found = True
2897
 
                except errors.NoSuchId:
2898
 
                    # The actual file id didn't exist at that time
2899
 
                    pass
2900
 
            if not found and old_file_id is not None:
2901
 
                # Finally try with the old file id
2902
 
                content = rev_tree.get_file_text(old_file_id)
2903
 
                found = True
2904
 
            if not found:
2905
 
                # Can't be found anywhere
2906
 
                raise errors.BzrCommandError(
2907
 
                    "%r is not present in revision %s" % (
2908
 
                        filename, rev_tree.get_revision_id()))
2909
 
        if filtered:
2910
 
            from bzrlib.filters import (
2911
 
                ContentFilterContext,
2912
 
                filtered_output_bytes,
2913
 
                )
2914
 
            filters = rev_tree._content_filter_stack(relpath)
2915
 
            chunks = content.splitlines(True)
2916
 
            content = filtered_output_bytes(chunks, filters,
2917
 
                ContentFilterContext(relpath, rev_tree))
2918
 
            self.cleanup_now()
2919
 
            self.outf.writelines(content)
2920
 
        else:
2921
 
            self.cleanup_now()
2922
 
            self.outf.write(content)
 
2566
        elif cur_file_id is not None:
 
2567
            content = rev_tree.get_file_text(cur_file_id)
 
2568
        elif old_file_id is not None:
 
2569
            content = rev_tree.get_file_text(old_file_id)
 
2570
        else:
 
2571
            raise errors.BzrCommandError(
 
2572
                "%r is not present in revision %s" % (
 
2573
                    filename, rev_tree.get_revision_id()))
 
2574
        self.outf.write(content)
2923
2575
 
2924
2576
 
2925
2577
class cmd_local_time_offset(Command):
2926
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
2927
 
    hidden = True
 
2578
    """Show the offset in seconds from GMT to local time."""
 
2579
    hidden = True    
2928
2580
    @display_command
2929
2581
    def run(self):
2930
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2582
        print osutils.local_time_offset()
2931
2583
 
2932
2584
 
2933
2585
 
2934
2586
class cmd_commit(Command):
2935
 
    __doc__ = """Commit changes into a new revision.
2936
 
 
2937
 
    An explanatory message needs to be given for each commit. This is
2938
 
    often done by using the --message option (getting the message from the
2939
 
    command line) or by using the --file option (getting the message from
2940
 
    a file). If neither of these options is given, an editor is opened for
2941
 
    the user to enter the message. To see the changed files in the
2942
 
    boilerplate text loaded into the editor, use the --show-diff option.
2943
 
 
2944
 
    By default, the entire tree is committed and the person doing the
2945
 
    commit is assumed to be the author. These defaults can be overridden
2946
 
    as explained below.
2947
 
 
2948
 
    :Selective commits:
2949
 
 
2950
 
      If selected files are specified, only changes to those files are
2951
 
      committed.  If a directory is specified then the directory and
2952
 
      everything within it is committed.
2953
 
  
2954
 
      When excludes are given, they take precedence over selected files.
2955
 
      For example, to commit only changes within foo, but not changes
2956
 
      within foo/bar::
2957
 
  
2958
 
        bzr commit foo -x foo/bar
2959
 
  
2960
 
      A selective commit after a merge is not yet supported.
2961
 
 
2962
 
    :Custom authors:
2963
 
 
2964
 
      If the author of the change is not the same person as the committer,
2965
 
      you can specify the author's name using the --author option. The
2966
 
      name should be in the same format as a committer-id, e.g.
2967
 
      "John Doe <jdoe@example.com>". If there is more than one author of
2968
 
      the change you can specify the option multiple times, once for each
2969
 
      author.
2970
 
  
2971
 
    :Checks:
2972
 
 
2973
 
      A common mistake is to forget to add a new file or directory before
2974
 
      running the commit command. The --strict option checks for unknown
2975
 
      files and aborts the commit if any are found. More advanced pre-commit
2976
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
2977
 
      for details.
2978
 
 
2979
 
    :Things to note:
2980
 
 
2981
 
      If you accidentially commit the wrong changes or make a spelling
2982
 
      mistake in the commit message say, you can use the uncommit command
2983
 
      to undo it. See ``bzr help uncommit`` for details.
2984
 
 
2985
 
      Hooks can also be configured to run after a commit. This allows you
2986
 
      to trigger updates to external systems like bug trackers. The --fixes
2987
 
      option can be used to record the association between a revision and
2988
 
      one or more bugs. See ``bzr help bugs`` for details.
2989
 
 
2990
 
      A selective commit may fail in some cases where the committed
2991
 
      tree would be invalid. Consider::
2992
 
  
2993
 
        bzr init foo
2994
 
        mkdir foo/bar
2995
 
        bzr add foo/bar
2996
 
        bzr commit foo -m "committing foo"
2997
 
        bzr mv foo/bar foo/baz
2998
 
        mkdir foo/bar
2999
 
        bzr add foo/bar
3000
 
        bzr commit foo/bar -m "committing bar but not baz"
3001
 
  
3002
 
      In the example above, the last commit will fail by design. This gives
3003
 
      the user the opportunity to decide whether they want to commit the
3004
 
      rename at the same time, separately first, or not at all. (As a general
3005
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2587
    """Commit changes into a new revision.
 
2588
    
 
2589
    If no arguments are given, the entire tree is committed.
 
2590
 
 
2591
    If selected files are specified, only changes to those files are
 
2592
    committed.  If a directory is specified then the directory and everything 
 
2593
    within it is committed.
 
2594
 
 
2595
    When excludes are given, they take precedence over selected files.
 
2596
    For example, too commit only changes within foo, but not changes within
 
2597
    foo/bar::
 
2598
 
 
2599
      bzr commit foo -x foo/bar
 
2600
 
 
2601
    If author of the change is not the same person as the committer, you can
 
2602
    specify the author's name using the --author option. The name should be
 
2603
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2604
 
 
2605
    A selected-file commit may fail in some cases where the committed
 
2606
    tree would be invalid. Consider::
 
2607
 
 
2608
      bzr init foo
 
2609
      mkdir foo/bar
 
2610
      bzr add foo/bar
 
2611
      bzr commit foo -m "committing foo"
 
2612
      bzr mv foo/bar foo/baz
 
2613
      mkdir foo/bar
 
2614
      bzr add foo/bar
 
2615
      bzr commit foo/bar -m "committing bar but not baz"
 
2616
 
 
2617
    In the example above, the last commit will fail by design. This gives
 
2618
    the user the opportunity to decide whether they want to commit the
 
2619
    rename at the same time, separately first, or not at all. (As a general
 
2620
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2621
 
 
2622
    Note: A selected-file commit after a merge is not yet supported.
3006
2623
    """
3007
2624
    # TODO: Run hooks on tree to-be-committed, and after commit.
3008
2625
 
3013
2630
 
3014
2631
    # XXX: verbose currently does nothing
3015
2632
 
3016
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2633
    _see_also = ['bugs', 'uncommit']
3017
2634
    takes_args = ['selected*']
3018
2635
    takes_options = [
3019
2636
            ListOption('exclude', type=str, short_name='x',
3031
2648
             Option('strict',
3032
2649
                    help="Refuse to commit if there are unknown "
3033
2650
                    "files in the working tree."),
3034
 
             Option('commit-time', type=str,
3035
 
                    help="Manually set a commit time using commit date "
3036
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3037
2651
             ListOption('fixes', type=str,
3038
 
                    help="Mark a bug as being fixed by this revision "
3039
 
                         "(see \"bzr help bugs\")."),
3040
 
             ListOption('author', type=unicode,
 
2652
                    help="Mark a bug as being fixed by this revision."),
 
2653
             Option('author', type=unicode,
3041
2654
                    help="Set the author's name, if it's different "
3042
2655
                         "from the committer."),
3043
2656
             Option('local',
3046
2659
                         "the master branch until a normal commit "
3047
2660
                         "is performed."
3048
2661
                    ),
3049
 
             Option('show-diff', short_name='p',
3050
 
                    help='When no message is supplied, show the diff along'
3051
 
                    ' with the status summary in the message editor.'),
 
2662
              Option('show-diff',
 
2663
                     help='When no message is supplied, show the diff along'
 
2664
                     ' with the status summary in the message editor.'),
3052
2665
             ]
3053
2666
    aliases = ['ci', 'checkin']
3054
2667
 
3055
 
    def _iter_bug_fix_urls(self, fixes, branch):
 
2668
    def _get_bug_fix_properties(self, fixes, branch):
 
2669
        properties = []
3056
2670
        # Configure the properties for bug fixing attributes.
3057
2671
        for fixed_bug in fixes:
3058
2672
            tokens = fixed_bug.split(':')
3059
2673
            if len(tokens) != 2:
3060
2674
                raise errors.BzrCommandError(
3061
 
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
3062
 
                    "See \"bzr help bugs\" for more information on this "
3063
 
                    "feature.\nCommit refused." % fixed_bug)
 
2675
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2676
                    "Commit refused." % fixed_bug)
3064
2677
            tag, bug_id = tokens
3065
2678
            try:
3066
 
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2679
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
3067
2680
            except errors.UnknownBugTrackerAbbreviation:
3068
2681
                raise errors.BzrCommandError(
3069
2682
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3070
 
            except errors.MalformedBugIdentifier, e:
 
2683
            except errors.MalformedBugIdentifier:
3071
2684
                raise errors.BzrCommandError(
3072
 
                    "%s\nCommit refused." % (str(e),))
 
2685
                    "Invalid bug identifier for %s. Commit refused."
 
2686
                    % fixed_bug)
 
2687
            properties.append('%s fixed' % bug_url)
 
2688
        return '\n'.join(properties)
3073
2689
 
3074
2690
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3075
2691
            unchanged=False, strict=False, local=False, fixes=None,
3076
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2692
            author=None, show_diff=False, exclude=None):
3077
2693
        from bzrlib.errors import (
3078
2694
            PointlessCommit,
3079
2695
            ConflictsInTree,
3085
2701
            make_commit_message_template_encoded
3086
2702
        )
3087
2703
 
3088
 
        commit_stamp = offset = None
3089
 
        if commit_time is not None:
3090
 
            try:
3091
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3092
 
            except ValueError, e:
3093
 
                raise errors.BzrCommandError(
3094
 
                    "Could not parse --commit-time: " + str(e))
3095
 
 
3096
2704
        # TODO: Need a blackbox test for invoking the external editor; may be
3097
2705
        # slightly problematic to run this cross-platform.
3098
2706
 
3099
 
        # TODO: do more checks that the commit will succeed before
 
2707
        # TODO: do more checks that the commit will succeed before 
3100
2708
        # spending the user's valuable time typing a commit message.
3101
2709
 
3102
2710
        properties = {}
3110
2718
 
3111
2719
        if fixes is None:
3112
2720
            fixes = []
3113
 
        bug_property = bugtracker.encode_fixes_bug_urls(
3114
 
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2721
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
3115
2722
        if bug_property:
3116
2723
            properties['bugs'] = bug_property
3117
2724
 
3118
2725
        if local and not tree.branch.get_bound_location():
3119
2726
            raise errors.LocalRequiresBoundBranch()
3120
2727
 
3121
 
        if message is not None:
3122
 
            try:
3123
 
                file_exists = osutils.lexists(message)
3124
 
            except UnicodeError:
3125
 
                # The commit message contains unicode characters that can't be
3126
 
                # represented in the filesystem encoding, so that can't be a
3127
 
                # file.
3128
 
                file_exists = False
3129
 
            if file_exists:
3130
 
                warning_msg = (
3131
 
                    'The commit message is a file name: "%(f)s".\n'
3132
 
                    '(use --file "%(f)s" to take commit message from that file)'
3133
 
                    % { 'f': message })
3134
 
                ui.ui_factory.show_warning(warning_msg)
3135
 
            if '\r' in message:
3136
 
                message = message.replace('\r\n', '\n')
3137
 
                message = message.replace('\r', '\n')
3138
 
            if file:
3139
 
                raise errors.BzrCommandError(
3140
 
                    "please specify either --message or --file")
3141
 
 
3142
2728
        def get_message(commit_obj):
3143
2729
            """Callback to get commit message"""
3144
 
            if file:
3145
 
                my_message = codecs.open(
3146
 
                    file, 'rt', osutils.get_user_encoding()).read()
3147
 
            elif message is not None:
3148
 
                my_message = message
3149
 
            else:
3150
 
                # No message supplied: make one up.
3151
 
                # text is the status of the tree
3152
 
                text = make_commit_message_template_encoded(tree,
 
2730
            my_message = message
 
2731
            if my_message is None and not file:
 
2732
                t = make_commit_message_template_encoded(tree,
3153
2733
                        selected_list, diff=show_diff,
3154
2734
                        output_encoding=osutils.get_user_encoding())
3155
 
                # start_message is the template generated from hooks
3156
 
                # XXX: Warning - looks like hooks return unicode,
3157
 
                # make_commit_message_template_encoded returns user encoding.
3158
 
                # We probably want to be using edit_commit_message instead to
3159
 
                # avoid this.
3160
2735
                start_message = generate_commit_message_template(commit_obj)
3161
 
                my_message = edit_commit_message_encoded(text,
 
2736
                my_message = edit_commit_message_encoded(t, 
3162
2737
                    start_message=start_message)
3163
2738
                if my_message is None:
3164
2739
                    raise errors.BzrCommandError("please specify a commit"
3165
2740
                        " message with either --message or --file")
 
2741
            elif my_message and file:
 
2742
                raise errors.BzrCommandError(
 
2743
                    "please specify either --message or --file")
 
2744
            if file:
 
2745
                my_message = codecs.open(file, 'rt',
 
2746
                                         osutils.get_user_encoding()).read()
3166
2747
            if my_message == "":
3167
2748
                raise errors.BzrCommandError("empty commit message specified")
3168
2749
            return my_message
3169
2750
 
3170
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3171
 
        # but the command line should not do that.
3172
 
        if not selected_list:
3173
 
            selected_list = None
3174
2751
        try:
3175
2752
            tree.commit(message_callback=get_message,
3176
2753
                        specific_files=selected_list,
3177
2754
                        allow_pointless=unchanged, strict=strict, local=local,
3178
2755
                        reporter=None, verbose=verbose, revprops=properties,
3179
 
                        authors=author, timestamp=commit_stamp,
3180
 
                        timezone=offset,
 
2756
                        author=author,
3181
2757
                        exclude=safe_relpath_files(tree, exclude))
3182
2758
        except PointlessCommit:
3183
 
            raise errors.BzrCommandError("No changes to commit."
3184
 
                              " Use --unchanged to commit anyhow.")
 
2759
            # FIXME: This should really happen before the file is read in;
 
2760
            # perhaps prepare the commit; get the message; then actually commit
 
2761
            raise errors.BzrCommandError("no changes to commit."
 
2762
                              " use --unchanged to commit anyhow")
3185
2763
        except ConflictsInTree:
3186
2764
            raise errors.BzrCommandError('Conflicts detected in working '
3187
2765
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3190
2768
            raise errors.BzrCommandError("Commit refused because there are"
3191
2769
                              " unknown files in the working tree.")
3192
2770
        except errors.BoundBranchOutOfDate, e:
3193
 
            e.extra_help = ("\n"
3194
 
                'To commit to master branch, run update and then commit.\n'
3195
 
                'You can also pass --local to commit to continue working '
3196
 
                'disconnected.')
3197
 
            raise
 
2771
            raise errors.BzrCommandError(str(e) + "\n"
 
2772
            'To commit to master branch, run update and then commit.\n'
 
2773
            'You can also pass --local to commit to continue working '
 
2774
            'disconnected.')
3198
2775
 
3199
2776
 
3200
2777
class cmd_check(Command):
3201
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2778
    """Validate working tree structure, branch consistency and repository history.
3202
2779
 
3203
2780
    This command checks various invariants about branch and repository storage
3204
2781
    to detect data corruption or bzr bugs.
3206
2783
    The working tree and branch checks will only give output if a problem is
3207
2784
    detected. The output fields of the repository check are:
3208
2785
 
3209
 
    revisions
3210
 
        This is just the number of revisions checked.  It doesn't
3211
 
        indicate a problem.
3212
 
 
3213
 
    versionedfiles
3214
 
        This is just the number of versionedfiles checked.  It
3215
 
        doesn't indicate a problem.
3216
 
 
3217
 
    unreferenced ancestors
3218
 
        Texts that are ancestors of other texts, but
3219
 
        are not properly referenced by the revision ancestry.  This is a
3220
 
        subtle problem that Bazaar can work around.
3221
 
 
3222
 
    unique file texts
3223
 
        This is the total number of unique file contents
3224
 
        seen in the checked revisions.  It does not indicate a problem.
3225
 
 
3226
 
    repeated file texts
3227
 
        This is the total number of repeated texts seen
3228
 
        in the checked revisions.  Texts can be repeated when their file
3229
 
        entries are modified, but the file contents are not.  It does not
3230
 
        indicate a problem.
 
2786
        revisions: This is just the number of revisions checked.  It doesn't
 
2787
            indicate a problem.
 
2788
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2789
            doesn't indicate a problem.
 
2790
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2791
            are not properly referenced by the revision ancestry.  This is a
 
2792
            subtle problem that Bazaar can work around.
 
2793
        unique file texts: This is the total number of unique file contents
 
2794
            seen in the checked revisions.  It does not indicate a problem.
 
2795
        repeated file texts: This is the total number of repeated texts seen
 
2796
            in the checked revisions.  Texts can be repeated when their file
 
2797
            entries are modified, but the file contents are not.  It does not
 
2798
            indicate a problem.
3231
2799
 
3232
2800
    If no restrictions are specified, all Bazaar data that is found at the given
3233
2801
    location will be checked.
3268
2836
 
3269
2837
 
3270
2838
class cmd_upgrade(Command):
3271
 
    __doc__ = """Upgrade branch storage to current format.
 
2839
    """Upgrade branch storage to current format.
3272
2840
 
3273
2841
    The check command or bzr developers may sometimes advise you to run
3274
2842
    this command. When the default format has changed you may also be warned
3288
2856
 
3289
2857
    def run(self, url='.', format=None):
3290
2858
        from bzrlib.upgrade import upgrade
 
2859
        if format is None:
 
2860
            format = bzrdir.format_registry.make_bzrdir('default')
3291
2861
        upgrade(url, format)
3292
2862
 
3293
2863
 
3294
2864
class cmd_whoami(Command):
3295
 
    __doc__ = """Show or set bzr user id.
3296
 
 
 
2865
    """Show or set bzr user id.
 
2866
    
3297
2867
    :Examples:
3298
2868
        Show the email of the current user::
3299
2869
 
3311
2881
                    ]
3312
2882
    takes_args = ['name?']
3313
2883
    encoding_type = 'replace'
3314
 
 
 
2884
    
3315
2885
    @display_command
3316
2886
    def run(self, email=False, branch=False, name=None):
3317
2887
        if name is None:
3332
2902
        except errors.NoEmailInUsername, e:
3333
2903
            warning('"%s" does not seem to contain an email address.  '
3334
2904
                    'This is allowed, but not recommended.', name)
3335
 
 
 
2905
        
3336
2906
        # use global config unless --branch given
3337
2907
        if branch:
3338
2908
            c = Branch.open_containing('.')[0].get_config()
3342
2912
 
3343
2913
 
3344
2914
class cmd_nick(Command):
3345
 
    __doc__ = """Print or set the branch nickname.
 
2915
    """Print or set the branch nickname.
3346
2916
 
3347
2917
    If unset, the tree root directory name is used as the nickname.
3348
2918
    To print the current nickname, execute with no argument.
3362
2932
 
3363
2933
    @display_command
3364
2934
    def printme(self, branch):
3365
 
        self.outf.write('%s\n' % branch.nick)
 
2935
        print branch.nick
3366
2936
 
3367
2937
 
3368
2938
class cmd_alias(Command):
3369
 
    __doc__ = """Set/unset and display aliases.
 
2939
    """Set/unset and display aliases.
3370
2940
 
3371
2941
    :Examples:
3372
2942
        Show the current aliases::
3436
3006
 
3437
3007
 
3438
3008
class cmd_selftest(Command):
3439
 
    __doc__ = """Run internal test suite.
3440
 
 
 
3009
    """Run internal test suite.
 
3010
    
3441
3011
    If arguments are given, they are regular expressions that say which tests
3442
3012
    should run.  Tests matching any expression are run, and other tests are
3443
3013
    not run.
3466
3036
    modified by plugins will not be tested, and tests provided by plugins will
3467
3037
    not be run.
3468
3038
 
3469
 
    Tests that need working space on disk use a common temporary directory,
 
3039
    Tests that need working space on disk use a common temporary directory, 
3470
3040
    typically inside $TMPDIR or /tmp.
3471
3041
 
3472
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3473
 
    into a pdb postmortem session.
3474
 
 
3475
3042
    :Examples:
3476
3043
        Run only tests relating to 'ignore'::
3477
3044
 
3486
3053
    def get_transport_type(typestring):
3487
3054
        """Parse and return a transport specifier."""
3488
3055
        if typestring == "sftp":
3489
 
            from bzrlib.tests import stub_sftp
3490
 
            return stub_sftp.SFTPAbsoluteServer
 
3056
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3057
            return SFTPAbsoluteServer
3491
3058
        if typestring == "memory":
3492
 
            from bzrlib.tests import test_server
3493
 
            return memory.MemoryServer
 
3059
            from bzrlib.transport.memory import MemoryServer
 
3060
            return MemoryServer
3494
3061
        if typestring == "fakenfs":
3495
 
            from bzrlib.tests import test_server
3496
 
            return test_server.FakeNFSServer
 
3062
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3063
            return FakeNFSServer
3497
3064
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3498
3065
            (typestring)
3499
3066
        raise errors.BzrCommandError(msg)
3514
3081
                     Option('lsprof-timed',
3515
3082
                            help='Generate lsprof output for benchmarked'
3516
3083
                                 ' sections of code.'),
3517
 
                     Option('lsprof-tests',
3518
 
                            help='Generate lsprof output for each test.'),
3519
3084
                     Option('cache-dir', type=str,
3520
3085
                            help='Cache intermediate benchmark output in this '
3521
3086
                                 'directory.'),
3525
3090
                            ),
3526
3091
                     Option('list-only',
3527
3092
                            help='List the tests instead of running them.'),
3528
 
                     RegistryOption('parallel',
3529
 
                        help="Run the test suite in parallel.",
3530
 
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
3531
 
                        value_switches=False,
3532
 
                        ),
3533
3093
                     Option('randomize', type=str, argname="SEED",
3534
3094
                            help='Randomize the order of tests using the given'
3535
3095
                                 ' seed or "now" for the current time.'),
3537
3097
                            short_name='x',
3538
3098
                            help='Exclude tests that match this regular'
3539
3099
                                 ' expression.'),
3540
 
                     Option('subunit',
3541
 
                        help='Output test progress via subunit.'),
3542
3100
                     Option('strict', help='Fail on missing dependencies or '
3543
3101
                            'known failures.'),
3544
3102
                     Option('load-list', type=str, argname='TESTLISTFILE',
3561
3119
            lsprof_timed=None, cache_dir=None,
3562
3120
            first=False, list_only=False,
3563
3121
            randomize=None, exclude=None, strict=False,
3564
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3565
 
            parallel=None, lsprof_tests=False):
 
3122
            load_list=None, debugflag=None, starting_with=None):
3566
3123
        from bzrlib.tests import selftest
3567
3124
        import bzrlib.benchmarks as benchmarks
3568
3125
        from bzrlib.benchmarks import tree_creator
3572
3129
 
3573
3130
        if cache_dir is not None:
3574
3131
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3132
        if not list_only:
 
3133
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3134
            print '   %s (%s python%s)' % (
 
3135
                    bzrlib.__path__[0],
 
3136
                    bzrlib.version_string,
 
3137
                    bzrlib._format_version_tuple(sys.version_info),
 
3138
                    )
 
3139
        print
3575
3140
        if testspecs_list is not None:
3576
3141
            pattern = '|'.join(testspecs_list)
3577
3142
        else:
3578
3143
            pattern = ".*"
3579
 
        if subunit:
3580
 
            try:
3581
 
                from bzrlib.tests import SubUnitBzrRunner
3582
 
            except ImportError:
3583
 
                raise errors.BzrCommandError("subunit not available. subunit "
3584
 
                    "needs to be installed to use --subunit.")
3585
 
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3586
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3587
 
            # stdout, which would corrupt the subunit stream. 
3588
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3589
 
                import msvcrt
3590
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3591
 
        if parallel:
3592
 
            self.additional_selftest_args.setdefault(
3593
 
                'suite_decorators', []).append(parallel)
3594
3144
        if benchmark:
3595
3145
            test_suite_factory = benchmarks.test_suite
3596
3146
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3597
3147
            verbose = not is_quiet()
3598
3148
            # TODO: should possibly lock the history file...
3599
3149
            benchfile = open(".perf_history", "at", buffering=1)
3600
 
            self.add_cleanup(benchfile.close)
3601
3150
        else:
3602
3151
            test_suite_factory = None
3603
3152
            benchfile = None
3604
 
        selftest_kwargs = {"verbose": verbose,
3605
 
                          "pattern": pattern,
3606
 
                          "stop_on_failure": one,
3607
 
                          "transport": transport,
3608
 
                          "test_suite_factory": test_suite_factory,
3609
 
                          "lsprof_timed": lsprof_timed,
3610
 
                          "lsprof_tests": lsprof_tests,
3611
 
                          "bench_history": benchfile,
3612
 
                          "matching_tests_first": first,
3613
 
                          "list_only": list_only,
3614
 
                          "random_seed": randomize,
3615
 
                          "exclude_pattern": exclude,
3616
 
                          "strict": strict,
3617
 
                          "load_list": load_list,
3618
 
                          "debug_flags": debugflag,
3619
 
                          "starting_with": starting_with
3620
 
                          }
3621
 
        selftest_kwargs.update(self.additional_selftest_args)
3622
 
        result = selftest(**selftest_kwargs)
 
3153
        try:
 
3154
            selftest_kwargs = {"verbose": verbose,
 
3155
                              "pattern": pattern,
 
3156
                              "stop_on_failure": one,
 
3157
                              "transport": transport,
 
3158
                              "test_suite_factory": test_suite_factory,
 
3159
                              "lsprof_timed": lsprof_timed,
 
3160
                              "bench_history": benchfile,
 
3161
                              "matching_tests_first": first,
 
3162
                              "list_only": list_only,
 
3163
                              "random_seed": randomize,
 
3164
                              "exclude_pattern": exclude,
 
3165
                              "strict": strict,
 
3166
                              "load_list": load_list,
 
3167
                              "debug_flags": debugflag,
 
3168
                              "starting_with": starting_with
 
3169
                              }
 
3170
            selftest_kwargs.update(self.additional_selftest_args)
 
3171
            result = selftest(**selftest_kwargs)
 
3172
        finally:
 
3173
            if benchfile is not None:
 
3174
                benchfile.close()
 
3175
        if result:
 
3176
            note('tests passed')
 
3177
        else:
 
3178
            note('tests failed')
3623
3179
        return int(not result)
3624
3180
 
3625
3181
 
3626
3182
class cmd_version(Command):
3627
 
    __doc__ = """Show version of bzr."""
 
3183
    """Show version of bzr."""
3628
3184
 
3629
3185
    encoding_type = 'replace'
3630
3186
    takes_options = [
3641
3197
 
3642
3198
 
3643
3199
class cmd_rocks(Command):
3644
 
    __doc__ = """Statement of optimism."""
 
3200
    """Statement of optimism."""
3645
3201
 
3646
3202
    hidden = True
3647
3203
 
3648
3204
    @display_command
3649
3205
    def run(self):
3650
 
        self.outf.write("It sure does!\n")
 
3206
        print "It sure does!"
3651
3207
 
3652
3208
 
3653
3209
class cmd_find_merge_base(Command):
3654
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3210
    """Find and print a base revision for merging two branches."""
3655
3211
    # TODO: Options to specify revisions on either side, as if
3656
3212
    #       merging only part of the history.
3657
3213
    takes_args = ['branch', 'other']
3658
3214
    hidden = True
3659
 
 
 
3215
    
3660
3216
    @display_command
3661
3217
    def run(self, branch, other):
3662
3218
        from bzrlib.revision import ensure_null
3663
 
 
 
3219
        
3664
3220
        branch1 = Branch.open_containing(branch)[0]
3665
3221
        branch2 = Branch.open_containing(other)[0]
3666
 
        self.add_cleanup(branch1.lock_read().unlock)
3667
 
        self.add_cleanup(branch2.lock_read().unlock)
3668
 
        last1 = ensure_null(branch1.last_revision())
3669
 
        last2 = ensure_null(branch2.last_revision())
3670
 
 
3671
 
        graph = branch1.repository.get_graph(branch2.repository)
3672
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3673
 
 
3674
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3222
        branch1.lock_read()
 
3223
        try:
 
3224
            branch2.lock_read()
 
3225
            try:
 
3226
                last1 = ensure_null(branch1.last_revision())
 
3227
                last2 = ensure_null(branch2.last_revision())
 
3228
 
 
3229
                graph = branch1.repository.get_graph(branch2.repository)
 
3230
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3231
 
 
3232
                print 'merge base is revision %s' % base_rev_id
 
3233
            finally:
 
3234
                branch2.unlock()
 
3235
        finally:
 
3236
            branch1.unlock()
3675
3237
 
3676
3238
 
3677
3239
class cmd_merge(Command):
3678
 
    __doc__ = """Perform a three-way merge.
3679
 
 
 
3240
    """Perform a three-way merge.
 
3241
    
3680
3242
    The source of the merge can be specified either in the form of a branch,
3681
3243
    or in the form of a path to a file containing a merge directive generated
3682
3244
    with bzr send. If neither is specified, the default is the upstream branch
3692
3254
    By default, bzr will try to merge in all new work from the other
3693
3255
    branch, automatically determining an appropriate base.  If this
3694
3256
    fails, you may need to give an explicit base.
3695
 
 
 
3257
    
3696
3258
    Merge will do its best to combine the changes in two branches, but there
3697
3259
    are some kinds of problems only a human can fix.  When it encounters those,
3698
3260
    it will mark a conflict.  A conflict means that you need to fix something,
3708
3270
    The results of the merge are placed into the destination working
3709
3271
    directory, where they can be reviewed (with bzr diff), tested, and then
3710
3272
    committed to record the result of the merge.
3711
 
 
 
3273
    
3712
3274
    merge refuses to run if there are any uncommitted changes, unless
3713
 
    --force is given. The --force option can also be used to create a
3714
 
    merge revision which has more than two parents.
3715
 
 
3716
 
    If one would like to merge changes from the working tree of the other
3717
 
    branch without merging any committed revisions, the --uncommitted option
3718
 
    can be given.
3719
 
 
3720
 
    To select only some changes to merge, use "merge -i", which will prompt
3721
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3275
    --force is given.
3722
3276
 
3723
3277
    :Examples:
3724
3278
        To merge the latest revision from bzr.dev::
3733
3287
 
3734
3288
            bzr merge -r 81..82 ../bzr.dev
3735
3289
 
3736
 
        To apply a merge directive contained in /tmp/merge::
 
3290
        To apply a merge directive contained in /tmp/merge:
3737
3291
 
3738
3292
            bzr merge /tmp/merge
3739
 
 
3740
 
        To create a merge revision with three parents from two branches
3741
 
        feature1a and feature1b:
3742
 
 
3743
 
            bzr merge ../feature1a
3744
 
            bzr merge ../feature1b --force
3745
 
            bzr commit -m 'revision with three parents'
3746
3293
    """
3747
3294
 
3748
3295
    encoding_type = 'exact'
3749
 
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3296
    _see_also = ['update', 'remerge', 'status-flags']
3750
3297
    takes_args = ['location?']
3751
3298
    takes_options = [
3752
3299
        'change',
3770
3317
               short_name='d',
3771
3318
               type=unicode,
3772
3319
               ),
3773
 
        Option('preview', help='Instead of merging, show a diff of the'
3774
 
               ' merge.'),
3775
 
        Option('interactive', help='Select changes interactively.',
3776
 
            short_name='i')
 
3320
        Option('preview', help='Instead of merging, show a diff of the merge.')
3777
3321
    ]
3778
3322
 
3779
3323
    def run(self, location=None, revision=None, force=False,
3781
3325
            uncommitted=False, pull=False,
3782
3326
            directory=None,
3783
3327
            preview=False,
3784
 
            interactive=False,
3785
3328
            ):
3786
3329
        if merge_type is None:
3787
3330
            merge_type = _mod_merge.Merge3Merger
3792
3335
        allow_pending = True
3793
3336
        verified = 'inapplicable'
3794
3337
        tree = WorkingTree.open_containing(directory)[0]
3795
 
 
3796
 
        try:
3797
 
            basis_tree = tree.revision_tree(tree.last_revision())
3798
 
        except errors.NoSuchRevision:
3799
 
            basis_tree = tree.basis_tree()
3800
 
 
3801
 
        # die as quickly as possible if there are uncommitted changes
3802
 
        if not force:
3803
 
            if tree.has_changes():
3804
 
                raise errors.UncommittedChanges(tree)
3805
 
 
3806
3338
        view_info = _get_view_info_for_change_reporter(tree)
3807
3339
        change_reporter = delta._ChangeReporter(
3808
3340
            unversioned_filter=tree.is_ignored, view_info=view_info)
3809
 
        pb = ui.ui_factory.nested_progress_bar()
3810
 
        self.add_cleanup(pb.finished)
3811
 
        self.add_cleanup(tree.lock_write().unlock)
3812
 
        if location is not None:
3813
 
            try:
3814
 
                mergeable = bundle.read_mergeable_from_url(location,
3815
 
                    possible_transports=possible_transports)
3816
 
            except errors.NotABundle:
3817
 
                mergeable = None
 
3341
        cleanups = []
 
3342
        try:
 
3343
            pb = ui.ui_factory.nested_progress_bar()
 
3344
            cleanups.append(pb.finished)
 
3345
            tree.lock_write()
 
3346
            cleanups.append(tree.unlock)
 
3347
            if location is not None:
 
3348
                try:
 
3349
                    mergeable = bundle.read_mergeable_from_url(location,
 
3350
                        possible_transports=possible_transports)
 
3351
                except errors.NotABundle:
 
3352
                    mergeable = None
 
3353
                else:
 
3354
                    if uncommitted:
 
3355
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3356
                            ' with bundles or merge directives.')
 
3357
 
 
3358
                    if revision is not None:
 
3359
                        raise errors.BzrCommandError(
 
3360
                            'Cannot use -r with merge directives or bundles')
 
3361
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3362
                       mergeable, pb)
 
3363
 
 
3364
            if merger is None and uncommitted:
 
3365
                if revision is not None and len(revision) > 0:
 
3366
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3367
                        ' --revision at the same time.')
 
3368
                location = self._select_branch_location(tree, location)[0]
 
3369
                other_tree, other_path = WorkingTree.open_containing(location)
 
3370
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3371
                    pb)
 
3372
                allow_pending = False
 
3373
                if other_path != '':
 
3374
                    merger.interesting_files = [other_path]
 
3375
 
 
3376
            if merger is None:
 
3377
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3378
                    location, revision, remember, possible_transports, pb)
 
3379
 
 
3380
            merger.merge_type = merge_type
 
3381
            merger.reprocess = reprocess
 
3382
            merger.show_base = show_base
 
3383
            self.sanity_check_merger(merger)
 
3384
            if (merger.base_rev_id == merger.other_rev_id and
 
3385
                merger.other_rev_id is not None):
 
3386
                note('Nothing to do.')
 
3387
                return 0
 
3388
            if pull:
 
3389
                if merger.interesting_files is not None:
 
3390
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3391
                if (merger.base_rev_id == tree.last_revision()):
 
3392
                    result = tree.pull(merger.other_branch, False,
 
3393
                                       merger.other_rev_id)
 
3394
                    result.report(self.outf)
 
3395
                    return 0
 
3396
            merger.check_basis(not force)
 
3397
            if preview:
 
3398
                return self._do_preview(merger)
3818
3399
            else:
3819
 
                if uncommitted:
3820
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3821
 
                        ' with bundles or merge directives.')
3822
 
 
3823
 
                if revision is not None:
3824
 
                    raise errors.BzrCommandError(
3825
 
                        'Cannot use -r with merge directives or bundles')
3826
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3827
 
                   mergeable, None)
3828
 
 
3829
 
        if merger is None and uncommitted:
3830
 
            if revision is not None and len(revision) > 0:
3831
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3832
 
                    ' --revision at the same time.')
3833
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3834
 
            allow_pending = False
3835
 
 
3836
 
        if merger is None:
3837
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3838
 
                location, revision, remember, possible_transports, None)
3839
 
 
3840
 
        merger.merge_type = merge_type
3841
 
        merger.reprocess = reprocess
3842
 
        merger.show_base = show_base
3843
 
        self.sanity_check_merger(merger)
3844
 
        if (merger.base_rev_id == merger.other_rev_id and
3845
 
            merger.other_rev_id is not None):
3846
 
            note('Nothing to do.')
3847
 
            return 0
3848
 
        if pull:
3849
 
            if merger.interesting_files is not None:
3850
 
                raise errors.BzrCommandError('Cannot pull individual files')
3851
 
            if (merger.base_rev_id == tree.last_revision()):
3852
 
                result = tree.pull(merger.other_branch, False,
3853
 
                                   merger.other_rev_id)
3854
 
                result.report(self.outf)
3855
 
                return 0
3856
 
        if merger.this_basis is None:
3857
 
            raise errors.BzrCommandError(
3858
 
                "This branch has no commits."
3859
 
                " (perhaps you would prefer 'bzr pull')")
3860
 
        if preview:
3861
 
            return self._do_preview(merger)
3862
 
        elif interactive:
3863
 
            return self._do_interactive(merger)
3864
 
        else:
3865
 
            return self._do_merge(merger, change_reporter, allow_pending,
3866
 
                                  verified)
3867
 
 
3868
 
    def _get_preview(self, merger):
 
3400
                return self._do_merge(merger, change_reporter, allow_pending,
 
3401
                                      verified)
 
3402
        finally:
 
3403
            for cleanup in reversed(cleanups):
 
3404
                cleanup()
 
3405
 
 
3406
    def _do_preview(self, merger):
 
3407
        from bzrlib.diff import show_diff_trees
3869
3408
        tree_merger = merger.make_merger()
3870
3409
        tt = tree_merger.make_preview_transform()
3871
 
        self.add_cleanup(tt.finalize)
3872
 
        result_tree = tt.get_preview_tree()
3873
 
        return result_tree
3874
 
 
3875
 
    def _do_preview(self, merger):
3876
 
        from bzrlib.diff import show_diff_trees
3877
 
        result_tree = self._get_preview(merger)
3878
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3879
 
                        old_label='', new_label='')
 
3410
        try:
 
3411
            result_tree = tt.get_preview_tree()
 
3412
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3413
                            old_label='', new_label='')
 
3414
        finally:
 
3415
            tt.finalize()
3880
3416
 
3881
3417
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
3418
        merger.change_reporter = change_reporter
3890
3426
        else:
3891
3427
            return 0
3892
3428
 
3893
 
    def _do_interactive(self, merger):
3894
 
        """Perform an interactive merge.
3895
 
 
3896
 
        This works by generating a preview tree of the merge, then using
3897
 
        Shelver to selectively remove the differences between the working tree
3898
 
        and the preview tree.
3899
 
        """
3900
 
        from bzrlib import shelf_ui
3901
 
        result_tree = self._get_preview(merger)
3902
 
        writer = bzrlib.option.diff_writer_registry.get()
3903
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3904
 
                                   reporter=shelf_ui.ApplyReporter(),
3905
 
                                   diff_writer=writer(sys.stdout))
3906
 
        try:
3907
 
            shelver.run()
3908
 
        finally:
3909
 
            shelver.finalize()
3910
 
 
3911
3429
    def sanity_check_merger(self, merger):
3912
3430
        if (merger.show_base and
3913
3431
            not merger.merge_type is _mod_merge.Merge3Merger):
3948
3466
            base_branch, base_path = Branch.open_containing(base_loc,
3949
3467
                possible_transports)
3950
3468
        # Find the revision ids
3951
 
        other_revision_id = None
3952
 
        base_revision_id = None
3953
 
        if revision is not None:
3954
 
            if len(revision) >= 1:
3955
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3956
 
            if len(revision) == 2:
3957
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3958
 
        if other_revision_id is None:
 
3469
        if revision is None or len(revision) < 1 or revision[-1] is None:
3959
3470
            other_revision_id = _mod_revision.ensure_null(
3960
3471
                other_branch.last_revision())
 
3472
        else:
 
3473
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3474
        if (revision is not None and len(revision) == 2
 
3475
            and revision[0] is not None):
 
3476
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3477
        else:
 
3478
            base_revision_id = None
3961
3479
        # Remember where we merge from
3962
3480
        if ((remember or tree.branch.get_submit_branch() is None) and
3963
3481
             user_location is not None):
3972
3490
            allow_pending = True
3973
3491
        return merger, allow_pending
3974
3492
 
3975
 
    def get_merger_from_uncommitted(self, tree, location, pb):
3976
 
        """Get a merger for uncommitted changes.
3977
 
 
3978
 
        :param tree: The tree the merger should apply to.
3979
 
        :param location: The location containing uncommitted changes.
3980
 
        :param pb: The progress bar to use for showing progress.
3981
 
        """
3982
 
        location = self._select_branch_location(tree, location)[0]
3983
 
        other_tree, other_path = WorkingTree.open_containing(location)
3984
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
3985
 
        if other_path != '':
3986
 
            merger.interesting_files = [other_path]
3987
 
        return merger
3988
 
 
3989
3493
    def _select_branch_location(self, tree, user_location, revision=None,
3990
3494
                                index=None):
3991
3495
        """Select a branch location, according to possible inputs.
4035
3539
 
4036
3540
 
4037
3541
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3542
    """Redo a merge.
4039
3543
 
4040
3544
    Use this if you want to try a different merge technique while resolving
4041
 
    conflicts.  Some merge techniques are better than others, and remerge
 
3545
    conflicts.  Some merge techniques are better than others, and remerge 
4042
3546
    lets you try different ones on different files.
4043
3547
 
4044
3548
    The options for remerge have the same meaning and defaults as the ones for
4048
3552
    :Examples:
4049
3553
        Re-do the merge of all conflicted files, and show the base text in
4050
3554
        conflict regions, in addition to the usual THIS and OTHER texts::
4051
 
 
 
3555
      
4052
3556
            bzr remerge --show-base
4053
3557
 
4054
3558
        Re-do the merge of "foobar", using the weave merge algorithm, with
4055
3559
        additional processing to reduce the size of conflict regions::
4056
 
 
 
3560
      
4057
3561
            bzr remerge --merge-type weave --reprocess foobar
4058
3562
    """
4059
3563
    takes_args = ['file*']
4066
3570
 
4067
3571
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3572
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3573
        if merge_type is None:
4071
3574
            merge_type = _mod_merge.Merge3Merger
4072
3575
        tree, file_list = tree_files(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
4074
 
        parents = tree.get_parent_ids()
4075
 
        if len(parents) != 2:
4076
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4077
 
                                         " merges.  Not cherrypicking or"
4078
 
                                         " multi-merges.")
4079
 
        repository = tree.branch.repository
4080
 
        interesting_ids = None
4081
 
        new_conflicts = []
4082
 
        conflicts = tree.conflicts()
4083
 
        if file_list is not None:
4084
 
            interesting_ids = set()
4085
 
            for filename in file_list:
4086
 
                file_id = tree.path2id(filename)
4087
 
                if file_id is None:
4088
 
                    raise errors.NotVersionedError(filename)
4089
 
                interesting_ids.add(file_id)
4090
 
                if tree.kind(file_id) != "directory":
4091
 
                    continue
4092
 
 
4093
 
                for name, ie in tree.inventory.iter_entries(file_id):
4094
 
                    interesting_ids.add(ie.file_id)
4095
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4096
 
        else:
4097
 
            # Remerge only supports resolving contents conflicts
4098
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4099
 
            restore_files = [c.path for c in conflicts
4100
 
                             if c.typestring in allowed_conflicts]
4101
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4102
 
        tree.set_conflicts(ConflictList(new_conflicts))
4103
 
        if file_list is not None:
4104
 
            restore_files = file_list
4105
 
        for filename in restore_files:
 
3576
        tree.lock_write()
 
3577
        try:
 
3578
            parents = tree.get_parent_ids()
 
3579
            if len(parents) != 2:
 
3580
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3581
                                             " merges.  Not cherrypicking or"
 
3582
                                             " multi-merges.")
 
3583
            repository = tree.branch.repository
 
3584
            interesting_ids = None
 
3585
            new_conflicts = []
 
3586
            conflicts = tree.conflicts()
 
3587
            if file_list is not None:
 
3588
                interesting_ids = set()
 
3589
                for filename in file_list:
 
3590
                    file_id = tree.path2id(filename)
 
3591
                    if file_id is None:
 
3592
                        raise errors.NotVersionedError(filename)
 
3593
                    interesting_ids.add(file_id)
 
3594
                    if tree.kind(file_id) != "directory":
 
3595
                        continue
 
3596
                    
 
3597
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3598
                        interesting_ids.add(ie.file_id)
 
3599
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3600
            else:
 
3601
                # Remerge only supports resolving contents conflicts
 
3602
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3603
                restore_files = [c.path for c in conflicts
 
3604
                                 if c.typestring in allowed_conflicts]
 
3605
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3606
            tree.set_conflicts(ConflictList(new_conflicts))
 
3607
            if file_list is not None:
 
3608
                restore_files = file_list
 
3609
            for filename in restore_files:
 
3610
                try:
 
3611
                    restore(tree.abspath(filename))
 
3612
                except errors.NotConflicted:
 
3613
                    pass
 
3614
            # Disable pending merges, because the file texts we are remerging
 
3615
            # have not had those merges performed.  If we use the wrong parents
 
3616
            # list, we imply that the working tree text has seen and rejected
 
3617
            # all the changes from the other tree, when in fact those changes
 
3618
            # have not yet been seen.
 
3619
            pb = ui.ui_factory.nested_progress_bar()
 
3620
            tree.set_parent_ids(parents[:1])
4106
3621
            try:
4107
 
                restore(tree.abspath(filename))
4108
 
            except errors.NotConflicted:
4109
 
                pass
4110
 
        # Disable pending merges, because the file texts we are remerging
4111
 
        # have not had those merges performed.  If we use the wrong parents
4112
 
        # list, we imply that the working tree text has seen and rejected
4113
 
        # all the changes from the other tree, when in fact those changes
4114
 
        # have not yet been seen.
4115
 
        tree.set_parent_ids(parents[:1])
4116
 
        try:
4117
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4118
 
            merger.interesting_ids = interesting_ids
4119
 
            merger.merge_type = merge_type
4120
 
            merger.show_base = show_base
4121
 
            merger.reprocess = reprocess
4122
 
            conflicts = merger.do_merge()
 
3622
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3623
                                                             tree, parents[1])
 
3624
                merger.interesting_ids = interesting_ids
 
3625
                merger.merge_type = merge_type
 
3626
                merger.show_base = show_base
 
3627
                merger.reprocess = reprocess
 
3628
                conflicts = merger.do_merge()
 
3629
            finally:
 
3630
                tree.set_parent_ids(parents)
 
3631
                pb.finished()
4123
3632
        finally:
4124
 
            tree.set_parent_ids(parents)
 
3633
            tree.unlock()
4125
3634
        if conflicts > 0:
4126
3635
            return 1
4127
3636
        else:
4129
3638
 
4130
3639
 
4131
3640
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
3641
    """Revert files to a previous revision.
4133
3642
 
4134
3643
    Giving a list of files will revert only those files.  Otherwise, all files
4135
3644
    will be reverted.  If the revision is not specified with '--revision', the
4139
3648
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4140
3649
    changes introduced by -2, without affecting the changes introduced by -1.
4141
3650
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4142
 
 
 
3651
    
4143
3652
    By default, any files that have been manually changed will be backed up
4144
3653
    first.  (Files changed only by merge are not backed up.)  Backup files have
4145
3654
    '.~#~' appended to their name, where # is a number.
4149
3658
    name.  If you name a directory, all the contents of that directory will be
4150
3659
    reverted.
4151
3660
 
4152
 
    If you have newly added files since the target revision, they will be
4153
 
    removed.  If the files to be removed have been changed, backups will be
4154
 
    created as above.  Directories containing unknown files will not be
4155
 
    deleted.
 
3661
    Any files that have been newly added since that revision will be deleted,
 
3662
    with a backup kept if appropriate.  Directories containing unknown files
 
3663
    will not be deleted.
4156
3664
 
4157
 
    The working tree contains a list of revisions that have been merged but
4158
 
    not yet committed. These revisions will be included as additional parents
4159
 
    of the next commit.  Normally, using revert clears that list as well as
4160
 
    reverting the files.  If any files are specified, revert leaves the list
4161
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4162
 
    .`` in the tree root to revert all files but keep the recorded merges,
4163
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3665
    The working tree contains a list of pending merged revisions, which will
 
3666
    be included as parents in the next commit.  Normally, revert clears that
 
3667
    list as well as reverting the files.  If any files are specified, revert
 
3668
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3669
    revert ." in the tree root to revert all files but keep the merge record,
 
3670
    and "bzr revert --forget-merges" to clear the pending merge list without
4164
3671
    reverting any files.
4165
 
 
4166
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4167
 
    changes from a branch in a single revision.  To do this, perform the merge
4168
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4169
 
    the content of the tree as it was, but it will clear the list of pending
4170
 
    merges.  The next commit will then contain all of the changes that are
4171
 
    present in the other branch, but without any other parent revisions.
4172
 
    Because this technique forgets where these changes originated, it may
4173
 
    cause additional conflicts on later merges involving the same source and
4174
 
    target branches.
4175
3672
    """
4176
3673
 
4177
3674
    _see_also = ['cat', 'export']
4186
3683
    def run(self, revision=None, no_backup=False, file_list=None,
4187
3684
            forget_merges=None):
4188
3685
        tree, file_list = tree_files(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
 
        if forget_merges:
4191
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
 
        else:
4193
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3686
        tree.lock_write()
 
3687
        try:
 
3688
            if forget_merges:
 
3689
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3690
            else:
 
3691
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3692
        finally:
 
3693
            tree.unlock()
4194
3694
 
4195
3695
    @staticmethod
4196
3696
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
3697
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4199
 
            report_changes=True)
 
3698
        pb = ui.ui_factory.nested_progress_bar()
 
3699
        try:
 
3700
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3701
                report_changes=True)
 
3702
        finally:
 
3703
            pb.finished()
4200
3704
 
4201
3705
 
4202
3706
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
3707
    """Test reporting of assertion failures"""
4204
3708
    # intended just for use in testing
4205
3709
 
4206
3710
    hidden = True
4210
3714
 
4211
3715
 
4212
3716
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
3717
    """Show help on a command or other topic.
4214
3718
    """
4215
3719
 
4216
3720
    _see_also = ['topics']
4219
3723
            ]
4220
3724
    takes_args = ['topic?']
4221
3725
    aliases = ['?', '--help', '-?', '-h']
4222
 
 
 
3726
    
4223
3727
    @display_command
4224
3728
    def run(self, topic=None, long=False):
4225
3729
        import bzrlib.help
4229
3733
 
4230
3734
 
4231
3735
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
3736
    """Show appropriate completions for context.
4233
3737
 
4234
3738
    For a list of all available commands, say 'bzr shell-complete'.
4235
3739
    """
4236
3740
    takes_args = ['context?']
4237
3741
    aliases = ['s-c']
4238
3742
    hidden = True
4239
 
 
 
3743
    
4240
3744
    @display_command
4241
3745
    def run(self, context=None):
4242
3746
        import shellcomplete
4244
3748
 
4245
3749
 
4246
3750
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3751
    """Show unmerged/unpulled revisions between two branches.
4248
3752
 
4249
3753
    OTHER_BRANCH may be local or remote.
4250
3754
 
4251
 
    To filter on a range of revisions, you can use the command -r begin..end
 
3755
    To filter on a range of revirions, you can use the command -r begin..end
4252
3756
    -r revision requests a specific revision, -r ..end or -r begin.. are
4253
3757
    also valid.
4254
 
            
4255
 
    :Exit values:
4256
 
        1 - some missing revisions
4257
 
        0 - no missing revisions
4258
3758
 
4259
3759
    :Examples:
4260
3760
 
4298
3798
            type=_parse_revision_str,
4299
3799
            help='Filter on local branch revisions (inclusive). '
4300
3800
                'See "help revisionspec" for details.'),
4301
 
        Option('include-merges',
4302
 
               'Show all revisions in addition to the mainline ones.'),
 
3801
        Option('include-merges', 'Show merged revisions.'),
4303
3802
        ]
4304
3803
    encoding_type = 'replace'
4305
3804
 
4328
3827
            restrict = 'remote'
4329
3828
 
4330
3829
        local_branch = Branch.open_containing(u".")[0]
4331
 
        self.add_cleanup(local_branch.lock_read().unlock)
4332
 
 
4333
3830
        parent = local_branch.get_parent()
4334
3831
        if other_branch is None:
4335
3832
            other_branch = parent
4344
3841
        remote_branch = Branch.open(other_branch)
4345
3842
        if remote_branch.base == local_branch.base:
4346
3843
            remote_branch = local_branch
4347
 
        else:
4348
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4349
3844
 
4350
3845
        local_revid_range = _revision_range_to_revid_range(
4351
3846
            _get_revision_range(my_revision, local_branch,
4355
3850
            _get_revision_range(revision,
4356
3851
                remote_branch, self.name()))
4357
3852
 
4358
 
        local_extra, remote_extra = find_unmerged(
4359
 
            local_branch, remote_branch, restrict,
4360
 
            backward=not reverse,
4361
 
            include_merges=include_merges,
4362
 
            local_revid_range=local_revid_range,
4363
 
            remote_revid_range=remote_revid_range)
4364
 
 
4365
 
        if log_format is None:
4366
 
            registry = log.log_formatter_registry
4367
 
            log_format = registry.get_default(local_branch)
4368
 
        lf = log_format(to_file=self.outf,
4369
 
                        show_ids=show_ids,
4370
 
                        show_timezone='original')
4371
 
 
4372
 
        status_code = 0
4373
 
        if local_extra and not theirs_only:
4374
 
            message("You have %d extra revision(s):\n" %
4375
 
                len(local_extra))
4376
 
            for revision in iter_log_revisions(local_extra,
4377
 
                                local_branch.repository,
4378
 
                                verbose):
4379
 
                lf.log_revision(revision)
4380
 
            printed_local = True
4381
 
            status_code = 1
4382
 
        else:
4383
 
            printed_local = False
4384
 
 
4385
 
        if remote_extra and not mine_only:
4386
 
            if printed_local is True:
4387
 
                message("\n\n\n")
4388
 
            message("You are missing %d revision(s):\n" %
4389
 
                len(remote_extra))
4390
 
            for revision in iter_log_revisions(remote_extra,
4391
 
                                remote_branch.repository,
4392
 
                                verbose):
4393
 
                lf.log_revision(revision)
4394
 
            status_code = 1
4395
 
 
4396
 
        if mine_only and not local_extra:
4397
 
            # We checked local, and found nothing extra
4398
 
            message('This branch is up to date.\n')
4399
 
        elif theirs_only and not remote_extra:
4400
 
            # We checked remote, and found nothing extra
4401
 
            message('Other branch is up to date.\n')
4402
 
        elif not (mine_only or theirs_only or local_extra or
4403
 
                  remote_extra):
4404
 
            # We checked both branches, and neither one had extra
4405
 
            # revisions
4406
 
            message("Branches are up to date.\n")
4407
 
        self.cleanup_now()
 
3853
        local_branch.lock_read()
 
3854
        try:
 
3855
            remote_branch.lock_read()
 
3856
            try:
 
3857
                local_extra, remote_extra = find_unmerged(
 
3858
                    local_branch, remote_branch, restrict,
 
3859
                    backward=not reverse,
 
3860
                    include_merges=include_merges,
 
3861
                    local_revid_range=local_revid_range,
 
3862
                    remote_revid_range=remote_revid_range)
 
3863
 
 
3864
                if log_format is None:
 
3865
                    registry = log.log_formatter_registry
 
3866
                    log_format = registry.get_default(local_branch)
 
3867
                lf = log_format(to_file=self.outf,
 
3868
                                show_ids=show_ids,
 
3869
                                show_timezone='original')
 
3870
 
 
3871
                status_code = 0
 
3872
                if local_extra and not theirs_only:
 
3873
                    message("You have %d extra revision(s):\n" %
 
3874
                        len(local_extra))
 
3875
                    for revision in iter_log_revisions(local_extra,
 
3876
                                        local_branch.repository,
 
3877
                                        verbose):
 
3878
                        lf.log_revision(revision)
 
3879
                    printed_local = True
 
3880
                    status_code = 1
 
3881
                else:
 
3882
                    printed_local = False
 
3883
 
 
3884
                if remote_extra and not mine_only:
 
3885
                    if printed_local is True:
 
3886
                        message("\n\n\n")
 
3887
                    message("You are missing %d revision(s):\n" %
 
3888
                        len(remote_extra))
 
3889
                    for revision in iter_log_revisions(remote_extra,
 
3890
                                        remote_branch.repository,
 
3891
                                        verbose):
 
3892
                        lf.log_revision(revision)
 
3893
                    status_code = 1
 
3894
 
 
3895
                if mine_only and not local_extra:
 
3896
                    # We checked local, and found nothing extra
 
3897
                    message('This branch is up to date.\n')
 
3898
                elif theirs_only and not remote_extra:
 
3899
                    # We checked remote, and found nothing extra
 
3900
                    message('Other branch is up to date.\n')
 
3901
                elif not (mine_only or theirs_only or local_extra or
 
3902
                          remote_extra):
 
3903
                    # We checked both branches, and neither one had extra
 
3904
                    # revisions
 
3905
                    message("Branches are up to date.\n")
 
3906
            finally:
 
3907
                remote_branch.unlock()
 
3908
        finally:
 
3909
            local_branch.unlock()
4408
3910
        if not status_code and parent is None and other_branch is not None:
4409
 
            self.add_cleanup(local_branch.lock_write().unlock)
4410
 
            # handle race conditions - a parent might be set while we run.
4411
 
            if local_branch.get_parent() is None:
4412
 
                local_branch.set_parent(remote_branch.base)
 
3911
            local_branch.lock_write()
 
3912
            try:
 
3913
                # handle race conditions - a parent might be set while we run.
 
3914
                if local_branch.get_parent() is None:
 
3915
                    local_branch.set_parent(remote_branch.base)
 
3916
            finally:
 
3917
                local_branch.unlock()
4413
3918
        return status_code
4414
3919
 
4415
3920
 
4416
3921
class cmd_pack(Command):
4417
 
    __doc__ = """Compress the data within a repository.
4418
 
 
4419
 
    This operation compresses the data within a bazaar repository. As
4420
 
    bazaar supports automatic packing of repository, this operation is
4421
 
    normally not required to be done manually.
4422
 
 
4423
 
    During the pack operation, bazaar takes a backup of existing repository
4424
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4425
 
    automatically when it is safe to do so. To save disk space by removing
4426
 
    the backed up pack files, the --clean-obsolete-packs option may be
4427
 
    used.
4428
 
 
4429
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4430
 
    during or immediately after repacking, you may be left with a state
4431
 
    where the deletion has been written to disk but the new packs have not
4432
 
    been. In this case the repository may be unusable.
4433
 
    """
 
3922
    """Compress the data within a repository."""
4434
3923
 
4435
3924
    _see_also = ['repositories']
4436
3925
    takes_args = ['branch_or_repo?']
4437
 
    takes_options = [
4438
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4439
 
        ]
4440
3926
 
4441
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
3927
    def run(self, branch_or_repo='.'):
4442
3928
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4443
3929
        try:
4444
3930
            branch = dir.open_branch()
4445
3931
            repository = branch.repository
4446
3932
        except errors.NotBranchError:
4447
3933
            repository = dir.open_repository()
4448
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
3934
        repository.pack()
4449
3935
 
4450
3936
 
4451
3937
class cmd_plugins(Command):
4452
 
    __doc__ = """List the installed plugins.
4453
 
 
 
3938
    """List the installed plugins.
 
3939
    
4454
3940
    This command displays the list of installed plugins including
4455
3941
    version of plugin and a short description of each.
4456
3942
 
4462
3948
    adding new commands, providing additional network transports and
4463
3949
    customizing log output.
4464
3950
 
4465
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4466
 
    for further information on plugins including where to find them and how to
4467
 
    install them. Instructions are also provided there on how to write new
4468
 
    plugins using the Python programming language.
 
3951
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3952
    information on plugins including where to find them and how to
 
3953
    install them. Instructions are also provided there on how to
 
3954
    write new plugins using the Python programming language.
4469
3955
    """
4470
3956
    takes_options = ['verbose']
4471
3957
 
4486
3972
                doc = '(no description)'
4487
3973
            result.append((name_ver, doc, plugin.path()))
4488
3974
        for name_ver, doc, path in sorted(result):
4489
 
            self.outf.write("%s\n" % name_ver)
4490
 
            self.outf.write("   %s\n" % doc)
 
3975
            print name_ver
 
3976
            print '   ', doc
4491
3977
            if verbose:
4492
 
                self.outf.write("   %s\n" % path)
4493
 
            self.outf.write("\n")
 
3978
                print '   ', path
 
3979
            print
4494
3980
 
4495
3981
 
4496
3982
class cmd_testament(Command):
4497
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
3983
    """Show testament (signing-form) of a revision."""
4498
3984
    takes_options = [
4499
3985
            'revision',
4500
3986
            Option('long', help='Produce long-format testament.'),
4512
3998
            b = Branch.open_containing(branch)[0]
4513
3999
        else:
4514
4000
            b = Branch.open(branch)
4515
 
        self.add_cleanup(b.lock_read().unlock)
4516
 
        if revision is None:
4517
 
            rev_id = b.last_revision()
4518
 
        else:
4519
 
            rev_id = revision[0].as_revision_id(b)
4520
 
        t = testament_class.from_revision(b.repository, rev_id)
4521
 
        if long:
4522
 
            sys.stdout.writelines(t.as_text_lines())
4523
 
        else:
4524
 
            sys.stdout.write(t.as_short_text())
 
4001
        b.lock_read()
 
4002
        try:
 
4003
            if revision is None:
 
4004
                rev_id = b.last_revision()
 
4005
            else:
 
4006
                rev_id = revision[0].as_revision_id(b)
 
4007
            t = testament_class.from_revision(b.repository, rev_id)
 
4008
            if long:
 
4009
                sys.stdout.writelines(t.as_text_lines())
 
4010
            else:
 
4011
                sys.stdout.write(t.as_short_text())
 
4012
        finally:
 
4013
            b.unlock()
4525
4014
 
4526
4015
 
4527
4016
class cmd_annotate(Command):
4528
 
    __doc__ = """Show the origin of each line in a file.
 
4017
    """Show the origin of each line in a file.
4529
4018
 
4530
4019
    This prints out the given file with an annotation on the left side
4531
4020
    indicating which revision, author and date introduced the change.
4532
4021
 
4533
 
    If the origin is the same for a run of consecutive lines, it is
 
4022
    If the origin is the same for a run of consecutive lines, it is 
4534
4023
    shown only at the top, unless the --all option is given.
4535
4024
    """
4536
4025
    # TODO: annotate directories; showing when each file was last changed
4537
 
    # TODO: if the working copy is modified, show annotations on that
 
4026
    # TODO: if the working copy is modified, show annotations on that 
4538
4027
    #       with new uncommitted lines marked
4539
4028
    aliases = ['ann', 'blame', 'praise']
4540
4029
    takes_args = ['filename']
4552
4041
        wt, branch, relpath = \
4553
4042
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4554
4043
        if wt is not None:
4555
 
            self.add_cleanup(wt.lock_read().unlock)
4556
 
        else:
4557
 
            self.add_cleanup(branch.lock_read().unlock)
4558
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4559
 
        self.add_cleanup(tree.lock_read().unlock)
4560
 
        if wt is not None:
4561
 
            file_id = wt.path2id(relpath)
4562
 
        else:
4563
 
            file_id = tree.path2id(relpath)
4564
 
        if file_id is None:
4565
 
            raise errors.NotVersionedError(filename)
4566
 
        file_version = tree.inventory[file_id].revision
4567
 
        if wt is not None and revision is None:
4568
 
            # If there is a tree and we're not annotating historical
4569
 
            # versions, annotate the working tree's content.
4570
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4571
 
                show_ids=show_ids)
4572
 
        else:
4573
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4574
 
                          show_ids=show_ids)
 
4044
            wt.lock_read()
 
4045
        else:
 
4046
            branch.lock_read()
 
4047
        try:
 
4048
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4049
            if wt is not None:
 
4050
                file_id = wt.path2id(relpath)
 
4051
            else:
 
4052
                file_id = tree.path2id(relpath)
 
4053
            if file_id is None:
 
4054
                raise errors.NotVersionedError(filename)
 
4055
            file_version = tree.inventory[file_id].revision
 
4056
            if wt is not None and revision is None:
 
4057
                # If there is a tree and we're not annotating historical
 
4058
                # versions, annotate the working tree's content.
 
4059
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4060
                    show_ids=show_ids)
 
4061
            else:
 
4062
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4063
                              show_ids=show_ids)
 
4064
        finally:
 
4065
            if wt is not None:
 
4066
                wt.unlock()
 
4067
            else:
 
4068
                branch.unlock()
4575
4069
 
4576
4070
 
4577
4071
class cmd_re_sign(Command):
4578
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4072
    """Create a digital signature for an existing revision."""
4579
4073
    # TODO be able to replace existing ones.
4580
4074
 
4581
4075
    hidden = True # is this right ?
4582
4076
    takes_args = ['revision_id*']
4583
4077
    takes_options = ['revision']
4584
 
 
 
4078
    
4585
4079
    def run(self, revision_id_list=None, revision=None):
4586
4080
        if revision_id_list is not None and revision is not None:
4587
4081
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4588
4082
        if revision_id_list is None and revision is None:
4589
4083
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4590
4084
        b = WorkingTree.open_containing(u'.')[0].branch
4591
 
        self.add_cleanup(b.lock_write().unlock)
4592
 
        return self._run(b, revision_id_list, revision)
 
4085
        b.lock_write()
 
4086
        try:
 
4087
            return self._run(b, revision_id_list, revision)
 
4088
        finally:
 
4089
            b.unlock()
4593
4090
 
4594
4091
    def _run(self, b, revision_id_list, revision):
4595
4092
        import bzrlib.gpg as gpg
4640
4137
 
4641
4138
 
4642
4139
class cmd_bind(Command):
4643
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4644
 
    If no branch is supplied, rebind to the last bound location.
 
4140
    """Convert the current branch into a checkout of the supplied branch.
4645
4141
 
4646
4142
    Once converted into a checkout, commits must succeed on the master branch
4647
4143
    before they will be applied to the local branch.
4648
4144
 
4649
4145
    Bound branches use the nickname of its master branch unless it is set
4650
 
    locally, in which case binding will update the local nickname to be
 
4146
    locally, in which case binding will update the the local nickname to be
4651
4147
    that of the master.
4652
4148
    """
4653
4149
 
4665
4161
                    'This format does not remember old locations.')
4666
4162
            else:
4667
4163
                if location is None:
4668
 
                    if b.get_bound_location() is not None:
4669
 
                        raise errors.BzrCommandError('Branch is already bound')
4670
 
                    else:
4671
 
                        raise errors.BzrCommandError('No location supplied '
4672
 
                            'and no previous location known')
 
4164
                    raise errors.BzrCommandError('No location supplied and no '
 
4165
                        'previous location known')
4673
4166
        b_other = Branch.open(location)
4674
4167
        try:
4675
4168
            b.bind(b_other)
4681
4174
 
4682
4175
 
4683
4176
class cmd_unbind(Command):
4684
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4177
    """Convert the current checkout into a regular branch.
4685
4178
 
4686
4179
    After unbinding, the local branch is considered independent and subsequent
4687
4180
    commits will be local only.
4698
4191
 
4699
4192
 
4700
4193
class cmd_uncommit(Command):
4701
 
    __doc__ = """Remove the last committed revision.
 
4194
    """Remove the last committed revision.
4702
4195
 
4703
4196
    --verbose will print out what is being removed.
4704
4197
    --dry-run will go through all the motions, but not actually
4744
4237
            b = control.open_branch()
4745
4238
 
4746
4239
        if tree is not None:
4747
 
            self.add_cleanup(tree.lock_write().unlock)
 
4240
            tree.lock_write()
4748
4241
        else:
4749
 
            self.add_cleanup(b.lock_write().unlock)
4750
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4242
            b.lock_write()
 
4243
        try:
 
4244
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4245
                             local=local)
 
4246
        finally:
 
4247
            if tree is not None:
 
4248
                tree.unlock()
 
4249
            else:
 
4250
                b.unlock()
4751
4251
 
4752
4252
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4753
4253
        from bzrlib.log import log_formatter, show_log
4785
4285
                 end_revision=last_revno)
4786
4286
 
4787
4287
        if dry_run:
4788
 
            self.outf.write('Dry-run, pretending to remove'
4789
 
                            ' the above revisions.\n')
 
4288
            print 'Dry-run, pretending to remove the above revisions.'
 
4289
            if not force:
 
4290
                val = raw_input('Press <enter> to continue')
4790
4291
        else:
4791
 
            self.outf.write('The above revision(s) will be removed.\n')
4792
 
 
4793
 
        if not force:
4794
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4795
 
                self.outf.write('Canceled')
4796
 
                return 0
 
4292
            print 'The above revision(s) will be removed.'
 
4293
            if not force:
 
4294
                val = raw_input('Are you sure [y/N]? ')
 
4295
                if val.lower() not in ('y', 'yes'):
 
4296
                    print 'Canceled'
 
4297
                    return 0
4797
4298
 
4798
4299
        mutter('Uncommitting from {%s} to {%s}',
4799
4300
               last_rev_id, rev_id)
4800
4301
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4801
4302
                 revno=revno, local=local)
4802
 
        self.outf.write('You can restore the old tip by running:\n'
4803
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4303
        note('You can restore the old tip by running:\n'
 
4304
             '  bzr pull . -r revid:%s', last_rev_id)
4804
4305
 
4805
4306
 
4806
4307
class cmd_break_lock(Command):
4807
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4308
    """Break a dead lock on a repository, branch or working directory.
4808
4309
 
4809
4310
    CAUTION: Locks should only be broken when you are sure that the process
4810
4311
    holding the lock has been stopped.
4811
4312
 
4812
 
    You can get information on what locks are open via the 'bzr info
4813
 
    [location]' command.
4814
 
 
 
4313
    You can get information on what locks are open via the 'bzr info' command.
 
4314
    
4815
4315
    :Examples:
4816
4316
        bzr break-lock
4817
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4818
4317
    """
4819
4318
    takes_args = ['location?']
4820
4319
 
4826
4325
            control.break_lock()
4827
4326
        except NotImplementedError:
4828
4327
            pass
4829
 
 
 
4328
        
4830
4329
 
4831
4330
class cmd_wait_until_signalled(Command):
4832
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4331
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4833
4332
 
4834
4333
    This just prints a line to signal when it is ready, then blocks on stdin.
4835
4334
    """
4843
4342
 
4844
4343
 
4845
4344
class cmd_serve(Command):
4846
 
    __doc__ = """Run the bzr server."""
 
4345
    """Run the bzr server."""
4847
4346
 
4848
4347
    aliases = ['server']
4849
4348
 
4850
4349
    takes_options = [
4851
4350
        Option('inet',
4852
4351
               help='Serve on stdin/out for use from inetd or sshd.'),
4853
 
        RegistryOption('protocol',
4854
 
               help="Protocol to serve.",
4855
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4856
 
               value_switches=True),
4857
4352
        Option('port',
4858
4353
               help='Listen for connections on nominated port of the form '
4859
4354
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4860
 
                    'result in a dynamically allocated port.  The default port '
4861
 
                    'depends on the protocol.',
 
4355
                    'result in a dynamically allocated port.  The default port is '
 
4356
                    '4155.',
4862
4357
               type=str),
4863
4358
        Option('directory',
4864
4359
               help='Serve contents of this directory.',
4866
4361
        Option('allow-writes',
4867
4362
               help='By default the server is a readonly server.  Supplying '
4868
4363
                    '--allow-writes enables write access to the contents of '
4869
 
                    'the served directory and below.  Note that ``bzr serve`` '
4870
 
                    'does not perform authentication, so unless some form of '
4871
 
                    'external authentication is arranged supplying this '
4872
 
                    'option leads to global uncontrolled write access to your '
4873
 
                    'file system.'
 
4364
                    'the served directory and below.'
4874
4365
                ),
4875
4366
        ]
4876
4367
 
 
4368
    def run_smart_server(self, smart_server):
 
4369
        """Run 'smart_server' forever, with no UI output at all."""
 
4370
        # For the duration of this server, no UI output is permitted. note
 
4371
        # that this may cause problems with blackbox tests. This should be
 
4372
        # changed with care though, as we dont want to use bandwidth sending
 
4373
        # progress over stderr to smart server clients!
 
4374
        from bzrlib import lockdir
 
4375
        old_factory = ui.ui_factory
 
4376
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4377
        try:
 
4378
            ui.ui_factory = ui.SilentUIFactory()
 
4379
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4380
            smart_server.serve()
 
4381
        finally:
 
4382
            ui.ui_factory = old_factory
 
4383
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4384
 
4877
4385
    def get_host_and_port(self, port):
4878
4386
        """Return the host and port to run the smart server on.
4879
4387
 
4880
 
        If 'port' is None, None will be returned for the host and port.
 
4388
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4389
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
4881
4390
 
4882
4391
        If 'port' has a colon in it, the string before the colon will be
4883
4392
        interpreted as the host.
4886
4395
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4887
4396
            and port is an integer TCP/IP port.
4888
4397
        """
4889
 
        host = None
4890
 
        if port is not None:
 
4398
        from bzrlib.smart import medium
 
4399
        host = medium.BZR_DEFAULT_INTERFACE
 
4400
        if port is None:
 
4401
            port = medium.BZR_DEFAULT_PORT
 
4402
        else:
4891
4403
            if ':' in port:
4892
4404
                host, port = port.split(':')
4893
4405
            port = int(port)
4894
4406
        return host, port
4895
4407
 
4896
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4897
 
            protocol=None):
4898
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4408
    def get_smart_server(self, transport, inet, port):
 
4409
        """Construct a smart server.
 
4410
 
 
4411
        :param transport: The base transport from which branches will be
 
4412
            served.
 
4413
        :param inet: If True, serve over stdin and stdout. Used for running
 
4414
            from inet.
 
4415
        :param port: The port to listen on. By default, it's `
 
4416
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4417
            information.
 
4418
        :return: A smart server.
 
4419
        """
 
4420
        from bzrlib.smart import medium, server
 
4421
        if inet:
 
4422
            smart_server = medium.SmartServerPipeStreamMedium(
 
4423
                sys.stdin, sys.stdout, transport)
 
4424
        else:
 
4425
            host, port = self.get_host_and_port(port)
 
4426
            smart_server = server.SmartTCPServer(
 
4427
                transport, host=host, port=port)
 
4428
            note('listening on port: %s' % smart_server.port)
 
4429
        return smart_server
 
4430
 
 
4431
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4432
        from bzrlib.transport import get_transport
 
4433
        from bzrlib.transport.chroot import ChrootServer
4899
4434
        if directory is None:
4900
4435
            directory = os.getcwd()
4901
 
        if protocol is None:
4902
 
            protocol = transport_server_registry.get()
4903
 
        host, port = self.get_host_and_port(port)
4904
4436
        url = urlutils.local_path_to_url(directory)
4905
4437
        if not allow_writes:
4906
4438
            url = 'readonly+' + url
4907
 
        transport = get_transport(url)
4908
 
        protocol(transport, host, port, inet)
 
4439
        chroot_server = ChrootServer(get_transport(url))
 
4440
        chroot_server.setUp()
 
4441
        t = get_transport(chroot_server.get_url())
 
4442
        smart_server = self.get_smart_server(t, inet, port)
 
4443
        self.run_smart_server(smart_server)
4909
4444
 
4910
4445
 
4911
4446
class cmd_join(Command):
4912
 
    __doc__ = """Combine a tree into its containing tree.
4913
 
 
4914
 
    This command requires the target tree to be in a rich-root format.
 
4447
    """Combine a subtree into its containing tree.
 
4448
    
 
4449
    This command is for experimental use only.  It requires the target tree
 
4450
    to be in dirstate-with-subtree format, which cannot be converted into
 
4451
    earlier formats.
4915
4452
 
4916
4453
    The TREE argument should be an independent tree, inside another tree, but
4917
4454
    not part of it.  (Such trees can be produced by "bzr split", but also by
4920
4457
    The result is a combined tree, with the subtree no longer an independant
4921
4458
    part.  This is marked as a merge of the subtree into the containing tree,
4922
4459
    and all history is preserved.
 
4460
 
 
4461
    If --reference is specified, the subtree retains its independence.  It can
 
4462
    be branched by itself, and can be part of multiple projects at the same
 
4463
    time.  But operations performed in the containing tree, such as commit
 
4464
    and merge, will recurse into the subtree.
4923
4465
    """
4924
4466
 
4925
4467
    _see_also = ['split']
4926
4468
    takes_args = ['tree']
4927
4469
    takes_options = [
4928
 
            Option('reference', help='Join by reference.', hidden=True),
 
4470
            Option('reference', help='Join by reference.'),
4929
4471
            ]
 
4472
    hidden = True
4930
4473
 
4931
4474
    def run(self, tree, reference=False):
4932
4475
        sub_tree = WorkingTree.open(tree)
4950
4493
            try:
4951
4494
                containing_tree.subsume(sub_tree)
4952
4495
            except errors.BadSubsumeSource, e:
4953
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4496
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
4954
4497
                                             (tree, e.reason))
4955
4498
 
4956
4499
 
4957
4500
class cmd_split(Command):
4958
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4501
    """Split a subdirectory of a tree into a separate tree.
4959
4502
 
4960
4503
    This command will produce a target tree in a format that supports
4961
4504
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4966
4509
    branch.  Commits in the top-level tree will not apply to the new subtree.
4967
4510
    """
4968
4511
 
4969
 
    _see_also = ['join']
 
4512
    # join is not un-hidden yet
 
4513
    #_see_also = ['join']
4970
4514
    takes_args = ['tree']
4971
4515
 
4972
4516
    def run(self, tree):
4977
4521
        try:
4978
4522
            containing_tree.extract(sub_id)
4979
4523
        except errors.RootNotRich:
4980
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4524
            raise errors.UpgradeRequired(containing_tree.branch.base)
4981
4525
 
4982
4526
 
4983
4527
class cmd_merge_directive(Command):
4984
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4528
    """Generate a merge directive for auto-merge tools.
4985
4529
 
4986
4530
    A directive requests a merge to be performed, and also provides all the
4987
4531
    information necessary to do so.  This means it must either include a
5080
4624
 
5081
4625
 
5082
4626
class cmd_send(Command):
5083
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4627
    """Mail or create a merge-directive for submitting changes.
5084
4628
 
5085
4629
    A merge directive provides many things needed for requesting merges:
5086
4630
 
5092
4636
      directly from the merge directive, without retrieving data from a
5093
4637
      branch.
5094
4638
 
5095
 
    `bzr send` creates a compact data set that, when applied using bzr
5096
 
    merge, has the same effect as merging from the source branch.  
5097
 
    
5098
 
    By default the merge directive is self-contained and can be applied to any
5099
 
    branch containing submit_branch in its ancestory without needing access to
5100
 
    the source branch.
5101
 
    
5102
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5103
 
    revisions, but only a structured request to merge from the
5104
 
    public_location.  In that case the public_branch is needed and it must be
5105
 
    up-to-date and accessible to the recipient.  The public_branch is always
5106
 
    included if known, so that people can check it later.
5107
 
 
5108
 
    The submit branch defaults to the parent of the source branch, but can be
5109
 
    overridden.  Both submit branch and public branch will be remembered in
5110
 
    branch.conf the first time they are used for a particular branch.  The
5111
 
    source branch defaults to that containing the working directory, but can
5112
 
    be changed using --from.
5113
 
 
5114
 
    In order to calculate those changes, bzr must analyse the submit branch.
5115
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5116
 
    If a public location is known for the submit_branch, that location is used
5117
 
    in the merge directive.
5118
 
 
5119
 
    The default behaviour is to send the merge directive by mail, unless -o is
5120
 
    given, in which case it is sent to a file.
 
4639
    If --no-bundle is specified, then public_branch is needed (and must be
 
4640
    up-to-date), so that the receiver can perform the merge using the
 
4641
    public_branch.  The public_branch is always included if known, so that
 
4642
    people can check it later.
 
4643
 
 
4644
    The submit branch defaults to the parent, but can be overridden.  Both
 
4645
    submit branch and public branch will be remembered if supplied.
 
4646
 
 
4647
    If a public_branch is known for the submit_branch, that public submit
 
4648
    branch is used in the merge instructions.  This means that a local mirror
 
4649
    can be used as your actual submit branch, once you have set public_branch
 
4650
    for that mirror.
5121
4651
 
5122
4652
    Mail is sent using your preferred mail program.  This should be transparent
5123
4653
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5124
4654
    If the preferred client can't be found (or used), your editor will be used.
5125
 
 
 
4655
    
5126
4656
    To use a specific mail program, set the mail_client configuration option.
5127
4657
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5128
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5129
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5130
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5131
 
    supported clients.
 
4658
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4659
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4660
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5132
4661
 
5133
4662
    If mail is being sent, a to address is required.  This can be supplied
5134
4663
    either on the commandline, by setting the submit_to configuration
5135
 
    option in the branch itself or the child_submit_to configuration option
 
4664
    option in the branch itself or the child_submit_to configuration option 
5136
4665
    in the submit branch.
5137
4666
 
5138
4667
    Two formats are currently supported: "4" uses revision bundle format 4 and
5140
4669
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5141
4670
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5142
4671
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
5143
 
 
5144
 
    The merge directives created by bzr send may be applied using bzr merge or
5145
 
    bzr pull by specifying a file containing a merge directive as the location.
5146
 
 
5147
 
    bzr send makes extensive use of public locations to map local locations into
5148
 
    URLs that can be used by other people.  See `bzr help configuration` to
5149
 
    set them, and use `bzr info` to display them.
 
4672
    
 
4673
    Merge directives are applied using the merge command or the pull command.
5150
4674
    """
5151
4675
 
5152
4676
    encoding_type = 'exact'
5168
4692
               short_name='f',
5169
4693
               type=unicode),
5170
4694
        Option('output', short_name='o',
5171
 
               help='Write merge directive to this file or directory; '
 
4695
               help='Write merge directive to this file; '
5172
4696
                    'use - for stdout.',
5173
4697
               type=unicode),
5174
 
        Option('strict',
5175
 
               help='Refuse to send if there are uncommitted changes in'
5176
 
               ' the working tree, --no-strict disables the check.'),
5177
4698
        Option('mail-to', help='Mail the request to this address.',
5178
4699
               type=unicode),
5179
4700
        'revision',
5180
4701
        'message',
5181
 
        Option('body', help='Body for the email.', type=unicode),
5182
 
        RegistryOption('format',
5183
 
                       help='Use the specified output format.',
5184
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4702
        RegistryOption.from_kwargs('format',
 
4703
        'Use the specified output format.',
 
4704
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4705
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5185
4706
        ]
5186
4707
 
5187
4708
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5188
4709
            no_patch=False, revision=None, remember=False, output=None,
5189
 
            format=None, mail_to=None, message=None, body=None,
5190
 
            strict=None, **kwargs):
5191
 
        from bzrlib.send import send
5192
 
        return send(submit_branch, revision, public_branch, remember,
5193
 
                    format, no_bundle, no_patch, output,
5194
 
                    kwargs.get('from', '.'), mail_to, message, body,
5195
 
                    self.outf,
5196
 
                    strict=strict)
 
4710
            format='4', mail_to=None, message=None, **kwargs):
 
4711
        return self._run(submit_branch, revision, public_branch, remember,
 
4712
                         format, no_bundle, no_patch, output,
 
4713
                         kwargs.get('from', '.'), mail_to, message)
 
4714
 
 
4715
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4716
             no_bundle, no_patch, output, from_, mail_to, message):
 
4717
        from bzrlib.revision import NULL_REVISION
 
4718
        branch = Branch.open_containing(from_)[0]
 
4719
        if output is None:
 
4720
            outfile = cStringIO.StringIO()
 
4721
        elif output == '-':
 
4722
            outfile = self.outf
 
4723
        else:
 
4724
            outfile = open(output, 'wb')
 
4725
        # we may need to write data into branch's repository to calculate
 
4726
        # the data to send.
 
4727
        branch.lock_write()
 
4728
        try:
 
4729
            if output is None:
 
4730
                config = branch.get_config()
 
4731
                if mail_to is None:
 
4732
                    mail_to = config.get_user_option('submit_to')
 
4733
                mail_client = config.get_mail_client()
 
4734
            if remember and submit_branch is None:
 
4735
                raise errors.BzrCommandError(
 
4736
                    '--remember requires a branch to be specified.')
 
4737
            stored_submit_branch = branch.get_submit_branch()
 
4738
            remembered_submit_branch = None
 
4739
            if submit_branch is None:
 
4740
                submit_branch = stored_submit_branch
 
4741
                remembered_submit_branch = "submit"
 
4742
            else:
 
4743
                if stored_submit_branch is None or remember:
 
4744
                    branch.set_submit_branch(submit_branch)
 
4745
            if submit_branch is None:
 
4746
                submit_branch = branch.get_parent()
 
4747
                remembered_submit_branch = "parent"
 
4748
            if submit_branch is None:
 
4749
                raise errors.BzrCommandError('No submit branch known or'
 
4750
                                             ' specified')
 
4751
            if remembered_submit_branch is not None:
 
4752
                note('Using saved %s location "%s" to determine what '
 
4753
                        'changes to submit.', remembered_submit_branch,
 
4754
                        submit_branch)
 
4755
 
 
4756
            if mail_to is None:
 
4757
                submit_config = Branch.open(submit_branch).get_config()
 
4758
                mail_to = submit_config.get_user_option("child_submit_to")
 
4759
 
 
4760
            stored_public_branch = branch.get_public_branch()
 
4761
            if public_branch is None:
 
4762
                public_branch = stored_public_branch
 
4763
            elif stored_public_branch is None or remember:
 
4764
                branch.set_public_branch(public_branch)
 
4765
            if no_bundle and public_branch is None:
 
4766
                raise errors.BzrCommandError('No public branch specified or'
 
4767
                                             ' known')
 
4768
            base_revision_id = None
 
4769
            revision_id = None
 
4770
            if revision is not None:
 
4771
                if len(revision) > 2:
 
4772
                    raise errors.BzrCommandError('bzr send takes '
 
4773
                        'at most two one revision identifiers')
 
4774
                revision_id = revision[-1].as_revision_id(branch)
 
4775
                if len(revision) == 2:
 
4776
                    base_revision_id = revision[0].as_revision_id(branch)
 
4777
            if revision_id is None:
 
4778
                revision_id = branch.last_revision()
 
4779
            if revision_id == NULL_REVISION:
 
4780
                raise errors.BzrCommandError('No revisions to submit.')
 
4781
            if format == '4':
 
4782
                directive = merge_directive.MergeDirective2.from_objects(
 
4783
                    branch.repository, revision_id, time.time(),
 
4784
                    osutils.local_time_offset(), submit_branch,
 
4785
                    public_branch=public_branch, include_patch=not no_patch,
 
4786
                    include_bundle=not no_bundle, message=message,
 
4787
                    base_revision_id=base_revision_id)
 
4788
            elif format == '0.9':
 
4789
                if not no_bundle:
 
4790
                    if not no_patch:
 
4791
                        patch_type = 'bundle'
 
4792
                    else:
 
4793
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4794
                            ' permit bundle with no patch')
 
4795
                else:
 
4796
                    if not no_patch:
 
4797
                        patch_type = 'diff'
 
4798
                    else:
 
4799
                        patch_type = None
 
4800
                directive = merge_directive.MergeDirective.from_objects(
 
4801
                    branch.repository, revision_id, time.time(),
 
4802
                    osutils.local_time_offset(), submit_branch,
 
4803
                    public_branch=public_branch, patch_type=patch_type,
 
4804
                    message=message)
 
4805
 
 
4806
            outfile.writelines(directive.to_lines())
 
4807
            if output is None:
 
4808
                subject = '[MERGE] '
 
4809
                if message is not None:
 
4810
                    subject += message
 
4811
                else:
 
4812
                    revision = branch.repository.get_revision(revision_id)
 
4813
                    subject += revision.get_summary()
 
4814
                basename = directive.get_disk_name(branch)
 
4815
                mail_client.compose_merge_request(mail_to, subject,
 
4816
                                                  outfile.getvalue(), basename)
 
4817
        finally:
 
4818
            if output != '-':
 
4819
                outfile.close()
 
4820
            branch.unlock()
5197
4821
 
5198
4822
 
5199
4823
class cmd_bundle_revisions(cmd_send):
5200
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4824
 
 
4825
    """Create a merge-directive for submitting changes.
5201
4826
 
5202
4827
    A merge directive provides many things needed for requesting merges:
5203
4828
 
5243
4868
               type=unicode),
5244
4869
        Option('output', short_name='o', help='Write directive to this file.',
5245
4870
               type=unicode),
5246
 
        Option('strict',
5247
 
               help='Refuse to bundle revisions if there are uncommitted'
5248
 
               ' changes in the working tree, --no-strict disables the check.'),
5249
4871
        'revision',
5250
 
        RegistryOption('format',
5251
 
                       help='Use the specified output format.',
5252
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4872
        RegistryOption.from_kwargs('format',
 
4873
        'Use the specified output format.',
 
4874
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4875
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5253
4876
        ]
5254
4877
    aliases = ['bundle']
5255
4878
 
5259
4882
 
5260
4883
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5261
4884
            no_patch=False, revision=None, remember=False, output=None,
5262
 
            format=None, strict=None, **kwargs):
 
4885
            format='4', **kwargs):
5263
4886
        if output is None:
5264
4887
            output = '-'
5265
 
        from bzrlib.send import send
5266
 
        return send(submit_branch, revision, public_branch, remember,
 
4888
        return self._run(submit_branch, revision, public_branch, remember,
5267
4889
                         format, no_bundle, no_patch, output,
5268
 
                         kwargs.get('from', '.'), None, None, None,
5269
 
                         self.outf, strict=strict)
 
4890
                         kwargs.get('from', '.'), None, None)
5270
4891
 
5271
4892
 
5272
4893
class cmd_tag(Command):
5273
 
    __doc__ = """Create, remove or modify a tag naming a revision.
5274
 
 
 
4894
    """Create, remove or modify a tag naming a revision.
 
4895
    
5275
4896
    Tags give human-meaningful names to revisions.  Commands that take a -r
5276
4897
    (--revision) option can be given -rtag:X, where X is any previously
5277
4898
    created tag.
5279
4900
    Tags are stored in the branch.  Tags are copied from one branch to another
5280
4901
    along when you branch, push, pull or merge.
5281
4902
 
5282
 
    It is an error to give a tag name that already exists unless you pass
 
4903
    It is an error to give a tag name that already exists unless you pass 
5283
4904
    --force, in which case the tag is moved to point to the new revision.
5284
4905
 
5285
4906
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5286
4907
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5287
 
 
5288
 
    If no tag name is specified it will be determined through the 
5289
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5290
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5291
 
    details.
5292
4908
    """
5293
4909
 
5294
4910
    _see_also = ['commit', 'tags']
5295
 
    takes_args = ['tag_name?']
 
4911
    takes_args = ['tag_name']
5296
4912
    takes_options = [
5297
4913
        Option('delete',
5298
4914
            help='Delete this tag rather than placing it.',
5308
4924
        'revision',
5309
4925
        ]
5310
4926
 
5311
 
    def run(self, tag_name=None,
 
4927
    def run(self, tag_name,
5312
4928
            delete=None,
5313
4929
            directory='.',
5314
4930
            force=None,
5315
4931
            revision=None,
5316
4932
            ):
5317
4933
        branch, relpath = Branch.open_containing(directory)
5318
 
        self.add_cleanup(branch.lock_write().unlock)
5319
 
        if delete:
5320
 
            if tag_name is None:
5321
 
                raise errors.BzrCommandError("No tag specified to delete.")
5322
 
            branch.tags.delete_tag(tag_name)
5323
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5324
 
        else:
5325
 
            if revision:
5326
 
                if len(revision) != 1:
5327
 
                    raise errors.BzrCommandError(
5328
 
                        "Tags can only be placed on a single revision, "
5329
 
                        "not on a range")
5330
 
                revision_id = revision[0].as_revision_id(branch)
 
4934
        branch.lock_write()
 
4935
        try:
 
4936
            if delete:
 
4937
                branch.tags.delete_tag(tag_name)
 
4938
                self.outf.write('Deleted tag %s.\n' % tag_name)
5331
4939
            else:
5332
 
                revision_id = branch.last_revision()
5333
 
            if tag_name is None:
5334
 
                tag_name = branch.automatic_tag_name(revision_id)
5335
 
                if tag_name is None:
5336
 
                    raise errors.BzrCommandError(
5337
 
                        "Please specify a tag name.")
5338
 
            if (not force) and branch.tags.has_tag(tag_name):
5339
 
                raise errors.TagAlreadyExists(tag_name)
5340
 
            branch.tags.set_tag(tag_name, revision_id)
5341
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
4940
                if revision:
 
4941
                    if len(revision) != 1:
 
4942
                        raise errors.BzrCommandError(
 
4943
                            "Tags can only be placed on a single revision, "
 
4944
                            "not on a range")
 
4945
                    revision_id = revision[0].as_revision_id(branch)
 
4946
                else:
 
4947
                    revision_id = branch.last_revision()
 
4948
                if (not force) and branch.tags.has_tag(tag_name):
 
4949
                    raise errors.TagAlreadyExists(tag_name)
 
4950
                branch.tags.set_tag(tag_name, revision_id)
 
4951
                self.outf.write('Created tag %s.\n' % tag_name)
 
4952
        finally:
 
4953
            branch.unlock()
5342
4954
 
5343
4955
 
5344
4956
class cmd_tags(Command):
5345
 
    __doc__ = """List tags.
 
4957
    """List tags.
5346
4958
 
5347
4959
    This command shows a table of tag names and the revisions they reference.
5348
4960
    """
5376
4988
        if not tags:
5377
4989
            return
5378
4990
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
4991
        if revision:
5381
 
            graph = branch.repository.get_graph()
5382
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
 
            # only show revisions between revid1 and revid2 (inclusive)
5385
 
            tags = [(tag, revid) for tag, revid in tags if
5386
 
                graph.is_between(revid, revid1, revid2)]
 
4992
            branch.lock_read()
 
4993
            try:
 
4994
                graph = branch.repository.get_graph()
 
4995
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
4996
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
4997
                # only show revisions between revid1 and revid2 (inclusive)
 
4998
                tags = [(tag, revid) for tag, revid in tags if
 
4999
                    graph.is_between(revid, revid1, revid2)]
 
5000
            finally:
 
5001
                branch.unlock()
5387
5002
        if sort == 'alpha':
5388
5003
            tags.sort()
5389
5004
        elif sort == 'time':
5399
5014
            tags.sort(key=lambda x: timestamps[x[1]])
5400
5015
        if not show_ids:
5401
5016
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5402
 
            for index, (tag, revid) in enumerate(tags):
5403
 
                try:
5404
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5405
 
                    if isinstance(revno, tuple):
5406
 
                        revno = '.'.join(map(str, revno))
5407
 
                except errors.NoSuchRevision:
5408
 
                    # Bad tag data/merges can lead to tagged revisions
5409
 
                    # which are not in this branch. Fail gracefully ...
5410
 
                    revno = '?'
5411
 
                tags[index] = (tag, revno)
5412
 
        self.cleanup_now()
 
5017
            revno_map = branch.get_revision_id_to_revno_map()
 
5018
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5019
                        for tag, revid in tags ]
5413
5020
        for tag, revspec in tags:
5414
5021
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
5022
 
5416
5023
 
5417
5024
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5025
    """Reconfigure the type of a bzr directory.
5419
5026
 
5420
5027
    A target configuration must be specified.
5421
5028
 
5451
5058
            ),
5452
5059
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5453
5060
        Option('force',
5454
 
            help='Perform reconfiguration even if local changes'
5455
 
            ' will be lost.'),
5456
 
        Option('stacked-on',
5457
 
            help='Reconfigure a branch to be stacked on another branch.',
5458
 
            type=unicode,
5459
 
            ),
5460
 
        Option('unstacked',
5461
 
            help='Reconfigure a branch to be unstacked.  This '
5462
 
                'may require copying substantial data into it.',
5463
 
            ),
 
5061
               help='Perform reconfiguration even if local changes'
 
5062
               ' will be lost.')
5464
5063
        ]
5465
5064
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
5065
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
5066
        directory = bzrdir.BzrDir.open(location)
5470
 
        if stacked_on and unstacked:
5471
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5472
 
        elif stacked_on is not None:
5473
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5474
 
        elif unstacked:
5475
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5476
 
        # At the moment you can use --stacked-on and a different
5477
 
        # reconfiguration shape at the same time; there seems no good reason
5478
 
        # to ban it.
5479
5067
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
5068
            raise errors.BzrCommandError('No target configuration specified')
5485
5069
        elif target_type == 'branch':
5486
5070
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
5071
        elif target_type == 'tree':
5506
5090
 
5507
5091
 
5508
5092
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
5510
 
 
 
5093
    """Set the branch of a checkout and update.
 
5094
    
5511
5095
    For lightweight checkouts, this changes the branch being referenced.
5512
5096
    For heavyweight checkouts, this checks that there are no local commits
5513
5097
    versus the current bound branch, then it makes the local branch a mirror
5524
5108
    /path/to/newbranch.
5525
5109
 
5526
5110
    Bound branches use the nickname of its master branch unless it is set
5527
 
    locally, in which case switching will update the local nickname to be
 
5111
    locally, in which case switching will update the the local nickname to be
5528
5112
    that of the master.
5529
5113
    """
5530
5114
 
5531
 
    takes_args = ['to_location?']
 
5115
    takes_args = ['to_location']
5532
5116
    takes_options = [Option('force',
5533
 
                        help='Switch even if local commits will be lost.'),
5534
 
                     'revision',
5535
 
                     Option('create-branch', short_name='b',
5536
 
                        help='Create the target branch from this one before'
5537
 
                             ' switching to it.'),
5538
 
                    ]
 
5117
                        help='Switch even if local commits will be lost.')
 
5118
                     ]
5539
5119
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
5120
    def run(self, to_location, force=False):
5542
5121
        from bzrlib import switch
5543
5122
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
5123
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5546
 
        if to_location is None:
5547
 
            if revision is None:
5548
 
                raise errors.BzrCommandError('You must supply either a'
5549
 
                                             ' revision or a location')
5550
 
            to_location = '.'
 
5124
        branch = control_dir.open_branch()
5551
5125
        try:
5552
 
            branch = control_dir.open_branch()
5553
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5126
            to_branch = Branch.open(to_location)
5554
5127
        except errors.NotBranchError:
5555
 
            branch = None
5556
 
            had_explicit_nick = False
5557
 
        if create_branch:
5558
 
            if branch is None:
5559
 
                raise errors.BzrCommandError('cannot create branch without'
5560
 
                                             ' source branch')
5561
 
            to_location = directory_service.directories.dereference(
5562
 
                              to_location)
5563
 
            if '/' not in to_location and '\\' not in to_location:
5564
 
                # This path is meant to be relative to the existing branch
5565
 
                this_url = self._get_branch_location(control_dir)
5566
 
                to_location = urlutils.join(this_url, '..', to_location)
5567
 
            to_branch = branch.bzrdir.sprout(to_location,
5568
 
                                 possible_transports=[branch.bzrdir.root_transport],
5569
 
                                 source_branch=branch).open_branch()
5570
 
        else:
5571
 
            try:
5572
 
                to_branch = Branch.open(to_location)
5573
 
            except errors.NotBranchError:
5574
 
                this_url = self._get_branch_location(control_dir)
5575
 
                to_branch = Branch.open(
5576
 
                    urlutils.join(this_url, '..', to_location))
5577
 
        if revision is not None:
5578
 
            revision = revision.as_revision_id(to_branch)
5579
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5580
 
        if had_explicit_nick:
 
5128
            this_branch = control_dir.open_branch()
 
5129
            # This may be a heavy checkout, where we want the master branch
 
5130
            this_url = this_branch.get_bound_location()
 
5131
            # If not, use a local sibling
 
5132
            if this_url is None:
 
5133
                this_url = this_branch.base
 
5134
            to_branch = Branch.open(
 
5135
                urlutils.join(this_url, '..', to_location))
 
5136
        switch.switch(control_dir, to_branch, force)
 
5137
        if branch.get_config().has_explicit_nickname():
5581
5138
            branch = control_dir.open_branch() #get the new branch!
5582
5139
            branch.nick = to_branch.nick
5583
5140
        note('Switched to branch: %s',
5584
5141
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5585
5142
 
5586
 
    def _get_branch_location(self, control_dir):
5587
 
        """Return location of branch for this control dir."""
5588
 
        try:
5589
 
            this_branch = control_dir.open_branch()
5590
 
            # This may be a heavy checkout, where we want the master branch
5591
 
            master_location = this_branch.get_bound_location()
5592
 
            if master_location is not None:
5593
 
                return master_location
5594
 
            # If not, use a local sibling
5595
 
            return this_branch.base
5596
 
        except errors.NotBranchError:
5597
 
            format = control_dir.find_branch_format()
5598
 
            if getattr(format, 'get_reference', None) is not None:
5599
 
                return format.get_reference(control_dir)
5600
 
            else:
5601
 
                return control_dir.root_transport.base
5602
 
 
5603
5143
 
5604
5144
class cmd_view(Command):
5605
 
    __doc__ = """Manage filtered views.
 
5145
    """Manage filtered views.
5606
5146
 
5607
5147
    Views provide a mask over the tree so that users can focus on
5608
5148
    a subset of a tree when doing their work. After creating a view,
5756
5296
 
5757
5297
 
5758
5298
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5299
    """Show a branch's currently registered hooks.
 
5300
    """
5760
5301
 
5761
5302
    hidden = True
5762
 
 
5763
 
    def run(self):
5764
 
        for hook_key in sorted(hooks.known_hooks.keys()):
5765
 
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
5766
 
            self.outf.write("%s:\n" % type(some_hooks).__name__)
5767
 
            for hook_name, hook_point in sorted(some_hooks.items()):
5768
 
                self.outf.write("  %s:\n" % (hook_name,))
5769
 
                found_hooks = list(hook_point)
5770
 
                if found_hooks:
5771
 
                    for hook in found_hooks:
5772
 
                        self.outf.write("    %s\n" %
5773
 
                                        (some_hooks.get_hook_name(hook),))
5774
 
                else:
5775
 
                    self.outf.write("    <no hooks installed>\n")
5776
 
 
5777
 
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
 
5303
    takes_args = ['path?']
 
5304
 
 
5305
    def run(self, path=None):
 
5306
        if path is None:
 
5307
            path = '.'
 
5308
        branch_hooks = Branch.open(path).hooks
 
5309
        for hook_type in branch_hooks:
 
5310
            hooks = branch_hooks[hook_type]
 
5311
            self.outf.write("%s:\n" % (hook_type,))
 
5312
            if hooks:
 
5313
                for hook in hooks:
 
5314
                    self.outf.write("  %s\n" %
 
5315
                                    (branch_hooks.get_hook_name(hook),))
 
5316
            else:
 
5317
                self.outf.write("  <no hooks installed>\n")
 
5318
 
5802
5319
 
5803
5320
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5321
    """Temporarily set aside some changes from the current tree.
5805
5322
 
5806
5323
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5324
    ie. out of the way, until a later time when you can bring them back from
5836
5353
                       value_switches=True, enum_switch=False),
5837
5354
 
5838
5355
        Option('list', help='List shelved changes.'),
5839
 
        Option('destroy',
5840
 
               help='Destroy removed changes instead of shelving them.'),
5841
5356
    ]
5842
5357
    _see_also = ['unshelve']
5843
5358
 
5844
5359
    def run(self, revision=None, all=False, file_list=None, message=None,
5845
 
            writer=None, list=False, destroy=False):
 
5360
            writer=None, list=False):
5846
5361
        if list:
5847
5362
            return self.run_for_list()
5848
5363
        from bzrlib.shelf_ui import Shelver
5849
5364
        if writer is None:
5850
5365
            writer = bzrlib.option.diff_writer_registry.get()
5851
5366
        try:
5852
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5853
 
                file_list, message, destroy=destroy)
5854
 
            try:
5855
 
                shelver.run()
5856
 
            finally:
5857
 
                shelver.finalize()
 
5367
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5368
                              message).run()
5858
5369
        except errors.UserAbort:
5859
5370
            return 0
5860
5371
 
5861
5372
    def run_for_list(self):
5862
5373
        tree = WorkingTree.open_containing('.')[0]
5863
 
        self.add_cleanup(tree.lock_read().unlock)
5864
 
        manager = tree.get_shelf_manager()
5865
 
        shelves = manager.active_shelves()
5866
 
        if len(shelves) == 0:
5867
 
            note('No shelved changes.')
5868
 
            return 0
5869
 
        for shelf_id in reversed(shelves):
5870
 
            message = manager.get_metadata(shelf_id).get('message')
5871
 
            if message is None:
5872
 
                message = '<no message>'
5873
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5874
 
        return 1
 
5374
        tree.lock_read()
 
5375
        try:
 
5376
            manager = tree.get_shelf_manager()
 
5377
            shelves = manager.active_shelves()
 
5378
            if len(shelves) == 0:
 
5379
                note('No shelved changes.')
 
5380
                return 0
 
5381
            for shelf_id in reversed(shelves):
 
5382
                message = manager.get_metadata(shelf_id).get('message')
 
5383
                if message is None:
 
5384
                    message = '<no message>'
 
5385
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5386
            return 1
 
5387
        finally:
 
5388
            tree.unlock()
5875
5389
 
5876
5390
 
5877
5391
class cmd_unshelve(Command):
5878
 
    __doc__ = """Restore shelved changes.
 
5392
    """Restore shelved changes.
5879
5393
 
5880
5394
    By default, the most recently shelved changes are restored. However if you
5881
5395
    specify a shelf by id those changes will be restored instead.  This works
5889
5403
            enum_switch=False, value_switches=True,
5890
5404
            apply="Apply changes and remove from the shelf.",
5891
5405
            dry_run="Show changes, but do not apply or remove them.",
5892
 
            preview="Instead of unshelving the changes, show the diff that "
5893
 
                    "would result from unshelving.",
5894
 
            delete_only="Delete changes without applying them.",
5895
 
            keep="Apply changes but don't delete them.",
 
5406
            delete_only="Delete changes without applying them."
5896
5407
        )
5897
5408
    ]
5898
5409
    _see_also = ['shelve']
5899
5410
 
5900
5411
    def run(self, shelf_id=None, action='apply'):
5901
5412
        from bzrlib.shelf_ui import Unshelver
5902
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
5413
        Unshelver.from_args(shelf_id, action).run()
 
5414
 
 
5415
 
 
5416
def _create_prefix(cur_transport):
 
5417
    needed = [cur_transport]
 
5418
    # Recurse upwards until we can create a directory successfully
 
5419
    while True:
 
5420
        new_transport = cur_transport.clone('..')
 
5421
        if new_transport.base == cur_transport.base:
 
5422
            raise errors.BzrCommandError(
 
5423
                "Failed to create path prefix for %s."
 
5424
                % cur_transport.base)
5903
5425
        try:
5904
 
            unshelver.run()
5905
 
        finally:
5906
 
            unshelver.tree.unlock()
5907
 
 
5908
 
 
5909
 
class cmd_clean_tree(Command):
5910
 
    __doc__ = """Remove unwanted files from working tree.
5911
 
 
5912
 
    By default, only unknown files, not ignored files, are deleted.  Versioned
5913
 
    files are never deleted.
5914
 
 
5915
 
    Another class is 'detritus', which includes files emitted by bzr during
5916
 
    normal operations and selftests.  (The value of these files decreases with
5917
 
    time.)
5918
 
 
5919
 
    If no options are specified, unknown files are deleted.  Otherwise, option
5920
 
    flags are respected, and may be combined.
5921
 
 
5922
 
    To check what clean-tree will do, use --dry-run.
5923
 
    """
5924
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5925
 
                     Option('detritus', help='Delete conflict files, merge'
5926
 
                            ' backups, and failed selftest dirs.'),
5927
 
                     Option('unknown',
5928
 
                            help='Delete files unknown to bzr (default).'),
5929
 
                     Option('dry-run', help='Show files to delete instead of'
5930
 
                            ' deleting them.'),
5931
 
                     Option('force', help='Do not prompt before deleting.')]
5932
 
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5933
 
            force=False):
5934
 
        from bzrlib.clean_tree import clean_tree
5935
 
        if not (unknown or ignored or detritus):
5936
 
            unknown = True
5937
 
        if dry_run:
5938
 
            force = True
5939
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5940
 
                   dry_run=dry_run, no_prompt=force)
5941
 
 
5942
 
 
5943
 
class cmd_reference(Command):
5944
 
    __doc__ = """list, view and set branch locations for nested trees.
5945
 
 
5946
 
    If no arguments are provided, lists the branch locations for nested trees.
5947
 
    If one argument is provided, display the branch location for that tree.
5948
 
    If two arguments are provided, set the branch location for that tree.
5949
 
    """
5950
 
 
5951
 
    hidden = True
5952
 
 
5953
 
    takes_args = ['path?', 'location?']
5954
 
 
5955
 
    def run(self, path=None, location=None):
5956
 
        branchdir = '.'
5957
 
        if path is not None:
5958
 
            branchdir = path
5959
 
        tree, branch, relpath =(
5960
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
5961
 
        if path is not None:
5962
 
            path = relpath
5963
 
        if tree is None:
5964
 
            tree = branch.basis_tree()
5965
 
        if path is None:
5966
 
            info = branch._get_all_reference_info().iteritems()
5967
 
            self._display_reference_info(tree, branch, info)
 
5426
            new_transport.mkdir('.')
 
5427
        except errors.NoSuchFile:
 
5428
            needed.append(new_transport)
 
5429
            cur_transport = new_transport
5968
5430
        else:
5969
 
            file_id = tree.path2id(path)
5970
 
            if file_id is None:
5971
 
                raise errors.NotVersionedError(path)
5972
 
            if location is None:
5973
 
                info = [(file_id, branch.get_reference_info(file_id))]
5974
 
                self._display_reference_info(tree, branch, info)
5975
 
            else:
5976
 
                branch.set_reference_info(file_id, path, location)
5977
 
 
5978
 
    def _display_reference_info(self, tree, branch, info):
5979
 
        ref_list = []
5980
 
        for file_id, (path, location) in info:
5981
 
            try:
5982
 
                path = tree.id2path(file_id)
5983
 
            except errors.NoSuchId:
5984
 
                pass
5985
 
            ref_list.append((path, location))
5986
 
        for path, location in sorted(ref_list):
5987
 
            self.outf.write('%s %s\n' % (path, location))
5988
 
 
5989
 
 
5990
 
def _register_lazy_builtins():
5991
 
    # register lazy builtins from other modules; called at startup and should
5992
 
    # be only called once.
5993
 
    for (name, aliases, module_name) in [
5994
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5995
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5996
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
5997
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
5998
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
5999
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6000
 
        ]:
6001
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5431
            break
 
5432
    # Now we only need to create child directories
 
5433
    while needed:
 
5434
        cur_transport = needed.pop()
 
5435
        cur_transport.ensure_base()
 
5436
 
 
5437
 
 
5438
# these get imported and then picked up by the scan for cmd_*
 
5439
# TODO: Some more consistent way to split command definitions across files;
 
5440
# we do need to load at least some information about them to know of 
 
5441
# aliases.  ideally we would avoid loading the implementation until the
 
5442
# details were needed.
 
5443
from bzrlib.cmd_version_info import cmd_version_info
 
5444
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5445
from bzrlib.bundle.commands import (
 
5446
    cmd_bundle_info,
 
5447
    )
 
5448
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5449
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5450
        cmd_weave_plan_merge, cmd_weave_merge_text