/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: Eduardo Padoan
  • Date: 2009-02-24 22:56:13 UTC
  • mto: (4048.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 4052.
  • Revision ID: eduardo.padoan@gmail.com-20090224225613-4acsk5hc9xxkj5im
Fixed the 'ignoring ...' message for ls.

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
 
                wt.lock_read()
532
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
533
 
                raise errors.NoWorkingTree(location)
534
 
            self.add_cleanup(wt.unlock)
535
 
            revid = wt.last_revision()
536
 
            try:
537
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
538
 
            except errors.NoSuchRevision:
539
 
                revno_t = ('???',)
540
 
            revno = ".".join(str(n) for n in revno_t)
541
 
        else:
542
 
            b = Branch.open_containing(location)[0]
543
 
            b.lock_read()
544
 
            self.add_cleanup(b.unlock)
545
 
            revno = b.revno()
546
 
        self.cleanup_now()
547
 
        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')
548
468
 
549
469
 
550
470
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
471
    """Show revision number and revision id for a given revision identifier.
552
472
    """
553
473
    hidden = True
554
474
    takes_args = ['revision_info*']
560
480
            short_name='d',
561
481
            type=unicode,
562
482
            ),
563
 
        Option('tree', help='Show revno of working tree'),
564
483
        ]
565
484
 
566
485
    @display_command
567
 
    def run(self, revision=None, directory=u'.', tree=False,
568
 
            revision_info_list=[]):
 
486
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
569
487
 
570
 
        try:
571
 
            wt = WorkingTree.open_containing(directory)[0]
572
 
            b = wt.branch
573
 
            wt.lock_read()
574
 
            self.add_cleanup(wt.unlock)
575
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
576
 
            wt = None
577
 
            b = Branch.open_containing(directory)[0]
578
 
            b.lock_read()
579
 
            self.add_cleanup(b.unlock)
580
 
        revision_ids = []
 
488
        revs = []
581
489
        if revision is not None:
582
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
490
            revs.extend(revision)
583
491
        if revision_info_list is not None:
584
 
            for rev_str in revision_info_list:
585
 
                rev_spec = RevisionSpec.from_string(rev_str)
586
 
                revision_ids.append(rev_spec.as_revision_id(b))
587
 
        # No arguments supplied, default to the last revision
588
 
        if len(revision_ids) == 0:
589
 
            if tree:
590
 
                if wt is None:
591
 
                    raise errors.NoWorkingTree(directory)
592
 
                revision_ids.append(wt.last_revision())
593
 
            else:
594
 
                revision_ids.append(b.last_revision())
595
 
 
596
 
        revinfos = []
597
 
        maxlen = 0
598
 
        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)
599
502
            try:
600
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
601
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
503
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
602
504
            except errors.NoSuchRevision:
603
 
                revno = '???'
604
 
            maxlen = max(maxlen, len(revno))
605
 
            revinfos.append([revno, revision_id])
606
 
 
607
 
        self.cleanup_now()
608
 
        for ri in revinfos:
609
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
610
 
 
611
 
 
 
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
    
612
510
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
511
    """Add specified files or directories.
614
512
 
615
513
    In non-recursive mode, all the named items are added, regardless
616
514
    of whether they were previously ignored.  A warning is given if
632
530
    you should never need to explicitly add a directory, they'll just
633
531
    get added when you add a file in the directory.
634
532
 
635
 
    --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 
636
534
    add them.
637
535
 
638
536
    --file-ids-from will try to use the file ids from the supplied path.
642
540
    branches that will be merged later (without showing the two different
643
541
    adds as a conflict). It is also useful when merging another project
644
542
    into a subdirectory of this one.
645
 
    
646
 
    Any files matching patterns in the ignore list will not be added
647
 
    unless they are explicitly mentioned.
648
543
    """
649
544
    takes_args = ['file*']
650
545
    takes_options = [
658
553
               help='Lookup file ids from this tree.'),
659
554
        ]
660
555
    encoding_type = 'replace'
661
 
    _see_also = ['remove', 'ignore']
 
556
    _see_also = ['remove']
662
557
 
663
558
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
664
559
            file_ids_from=None):
682
577
 
683
578
        if base_tree:
684
579
            base_tree.lock_read()
685
 
            self.add_cleanup(base_tree.unlock)
686
 
        tree, file_list = tree_files_for_add(file_list)
687
 
        added, ignored = tree.smart_add(file_list, not
688
 
            no_recurse, action=action, save=not dry_run)
689
 
        self.cleanup_now()
 
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')
690
590
        if len(ignored) > 0:
691
591
            if verbose:
692
592
                for glob in sorted(ignored.keys()):
693
593
                    for path in ignored[glob]:
694
 
                        self.outf.write("ignored %s matching \"%s\"\n"
 
594
                        self.outf.write("ignored %s matching \"%s\"\n" 
695
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")
696
603
 
697
604
 
698
605
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
606
    """Create a new versioned directory.
700
607
 
701
608
    This is equivalent to creating the directory and then adding it.
702
609
    """
706
613
 
707
614
    def run(self, dir_list):
708
615
        for d in dir_list:
 
616
            os.mkdir(d)
709
617
            wt, dd = WorkingTree.open_containing(d)
710
 
            base = os.path.dirname(dd)
711
 
            id = wt.path2id(base)
712
 
            if id != None:
713
 
                os.mkdir(d)
714
 
                wt.add([dd])
715
 
                self.outf.write('added %s\n' % d)
716
 
            else:
717
 
                raise errors.NotVersionedError(path=base)
 
618
            wt.add([dd])
 
619
            self.outf.write('added %s\n' % d)
718
620
 
719
621
 
720
622
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
623
    """Show path of a file relative to root"""
722
624
 
723
625
    takes_args = ['filename']
724
626
    hidden = True
725
 
 
 
627
    
726
628
    @display_command
727
629
    def run(self, filename):
728
630
        # TODO: jam 20050106 Can relpath return a munged path if
733
635
 
734
636
 
735
637
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
638
    """Show inventory of the current working copy or a revision.
737
639
 
738
640
    It is possible to limit the output to a particular entry
739
641
    type using the --kind option.  For example: --kind file.
761
663
        revision = _get_one_revision('inventory', revision)
762
664
        work_tree, file_list = tree_files(file_list)
763
665
        work_tree.lock_read()
764
 
        self.add_cleanup(work_tree.unlock)
765
 
        if revision is not None:
766
 
            tree = revision.as_tree(work_tree.branch)
767
 
 
768
 
            extra_trees = [work_tree]
769
 
            tree.lock_read()
770
 
            self.add_cleanup(tree.unlock)
771
 
        else:
772
 
            tree = work_tree
773
 
            extra_trees = []
774
 
 
775
 
        if file_list is not None:
776
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
777
 
                                      require_versioned=True)
778
 
            # find_ids_across_trees may include some paths that don't
779
 
            # exist in 'tree'.
780
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
781
 
                             for file_id in file_ids if file_id in tree)
782
 
        else:
783
 
            entries = tree.inventory.entries()
784
 
 
785
 
        self.cleanup_now()
 
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
 
786
690
        for path, entry in entries:
787
691
            if kind and kind != entry.kind:
788
692
                continue
794
698
 
795
699
 
796
700
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
701
    """Move or rename a file.
798
702
 
799
703
    :Usage:
800
704
        bzr mv OLDNAME NEWNAME
817
721
    takes_args = ['names*']
818
722
    takes_options = [Option("after", help="Move only the bzr identifier"
819
723
        " of the file, because the file has already been moved."),
820
 
        Option('auto', help='Automatically guess renames.'),
821
 
        Option('dry-run', help='Avoid making changes when guessing renames.'),
822
724
        ]
823
725
    aliases = ['move', 'rename']
824
726
    encoding_type = 'replace'
825
727
 
826
 
    def run(self, names_list, after=False, auto=False, dry_run=False):
827
 
        if auto:
828
 
            return self.run_auto(names_list, after, dry_run)
829
 
        elif dry_run:
830
 
            raise errors.BzrCommandError('--dry-run requires --auto.')
 
728
    def run(self, names_list, after=False):
831
729
        if names_list is None:
832
730
            names_list = []
 
731
 
833
732
        if len(names_list) < 2:
834
733
            raise errors.BzrCommandError("missing file argument")
835
734
        tree, rel_names = tree_files(names_list, canonicalize=False)
836
 
        tree.lock_tree_write()
837
 
        self.add_cleanup(tree.unlock)
838
 
        self._run(tree, names_list, rel_names, after)
839
 
 
840
 
    def run_auto(self, names_list, after, dry_run):
841
 
        if names_list is not None and len(names_list) > 1:
842
 
            raise errors.BzrCommandError('Only one path may be specified to'
843
 
                                         ' --auto.')
844
 
        if after:
845
 
            raise errors.BzrCommandError('--after cannot be specified with'
846
 
                                         ' --auto.')
847
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
848
 
        work_tree.lock_tree_write()
849
 
        self.add_cleanup(work_tree.unlock)
850
 
        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()
851
740
 
852
741
    def _run(self, tree, names_list, rel_names, after):
853
742
        into_existing = osutils.isdir(names_list[-1])
874
763
            # All entries reference existing inventory items, so fix them up
875
764
            # for cicp file-systems.
876
765
            rel_names = tree.get_canonical_inventory_paths(rel_names)
877
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
878
 
                if not is_quiet():
879
 
                    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)
880
768
        else:
881
769
            if len(names_list) != 2:
882
770
                raise errors.BzrCommandError('to mv multiple files the'
913
801
                        # pathjoin with an empty tail adds a slash, which breaks
914
802
                        # relpath :(
915
803
                        dest_parent_fq = tree.basedir
916
 
 
 
804
    
917
805
                    dest_tail = osutils.canonical_relpath(
918
806
                                    dest_parent_fq,
919
807
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
926
814
            dest = osutils.pathjoin(dest_parent, dest_tail)
927
815
            mutter("attempting to move %s => %s", src, dest)
928
816
            tree.rename_one(src, dest, after=after)
929
 
            if not is_quiet():
930
 
                self.outf.write("%s => %s\n" % (src, dest))
 
817
            self.outf.write("%s => %s\n" % (src, dest))
931
818
 
932
819
 
933
820
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
821
    """Turn this branch into a mirror of another branch.
935
822
 
936
 
    By default, this command only works on branches that have not diverged.
937
 
    Branches are considered diverged if the destination branch's most recent 
938
 
    commit is one that has not been merged (directly or indirectly) into the 
939
 
    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.
940
826
 
941
827
    If branches have diverged, you can use 'bzr merge' to integrate the changes
942
828
    from one into the other.  Once one branch has merged, the other should
943
829
    be able to pull it again.
944
830
 
945
 
    If you want to replace your local changes and just want your branch to
946
 
    match the remote one, use pull --overwrite. This will work even if the two
947
 
    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.
948
833
 
949
834
    If there is no default location set, the first pull will set it.  After
950
835
    that, you can omit the location to use the default.  To change the
956
841
    with bzr send.
957
842
    """
958
843
 
959
 
    _see_also = ['push', 'update', 'status-flags', 'send']
 
844
    _see_also = ['push', 'update', 'status-flags']
960
845
    takes_options = ['remember', 'overwrite', 'revision',
961
846
        custom_help('verbose',
962
847
            help='Show logs of pulled revisions.'),
966
851
            short_name='d',
967
852
            type=unicode,
968
853
            ),
969
 
        Option('local',
970
 
            help="Perform a local pull in a bound "
971
 
                 "branch.  Local pulls are not applied to "
972
 
                 "the master branch."
973
 
            ),
974
854
        ]
975
855
    takes_args = ['location?']
976
856
    encoding_type = 'replace'
977
857
 
978
858
    def run(self, location=None, remember=False, overwrite=False,
979
859
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
860
            directory=None):
981
861
        # FIXME: too much stuff is in the command class
982
862
        revision_id = None
983
863
        mergeable = None
986
866
        try:
987
867
            tree_to = WorkingTree.open_containing(directory)[0]
988
868
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
869
        except errors.NoWorkingTree:
992
870
            tree_to = None
993
871
            branch_to = Branch.open_containing(directory)[0]
994
 
            branch_to.lock_write()
995
 
            self.add_cleanup(branch_to.unlock)
996
 
 
997
 
        if local and not branch_to.get_bound_location():
998
 
            raise errors.LocalRequiresBoundBranch()
999
872
 
1000
873
        possible_transports = []
1001
874
        if location is not None:
1029
902
        else:
1030
903
            branch_from = Branch.open(location,
1031
904
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
905
 
1035
906
            if branch_to.get_parent() is None or remember:
1036
907
                branch_to.set_parent(branch_from.base)
1038
909
        if revision is not None:
1039
910
            revision_id = revision.as_revision_id(branch_from)
1040
911
 
1041
 
        if tree_to is not None:
1042
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1043
 
            change_reporter = delta._ChangeReporter(
1044
 
                unversioned_filter=tree_to.is_ignored,
1045
 
                view_info=view_info)
1046
 
            result = tree_to.pull(
1047
 
                branch_from, overwrite, revision_id, change_reporter,
1048
 
                possible_transports=possible_transports, local=local)
1049
 
        else:
1050
 
            result = branch_to.pull(
1051
 
                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)
1052
923
 
1053
 
        result.report(self.outf)
1054
 
        if verbose and result.old_revid != result.new_revid:
1055
 
            log.show_branch_change(
1056
 
                branch_to, self.outf, result.old_revno,
1057
 
                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()
1058
930
 
1059
931
 
1060
932
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
1062
 
 
 
933
    """Update a mirror of this branch.
 
934
    
1063
935
    The target branch will not have its working tree populated because this
1064
936
    is both expensive, and is not supported on remote file systems.
1065
 
 
 
937
    
1066
938
    Some smart servers or protocols *may* put the working tree in place in
1067
939
    the future.
1068
940
 
1072
944
 
1073
945
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1074
946
    the other branch completely, discarding its unmerged changes.
1075
 
 
 
947
    
1076
948
    If you want to ensure you have the different changes in the other branch,
1077
949
    do a merge (see bzr help merge) from the other branch, and commit that.
1078
950
    After that you will be able to do a push without '--overwrite'.
1107
979
                'for the commit history. Only the work not present in the '
1108
980
                'referenced branch is included in the branch created.',
1109
981
            type=unicode),
1110
 
        Option('strict',
1111
 
               help='Refuse to push if there are uncommitted changes in'
1112
 
               ' the working tree, --no-strict disables the check.'),
1113
982
        ]
1114
983
    takes_args = ['location?']
1115
984
    encoding_type = 'replace'
1117
986
    def run(self, location=None, remember=False, overwrite=False,
1118
987
        create_prefix=False, verbose=False, revision=None,
1119
988
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
989
        stacked=False):
1121
990
        from bzrlib.push import _show_push_branch
1122
991
 
 
992
        # Get the source branch and revision_id
1123
993
        if directory is None:
1124
994
            directory = '.'
1125
 
        # Get the source branch
1126
 
        (tree, br_from,
1127
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1128
 
        # Get the tip's revision_id
 
995
        br_from = Branch.open_containing(directory)[0]
1129
996
        revision = _get_one_revision('push', revision)
1130
997
        if revision is not None:
1131
998
            revision_id = revision.in_history(br_from).rev_id
1132
999
        else:
1133
 
            revision_id = None
1134
 
        if tree is not None and revision_id is None:
1135
 
            tree.check_changed_or_out_of_date(
1136
 
                strict, 'push_strict',
1137
 
                more_error='Use --no-strict to force the push.',
1138
 
                more_warning='Uncommitted changes will not be pushed.')
 
1000
            revision_id = br_from.last_revision()
 
1001
 
1139
1002
        # Get the stacked_on branch, if any
1140
1003
        if stacked_on is not None:
1141
1004
            stacked_on = urlutils.normalize_url(stacked_on)
1173
1036
 
1174
1037
 
1175
1038
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1039
    """Create a new copy of a branch.
1177
1040
 
1178
1041
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
1042
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1192
1055
        help='Hard-link working tree files where possible.'),
1193
1056
        Option('no-tree',
1194
1057
            help="Create a branch without a working-tree."),
1195
 
        Option('switch',
1196
 
            help="Switch the checkout in the current directory "
1197
 
                 "to the new branch."),
1198
1058
        Option('stacked',
1199
1059
            help='Create a stacked branch referring to the source branch. '
1200
1060
                'The new branch will depend on the availability of the source '
1201
1061
                'branch for all operations.'),
1202
1062
        Option('standalone',
1203
1063
               help='Do not use a shared repository, even if available.'),
1204
 
        Option('use-existing-dir',
1205
 
               help='By default branch will fail if the target'
1206
 
                    ' directory exists, but does not already'
1207
 
                    ' have a control directory.  This flag will'
1208
 
                    ' allow branch to proceed.'),
1209
 
        Option('bind',
1210
 
            help="Bind new branch to from location."),
1211
1064
        ]
1212
1065
    aliases = ['get', 'clone']
1213
1066
 
1214
1067
    def run(self, from_location, to_location=None, revision=None,
1215
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1216
 
            use_existing_dir=False, switch=False, bind=False):
1217
 
        from bzrlib import switch as _mod_switch
 
1068
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1218
1069
        from bzrlib.tag import _merge_tags_if_possible
 
1070
 
1219
1071
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
1072
            from_location)
1221
1073
        revision = _get_one_revision('branch', revision)
1222
1074
        br_from.lock_read()
1223
 
        self.add_cleanup(br_from.unlock)
1224
 
        if revision is not None:
1225
 
            revision_id = revision.as_revision_id(br_from)
1226
 
        else:
1227
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1228
 
            # None or perhaps NULL_REVISION to mean copy nothing
1229
 
            # RBC 20060209
1230
 
            revision_id = br_from.last_revision()
1231
 
        if to_location is None:
1232
 
            to_location = urlutils.derive_to_location(from_location)
1233
 
        to_transport = transport.get_transport(to_location)
1234
1075
        try:
1235
 
            to_transport.mkdir('.')
1236
 
        except errors.FileExists:
1237
 
            if not use_existing_dir:
1238
 
                raise errors.BzrCommandError('Target directory "%s" '
1239
 
                    'already exists.' % to_location)
 
1076
            if revision is not None:
 
1077
                revision_id = revision.as_revision_id(br_from)
1240
1078
            else:
1241
 
                try:
1242
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1243
 
                except errors.NotBranchError:
1244
 
                    pass
1245
 
                else:
1246
 
                    raise errors.AlreadyBranchError(to_location)
1247
 
        except errors.NoSuchFile:
1248
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1249
 
                                         % to_location)
1250
 
        try:
1251
 
            # preserve whatever source format we have.
1252
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1253
 
                                        possible_transports=[to_transport],
1254
 
                                        accelerator_tree=accelerator_tree,
1255
 
                                        hardlink=hardlink, stacked=stacked,
1256
 
                                        force_new_repo=standalone,
1257
 
                                        create_tree_if_local=not no_tree,
1258
 
                                        source_branch=br_from)
1259
 
            branch = dir.open_branch()
1260
 
        except errors.NoSuchRevision:
1261
 
            to_transport.delete_tree('.')
1262
 
            msg = "The branch %s has no revision %s." % (from_location,
1263
 
                revision)
1264
 
            raise errors.BzrCommandError(msg)
1265
 
        _merge_tags_if_possible(br_from, branch)
1266
 
        # If the source branch is stacked, the new branch may
1267
 
        # be stacked whether we asked for that explicitly or not.
1268
 
        # We therefore need a try/except here and not just 'if stacked:'
1269
 
        try:
1270
 
            note('Created new stacked branch referring to %s.' %
1271
 
                branch.get_stacked_on_url())
1272
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1273
 
            errors.UnstackableRepositoryFormat), e:
1274
 
            note('Branched %d revision(s).' % branch.revno())
1275
 
        if bind:
1276
 
            # Bind to the parent
1277
 
            parent_branch = Branch.open(from_location)
1278
 
            branch.bind(parent_branch)
1279
 
            note('New branch bound to %s' % from_location)
1280
 
        if switch:
1281
 
            # Switch to the new branch
1282
 
            wt, _ = WorkingTree.open_containing('.')
1283
 
            _mod_switch.switch(wt.bzrdir, branch)
1284
 
            note('Switched to branch: %s',
1285
 
                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()
1286
1121
 
1287
1122
 
1288
1123
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
1124
    """Create a new checkout of an existing branch.
1290
1125
 
1291
1126
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
1127
    the branch found in '.'. This is useful if you have removed the working tree
1293
1128
    or if it was never created - i.e. if you pushed the branch to its current
1294
1129
    location using SFTP.
1295
 
 
 
1130
    
1296
1131
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1297
1132
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1298
1133
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1340
1175
            revision_id = None
1341
1176
        if to_location is None:
1342
1177
            to_location = urlutils.derive_to_location(branch_location)
1343
 
        # if the source and to_location are the same,
 
1178
        # if the source and to_location are the same, 
1344
1179
        # and there is no working tree,
1345
1180
        # then reconstitute a branch
1346
1181
        if (osutils.abspath(to_location) ==
1355
1190
 
1356
1191
 
1357
1192
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1193
    """Show list of renamed files.
1359
1194
    """
1360
1195
    # TODO: Option to show renames between two historical versions.
1361
1196
 
1367
1202
    def run(self, dir=u'.'):
1368
1203
        tree = WorkingTree.open_containing(dir)[0]
1369
1204
        tree.lock_read()
1370
 
        self.add_cleanup(tree.unlock)
1371
 
        new_inv = tree.inventory
1372
 
        old_tree = tree.basis_tree()
1373
 
        old_tree.lock_read()
1374
 
        self.add_cleanup(old_tree.unlock)
1375
 
        old_inv = old_tree.inventory
1376
 
        renames = []
1377
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1378
 
        for f, paths, c, v, p, n, k, e in iterator:
1379
 
            if paths[0] == paths[1]:
1380
 
                continue
1381
 
            if None in (paths):
1382
 
                continue
1383
 
            renames.append(paths)
1384
 
        renames.sort()
1385
 
        for old_name, new_name in renames:
1386
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
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()
1387
1226
 
1388
1227
 
1389
1228
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
1391
 
 
 
1229
    """Update a tree to have the latest code committed to its branch.
 
1230
    
1392
1231
    This will perform a merge into the working tree, and may generate
1393
 
    conflicts. If you have any local changes, you will still
 
1232
    conflicts. If you have any local changes, you will still 
1394
1233
    need to commit them after the update for the update to be complete.
1395
 
 
1396
 
    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 
1397
1236
    'bzr revert' instead of 'bzr commit' after the update.
1398
 
 
1399
 
    If the tree's branch is bound to a master branch, it will also update
1400
 
    the branch from the master.
1401
1237
    """
1402
1238
 
1403
1239
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1240
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1241
    aliases = ['up']
1407
1242
 
1408
 
    def run(self, dir='.', revision=None):
1409
 
        if revision is not None and len(revision) != 1:
1410
 
            raise errors.BzrCommandError(
1411
 
                        "bzr update --revision takes exactly one revision")
 
1243
    def run(self, dir='.'):
1412
1244
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1245
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1246
        master = tree.branch.get_master_branch(
1416
1247
            possible_transports=possible_transports)
1417
1248
        if master is not None:
1418
1249
            tree.lock_write()
1419
 
            branch_location = master.base
1420
1250
        else:
1421
1251
            tree.lock_tree_write()
1422
 
            branch_location = tree.branch.base
1423
 
        self.add_cleanup(tree.unlock)
1424
 
        # get rid of the final '/' and be ready for display
1425
 
        branch_location = urlutils.unescape_for_display(
1426
 
            branch_location.rstrip('/'),
1427
 
            self.outf.encoding)
1428
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1429
 
        if master is None:
1430
 
            old_tip = None
1431
 
        else:
1432
 
            # may need to fetch data into a heavyweight checkout
1433
 
            # XXX: this may take some time, maybe we should display a
1434
 
            # message
1435
 
            old_tip = branch.update(possible_transports)
1436
 
        if revision is not None:
1437
 
            revision_id = revision[0].as_revision_id(branch)
1438
 
        else:
1439
 
            revision_id = branch.last_revision()
1440
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1441
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1442
 
            note("Tree is up to date at revision %s of branch %s" %
1443
 
                ('.'.join(map(str, revno)), branch_location))
1444
 
            return 0
1445
 
        view_info = _get_view_info_for_change_reporter(tree)
1446
 
        change_reporter = delta._ChangeReporter(
1447
 
            unversioned_filter=tree.is_ignored,
1448
 
            view_info=view_info)
1449
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)
1450
1264
            conflicts = tree.update(
1451
 
                change_reporter,
1452
 
                possible_transports=possible_transports,
1453
 
                revision=revision_id,
1454
 
                old_tip=old_tip)
1455
 
        except errors.NoSuchRevision, e:
1456
 
            raise errors.BzrCommandError(
1457
 
                                  "branch has no revision %s\n"
1458
 
                                  "bzr update --revision only works"
1459
 
                                  " for a revision in the branch history"
1460
 
                                  % (e.revision))
1461
 
        revno = tree.branch.revision_id_to_dotted_revno(
1462
 
            _mod_revision.ensure_null(tree.last_revision()))
1463
 
        note('Updated to revision %s of branch %s' %
1464
 
             ('.'.join(map(str, revno)), branch_location))
1465
 
        parent_ids = tree.get_parent_ids()
1466
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1467
 
            note('Your local commits will now show as pending merges with '
1468
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1469
 
        if conflicts != 0:
1470
 
            return 1
1471
 
        else:
1472
 
            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()
1473
1279
 
1474
1280
 
1475
1281
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1282
    """Show information about a working tree, branch or repository.
1477
1283
 
1478
1284
    This command will show all known locations and formats associated to the
1479
 
    tree, branch or repository.
1480
 
 
1481
 
    In verbose mode, statistical information is included with each report.
1482
 
    To see extended statistic information, use a verbosity level of 2 or
1483
 
    higher by specifying the verbose option multiple times, e.g. -vv.
 
1285
    tree, branch or repository.  Statistical information is included with
 
1286
    each report.
1484
1287
 
1485
1288
    Branches and working trees will also report any missing revisions.
1486
 
 
1487
 
    :Examples:
1488
 
 
1489
 
      Display information on the format and related locations:
1490
 
 
1491
 
        bzr info
1492
 
 
1493
 
      Display the above together with extended format information and
1494
 
      basic statistics (like the number of files in the working tree and
1495
 
      number of revisions in the branch and repository):
1496
 
 
1497
 
        bzr info -v
1498
 
 
1499
 
      Display the above together with number of committers to the branch:
1500
 
 
1501
 
        bzr info -vv
1502
1289
    """
1503
1290
    _see_also = ['revno', 'working-trees', 'repositories']
1504
1291
    takes_args = ['location?']
1508
1295
    @display_command
1509
1296
    def run(self, location=None, verbose=False):
1510
1297
        if verbose:
1511
 
            noise_level = get_verbosity_level()
 
1298
            noise_level = 2
1512
1299
        else:
1513
1300
            noise_level = 0
1514
1301
        from bzrlib.info import show_bzrdir_info
1517
1304
 
1518
1305
 
1519
1306
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1307
    """Remove files or directories.
1521
1308
 
1522
1309
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1310
    them if they can easily be recovered using revert. If no options or
1532
1319
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
1320
            safe='Only delete files if they can be'
1534
1321
                 ' safely recovered (default).',
1535
 
            keep='Delete from bzr but leave the working copy.',
 
1322
            keep="Don't delete any files.",
1536
1323
            force='Delete all the specified files, even if they can not be '
1537
1324
                'recovered and even if they are non-empty directories.')]
1538
1325
    aliases = ['rm', 'del']
1546
1333
            file_list = [f for f in file_list]
1547
1334
 
1548
1335
        tree.lock_write()
1549
 
        self.add_cleanup(tree.unlock)
1550
 
        # Heuristics should probably all move into tree.remove_smart or
1551
 
        # some such?
1552
 
        if new:
1553
 
            added = tree.changes_from(tree.basis_tree(),
1554
 
                specific_files=file_list).added
1555
 
            file_list = sorted([f[0] for f in added], reverse=True)
1556
 
            if len(file_list) == 0:
1557
 
                raise errors.BzrCommandError('No matching files.')
1558
 
        elif file_list is None:
1559
 
            # missing files show up in iter_changes(basis) as
1560
 
            # versioned-with-no-kind.
1561
 
            missing = []
1562
 
            for change in tree.iter_changes(tree.basis_tree()):
1563
 
                # Find paths in the working tree that have no kind:
1564
 
                if change[1][1] is not None and change[6][1] is None:
1565
 
                    missing.append(change[1][1])
1566
 
            file_list = sorted(missing, reverse=True)
1567
 
            file_deletion_strategy = 'keep'
1568
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1569
 
            keep_files=file_deletion_strategy=='keep',
1570
 
            force=file_deletion_strategy=='force')
 
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()
1571
1360
 
1572
1361
 
1573
1362
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1363
    """Print file_id of a particular file or directory.
1575
1364
 
1576
1365
    The file_id is assigned when the file is first added and remains the
1577
1366
    same through all revisions where the file exists, even when it is
1593
1382
 
1594
1383
 
1595
1384
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1385
    """Print path of file_ids to a file or directory.
1597
1386
 
1598
1387
    This prints one line for each directory down to the target,
1599
1388
    starting at the branch root.
1615
1404
 
1616
1405
 
1617
1406
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1407
    """Reconcile bzr metadata in a branch.
1619
1408
 
1620
1409
    This can correct data mismatches that may have been caused by
1621
1410
    previous ghost operations or bzr upgrades. You should only
1622
 
    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 
1623
1412
    advises you to run it.
1624
1413
 
1625
1414
    If a second branch is provided, cross-branch reconciliation is
1627
1416
    id which was not present in very early bzr versions is represented
1628
1417
    correctly in both branches.
1629
1418
 
1630
 
    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 
1631
1420
    a potential saving in disk space or performance gain.
1632
1421
 
1633
1422
    The branch *MUST* be on a listable system such as local disk or sftp.
1643
1432
 
1644
1433
 
1645
1434
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1435
    """Display the list of revision ids on a branch."""
1647
1436
 
1648
1437
    _see_also = ['log']
1649
1438
    takes_args = ['location?']
1659
1448
 
1660
1449
 
1661
1450
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1451
    """List all revisions merged into this branch."""
1663
1452
 
1664
1453
    _see_also = ['log', 'revision-history']
1665
1454
    takes_args = ['location?']
1684
1473
 
1685
1474
 
1686
1475
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1476
    """Make a directory into a versioned branch.
1688
1477
 
1689
1478
    Use this to create an empty branch, or before importing an
1690
1479
    existing project.
1691
1480
 
1692
 
    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 
1693
1482
    the history of the branch will be stored in the repository.  Otherwise
1694
1483
    init creates a standalone branch which carries its own history
1695
1484
    in the .bzr directory.
1718
1507
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1719
1508
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1720
1509
                value_switches=True,
1721
 
                title="Branch format",
 
1510
                title="Branch Format",
1722
1511
                ),
1723
1512
         Option('append-revisions-only',
1724
1513
                help='Never change revnos or the existing log.'
1747
1536
                    "\nYou may supply --create-prefix to create all"
1748
1537
                    " leading parent directories."
1749
1538
                    % location)
1750
 
            to_transport.create_prefix()
 
1539
            _create_prefix(to_transport)
1751
1540
 
1752
1541
        try:
1753
1542
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1771
1560
                branch.set_append_revisions_only(True)
1772
1561
            except errors.UpgradeRequired:
1773
1562
                raise errors.BzrCommandError('This branch format cannot be set'
1774
 
                    ' to append-revisions-only.  Try --default.')
 
1563
                    ' to append-revisions-only.  Try --experimental-branch6')
1775
1564
        if not is_quiet():
1776
1565
            from bzrlib.info import describe_layout, describe_format
1777
1566
            try:
1793
1582
 
1794
1583
 
1795
1584
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1585
    """Create a shared repository to hold branches.
1797
1586
 
1798
1587
    New branches created under the repository directory will store their
1799
 
    revisions in the repository, not in the branch directory.  For branches
1800
 
    with shared history, this reduces the amount of storage needed and 
1801
 
    speeds up the creation of new branches.
 
1588
    revisions in the repository, not in the branch directory.
1802
1589
 
1803
 
    If the --no-trees option is given then the branches in the repository
1804
 
    will not have working trees by default.  They will still exist as 
1805
 
    directories on disk, but they will not have separate copies of the 
1806
 
    files at a certain revision.  This can be useful for repositories that
1807
 
    store branches which are interacted with through checkouts or remote
1808
 
    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.
1809
1592
 
1810
1593
    :Examples:
1811
 
        Create a shared repository holding just branches::
 
1594
        Create a shared repositories holding just branches::
1812
1595
 
1813
1596
            bzr init-repo --no-trees repo
1814
1597
            bzr init repo/trunk
1853
1636
 
1854
1637
 
1855
1638
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
1857
 
 
 
1639
    """Show differences in the working tree, between revisions or branches.
 
1640
    
1858
1641
    If no arguments are given, all changes for the current tree are listed.
1859
1642
    If files are given, only the changes in those files are listed.
1860
1643
    Remote and multiple branches can be compared by using the --old and
1880
1663
 
1881
1664
            bzr diff -r1
1882
1665
 
1883
 
        Difference between revision 3 and revision 1::
1884
 
 
1885
 
            bzr diff -r1..3
1886
 
 
1887
 
        Difference between revision 3 and revision 1 for branch xxx::
1888
 
 
1889
 
            bzr diff -r1..3 xxx
1890
 
 
1891
 
        To see the changes introduced in revision X::
1892
 
        
1893
 
            bzr diff -cX
1894
 
 
1895
 
        Note that in the case of a merge, the -c option shows the changes
1896
 
        compared to the left hand parent. To see the changes against
1897
 
        another parent, use::
1898
 
 
1899
 
            bzr diff -r<chosen_parent>..X
1900
 
 
1901
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1902
 
 
1903
 
            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
1904
1673
 
1905
1674
        Show just the differences for file NEWS::
1906
1675
 
1945
1714
            help='Use this command to compare files.',
1946
1715
            type=unicode,
1947
1716
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1717
        ]
1953
1718
    aliases = ['di', 'dif']
1954
1719
    encoding_type = 'exact'
1955
1720
 
1956
1721
    @display_command
1957
1722
    def run(self, revision=None, file_list=None, diff_options=None,
1958
 
            prefix=None, old=None, new=None, using=None, format=None):
1959
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1960
 
            show_diff_trees)
 
1723
            prefix=None, old=None, new=None, using=None):
 
1724
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1961
1725
 
1962
1726
        if (prefix is None) or (prefix == '0'):
1963
1727
            # diff -p0 format
1977
1741
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1742
                                         ' one or two revision specifiers')
1979
1743
 
1980
 
        if using is not None and format is not None:
1981
 
            raise errors.BzrCommandError('--using and --format are mutually '
1982
 
                'exclusive.')
1983
 
 
1984
 
        (old_tree, new_tree,
1985
 
         old_branch, new_branch,
1986
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1987
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1988
 
        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, 
1989
1748
                               specific_files=specific_files,
1990
1749
                               external_diff_options=diff_options,
1991
1750
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1751
                               extra_trees=extra_trees, using=using)
1994
1752
 
1995
1753
 
1996
1754
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1755
    """List files deleted in the working tree.
1998
1756
    """
1999
1757
    # TODO: Show files deleted since a previous revision, or
2000
1758
    # between two revisions.
2009
1767
    def run(self, show_ids=False):
2010
1768
        tree = WorkingTree.open_containing(u'.')[0]
2011
1769
        tree.lock_read()
2012
 
        self.add_cleanup(tree.unlock)
2013
 
        old = tree.basis_tree()
2014
 
        old.lock_read()
2015
 
        self.add_cleanup(old.unlock)
2016
 
        for path, ie in old.inventory.iter_entries():
2017
 
            if not tree.has_id(ie.file_id):
2018
 
                self.outf.write(path)
2019
 
                if show_ids:
2020
 
                    self.outf.write(' ')
2021
 
                    self.outf.write(ie.file_id)
2022
 
                self.outf.write('\n')
 
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()
2023
1785
 
2024
1786
 
2025
1787
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1788
    """List files modified in working tree.
2027
1789
    """
2028
1790
 
2029
1791
    hidden = True
2046
1808
 
2047
1809
 
2048
1810
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1811
    """List files added in working tree.
2050
1812
    """
2051
1813
 
2052
1814
    hidden = True
2061
1823
    def run(self, null=False):
2062
1824
        wt = WorkingTree.open_containing(u'.')[0]
2063
1825
        wt.lock_read()
2064
 
        self.add_cleanup(wt.unlock)
2065
 
        basis = wt.basis_tree()
2066
 
        basis.lock_read()
2067
 
        self.add_cleanup(basis.unlock)
2068
 
        basis_inv = basis.inventory
2069
 
        inv = wt.inventory
2070
 
        for file_id in inv:
2071
 
            if file_id in basis_inv:
2072
 
                continue
2073
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2074
 
                continue
2075
 
            path = inv.id2path(file_id)
2076
 
            if not os.access(osutils.abspath(path), os.F_OK):
2077
 
                continue
2078
 
            if null:
2079
 
                self.outf.write(path + '\0')
2080
 
            else:
2081
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
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()
2082
1848
 
2083
1849
 
2084
1850
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
1851
    """Show the tree root directory.
2086
1852
 
2087
1853
    The root is the nearest enclosing directory with a .bzr control
2088
1854
    directory."""
2112
1878
 
2113
1879
 
2114
1880
class cmd_log(Command):
2115
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1881
    """Show historical log for a branch or subset of a branch.
2116
1882
 
2117
1883
    log is bzr's default tool for exploring the history of a branch.
2118
1884
    The branch to use is taken from the first parameter. If no parameters
2131
1897
    were merged.
2132
1898
 
2133
1899
    :Output control:
2134
 
 
 
1900
 
2135
1901
      The log format controls how information about each revision is
2136
1902
      displayed. The standard log formats are called ``long``, ``short``
2137
1903
      and ``line``. The default is long. See ``bzr help log-formats``
2139
1905
 
2140
1906
      The following options can be used to control what information is
2141
1907
      displayed::
2142
 
 
 
1908
  
2143
1909
        -l N        display a maximum of N revisions
2144
1910
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
2145
1911
        -v          display a status summary (delta) for each revision
2146
1912
        -p          display a diff (patch) for each revision
2147
1913
        --show-ids  display revision-ids (and file-ids), not just revnos
2148
 
 
 
1914
  
2149
1915
      Note that the default number of levels to display is a function of the
2150
 
      log format. If the -n option is not used, the standard log formats show
2151
 
      just the top level (mainline).
2152
 
 
 
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
  
2153
1920
      Status summaries are shown using status flags like A, M, etc. To see
2154
1921
      the changes explained using words like ``added`` and ``modified``
2155
1922
      instead, use the -vv option.
2156
 
 
 
1923
  
2157
1924
    :Ordering control:
2158
 
 
 
1925
  
2159
1926
      To display revisions from oldest to newest, use the --forward option.
2160
1927
      In most cases, using this option will have little impact on the total
2161
1928
      time taken to produce a log, though --forward does not incrementally
2162
1929
      display revisions like --reverse does when it can.
2163
 
 
 
1930
  
2164
1931
    :Revision filtering:
2165
 
 
 
1932
  
2166
1933
      The -r option can be used to specify what revision or range of revisions
2167
1934
      to filter against. The various forms are shown below::
2168
 
 
 
1935
  
2169
1936
        -rX      display revision X
2170
1937
        -rX..    display revision X and later
2171
1938
        -r..Y    display up to and including revision Y
2172
1939
        -rX..Y   display from X to Y inclusive
2173
 
 
 
1940
  
2174
1941
      See ``bzr help revisionspec`` for details on how to specify X and Y.
2175
1942
      Some common examples are given below::
2176
 
 
 
1943
  
2177
1944
        -r-1                show just the tip
2178
1945
        -r-10..             show the last 10 mainline revisions
2179
1946
        -rsubmit:..         show what's new on this branch
2180
1947
        -rancestor:path..   show changes since the common ancestor of this
2181
1948
                            branch and the one at location path
2182
1949
        -rdate:yesterday..  show changes since yesterday
2183
 
 
 
1950
  
2184
1951
      When logging a range of revisions using -rX..Y, log starts at
2185
1952
      revision Y and searches back in history through the primary
2186
1953
      ("left-hand") parents until it finds X. When logging just the
2189
1956
      a nested merge revision and the log will be truncated accordingly.
2190
1957
 
2191
1958
    :Path filtering:
2192
 
 
2193
 
      If parameters are given and the first one is not a branch, the log
2194
 
      will be filtered to show only those revisions that changed the
2195
 
      nominated files or directories.
2196
 
 
 
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
  
2197
1964
      Filenames are interpreted within their historical context. To log a
2198
1965
      deleted file, specify a revision range so that the file existed at
2199
1966
      the end or start of the range.
2200
 
 
 
1967
  
2201
1968
      Historical context is also important when interpreting pathnames of
2202
1969
      renamed files/directories. Consider the following example:
2203
 
 
 
1970
  
2204
1971
      * revision 1: add tutorial.txt
2205
1972
      * revision 2: modify tutorial.txt
2206
1973
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
2207
 
 
 
1974
  
2208
1975
      In this case:
2209
 
 
 
1976
  
2210
1977
      * ``bzr log guide.txt`` will log the file added in revision 1
2211
 
 
 
1978
  
2212
1979
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
2213
 
 
 
1980
  
2214
1981
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
2215
1982
        the original file in revision 2.
2216
 
 
 
1983
  
2217
1984
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
2218
1985
        was no file called guide.txt in revision 2.
2219
 
 
 
1986
  
2220
1987
      Renames are always followed by log. By design, there is no need to
2221
1988
      explicitly ask for this (and no way to stop logging a file back
2222
1989
      until it was last renamed).
2223
 
 
 
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
  
2224
1996
    :Other filtering:
2225
 
 
 
1997
  
2226
1998
      The --message option can be used for finding revisions that match a
2227
1999
      regular expression in a commit message.
2228
 
 
 
2000
  
2229
2001
    :Tips & tricks:
2230
 
 
 
2002
  
2231
2003
      GUI tools and IDEs are often better at exploring history than command
2232
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2233
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2234
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2235
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2236
 
 
 
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
  
2237
2012
      You may find it useful to add the aliases below to ``bazaar.conf``::
2238
 
 
 
2013
  
2239
2014
        [ALIASES]
2240
 
        tip = log -r-1
2241
 
        top = log -l10 --line
2242
 
        show = log -v -p
2243
 
 
 
2015
        tip = log -r-1 -n1
 
2016
        top = log -r-10.. --short --forward
 
2017
        show = log -v -p -n1 --long
 
2018
  
2244
2019
      ``bzr tip`` will then show the latest revision while ``bzr top``
2245
2020
      will show the last 10 mainline revisions. To see the details of a
2246
2021
      particular revision X,  ``bzr show -rX``.
2247
 
 
2248
 
      If you are interested in looking deeper into a particular merge X,
2249
 
      use ``bzr log -n0 -rX``.
2250
 
 
 
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
  
2251
2031
      ``bzr log -v`` on a branch with lots of history is currently
2252
2032
      very slow. A fix for this issue is currently under development.
2253
2033
      With or without that fix, it is recommended that a revision range
2254
2034
      be given when using the -v option.
2255
 
 
 
2035
  
2256
2036
      bzr has a generic full-text matching plugin, bzr-search, that can be
2257
2037
      used to find revisions matching user names, commit messages, etc.
2258
2038
      Among other features, this plugin can find all revisions containing
2259
2039
      a list of words but not others.
2260
 
 
 
2040
  
2261
2041
      When exploring non-mainline history on large projects with deep
2262
2042
      history, the performance of log can be greatly improved by installing
2263
 
      the historycache plugin. This plugin buffers historical information
 
2043
      the revnocache plugin. This plugin buffers historical information
2264
2044
      trading disk space for faster speed.
2265
2045
    """
2266
 
    takes_args = ['file*']
 
2046
    takes_args = ['location?']
2267
2047
    _see_also = ['log-formats', 'revisionspec']
2268
2048
    takes_options = [
2269
2049
            Option('forward',
2297
2077
            Option('show-diff',
2298
2078
                   short_name='p',
2299
2079
                   help='Show changes made in each revision as a patch.'),
2300
 
            Option('include-merges',
2301
 
                   help='Show merged revisions like --levels 0 does.'),
2302
 
            Option('exclude-common-ancestry',
2303
 
                   help='Display only the revisions that are not part'
2304
 
                   ' of both ancestries (require -rX..Y)'
2305
 
                   )
2306
2080
            ]
2307
2081
    encoding_type = 'replace'
2308
2082
 
2309
2083
    @display_command
2310
 
    def run(self, file_list=None, timezone='original',
 
2084
    def run(self, location=None, timezone='original',
2311
2085
            verbose=False,
2312
2086
            show_ids=False,
2313
2087
            forward=False,
2317
2091
            levels=None,
2318
2092
            message=None,
2319
2093
            limit=None,
2320
 
            show_diff=False,
2321
 
            include_merges=False,
2322
 
            exclude_common_ancestry=False,
2323
 
            ):
2324
 
        from bzrlib.log import (
2325
 
            Logger,
2326
 
            make_log_request_dict,
2327
 
            _get_info_for_log_files,
2328
 
            )
 
2094
            show_diff=False):
 
2095
        from bzrlib.log import show_log, _get_fileid_to_log
2329
2096
        direction = (forward and 'forward') or 'reverse'
2330
 
        if (exclude_common_ancestry
2331
 
            and (revision is None or len(revision) != 2)):
2332
 
            raise errors.BzrCommandError(
2333
 
                '--exclude-common-ancestry requires -r with two revisions')
2334
 
        if include_merges:
2335
 
            if levels is None:
2336
 
                levels = 0
2337
 
            else:
2338
 
                raise errors.BzrCommandError(
2339
 
                    '--levels and --include-merges are mutually exclusive')
2340
2097
 
2341
2098
        if change is not None:
2342
2099
            if len(change) > 1:
2347
2104
            else:
2348
2105
                revision = change
2349
2106
 
2350
 
        file_ids = []
2351
 
        filter_by_dir = False
2352
 
        if file_list:
2353
 
            # find the file ids to log and check for directory filtering
2354
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2355
 
                revision, file_list)
2356
 
            self.add_cleanup(b.unlock)
2357
 
            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)
2358
2116
                if file_id is None:
2359
2117
                    raise errors.BzrCommandError(
2360
2118
                        "Path unknown at end or start of revision range: %s" %
2361
 
                        relpath)
2362
 
                # If the relpath is the top of the tree, we log everything
2363
 
                if relpath == '':
2364
 
                    file_ids = []
2365
 
                    break
2366
 
                else:
2367
 
                    file_ids.append(file_id)
2368
 
                filter_by_dir = filter_by_dir or (
2369
 
                    kind in ['directory', 'tree-reference'])
 
2119
                        location)
2370
2120
        else:
2371
 
            # log everything
2372
 
            # FIXME ? log the current subdir only RBC 20060203
 
2121
            # local dir only
 
2122
            # FIXME ? log the current subdir only RBC 20060203 
2373
2123
            if revision is not None \
2374
2124
                    and len(revision) > 0 and revision[0].get_branch():
2375
2125
                location = revision[0].get_branch()
2377
2127
                location = '.'
2378
2128
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
2129
            b = dir.open_branch()
2380
 
            b.lock_read()
2381
 
            self.add_cleanup(b.unlock)
 
2130
 
 
2131
        b.lock_read()
 
2132
        try:
2382
2133
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2383
 
 
2384
 
        # Decide on the type of delta & diff filtering to use
2385
 
        # TODO: add an --all-files option to make this configurable & consistent
2386
 
        if not verbose:
2387
 
            delta_type = None
2388
 
        else:
2389
 
            delta_type = 'full'
2390
 
        if not show_diff:
2391
 
            diff_type = None
2392
 
        elif file_ids:
2393
 
            diff_type = 'partial'
2394
 
        else:
2395
 
            diff_type = 'full'
2396
 
 
2397
 
        # Build the log formatter
2398
 
        if log_format is None:
2399
 
            log_format = log.log_formatter_registry.get_default(b)
2400
 
        # Make a non-encoding output to include the diffs - bug 328007
2401
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2402
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2403
 
                        to_exact_file=unencoded_output,
2404
 
                        show_timezone=timezone,
2405
 
                        delta_format=get_verbosity_level(),
2406
 
                        levels=levels,
2407
 
                        show_advice=levels is None)
2408
 
 
2409
 
        # Choose the algorithm for doing the logging. It's annoying
2410
 
        # having multiple code paths like this but necessary until
2411
 
        # the underlying repository format is faster at generating
2412
 
        # deltas or can provide everything we need from the indices.
2413
 
        # The default algorithm - match-using-deltas - works for
2414
 
        # multiple files and directories and is faster for small
2415
 
        # amounts of history (200 revisions say). However, it's too
2416
 
        # slow for logging a single file in a repository with deep
2417
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2418
 
        # evil when adding features", we continue to use the
2419
 
        # original algorithm - per-file-graph - for the "single
2420
 
        # file that isn't a directory without showing a delta" case.
2421
 
        partial_history = revision and b.repository._format.supports_chks
2422
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2423
 
            or delta_type or partial_history)
2424
 
 
2425
 
        # Build the LogRequest and execute it
2426
 
        if len(file_ids) == 0:
2427
 
            file_ids = None
2428
 
        rqst = make_log_request_dict(
2429
 
            direction=direction, specific_fileids=file_ids,
2430
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2431
 
            message_search=message, delta_type=delta_type,
2432
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2433
 
            exclude_common_ancestry=exclude_common_ancestry,
2434
 
            )
2435
 
        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()
2436
2154
 
2437
2155
 
2438
2156
def _get_revision_range(revisionspec_list, branch, command_name):
2439
2157
    """Take the input of a revision option and turn it into a revision range.
2440
2158
 
2441
2159
    It returns RevisionInfo objects which can be used to obtain the rev_id's
2442
 
    of the desired revisions. It does some user input validations.
 
2160
    of the desired revisons. It does some user input validations.
2443
2161
    """
2444
2162
    if revisionspec_list is None:
2445
2163
        rev1 = None
2456
2174
            raise errors.BzrCommandError(
2457
2175
                "bzr %s doesn't accept two revisions in different"
2458
2176
                " branches." % command_name)
2459
 
        if start_spec.spec is None:
2460
 
            # Avoid loading all the history.
2461
 
            rev1 = RevisionInfo(branch, None, None)
2462
 
        else:
2463
 
            rev1 = start_spec.in_history(branch)
 
2177
        rev1 = start_spec.in_history(branch)
2464
2178
        # Avoid loading all of history when we know a missing
2465
2179
        # end of range means the last revision ...
2466
2180
        if end_spec.spec is None:
2495
2209
 
2496
2210
 
2497
2211
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2212
    """Return revision-ids which affected a particular file.
2499
2213
 
2500
2214
    A more user-friendly interface is "bzr log FILE".
2501
2215
    """
2506
2220
    @display_command
2507
2221
    def run(self, filename):
2508
2222
        tree, relpath = WorkingTree.open_containing(filename)
 
2223
        b = tree.branch
2509
2224
        file_id = tree.path2id(relpath)
2510
 
        b = tree.branch
2511
 
        b.lock_read()
2512
 
        self.add_cleanup(b.unlock)
2513
 
        touching_revs = log.find_touching_revisions(b, file_id)
2514
 
        for revno, revision_id, what in touching_revs:
 
2225
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2515
2226
            self.outf.write("%6d %s\n" % (revno, what))
2516
2227
 
2517
2228
 
2518
2229
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
2230
    """List files in a tree.
2520
2231
    """
2521
2232
 
2522
2233
    _see_also = ['status', 'cat']
2523
2234
    takes_args = ['path?']
 
2235
    # TODO: Take a revision or remote path and list that tree instead.
2524
2236
    takes_options = [
2525
2237
            'verbose',
2526
2238
            'revision',
2527
 
            Option('recursive', short_name='R',
2528
 
                   help='Recurse into subdirectories.'),
 
2239
            Option('non-recursive',
 
2240
                   help='Don\'t recurse into subdirectories.'),
2529
2241
            Option('from-root',
2530
2242
                   help='Print paths relative to the root of the branch.'),
2531
2243
            Option('unknown', help='Print unknown files.'),
2542
2254
            ]
2543
2255
    @display_command
2544
2256
    def run(self, revision=None, verbose=False,
2545
 
            recursive=False, from_root=False,
 
2257
            non_recursive=False, from_root=False,
2546
2258
            unknown=False, versioned=False, ignored=False,
2547
2259
            null=False, kind=None, show_ids=False, path=None):
2548
2260
 
2557
2269
 
2558
2270
        if path is None:
2559
2271
            fs_path = '.'
 
2272
            prefix = ''
2560
2273
        else:
2561
2274
            if from_root:
2562
2275
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
2276
                                             ' and PATH')
2564
2277
            fs_path = path
 
2278
            prefix = path
2565
2279
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
2280
            fs_path)
2567
 
 
2568
 
        # Calculate the prefix to use
2569
 
        prefix = None
2570
2281
        if from_root:
2571
 
            if relpath:
2572
 
                prefix = relpath + '/'
2573
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2574
 
            prefix = fs_path + '/'
2575
 
 
 
2282
            relpath = u''
 
2283
        elif relpath:
 
2284
            relpath += '/'
2576
2285
        if revision is not None or tree is None:
2577
2286
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2578
2287
 
2579
2288
        apply_view = False
2580
 
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
2289
        if tree.supports_views():
2581
2290
            view_files = tree.views.lookup_view()
2582
2291
            if view_files:
2583
2292
                apply_view = True
2584
2293
                view_str = views.view_display_str(view_files)
2585
 
                note("Ignoring files outside view. View is %s" % view_str)
 
2294
                note("ignoring files outside view: %s" % view_str)
2586
2295
 
2587
2296
        tree.lock_read()
2588
 
        self.add_cleanup(tree.unlock)
2589
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2590
 
            from_dir=relpath, recursive=recursive):
2591
 
            # Apply additional masking
2592
 
            if not all and not selection[fc]:
2593
 
                continue
2594
 
            if kind is not None and fkind != kind:
2595
 
                continue
2596
 
            if apply_view:
2597
 
                try:
2598
 
                    if relpath:
2599
 
                        fullpath = osutils.pathjoin(relpath, fp)
2600
 
                    else:
2601
 
                        fullpath = fp
2602
 
                    views.check_path_in_view(tree, fullpath)
2603
 
                except errors.FileOutsideView:
2604
 
                    continue
2605
 
 
2606
 
            # Output the entry
2607
 
            if prefix:
2608
 
                fp = osutils.pathjoin(prefix, fp)
2609
 
            kindch = entry.kind_character()
2610
 
            outstring = fp + kindch
2611
 
            ui.ui_factory.clear_term()
2612
 
            if verbose:
2613
 
                outstring = '%-8s %s' % (fc, outstring)
2614
 
                if show_ids and fid is not None:
2615
 
                    outstring = "%-50s %s" % (outstring, fid)
2616
 
                self.outf.write(outstring + '\n')
2617
 
            elif null:
2618
 
                self.outf.write(fp + '\0')
2619
 
                if show_ids:
2620
 
                    if fid is not None:
2621
 
                        self.outf.write(fid)
2622
 
                    self.outf.write('\0')
2623
 
                self.outf.flush()
2624
 
            else:
2625
 
                if show_ids:
2626
 
                    if fid is not None:
2627
 
                        my_id = fid
2628
 
                    else:
2629
 
                        my_id = ''
2630
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2631
 
                else:
2632
 
                    self.outf.write(outstring + '\n')
 
2297
        try:
 
2298
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2299
                if fp.startswith(relpath):
 
2300
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2301
                    if non_recursive and '/' in fp:
 
2302
                        continue
 
2303
                    if not all and not selection[fc]:
 
2304
                        continue
 
2305
                    if kind is not None and fkind != kind:
 
2306
                        continue
 
2307
                    if apply_view:
 
2308
                        try:
 
2309
                            views.check_path_in_view(tree, fp)
 
2310
                        except errors.FileOutsideView:
 
2311
                            continue
 
2312
                    kindch = entry.kind_character()
 
2313
                    outstring = fp + kindch
 
2314
                    if verbose:
 
2315
                        outstring = '%-8s %s' % (fc, outstring)
 
2316
                        if show_ids and fid is not None:
 
2317
                            outstring = "%-50s %s" % (outstring, fid)
 
2318
                        self.outf.write(outstring + '\n')
 
2319
                    elif null:
 
2320
                        self.outf.write(fp + '\0')
 
2321
                        if show_ids:
 
2322
                            if fid is not None:
 
2323
                                self.outf.write(fid)
 
2324
                            self.outf.write('\0')
 
2325
                        self.outf.flush()
 
2326
                    else:
 
2327
                        if fid is not None:
 
2328
                            my_id = fid
 
2329
                        else:
 
2330
                            my_id = ''
 
2331
                        if show_ids:
 
2332
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2333
                        else:
 
2334
                            self.outf.write(outstring + '\n')
 
2335
        finally:
 
2336
            tree.unlock()
2633
2337
 
2634
2338
 
2635
2339
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
2340
    """List unknown files.
2637
2341
    """
2638
2342
 
2639
2343
    hidden = True
2646
2350
 
2647
2351
 
2648
2352
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
2353
    """Ignore specified files or patterns.
2650
2354
 
2651
2355
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
2356
 
2653
 
    If a .bzrignore file does not exist, the ignore command
2654
 
    will create one and add the specified files or patterns to the newly
2655
 
    created file. The ignore command will also automatically add the 
2656
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2657
 
    the use of the ignore command will require an explicit add command.
2658
 
 
2659
2357
    To remove patterns from the ignore list, edit the .bzrignore file.
2660
2358
    After adding, editing or deleting that file either indirectly by
2661
2359
    using this command or directly by using an editor, be sure to commit
2662
2360
    it.
2663
 
    
2664
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2665
 
    the global ignore file can be found in the application data directory as
2666
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2667
 
    Global ignores are not touched by this command. The global ignore file
2668
 
    can be edited directly using an editor.
2669
 
 
2670
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2671
 
    precedence over regular ignores.  Such exceptions are used to specify
2672
 
    files that should be versioned which would otherwise be ignored.
2673
 
    
2674
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2675
 
    precedence over the '!' exception patterns.
2676
 
 
2677
 
    Note: ignore patterns containing shell wildcards must be quoted from
 
2361
 
 
2362
    Note: ignore patterns containing shell wildcards must be quoted from 
2678
2363
    the shell on Unix.
2679
2364
 
2680
2365
    :Examples:
2682
2367
 
2683
2368
            bzr ignore ./Makefile
2684
2369
 
2685
 
        Ignore .class files in all directories...::
 
2370
        Ignore class files in all directories::
2686
2371
 
2687
2372
            bzr ignore "*.class"
2688
2373
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
2374
        Ignore .o files under the lib directory::
2694
2375
 
2695
2376
            bzr ignore "lib/**/*.o"
2701
2382
        Ignore everything but the "debian" toplevel directory::
2702
2383
 
2703
2384
            bzr ignore "RE:(?!debian/).*"
2704
 
        
2705
 
        Ignore everything except the "local" toplevel directory,
2706
 
        but always ignore "*~" autosave files, even under local/::
2707
 
        
2708
 
            bzr ignore "*"
2709
 
            bzr ignore "!./local"
2710
 
            bzr ignore "!!*~"
2711
2385
    """
2712
2386
 
2713
2387
    _see_also = ['status', 'ignored', 'patterns']
2714
2388
    takes_args = ['name_pattern*']
2715
2389
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
2390
        Option('old-default-rules',
 
2391
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
2392
        ]
2719
 
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
2393
    
 
2394
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
2395
        from bzrlib import ignores
2722
 
        if default_rules is not None:
2723
 
            # dump the default rules and exit
2724
 
            for pattern in ignores.USER_DEFAULTS:
2725
 
                self.outf.write("%s\n" % pattern)
 
2396
        if old_default_rules is not None:
 
2397
            # dump the rules and exit
 
2398
            for pattern in ignores.OLD_DEFAULTS:
 
2399
                print pattern
2726
2400
            return
2727
2401
        if not name_pattern_list:
2728
2402
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
2730
 
        name_pattern_list = [globbing.normalize_pattern(p)
 
2403
                                  "NAME_PATTERN or --old-default-rules")
 
2404
        name_pattern_list = [globbing.normalize_pattern(p) 
2731
2405
                             for p in name_pattern_list]
2732
2406
        for name_pattern in name_pattern_list:
2733
 
            if (name_pattern[0] == '/' or
 
2407
            if (name_pattern[0] == '/' or 
2734
2408
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
2409
                raise errors.BzrCommandError(
2736
2410
                    "NAME_PATTERN should not be an absolute path")
2744
2418
            if id is not None:
2745
2419
                filename = entry[0]
2746
2420
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2421
                    matches.append(filename.encode('utf-8'))
2748
2422
        tree.unlock()
2749
2423
        if len(matches) > 0:
2750
 
            self.outf.write("Warning: the following files are version controlled and"
2751
 
                  " match your ignore pattern:\n%s"
2752
 
                  "\nThese files will continue to be version controlled"
2753
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2424
            print "Warning: the following files are version controlled and" \
 
2425
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
2754
2426
 
2755
2427
 
2756
2428
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2429
    """List ignored files and the patterns that matched them.
2758
2430
 
2759
2431
    List all the ignored files and the ignore pattern that caused the file to
2760
2432
    be ignored.
2771
2443
    def run(self):
2772
2444
        tree = WorkingTree.open_containing(u'.')[0]
2773
2445
        tree.lock_read()
2774
 
        self.add_cleanup(tree.unlock)
2775
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2776
 
            if file_class != 'I':
2777
 
                continue
2778
 
            ## XXX: Slightly inefficient since this was already calculated
2779
 
            pat = tree.is_ignored(path)
2780
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2446
        try:
 
2447
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2448
                if file_class != 'I':
 
2449
                    continue
 
2450
                ## XXX: Slightly inefficient since this was already calculated
 
2451
                pat = tree.is_ignored(path)
 
2452
                self.outf.write('%-50s %s\n' % (path, pat))
 
2453
        finally:
 
2454
            tree.unlock()
2781
2455
 
2782
2456
 
2783
2457
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2458
    """Lookup the revision-id from a revision-number
2785
2459
 
2786
2460
    :Examples:
2787
2461
        bzr lookup-revision 33
2788
2462
    """
2789
2463
    hidden = True
2790
2464
    takes_args = ['revno']
2791
 
 
 
2465
    
2792
2466
    @display_command
2793
2467
    def run(self, revno):
2794
2468
        try:
2795
2469
            revno = int(revno)
2796
2470
        except ValueError:
2797
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2798
 
                                         % revno)
2799
 
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2800
 
        self.outf.write("%s\n" % revid)
 
2471
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2472
 
 
2473
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2474
 
2802
2475
 
2803
2476
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2477
    """Export current or past revision to a destination directory or archive.
2805
2478
 
2806
2479
    If no revision is specified this exports the last committed revision.
2807
2480
 
2834
2507
               help="Type of file to export to.",
2835
2508
               type=unicode),
2836
2509
        'revision',
2837
 
        Option('filters', help='Apply content filters to export the '
2838
 
                'convenient form.'),
2839
2510
        Option('root',
2840
2511
               type=str,
2841
2512
               help="Name of the root directory inside the exported file."),
2842
 
        Option('per-file-timestamps',
2843
 
               help='Set modification time of files to that of the last '
2844
 
                    'revision in which it was changed.'),
2845
2513
        ]
2846
2514
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2515
        root=None):
2848
2516
        from bzrlib.export import export
2849
2517
 
2850
2518
        if branch_or_subdir is None:
2857
2525
 
2858
2526
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2527
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2528
            export(rev_tree, dest, format, root, subdir)
2862
2529
        except errors.NoSuchExportFormat, e:
2863
2530
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2531
 
2865
2532
 
2866
2533
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2534
    """Write the contents of a file as of a given revision to standard output.
2868
2535
 
2869
2536
    If no revision is nominated, the last revision is used.
2870
2537
 
2871
2538
    Note: Take care to redirect standard output when using this command on a
2872
 
    binary file.
 
2539
    binary file. 
2873
2540
    """
2874
2541
 
2875
2542
    _see_also = ['ls']
2876
2543
    takes_options = [
2877
2544
        Option('name-from-revision', help='The path name in the old tree.'),
2878
 
        Option('filters', help='Apply content filters to display the '
2879
 
                'convenience form.'),
2880
2545
        'revision',
2881
2546
        ]
2882
2547
    takes_args = ['filename']
2883
2548
    encoding_type = 'exact'
2884
2549
 
2885
2550
    @display_command
2886
 
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
2551
    def run(self, filename, revision=None, name_from_revision=False):
2888
2552
        if revision is not None and len(revision) != 1:
2889
2553
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2554
                                         " one revision specifier")
2891
2555
        tree, branch, relpath = \
2892
2556
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
2557
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
2895
 
        return self._run(tree, branch, relpath, filename, revision,
2896
 
                         name_from_revision, filters)
 
2558
        try:
 
2559
            return self._run(tree, branch, relpath, filename, revision,
 
2560
                             name_from_revision)
 
2561
        finally:
 
2562
            branch.unlock()
2897
2563
 
2898
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
 
        filtered):
 
2564
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2900
2565
        if tree is None:
2901
2566
            tree = b.basis_tree()
2902
2567
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2568
 
 
2569
        cur_file_id = tree.path2id(relpath)
2906
2570
        old_file_id = rev_tree.path2id(relpath)
2907
2571
 
2908
2572
        if name_from_revision:
2909
 
            # Try in revision if requested
2910
2573
            if old_file_id is None:
2911
2574
                raise errors.BzrCommandError(
2912
2575
                    "%r is not present in revision %s" % (
2913
2576
                        filename, rev_tree.get_revision_id()))
2914
2577
            else:
2915
2578
                content = rev_tree.get_file_text(old_file_id)
2916
 
        else:
2917
 
            cur_file_id = tree.path2id(relpath)
2918
 
            found = False
2919
 
            if cur_file_id is not None:
2920
 
                # Then try with the actual file id
2921
 
                try:
2922
 
                    content = rev_tree.get_file_text(cur_file_id)
2923
 
                    found = True
2924
 
                except errors.NoSuchId:
2925
 
                    # The actual file id didn't exist at that time
2926
 
                    pass
2927
 
            if not found and old_file_id is not None:
2928
 
                # Finally try with the old file id
2929
 
                content = rev_tree.get_file_text(old_file_id)
2930
 
                found = True
2931
 
            if not found:
2932
 
                # Can't be found anywhere
2933
 
                raise errors.BzrCommandError(
2934
 
                    "%r is not present in revision %s" % (
2935
 
                        filename, rev_tree.get_revision_id()))
2936
 
        if filtered:
2937
 
            from bzrlib.filters import (
2938
 
                ContentFilterContext,
2939
 
                filtered_output_bytes,
2940
 
                )
2941
 
            filters = rev_tree._content_filter_stack(relpath)
2942
 
            chunks = content.splitlines(True)
2943
 
            content = filtered_output_bytes(chunks, filters,
2944
 
                ContentFilterContext(relpath, rev_tree))
2945
 
            self.cleanup_now()
2946
 
            self.outf.writelines(content)
2947
 
        else:
2948
 
            self.cleanup_now()
2949
 
            self.outf.write(content)
 
2579
        elif cur_file_id is not None:
 
2580
            content = rev_tree.get_file_text(cur_file_id)
 
2581
        elif old_file_id is not None:
 
2582
            content = rev_tree.get_file_text(old_file_id)
 
2583
        else:
 
2584
            raise errors.BzrCommandError(
 
2585
                "%r is not present in revision %s" % (
 
2586
                    filename, rev_tree.get_revision_id()))
 
2587
        self.outf.write(content)
2950
2588
 
2951
2589
 
2952
2590
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
2954
 
    hidden = True
 
2591
    """Show the offset in seconds from GMT to local time."""
 
2592
    hidden = True    
2955
2593
    @display_command
2956
2594
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2595
        print osutils.local_time_offset()
2958
2596
 
2959
2597
 
2960
2598
 
2961
2599
class cmd_commit(Command):
2962
 
    __doc__ = """Commit changes into a new revision.
2963
 
 
2964
 
    An explanatory message needs to be given for each commit. This is
2965
 
    often done by using the --message option (getting the message from the
2966
 
    command line) or by using the --file option (getting the message from
2967
 
    a file). If neither of these options is given, an editor is opened for
2968
 
    the user to enter the message. To see the changed files in the
2969
 
    boilerplate text loaded into the editor, use the --show-diff option.
2970
 
 
2971
 
    By default, the entire tree is committed and the person doing the
2972
 
    commit is assumed to be the author. These defaults can be overridden
2973
 
    as explained below.
2974
 
 
2975
 
    :Selective commits:
2976
 
 
2977
 
      If selected files are specified, only changes to those files are
2978
 
      committed.  If a directory is specified then the directory and
2979
 
      everything within it is committed.
2980
 
  
2981
 
      When excludes are given, they take precedence over selected files.
2982
 
      For example, to commit only changes within foo, but not changes
2983
 
      within foo/bar::
2984
 
  
2985
 
        bzr commit foo -x foo/bar
2986
 
  
2987
 
      A selective commit after a merge is not yet supported.
2988
 
 
2989
 
    :Custom authors:
2990
 
 
2991
 
      If the author of the change is not the same person as the committer,
2992
 
      you can specify the author's name using the --author option. The
2993
 
      name should be in the same format as a committer-id, e.g.
2994
 
      "John Doe <jdoe@example.com>". If there is more than one author of
2995
 
      the change you can specify the option multiple times, once for each
2996
 
      author.
2997
 
  
2998
 
    :Checks:
2999
 
 
3000
 
      A common mistake is to forget to add a new file or directory before
3001
 
      running the commit command. The --strict option checks for unknown
3002
 
      files and aborts the commit if any are found. More advanced pre-commit
3003
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
3004
 
      for details.
3005
 
 
3006
 
    :Things to note:
3007
 
 
3008
 
      If you accidentially commit the wrong changes or make a spelling
3009
 
      mistake in the commit message say, you can use the uncommit command
3010
 
      to undo it. See ``bzr help uncommit`` for details.
3011
 
 
3012
 
      Hooks can also be configured to run after a commit. This allows you
3013
 
      to trigger updates to external systems like bug trackers. The --fixes
3014
 
      option can be used to record the association between a revision and
3015
 
      one or more bugs. See ``bzr help bugs`` for details.
3016
 
 
3017
 
      A selective commit may fail in some cases where the committed
3018
 
      tree would be invalid. Consider::
3019
 
  
3020
 
        bzr init foo
3021
 
        mkdir foo/bar
3022
 
        bzr add foo/bar
3023
 
        bzr commit foo -m "committing foo"
3024
 
        bzr mv foo/bar foo/baz
3025
 
        mkdir foo/bar
3026
 
        bzr add foo/bar
3027
 
        bzr commit foo/bar -m "committing bar but not baz"
3028
 
  
3029
 
      In the example above, the last commit will fail by design. This gives
3030
 
      the user the opportunity to decide whether they want to commit the
3031
 
      rename at the same time, separately first, or not at all. (As a general
3032
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2600
    """Commit changes into a new revision.
 
2601
    
 
2602
    If no arguments are given, the entire tree is committed.
 
2603
 
 
2604
    If selected files are specified, only changes to those files are
 
2605
    committed.  If a directory is specified then the directory and everything 
 
2606
    within it is committed.
 
2607
 
 
2608
    When excludes are given, they take precedence over selected files.
 
2609
    For example, too commit only changes within foo, but not changes within
 
2610
    foo/bar::
 
2611
 
 
2612
      bzr commit foo -x foo/bar
 
2613
 
 
2614
    If author of the change is not the same person as the committer, you can
 
2615
    specify the author's name using the --author option. The name should be
 
2616
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2617
 
 
2618
    A selected-file commit may fail in some cases where the committed
 
2619
    tree would be invalid. Consider::
 
2620
 
 
2621
      bzr init foo
 
2622
      mkdir foo/bar
 
2623
      bzr add foo/bar
 
2624
      bzr commit foo -m "committing foo"
 
2625
      bzr mv foo/bar foo/baz
 
2626
      mkdir foo/bar
 
2627
      bzr add foo/bar
 
2628
      bzr commit foo/bar -m "committing bar but not baz"
 
2629
 
 
2630
    In the example above, the last commit will fail by design. This gives
 
2631
    the user the opportunity to decide whether they want to commit the
 
2632
    rename at the same time, separately first, or not at all. (As a general
 
2633
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2634
 
 
2635
    Note: A selected-file commit after a merge is not yet supported.
3033
2636
    """
3034
2637
    # TODO: Run hooks on tree to-be-committed, and after commit.
3035
2638
 
3040
2643
 
3041
2644
    # XXX: verbose currently does nothing
3042
2645
 
3043
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2646
    _see_also = ['bugs', 'uncommit']
3044
2647
    takes_args = ['selected*']
3045
2648
    takes_options = [
3046
2649
            ListOption('exclude', type=str, short_name='x',
3058
2661
             Option('strict',
3059
2662
                    help="Refuse to commit if there are unknown "
3060
2663
                    "files in the working tree."),
3061
 
             Option('commit-time', type=str,
3062
 
                    help="Manually set a commit time using commit date "
3063
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3064
2664
             ListOption('fixes', type=str,
3065
 
                    help="Mark a bug as being fixed by this revision "
3066
 
                         "(see \"bzr help bugs\")."),
3067
 
             ListOption('author', type=unicode,
 
2665
                    help="Mark a bug as being fixed by this revision."),
 
2666
             Option('author', type=unicode,
3068
2667
                    help="Set the author's name, if it's different "
3069
2668
                         "from the committer."),
3070
2669
             Option('local',
3073
2672
                         "the master branch until a normal commit "
3074
2673
                         "is performed."
3075
2674
                    ),
3076
 
             Option('show-diff', short_name='p',
3077
 
                    help='When no message is supplied, show the diff along'
3078
 
                    ' with the status summary in the message editor.'),
 
2675
              Option('show-diff',
 
2676
                     help='When no message is supplied, show the diff along'
 
2677
                     ' with the status summary in the message editor.'),
3079
2678
             ]
3080
2679
    aliases = ['ci', 'checkin']
3081
2680
 
3082
 
    def _iter_bug_fix_urls(self, fixes, branch):
 
2681
    def _get_bug_fix_properties(self, fixes, branch):
 
2682
        properties = []
3083
2683
        # Configure the properties for bug fixing attributes.
3084
2684
        for fixed_bug in fixes:
3085
2685
            tokens = fixed_bug.split(':')
3086
2686
            if len(tokens) != 2:
3087
2687
                raise errors.BzrCommandError(
3088
 
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
3089
 
                    "See \"bzr help bugs\" for more information on this "
3090
 
                    "feature.\nCommit refused." % fixed_bug)
 
2688
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2689
                    "Commit refused." % fixed_bug)
3091
2690
            tag, bug_id = tokens
3092
2691
            try:
3093
 
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2692
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
3094
2693
            except errors.UnknownBugTrackerAbbreviation:
3095
2694
                raise errors.BzrCommandError(
3096
2695
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3097
 
            except errors.MalformedBugIdentifier, e:
 
2696
            except errors.MalformedBugIdentifier:
3098
2697
                raise errors.BzrCommandError(
3099
 
                    "%s\nCommit refused." % (str(e),))
 
2698
                    "Invalid bug identifier for %s. Commit refused."
 
2699
                    % fixed_bug)
 
2700
            properties.append('%s fixed' % bug_url)
 
2701
        return '\n'.join(properties)
3100
2702
 
3101
2703
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
2704
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2705
            author=None, show_diff=False, exclude=None):
3104
2706
        from bzrlib.errors import (
3105
2707
            PointlessCommit,
3106
2708
            ConflictsInTree,
3112
2714
            make_commit_message_template_encoded
3113
2715
        )
3114
2716
 
3115
 
        commit_stamp = offset = None
3116
 
        if commit_time is not None:
3117
 
            try:
3118
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3119
 
            except ValueError, e:
3120
 
                raise errors.BzrCommandError(
3121
 
                    "Could not parse --commit-time: " + str(e))
3122
 
 
3123
2717
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
2718
        # slightly problematic to run this cross-platform.
3125
2719
 
3126
 
        # TODO: do more checks that the commit will succeed before
 
2720
        # TODO: do more checks that the commit will succeed before 
3127
2721
        # spending the user's valuable time typing a commit message.
3128
2722
 
3129
2723
        properties = {}
3137
2731
 
3138
2732
        if fixes is None:
3139
2733
            fixes = []
3140
 
        bug_property = bugtracker.encode_fixes_bug_urls(
3141
 
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2734
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
3142
2735
        if bug_property:
3143
2736
            properties['bugs'] = bug_property
3144
2737
 
3145
2738
        if local and not tree.branch.get_bound_location():
3146
2739
            raise errors.LocalRequiresBoundBranch()
3147
2740
 
3148
 
        if message is not None:
3149
 
            try:
3150
 
                file_exists = osutils.lexists(message)
3151
 
            except UnicodeError:
3152
 
                # The commit message contains unicode characters that can't be
3153
 
                # represented in the filesystem encoding, so that can't be a
3154
 
                # file.
3155
 
                file_exists = False
3156
 
            if file_exists:
3157
 
                warning_msg = (
3158
 
                    'The commit message is a file name: "%(f)s".\n'
3159
 
                    '(use --file "%(f)s" to take commit message from that file)'
3160
 
                    % { 'f': message })
3161
 
                ui.ui_factory.show_warning(warning_msg)
3162
 
            if '\r' in message:
3163
 
                message = message.replace('\r\n', '\n')
3164
 
                message = message.replace('\r', '\n')
3165
 
            if file:
3166
 
                raise errors.BzrCommandError(
3167
 
                    "please specify either --message or --file")
3168
 
 
3169
2741
        def get_message(commit_obj):
3170
2742
            """Callback to get commit message"""
3171
 
            if file:
3172
 
                my_message = codecs.open(
3173
 
                    file, 'rt', osutils.get_user_encoding()).read()
3174
 
            elif message is not None:
3175
 
                my_message = message
3176
 
            else:
3177
 
                # No message supplied: make one up.
3178
 
                # text is the status of the tree
3179
 
                text = make_commit_message_template_encoded(tree,
 
2743
            my_message = message
 
2744
            if my_message is None and not file:
 
2745
                t = make_commit_message_template_encoded(tree,
3180
2746
                        selected_list, diff=show_diff,
3181
2747
                        output_encoding=osutils.get_user_encoding())
3182
 
                # start_message is the template generated from hooks
3183
 
                # XXX: Warning - looks like hooks return unicode,
3184
 
                # make_commit_message_template_encoded returns user encoding.
3185
 
                # We probably want to be using edit_commit_message instead to
3186
 
                # avoid this.
3187
2748
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
 
2749
                my_message = edit_commit_message_encoded(t, 
3189
2750
                    start_message=start_message)
3190
2751
                if my_message is None:
3191
2752
                    raise errors.BzrCommandError("please specify a commit"
3192
2753
                        " message with either --message or --file")
 
2754
            elif my_message and file:
 
2755
                raise errors.BzrCommandError(
 
2756
                    "please specify either --message or --file")
 
2757
            if file:
 
2758
                my_message = codecs.open(file, 'rt',
 
2759
                                         osutils.get_user_encoding()).read()
3193
2760
            if my_message == "":
3194
2761
                raise errors.BzrCommandError("empty commit message specified")
3195
2762
            return my_message
3196
2763
 
3197
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3198
 
        # but the command line should not do that.
3199
 
        if not selected_list:
3200
 
            selected_list = None
3201
2764
        try:
3202
2765
            tree.commit(message_callback=get_message,
3203
2766
                        specific_files=selected_list,
3204
2767
                        allow_pointless=unchanged, strict=strict, local=local,
3205
2768
                        reporter=None, verbose=verbose, revprops=properties,
3206
 
                        authors=author, timestamp=commit_stamp,
3207
 
                        timezone=offset,
 
2769
                        author=author,
3208
2770
                        exclude=safe_relpath_files(tree, exclude))
3209
2771
        except PointlessCommit:
3210
 
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
2772
            # FIXME: This should really happen before the file is read in;
 
2773
            # perhaps prepare the commit; get the message; then actually commit
 
2774
            raise errors.BzrCommandError("no changes to commit."
 
2775
                              " use --unchanged to commit anyhow")
3212
2776
        except ConflictsInTree:
3213
2777
            raise errors.BzrCommandError('Conflicts detected in working '
3214
2778
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3217
2781
            raise errors.BzrCommandError("Commit refused because there are"
3218
2782
                              " unknown files in the working tree.")
3219
2783
        except errors.BoundBranchOutOfDate, e:
3220
 
            e.extra_help = ("\n"
3221
 
                'To commit to master branch, run update and then commit.\n'
3222
 
                'You can also pass --local to commit to continue working '
3223
 
                'disconnected.')
3224
 
            raise
 
2784
            raise errors.BzrCommandError(str(e) + "\n"
 
2785
            'To commit to master branch, run update and then commit.\n'
 
2786
            'You can also pass --local to commit to continue working '
 
2787
            'disconnected.')
3225
2788
 
3226
2789
 
3227
2790
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2791
    """Validate working tree structure, branch consistency and repository history.
3229
2792
 
3230
2793
    This command checks various invariants about branch and repository storage
3231
2794
    to detect data corruption or bzr bugs.
3233
2796
    The working tree and branch checks will only give output if a problem is
3234
2797
    detected. The output fields of the repository check are:
3235
2798
 
3236
 
    revisions
3237
 
        This is just the number of revisions checked.  It doesn't
3238
 
        indicate a problem.
3239
 
 
3240
 
    versionedfiles
3241
 
        This is just the number of versionedfiles checked.  It
3242
 
        doesn't indicate a problem.
3243
 
 
3244
 
    unreferenced ancestors
3245
 
        Texts that are ancestors of other texts, but
3246
 
        are not properly referenced by the revision ancestry.  This is a
3247
 
        subtle problem that Bazaar can work around.
3248
 
 
3249
 
    unique file texts
3250
 
        This is the total number of unique file contents
3251
 
        seen in the checked revisions.  It does not indicate a problem.
3252
 
 
3253
 
    repeated file texts
3254
 
        This is the total number of repeated texts seen
3255
 
        in the checked revisions.  Texts can be repeated when their file
3256
 
        entries are modified, but the file contents are not.  It does not
3257
 
        indicate a problem.
 
2799
        revisions: This is just the number of revisions checked.  It doesn't
 
2800
            indicate a problem.
 
2801
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2802
            doesn't indicate a problem.
 
2803
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2804
            are not properly referenced by the revision ancestry.  This is a
 
2805
            subtle problem that Bazaar can work around.
 
2806
        unique file texts: This is the total number of unique file contents
 
2807
            seen in the checked revisions.  It does not indicate a problem.
 
2808
        repeated file texts: This is the total number of repeated texts seen
 
2809
            in the checked revisions.  Texts can be repeated when their file
 
2810
            entries are modified, but the file contents are not.  It does not
 
2811
            indicate a problem.
3258
2812
 
3259
2813
    If no restrictions are specified, all Bazaar data that is found at the given
3260
2814
    location will be checked.
3295
2849
 
3296
2850
 
3297
2851
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
2852
    """Upgrade branch storage to current format.
3299
2853
 
3300
2854
    The check command or bzr developers may sometimes advise you to run
3301
2855
    this command. When the default format has changed you may also be warned
3315
2869
 
3316
2870
    def run(self, url='.', format=None):
3317
2871
        from bzrlib.upgrade import upgrade
 
2872
        if format is None:
 
2873
            format = bzrdir.format_registry.make_bzrdir('default')
3318
2874
        upgrade(url, format)
3319
2875
 
3320
2876
 
3321
2877
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
3323
 
 
 
2878
    """Show or set bzr user id.
 
2879
    
3324
2880
    :Examples:
3325
2881
        Show the email of the current user::
3326
2882
 
3338
2894
                    ]
3339
2895
    takes_args = ['name?']
3340
2896
    encoding_type = 'replace'
3341
 
 
 
2897
    
3342
2898
    @display_command
3343
2899
    def run(self, email=False, branch=False, name=None):
3344
2900
        if name is None:
3359
2915
        except errors.NoEmailInUsername, e:
3360
2916
            warning('"%s" does not seem to contain an email address.  '
3361
2917
                    'This is allowed, but not recommended.', name)
3362
 
 
 
2918
        
3363
2919
        # use global config unless --branch given
3364
2920
        if branch:
3365
2921
            c = Branch.open_containing('.')[0].get_config()
3369
2925
 
3370
2926
 
3371
2927
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
 
2928
    """Print or set the branch nickname.
3373
2929
 
3374
2930
    If unset, the tree root directory name is used as the nickname.
3375
2931
    To print the current nickname, execute with no argument.
3389
2945
 
3390
2946
    @display_command
3391
2947
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
2948
        print branch.nick
3393
2949
 
3394
2950
 
3395
2951
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
2952
    """Set/unset and display aliases.
3397
2953
 
3398
2954
    :Examples:
3399
2955
        Show the current aliases::
3463
3019
 
3464
3020
 
3465
3021
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
3467
 
 
 
3022
    """Run internal test suite.
 
3023
    
3468
3024
    If arguments are given, they are regular expressions that say which tests
3469
3025
    should run.  Tests matching any expression are run, and other tests are
3470
3026
    not run.
3493
3049
    modified by plugins will not be tested, and tests provided by plugins will
3494
3050
    not be run.
3495
3051
 
3496
 
    Tests that need working space on disk use a common temporary directory,
 
3052
    Tests that need working space on disk use a common temporary directory, 
3497
3053
    typically inside $TMPDIR or /tmp.
3498
3054
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
3055
    :Examples:
3503
3056
        Run only tests relating to 'ignore'::
3504
3057
 
3513
3066
    def get_transport_type(typestring):
3514
3067
        """Parse and return a transport specifier."""
3515
3068
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
3069
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3070
            return SFTPAbsoluteServer
3518
3071
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
3072
            from bzrlib.transport.memory import MemoryServer
 
3073
            return MemoryServer
3521
3074
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
3075
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3076
            return FakeNFSServer
3524
3077
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
3078
            (typestring)
3526
3079
        raise errors.BzrCommandError(msg)
3541
3094
                     Option('lsprof-timed',
3542
3095
                            help='Generate lsprof output for benchmarked'
3543
3096
                                 ' sections of code.'),
3544
 
                     Option('lsprof-tests',
3545
 
                            help='Generate lsprof output for each test.'),
3546
3097
                     Option('cache-dir', type=str,
3547
3098
                            help='Cache intermediate benchmark output in this '
3548
3099
                                 'directory.'),
3552
3103
                            ),
3553
3104
                     Option('list-only',
3554
3105
                            help='List the tests instead of running them.'),
3555
 
                     RegistryOption('parallel',
3556
 
                        help="Run the test suite in parallel.",
3557
 
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
3558
 
                        value_switches=False,
3559
 
                        ),
3560
3106
                     Option('randomize', type=str, argname="SEED",
3561
3107
                            help='Randomize the order of tests using the given'
3562
3108
                                 ' seed or "now" for the current time.'),
3564
3110
                            short_name='x',
3565
3111
                            help='Exclude tests that match this regular'
3566
3112
                                 ' expression.'),
3567
 
                     Option('subunit',
3568
 
                        help='Output test progress via subunit.'),
3569
3113
                     Option('strict', help='Fail on missing dependencies or '
3570
3114
                            'known failures.'),
3571
3115
                     Option('load-list', type=str, argname='TESTLISTFILE',
3588
3132
            lsprof_timed=None, cache_dir=None,
3589
3133
            first=False, list_only=False,
3590
3134
            randomize=None, exclude=None, strict=False,
3591
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
 
            parallel=None, lsprof_tests=False):
 
3135
            load_list=None, debugflag=None, starting_with=None):
3593
3136
        from bzrlib.tests import selftest
3594
3137
        import bzrlib.benchmarks as benchmarks
3595
3138
        from bzrlib.benchmarks import tree_creator
3599
3142
 
3600
3143
        if cache_dir is not None:
3601
3144
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3145
        if not list_only:
 
3146
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3147
            print '   %s (%s python%s)' % (
 
3148
                    bzrlib.__path__[0],
 
3149
                    bzrlib.version_string,
 
3150
                    bzrlib._format_version_tuple(sys.version_info),
 
3151
                    )
 
3152
        print
3602
3153
        if testspecs_list is not None:
3603
3154
            pattern = '|'.join(testspecs_list)
3604
3155
        else:
3605
3156
            pattern = ".*"
3606
 
        if subunit:
3607
 
            try:
3608
 
                from bzrlib.tests import SubUnitBzrRunner
3609
 
            except ImportError:
3610
 
                raise errors.BzrCommandError("subunit not available. subunit "
3611
 
                    "needs to be installed to use --subunit.")
3612
 
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3613
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3614
 
            # stdout, which would corrupt the subunit stream. 
3615
 
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
3616
 
                import msvcrt
3617
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3618
 
        if parallel:
3619
 
            self.additional_selftest_args.setdefault(
3620
 
                'suite_decorators', []).append(parallel)
3621
3157
        if benchmark:
3622
3158
            test_suite_factory = benchmarks.test_suite
3623
3159
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3624
3160
            verbose = not is_quiet()
3625
3161
            # TODO: should possibly lock the history file...
3626
3162
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
3163
        else:
3629
3164
            test_suite_factory = None
3630
3165
            benchfile = None
3631
 
        selftest_kwargs = {"verbose": verbose,
3632
 
                          "pattern": pattern,
3633
 
                          "stop_on_failure": one,
3634
 
                          "transport": transport,
3635
 
                          "test_suite_factory": test_suite_factory,
3636
 
                          "lsprof_timed": lsprof_timed,
3637
 
                          "lsprof_tests": lsprof_tests,
3638
 
                          "bench_history": benchfile,
3639
 
                          "matching_tests_first": first,
3640
 
                          "list_only": list_only,
3641
 
                          "random_seed": randomize,
3642
 
                          "exclude_pattern": exclude,
3643
 
                          "strict": strict,
3644
 
                          "load_list": load_list,
3645
 
                          "debug_flags": debugflag,
3646
 
                          "starting_with": starting_with
3647
 
                          }
3648
 
        selftest_kwargs.update(self.additional_selftest_args)
3649
 
        result = selftest(**selftest_kwargs)
 
3166
        try:
 
3167
            selftest_kwargs = {"verbose": verbose,
 
3168
                              "pattern": pattern,
 
3169
                              "stop_on_failure": one,
 
3170
                              "transport": transport,
 
3171
                              "test_suite_factory": test_suite_factory,
 
3172
                              "lsprof_timed": lsprof_timed,
 
3173
                              "bench_history": benchfile,
 
3174
                              "matching_tests_first": first,
 
3175
                              "list_only": list_only,
 
3176
                              "random_seed": randomize,
 
3177
                              "exclude_pattern": exclude,
 
3178
                              "strict": strict,
 
3179
                              "load_list": load_list,
 
3180
                              "debug_flags": debugflag,
 
3181
                              "starting_with": starting_with
 
3182
                              }
 
3183
            selftest_kwargs.update(self.additional_selftest_args)
 
3184
            result = selftest(**selftest_kwargs)
 
3185
        finally:
 
3186
            if benchfile is not None:
 
3187
                benchfile.close()
 
3188
        if result:
 
3189
            note('tests passed')
 
3190
        else:
 
3191
            note('tests failed')
3650
3192
        return int(not result)
3651
3193
 
3652
3194
 
3653
3195
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
3196
    """Show version of bzr."""
3655
3197
 
3656
3198
    encoding_type = 'replace'
3657
3199
    takes_options = [
3668
3210
 
3669
3211
 
3670
3212
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
3213
    """Statement of optimism."""
3672
3214
 
3673
3215
    hidden = True
3674
3216
 
3675
3217
    @display_command
3676
3218
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
3219
        print "It sure does!"
3678
3220
 
3679
3221
 
3680
3222
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3223
    """Find and print a base revision for merging two branches."""
3682
3224
    # TODO: Options to specify revisions on either side, as if
3683
3225
    #       merging only part of the history.
3684
3226
    takes_args = ['branch', 'other']
3685
3227
    hidden = True
3686
 
 
 
3228
    
3687
3229
    @display_command
3688
3230
    def run(self, branch, other):
3689
3231
        from bzrlib.revision import ensure_null
3690
 
 
 
3232
        
3691
3233
        branch1 = Branch.open_containing(branch)[0]
3692
3234
        branch2 = Branch.open_containing(other)[0]
3693
3235
        branch1.lock_read()
3694
 
        self.add_cleanup(branch1.unlock)
3695
 
        branch2.lock_read()
3696
 
        self.add_cleanup(branch2.unlock)
3697
 
        last1 = ensure_null(branch1.last_revision())
3698
 
        last2 = ensure_null(branch2.last_revision())
3699
 
 
3700
 
        graph = branch1.repository.get_graph(branch2.repository)
3701
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3702
 
 
3703
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3236
        try:
 
3237
            branch2.lock_read()
 
3238
            try:
 
3239
                last1 = ensure_null(branch1.last_revision())
 
3240
                last2 = ensure_null(branch2.last_revision())
 
3241
 
 
3242
                graph = branch1.repository.get_graph(branch2.repository)
 
3243
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3244
 
 
3245
                print 'merge base is revision %s' % base_rev_id
 
3246
            finally:
 
3247
                branch2.unlock()
 
3248
        finally:
 
3249
            branch1.unlock()
3704
3250
 
3705
3251
 
3706
3252
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
3708
 
 
 
3253
    """Perform a three-way merge.
 
3254
    
3709
3255
    The source of the merge can be specified either in the form of a branch,
3710
3256
    or in the form of a path to a file containing a merge directive generated
3711
3257
    with bzr send. If neither is specified, the default is the upstream branch
3721
3267
    By default, bzr will try to merge in all new work from the other
3722
3268
    branch, automatically determining an appropriate base.  If this
3723
3269
    fails, you may need to give an explicit base.
3724
 
 
 
3270
    
3725
3271
    Merge will do its best to combine the changes in two branches, but there
3726
3272
    are some kinds of problems only a human can fix.  When it encounters those,
3727
3273
    it will mark a conflict.  A conflict means that you need to fix something,
3737
3283
    The results of the merge are placed into the destination working
3738
3284
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
3285
    committed to record the result of the merge.
3740
 
 
 
3286
    
3741
3287
    merge refuses to run if there are any uncommitted changes, unless
3742
 
    --force is given. The --force option can also be used to create a
3743
 
    merge revision which has more than two parents.
3744
 
 
3745
 
    If one would like to merge changes from the working tree of the other
3746
 
    branch without merging any committed revisions, the --uncommitted option
3747
 
    can be given.
3748
 
 
3749
 
    To select only some changes to merge, use "merge -i", which will prompt
3750
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3288
    --force is given.
3751
3289
 
3752
3290
    :Examples:
3753
3291
        To merge the latest revision from bzr.dev::
3762
3300
 
3763
3301
            bzr merge -r 81..82 ../bzr.dev
3764
3302
 
3765
 
        To apply a merge directive contained in /tmp/merge::
 
3303
        To apply a merge directive contained in in /tmp/merge:
3766
3304
 
3767
3305
            bzr merge /tmp/merge
3768
 
 
3769
 
        To create a merge revision with three parents from two branches
3770
 
        feature1a and feature1b:
3771
 
 
3772
 
            bzr merge ../feature1a
3773
 
            bzr merge ../feature1b --force
3774
 
            bzr commit -m 'revision with three parents'
3775
3306
    """
3776
3307
 
3777
3308
    encoding_type = 'exact'
3778
 
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3309
    _see_also = ['update', 'remerge', 'status-flags']
3779
3310
    takes_args = ['location?']
3780
3311
    takes_options = [
3781
3312
        'change',
3799
3330
               short_name='d',
3800
3331
               type=unicode,
3801
3332
               ),
3802
 
        Option('preview', help='Instead of merging, show a diff of the'
3803
 
               ' merge.'),
3804
 
        Option('interactive', help='Select changes interactively.',
3805
 
            short_name='i')
 
3333
        Option('preview', help='Instead of merging, show a diff of the merge.')
3806
3334
    ]
3807
3335
 
3808
3336
    def run(self, location=None, revision=None, force=False,
3810
3338
            uncommitted=False, pull=False,
3811
3339
            directory=None,
3812
3340
            preview=False,
3813
 
            interactive=False,
3814
3341
            ):
3815
3342
        if merge_type is None:
3816
3343
            merge_type = _mod_merge.Merge3Merger
3821
3348
        allow_pending = True
3822
3349
        verified = 'inapplicable'
3823
3350
        tree = WorkingTree.open_containing(directory)[0]
3824
 
 
3825
 
        try:
3826
 
            basis_tree = tree.revision_tree(tree.last_revision())
3827
 
        except errors.NoSuchRevision:
3828
 
            basis_tree = tree.basis_tree()
3829
 
 
3830
 
        # die as quickly as possible if there are uncommitted changes
3831
 
        if not force:
3832
 
            if tree.has_changes():
3833
 
                raise errors.UncommittedChanges(tree)
3834
 
 
3835
3351
        view_info = _get_view_info_for_change_reporter(tree)
3836
3352
        change_reporter = delta._ChangeReporter(
3837
3353
            unversioned_filter=tree.is_ignored, view_info=view_info)
3838
 
        pb = ui.ui_factory.nested_progress_bar()
3839
 
        self.add_cleanup(pb.finished)
3840
 
        tree.lock_write()
3841
 
        self.add_cleanup(tree.unlock)
3842
 
        if location is not None:
3843
 
            try:
3844
 
                mergeable = bundle.read_mergeable_from_url(location,
3845
 
                    possible_transports=possible_transports)
3846
 
            except errors.NotABundle:
3847
 
                mergeable = None
 
3354
        cleanups = []
 
3355
        try:
 
3356
            pb = ui.ui_factory.nested_progress_bar()
 
3357
            cleanups.append(pb.finished)
 
3358
            tree.lock_write()
 
3359
            cleanups.append(tree.unlock)
 
3360
            if location is not None:
 
3361
                try:
 
3362
                    mergeable = bundle.read_mergeable_from_url(location,
 
3363
                        possible_transports=possible_transports)
 
3364
                except errors.NotABundle:
 
3365
                    mergeable = None
 
3366
                else:
 
3367
                    if uncommitted:
 
3368
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3369
                            ' with bundles or merge directives.')
 
3370
 
 
3371
                    if revision is not None:
 
3372
                        raise errors.BzrCommandError(
 
3373
                            'Cannot use -r with merge directives or bundles')
 
3374
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3375
                       mergeable, pb)
 
3376
 
 
3377
            if merger is None and uncommitted:
 
3378
                if revision is not None and len(revision) > 0:
 
3379
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3380
                        ' --revision at the same time.')
 
3381
                location = self._select_branch_location(tree, location)[0]
 
3382
                other_tree, other_path = WorkingTree.open_containing(location)
 
3383
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3384
                    pb)
 
3385
                allow_pending = False
 
3386
                if other_path != '':
 
3387
                    merger.interesting_files = [other_path]
 
3388
 
 
3389
            if merger is None:
 
3390
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3391
                    location, revision, remember, possible_transports, pb)
 
3392
 
 
3393
            merger.merge_type = merge_type
 
3394
            merger.reprocess = reprocess
 
3395
            merger.show_base = show_base
 
3396
            self.sanity_check_merger(merger)
 
3397
            if (merger.base_rev_id == merger.other_rev_id and
 
3398
                merger.other_rev_id is not None):
 
3399
                note('Nothing to do.')
 
3400
                return 0
 
3401
            if pull:
 
3402
                if merger.interesting_files is not None:
 
3403
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3404
                if (merger.base_rev_id == tree.last_revision()):
 
3405
                    result = tree.pull(merger.other_branch, False,
 
3406
                                       merger.other_rev_id)
 
3407
                    result.report(self.outf)
 
3408
                    return 0
 
3409
            merger.check_basis(not force)
 
3410
            if preview:
 
3411
                return self._do_preview(merger)
3848
3412
            else:
3849
 
                if uncommitted:
3850
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3851
 
                        ' with bundles or merge directives.')
3852
 
 
3853
 
                if revision is not None:
3854
 
                    raise errors.BzrCommandError(
3855
 
                        'Cannot use -r with merge directives or bundles')
3856
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3857
 
                   mergeable, None)
3858
 
 
3859
 
        if merger is None and uncommitted:
3860
 
            if revision is not None and len(revision) > 0:
3861
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3862
 
                    ' --revision at the same time.')
3863
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3864
 
            allow_pending = False
3865
 
 
3866
 
        if merger is None:
3867
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3868
 
                location, revision, remember, possible_transports, None)
3869
 
 
3870
 
        merger.merge_type = merge_type
3871
 
        merger.reprocess = reprocess
3872
 
        merger.show_base = show_base
3873
 
        self.sanity_check_merger(merger)
3874
 
        if (merger.base_rev_id == merger.other_rev_id and
3875
 
            merger.other_rev_id is not None):
3876
 
            note('Nothing to do.')
3877
 
            return 0
3878
 
        if pull:
3879
 
            if merger.interesting_files is not None:
3880
 
                raise errors.BzrCommandError('Cannot pull individual files')
3881
 
            if (merger.base_rev_id == tree.last_revision()):
3882
 
                result = tree.pull(merger.other_branch, False,
3883
 
                                   merger.other_rev_id)
3884
 
                result.report(self.outf)
3885
 
                return 0
3886
 
        if merger.this_basis is None:
3887
 
            raise errors.BzrCommandError(
3888
 
                "This branch has no commits."
3889
 
                " (perhaps you would prefer 'bzr pull')")
3890
 
        if preview:
3891
 
            return self._do_preview(merger)
3892
 
        elif interactive:
3893
 
            return self._do_interactive(merger)
3894
 
        else:
3895
 
            return self._do_merge(merger, change_reporter, allow_pending,
3896
 
                                  verified)
3897
 
 
3898
 
    def _get_preview(self, merger):
 
3413
                return self._do_merge(merger, change_reporter, allow_pending,
 
3414
                                      verified)
 
3415
        finally:
 
3416
            for cleanup in reversed(cleanups):
 
3417
                cleanup()
 
3418
 
 
3419
    def _do_preview(self, merger):
 
3420
        from bzrlib.diff import show_diff_trees
3899
3421
        tree_merger = merger.make_merger()
3900
3422
        tt = tree_merger.make_preview_transform()
3901
 
        self.add_cleanup(tt.finalize)
3902
 
        result_tree = tt.get_preview_tree()
3903
 
        return result_tree
3904
 
 
3905
 
    def _do_preview(self, merger):
3906
 
        from bzrlib.diff import show_diff_trees
3907
 
        result_tree = self._get_preview(merger)
3908
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
3423
        try:
 
3424
            result_tree = tt.get_preview_tree()
 
3425
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3426
                            old_label='', new_label='')
 
3427
        finally:
 
3428
            tt.finalize()
3910
3429
 
3911
3430
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
3431
        merger.change_reporter = change_reporter
3920
3439
        else:
3921
3440
            return 0
3922
3441
 
3923
 
    def _do_interactive(self, merger):
3924
 
        """Perform an interactive merge.
3925
 
 
3926
 
        This works by generating a preview tree of the merge, then using
3927
 
        Shelver to selectively remove the differences between the working tree
3928
 
        and the preview tree.
3929
 
        """
3930
 
        from bzrlib import shelf_ui
3931
 
        result_tree = self._get_preview(merger)
3932
 
        writer = bzrlib.option.diff_writer_registry.get()
3933
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3934
 
                                   reporter=shelf_ui.ApplyReporter(),
3935
 
                                   diff_writer=writer(sys.stdout))
3936
 
        try:
3937
 
            shelver.run()
3938
 
        finally:
3939
 
            shelver.finalize()
3940
 
 
3941
3442
    def sanity_check_merger(self, merger):
3942
3443
        if (merger.show_base and
3943
3444
            not merger.merge_type is _mod_merge.Merge3Merger):
3978
3479
            base_branch, base_path = Branch.open_containing(base_loc,
3979
3480
                possible_transports)
3980
3481
        # Find the revision ids
3981
 
        other_revision_id = None
3982
 
        base_revision_id = None
3983
 
        if revision is not None:
3984
 
            if len(revision) >= 1:
3985
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
3986
 
            if len(revision) == 2:
3987
 
                base_revision_id = revision[0].as_revision_id(base_branch)
3988
 
        if other_revision_id is None:
 
3482
        if revision is None or len(revision) < 1 or revision[-1] is None:
3989
3483
            other_revision_id = _mod_revision.ensure_null(
3990
3484
                other_branch.last_revision())
 
3485
        else:
 
3486
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3487
        if (revision is not None and len(revision) == 2
 
3488
            and revision[0] is not None):
 
3489
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3490
        else:
 
3491
            base_revision_id = None
3991
3492
        # Remember where we merge from
3992
3493
        if ((remember or tree.branch.get_submit_branch() is None) and
3993
3494
             user_location is not None):
4002
3503
            allow_pending = True
4003
3504
        return merger, allow_pending
4004
3505
 
4005
 
    def get_merger_from_uncommitted(self, tree, location, pb):
4006
 
        """Get a merger for uncommitted changes.
4007
 
 
4008
 
        :param tree: The tree the merger should apply to.
4009
 
        :param location: The location containing uncommitted changes.
4010
 
        :param pb: The progress bar to use for showing progress.
4011
 
        """
4012
 
        location = self._select_branch_location(tree, location)[0]
4013
 
        other_tree, other_path = WorkingTree.open_containing(location)
4014
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4015
 
        if other_path != '':
4016
 
            merger.interesting_files = [other_path]
4017
 
        return merger
4018
 
 
4019
3506
    def _select_branch_location(self, tree, user_location, revision=None,
4020
3507
                                index=None):
4021
3508
        """Select a branch location, according to possible inputs.
4065
3552
 
4066
3553
 
4067
3554
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3555
    """Redo a merge.
4069
3556
 
4070
3557
    Use this if you want to try a different merge technique while resolving
4071
 
    conflicts.  Some merge techniques are better than others, and remerge
 
3558
    conflicts.  Some merge techniques are better than others, and remerge 
4072
3559
    lets you try different ones on different files.
4073
3560
 
4074
3561
    The options for remerge have the same meaning and defaults as the ones for
4078
3565
    :Examples:
4079
3566
        Re-do the merge of all conflicted files, and show the base text in
4080
3567
        conflict regions, in addition to the usual THIS and OTHER texts::
4081
 
 
 
3568
      
4082
3569
            bzr remerge --show-base
4083
3570
 
4084
3571
        Re-do the merge of "foobar", using the weave merge algorithm, with
4085
3572
        additional processing to reduce the size of conflict regions::
4086
 
 
 
3573
      
4087
3574
            bzr remerge --merge-type weave --reprocess foobar
4088
3575
    """
4089
3576
    takes_args = ['file*']
4096
3583
 
4097
3584
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3585
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3586
        if merge_type is None:
4101
3587
            merge_type = _mod_merge.Merge3Merger
4102
3588
        tree, file_list = tree_files(file_list)
4103
3589
        tree.lock_write()
4104
 
        self.add_cleanup(tree.unlock)
4105
 
        parents = tree.get_parent_ids()
4106
 
        if len(parents) != 2:
4107
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4108
 
                                         " merges.  Not cherrypicking or"
4109
 
                                         " multi-merges.")
4110
 
        repository = tree.branch.repository
4111
 
        interesting_ids = None
4112
 
        new_conflicts = []
4113
 
        conflicts = tree.conflicts()
4114
 
        if file_list is not None:
4115
 
            interesting_ids = set()
4116
 
            for filename in file_list:
4117
 
                file_id = tree.path2id(filename)
4118
 
                if file_id is None:
4119
 
                    raise errors.NotVersionedError(filename)
4120
 
                interesting_ids.add(file_id)
4121
 
                if tree.kind(file_id) != "directory":
4122
 
                    continue
4123
 
 
4124
 
                for name, ie in tree.inventory.iter_entries(file_id):
4125
 
                    interesting_ids.add(ie.file_id)
4126
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4127
 
        else:
4128
 
            # Remerge only supports resolving contents conflicts
4129
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4130
 
            restore_files = [c.path for c in conflicts
4131
 
                             if c.typestring in allowed_conflicts]
4132
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4133
 
        tree.set_conflicts(ConflictList(new_conflicts))
4134
 
        if file_list is not None:
4135
 
            restore_files = file_list
4136
 
        for filename in restore_files:
 
3590
        try:
 
3591
            parents = tree.get_parent_ids()
 
3592
            if len(parents) != 2:
 
3593
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3594
                                             " merges.  Not cherrypicking or"
 
3595
                                             " multi-merges.")
 
3596
            repository = tree.branch.repository
 
3597
            interesting_ids = None
 
3598
            new_conflicts = []
 
3599
            conflicts = tree.conflicts()
 
3600
            if file_list is not None:
 
3601
                interesting_ids = set()
 
3602
                for filename in file_list:
 
3603
                    file_id = tree.path2id(filename)
 
3604
                    if file_id is None:
 
3605
                        raise errors.NotVersionedError(filename)
 
3606
                    interesting_ids.add(file_id)
 
3607
                    if tree.kind(file_id) != "directory":
 
3608
                        continue
 
3609
                    
 
3610
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3611
                        interesting_ids.add(ie.file_id)
 
3612
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3613
            else:
 
3614
                # Remerge only supports resolving contents conflicts
 
3615
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3616
                restore_files = [c.path for c in conflicts
 
3617
                                 if c.typestring in allowed_conflicts]
 
3618
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3619
            tree.set_conflicts(ConflictList(new_conflicts))
 
3620
            if file_list is not None:
 
3621
                restore_files = file_list
 
3622
            for filename in restore_files:
 
3623
                try:
 
3624
                    restore(tree.abspath(filename))
 
3625
                except errors.NotConflicted:
 
3626
                    pass
 
3627
            # Disable pending merges, because the file texts we are remerging
 
3628
            # have not had those merges performed.  If we use the wrong parents
 
3629
            # list, we imply that the working tree text has seen and rejected
 
3630
            # all the changes from the other tree, when in fact those changes
 
3631
            # have not yet been seen.
 
3632
            pb = ui.ui_factory.nested_progress_bar()
 
3633
            tree.set_parent_ids(parents[:1])
4137
3634
            try:
4138
 
                restore(tree.abspath(filename))
4139
 
            except errors.NotConflicted:
4140
 
                pass
4141
 
        # Disable pending merges, because the file texts we are remerging
4142
 
        # have not had those merges performed.  If we use the wrong parents
4143
 
        # list, we imply that the working tree text has seen and rejected
4144
 
        # all the changes from the other tree, when in fact those changes
4145
 
        # have not yet been seen.
4146
 
        tree.set_parent_ids(parents[:1])
4147
 
        try:
4148
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4149
 
            merger.interesting_ids = interesting_ids
4150
 
            merger.merge_type = merge_type
4151
 
            merger.show_base = show_base
4152
 
            merger.reprocess = reprocess
4153
 
            conflicts = merger.do_merge()
 
3635
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3636
                                                             tree, parents[1])
 
3637
                merger.interesting_ids = interesting_ids
 
3638
                merger.merge_type = merge_type
 
3639
                merger.show_base = show_base
 
3640
                merger.reprocess = reprocess
 
3641
                conflicts = merger.do_merge()
 
3642
            finally:
 
3643
                tree.set_parent_ids(parents)
 
3644
                pb.finished()
4154
3645
        finally:
4155
 
            tree.set_parent_ids(parents)
 
3646
            tree.unlock()
4156
3647
        if conflicts > 0:
4157
3648
            return 1
4158
3649
        else:
4160
3651
 
4161
3652
 
4162
3653
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
3654
    """Revert files to a previous revision.
4164
3655
 
4165
3656
    Giving a list of files will revert only those files.  Otherwise, all files
4166
3657
    will be reverted.  If the revision is not specified with '--revision', the
4170
3661
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4171
3662
    changes introduced by -2, without affecting the changes introduced by -1.
4172
3663
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4173
 
 
 
3664
    
4174
3665
    By default, any files that have been manually changed will be backed up
4175
3666
    first.  (Files changed only by merge are not backed up.)  Backup files have
4176
3667
    '.~#~' appended to their name, where # is a number.
4180
3671
    name.  If you name a directory, all the contents of that directory will be
4181
3672
    reverted.
4182
3673
 
4183
 
    If you have newly added files since the target revision, they will be
4184
 
    removed.  If the files to be removed have been changed, backups will be
4185
 
    created as above.  Directories containing unknown files will not be
4186
 
    deleted.
 
3674
    Any files that have been newly added since that revision will be deleted,
 
3675
    with a backup kept if appropriate.  Directories containing unknown files
 
3676
    will not be deleted.
4187
3677
 
4188
 
    The working tree contains a list of revisions that have been merged but
4189
 
    not yet committed. These revisions will be included as additional parents
4190
 
    of the next commit.  Normally, using revert clears that list as well as
4191
 
    reverting the files.  If any files are specified, revert leaves the list
4192
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4193
 
    .`` in the tree root to revert all files but keep the recorded merges,
4194
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3678
    The working tree contains a list of pending merged revisions, which will
 
3679
    be included as parents in the next commit.  Normally, revert clears that
 
3680
    list as well as reverting the files.  If any files are specified, revert
 
3681
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3682
    revert ." in the tree root to revert all files but keep the merge record,
 
3683
    and "bzr revert --forget-merges" to clear the pending merge list without
4195
3684
    reverting any files.
4196
 
 
4197
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4198
 
    changes from a branch in a single revision.  To do this, perform the merge
4199
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4200
 
    the content of the tree as it was, but it will clear the list of pending
4201
 
    merges.  The next commit will then contain all of the changes that are
4202
 
    present in the other branch, but without any other parent revisions.
4203
 
    Because this technique forgets where these changes originated, it may
4204
 
    cause additional conflicts on later merges involving the same source and
4205
 
    target branches.
4206
3685
    """
4207
3686
 
4208
3687
    _see_also = ['cat', 'export']
4217
3696
    def run(self, revision=None, no_backup=False, file_list=None,
4218
3697
            forget_merges=None):
4219
3698
        tree, file_list = tree_files(file_list)
4220
 
        tree.lock_tree_write()
4221
 
        self.add_cleanup(tree.unlock)
4222
 
        if forget_merges:
4223
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4224
 
        else:
4225
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3699
        tree.lock_write()
 
3700
        try:
 
3701
            if forget_merges:
 
3702
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3703
            else:
 
3704
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3705
        finally:
 
3706
            tree.unlock()
4226
3707
 
4227
3708
    @staticmethod
4228
3709
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
3710
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
3711
        pb = ui.ui_factory.nested_progress_bar()
 
3712
        try:
 
3713
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3714
                report_changes=True)
 
3715
        finally:
 
3716
            pb.finished()
4232
3717
 
4233
3718
 
4234
3719
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
3720
    """Test reporting of assertion failures"""
4236
3721
    # intended just for use in testing
4237
3722
 
4238
3723
    hidden = True
4242
3727
 
4243
3728
 
4244
3729
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
3730
    """Show help on a command or other topic.
4246
3731
    """
4247
3732
 
4248
3733
    _see_also = ['topics']
4251
3736
            ]
4252
3737
    takes_args = ['topic?']
4253
3738
    aliases = ['?', '--help', '-?', '-h']
4254
 
 
 
3739
    
4255
3740
    @display_command
4256
3741
    def run(self, topic=None, long=False):
4257
3742
        import bzrlib.help
4261
3746
 
4262
3747
 
4263
3748
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
3749
    """Show appropriate completions for context.
4265
3750
 
4266
3751
    For a list of all available commands, say 'bzr shell-complete'.
4267
3752
    """
4268
3753
    takes_args = ['context?']
4269
3754
    aliases = ['s-c']
4270
3755
    hidden = True
4271
 
 
 
3756
    
4272
3757
    @display_command
4273
3758
    def run(self, context=None):
4274
3759
        import shellcomplete
4276
3761
 
4277
3762
 
4278
3763
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3764
    """Show unmerged/unpulled revisions between two branches.
4280
3765
 
4281
3766
    OTHER_BRANCH may be local or remote.
4282
3767
 
4283
 
    To filter on a range of revisions, you can use the command -r begin..end
 
3768
    To filter on a range of revirions, you can use the command -r begin..end
4284
3769
    -r revision requests a specific revision, -r ..end or -r begin.. are
4285
3770
    also valid.
4286
 
            
4287
 
    :Exit values:
4288
 
        1 - some missing revisions
4289
 
        0 - no missing revisions
4290
3771
 
4291
3772
    :Examples:
4292
3773
 
4330
3811
            type=_parse_revision_str,
4331
3812
            help='Filter on local branch revisions (inclusive). '
4332
3813
                'See "help revisionspec" for details.'),
4333
 
        Option('include-merges',
4334
 
               'Show all revisions in addition to the mainline ones.'),
 
3814
        Option('include-merges', 'Show merged revisions.'),
4335
3815
        ]
4336
3816
    encoding_type = 'replace'
4337
3817
 
4360
3840
            restrict = 'remote'
4361
3841
 
4362
3842
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
3843
        parent = local_branch.get_parent()
4367
3844
        if other_branch is None:
4368
3845
            other_branch = parent
4377
3854
        remote_branch = Branch.open(other_branch)
4378
3855
        if remote_branch.base == local_branch.base:
4379
3856
            remote_branch = local_branch
4380
 
        else:
4381
 
            remote_branch.lock_read()
4382
 
            self.add_cleanup(remote_branch.unlock)
4383
3857
 
4384
3858
        local_revid_range = _revision_range_to_revid_range(
4385
3859
            _get_revision_range(my_revision, local_branch,
4389
3863
            _get_revision_range(revision,
4390
3864
                remote_branch, self.name()))
4391
3865
 
4392
 
        local_extra, remote_extra = find_unmerged(
4393
 
            local_branch, remote_branch, restrict,
4394
 
            backward=not reverse,
4395
 
            include_merges=include_merges,
4396
 
            local_revid_range=local_revid_range,
4397
 
            remote_revid_range=remote_revid_range)
4398
 
 
4399
 
        if log_format is None:
4400
 
            registry = log.log_formatter_registry
4401
 
            log_format = registry.get_default(local_branch)
4402
 
        lf = log_format(to_file=self.outf,
4403
 
                        show_ids=show_ids,
4404
 
                        show_timezone='original')
4405
 
 
4406
 
        status_code = 0
4407
 
        if local_extra and not theirs_only:
4408
 
            message("You have %d extra revision(s):\n" %
4409
 
                len(local_extra))
4410
 
            for revision in iter_log_revisions(local_extra,
4411
 
                                local_branch.repository,
4412
 
                                verbose):
4413
 
                lf.log_revision(revision)
4414
 
            printed_local = True
4415
 
            status_code = 1
4416
 
        else:
4417
 
            printed_local = False
4418
 
 
4419
 
        if remote_extra and not mine_only:
4420
 
            if printed_local is True:
4421
 
                message("\n\n\n")
4422
 
            message("You are missing %d revision(s):\n" %
4423
 
                len(remote_extra))
4424
 
            for revision in iter_log_revisions(remote_extra,
4425
 
                                remote_branch.repository,
4426
 
                                verbose):
4427
 
                lf.log_revision(revision)
4428
 
            status_code = 1
4429
 
 
4430
 
        if mine_only and not local_extra:
4431
 
            # We checked local, and found nothing extra
4432
 
            message('This branch is up to date.\n')
4433
 
        elif theirs_only and not remote_extra:
4434
 
            # We checked remote, and found nothing extra
4435
 
            message('Other branch is up to date.\n')
4436
 
        elif not (mine_only or theirs_only or local_extra or
4437
 
                  remote_extra):
4438
 
            # We checked both branches, and neither one had extra
4439
 
            # revisions
4440
 
            message("Branches are up to date.\n")
4441
 
        self.cleanup_now()
 
3866
        local_branch.lock_read()
 
3867
        try:
 
3868
            remote_branch.lock_read()
 
3869
            try:
 
3870
                local_extra, remote_extra = find_unmerged(
 
3871
                    local_branch, remote_branch, restrict,
 
3872
                    backward=not reverse,
 
3873
                    include_merges=include_merges,
 
3874
                    local_revid_range=local_revid_range,
 
3875
                    remote_revid_range=remote_revid_range)
 
3876
 
 
3877
                if log_format is None:
 
3878
                    registry = log.log_formatter_registry
 
3879
                    log_format = registry.get_default(local_branch)
 
3880
                lf = log_format(to_file=self.outf,
 
3881
                                show_ids=show_ids,
 
3882
                                show_timezone='original')
 
3883
 
 
3884
                status_code = 0
 
3885
                if local_extra and not theirs_only:
 
3886
                    message("You have %d extra revision(s):\n" %
 
3887
                        len(local_extra))
 
3888
                    for revision in iter_log_revisions(local_extra,
 
3889
                                        local_branch.repository,
 
3890
                                        verbose):
 
3891
                        lf.log_revision(revision)
 
3892
                    printed_local = True
 
3893
                    status_code = 1
 
3894
                else:
 
3895
                    printed_local = False
 
3896
 
 
3897
                if remote_extra and not mine_only:
 
3898
                    if printed_local is True:
 
3899
                        message("\n\n\n")
 
3900
                    message("You are missing %d revision(s):\n" %
 
3901
                        len(remote_extra))
 
3902
                    for revision in iter_log_revisions(remote_extra,
 
3903
                                        remote_branch.repository,
 
3904
                                        verbose):
 
3905
                        lf.log_revision(revision)
 
3906
                    status_code = 1
 
3907
 
 
3908
                if mine_only and not local_extra:
 
3909
                    # We checked local, and found nothing extra
 
3910
                    message('This branch is up to date.\n')
 
3911
                elif theirs_only and not remote_extra:
 
3912
                    # We checked remote, and found nothing extra
 
3913
                    message('Other branch is up to date.\n')
 
3914
                elif not (mine_only or theirs_only or local_extra or
 
3915
                          remote_extra):
 
3916
                    # We checked both branches, and neither one had extra
 
3917
                    # revisions
 
3918
                    message("Branches are up to date.\n")
 
3919
            finally:
 
3920
                remote_branch.unlock()
 
3921
        finally:
 
3922
            local_branch.unlock()
4442
3923
        if not status_code and parent is None and other_branch is not None:
4443
3924
            local_branch.lock_write()
4444
 
            self.add_cleanup(local_branch.unlock)
4445
 
            # handle race conditions - a parent might be set while we run.
4446
 
            if local_branch.get_parent() is None:
4447
 
                local_branch.set_parent(remote_branch.base)
 
3925
            try:
 
3926
                # handle race conditions - a parent might be set while we run.
 
3927
                if local_branch.get_parent() is None:
 
3928
                    local_branch.set_parent(remote_branch.base)
 
3929
            finally:
 
3930
                local_branch.unlock()
4448
3931
        return status_code
4449
3932
 
4450
3933
 
4451
3934
class cmd_pack(Command):
4452
 
    __doc__ = """Compress the data within a repository.
4453
 
 
4454
 
    This operation compresses the data within a bazaar repository. As
4455
 
    bazaar supports automatic packing of repository, this operation is
4456
 
    normally not required to be done manually.
4457
 
 
4458
 
    During the pack operation, bazaar takes a backup of existing repository
4459
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4460
 
    automatically when it is safe to do so. To save disk space by removing
4461
 
    the backed up pack files, the --clean-obsolete-packs option may be
4462
 
    used.
4463
 
 
4464
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4465
 
    during or immediately after repacking, you may be left with a state
4466
 
    where the deletion has been written to disk but the new packs have not
4467
 
    been. In this case the repository may be unusable.
4468
 
    """
 
3935
    """Compress the data within a repository."""
4469
3936
 
4470
3937
    _see_also = ['repositories']
4471
3938
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
3939
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
3940
    def run(self, branch_or_repo='.'):
4477
3941
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
3942
        try:
4479
3943
            branch = dir.open_branch()
4480
3944
            repository = branch.repository
4481
3945
        except errors.NotBranchError:
4482
3946
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
3947
        repository.pack()
4484
3948
 
4485
3949
 
4486
3950
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
4488
 
 
 
3951
    """List the installed plugins.
 
3952
    
4489
3953
    This command displays the list of installed plugins including
4490
3954
    version of plugin and a short description of each.
4491
3955
 
4497
3961
    adding new commands, providing additional network transports and
4498
3962
    customizing log output.
4499
3963
 
4500
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4501
 
    for further information on plugins including where to find them and how to
4502
 
    install them. Instructions are also provided there on how to write new
4503
 
    plugins using the Python programming language.
 
3964
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3965
    information on plugins including where to find them and how to
 
3966
    install them. Instructions are also provided there on how to
 
3967
    write new plugins using the Python programming language.
4504
3968
    """
4505
3969
    takes_options = ['verbose']
4506
3970
 
4521
3985
                doc = '(no description)'
4522
3986
            result.append((name_ver, doc, plugin.path()))
4523
3987
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
3988
            print name_ver
 
3989
            print '   ', doc
4526
3990
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
3991
                print '   ', path
 
3992
            print
4529
3993
 
4530
3994
 
4531
3995
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
3996
    """Show testament (signing-form) of a revision."""
4533
3997
    takes_options = [
4534
3998
            'revision',
4535
3999
            Option('long', help='Produce long-format testament.'),
4548
4012
        else:
4549
4013
            b = Branch.open(branch)
4550
4014
        b.lock_read()
4551
 
        self.add_cleanup(b.unlock)
4552
 
        if revision is None:
4553
 
            rev_id = b.last_revision()
4554
 
        else:
4555
 
            rev_id = revision[0].as_revision_id(b)
4556
 
        t = testament_class.from_revision(b.repository, rev_id)
4557
 
        if long:
4558
 
            sys.stdout.writelines(t.as_text_lines())
4559
 
        else:
4560
 
            sys.stdout.write(t.as_short_text())
 
4015
        try:
 
4016
            if revision is None:
 
4017
                rev_id = b.last_revision()
 
4018
            else:
 
4019
                rev_id = revision[0].as_revision_id(b)
 
4020
            t = testament_class.from_revision(b.repository, rev_id)
 
4021
            if long:
 
4022
                sys.stdout.writelines(t.as_text_lines())
 
4023
            else:
 
4024
                sys.stdout.write(t.as_short_text())
 
4025
        finally:
 
4026
            b.unlock()
4561
4027
 
4562
4028
 
4563
4029
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
4030
    """Show the origin of each line in a file.
4565
4031
 
4566
4032
    This prints out the given file with an annotation on the left side
4567
4033
    indicating which revision, author and date introduced the change.
4568
4034
 
4569
 
    If the origin is the same for a run of consecutive lines, it is
 
4035
    If the origin is the same for a run of consecutive lines, it is 
4570
4036
    shown only at the top, unless the --all option is given.
4571
4037
    """
4572
4038
    # TODO: annotate directories; showing when each file was last changed
4573
 
    # TODO: if the working copy is modified, show annotations on that
 
4039
    # TODO: if the working copy is modified, show annotations on that 
4574
4040
    #       with new uncommitted lines marked
4575
4041
    aliases = ['ann', 'blame', 'praise']
4576
4042
    takes_args = ['filename']
4589
4055
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
4056
        if wt is not None:
4591
4057
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
4593
4058
        else:
4594
4059
            branch.lock_read()
4595
 
            self.add_cleanup(branch.unlock)
4596
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4597
 
        tree.lock_read()
4598
 
        self.add_cleanup(tree.unlock)
4599
 
        if wt is not None:
4600
 
            file_id = wt.path2id(relpath)
4601
 
        else:
4602
 
            file_id = tree.path2id(relpath)
4603
 
        if file_id is None:
4604
 
            raise errors.NotVersionedError(filename)
4605
 
        file_version = tree.inventory[file_id].revision
4606
 
        if wt is not None and revision is None:
4607
 
            # If there is a tree and we're not annotating historical
4608
 
            # versions, annotate the working tree's content.
4609
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4610
 
                show_ids=show_ids)
4611
 
        else:
4612
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4613
 
                          show_ids=show_ids)
 
4060
        try:
 
4061
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4062
            if wt is not None:
 
4063
                file_id = wt.path2id(relpath)
 
4064
            else:
 
4065
                file_id = tree.path2id(relpath)
 
4066
            if file_id is None:
 
4067
                raise errors.NotVersionedError(filename)
 
4068
            file_version = tree.inventory[file_id].revision
 
4069
            if wt is not None and revision is None:
 
4070
                # If there is a tree and we're not annotating historical
 
4071
                # versions, annotate the working tree's content.
 
4072
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4073
                    show_ids=show_ids)
 
4074
            else:
 
4075
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4076
                              show_ids=show_ids)
 
4077
        finally:
 
4078
            if wt is not None:
 
4079
                wt.unlock()
 
4080
            else:
 
4081
                branch.unlock()
4614
4082
 
4615
4083
 
4616
4084
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4085
    """Create a digital signature for an existing revision."""
4618
4086
    # TODO be able to replace existing ones.
4619
4087
 
4620
4088
    hidden = True # is this right ?
4621
4089
    takes_args = ['revision_id*']
4622
4090
    takes_options = ['revision']
4623
 
 
 
4091
    
4624
4092
    def run(self, revision_id_list=None, revision=None):
4625
4093
        if revision_id_list is not None and revision is not None:
4626
4094
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4628
4096
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
4097
        b = WorkingTree.open_containing(u'.')[0].branch
4630
4098
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
4632
 
        return self._run(b, revision_id_list, revision)
 
4099
        try:
 
4100
            return self._run(b, revision_id_list, revision)
 
4101
        finally:
 
4102
            b.unlock()
4633
4103
 
4634
4104
    def _run(self, b, revision_id_list, revision):
4635
4105
        import bzrlib.gpg as gpg
4680
4150
 
4681
4151
 
4682
4152
class cmd_bind(Command):
4683
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4684
 
    If no branch is supplied, rebind to the last bound location.
 
4153
    """Convert the current branch into a checkout of the supplied branch.
4685
4154
 
4686
4155
    Once converted into a checkout, commits must succeed on the master branch
4687
4156
    before they will be applied to the local branch.
4688
4157
 
4689
4158
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case binding will update the local nickname to be
 
4159
    locally, in which case binding will update the the local nickname to be
4691
4160
    that of the master.
4692
4161
    """
4693
4162
 
4705
4174
                    'This format does not remember old locations.')
4706
4175
            else:
4707
4176
                if location is None:
4708
 
                    if b.get_bound_location() is not None:
4709
 
                        raise errors.BzrCommandError('Branch is already bound')
4710
 
                    else:
4711
 
                        raise errors.BzrCommandError('No location supplied '
4712
 
                            'and no previous location known')
 
4177
                    raise errors.BzrCommandError('No location supplied and no '
 
4178
                        'previous location known')
4713
4179
        b_other = Branch.open(location)
4714
4180
        try:
4715
4181
            b.bind(b_other)
4721
4187
 
4722
4188
 
4723
4189
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4190
    """Convert the current checkout into a regular branch.
4725
4191
 
4726
4192
    After unbinding, the local branch is considered independent and subsequent
4727
4193
    commits will be local only.
4738
4204
 
4739
4205
 
4740
4206
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
4207
    """Remove the last committed revision.
4742
4208
 
4743
4209
    --verbose will print out what is being removed.
4744
4210
    --dry-run will go through all the motions, but not actually
4785
4251
 
4786
4252
        if tree is not None:
4787
4253
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
4789
4254
        else:
4790
4255
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
4792
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4256
        try:
 
4257
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4258
                             local=local)
 
4259
        finally:
 
4260
            if tree is not None:
 
4261
                tree.unlock()
 
4262
            else:
 
4263
                b.unlock()
4793
4264
 
4794
4265
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4795
4266
        from bzrlib.log import log_formatter, show_log
4827
4298
                 end_revision=last_revno)
4828
4299
 
4829
4300
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
4301
            print 'Dry-run, pretending to remove the above revisions.'
 
4302
            if not force:
 
4303
                val = raw_input('Press <enter> to continue')
4832
4304
        else:
4833
 
            self.outf.write('The above revision(s) will be removed.\n')
4834
 
 
4835
 
        if not force:
4836
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4837
 
                self.outf.write('Canceled')
4838
 
                return 0
 
4305
            print 'The above revision(s) will be removed.'
 
4306
            if not force:
 
4307
                val = raw_input('Are you sure [y/N]? ')
 
4308
                if val.lower() not in ('y', 'yes'):
 
4309
                    print 'Canceled'
 
4310
                    return 0
4839
4311
 
4840
4312
        mutter('Uncommitting from {%s} to {%s}',
4841
4313
               last_rev_id, rev_id)
4842
4314
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
4315
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4316
        note('You can restore the old tip by running:\n'
 
4317
             '  bzr pull . -r revid:%s', last_rev_id)
4846
4318
 
4847
4319
 
4848
4320
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4321
    """Break a dead lock on a repository, branch or working directory.
4850
4322
 
4851
4323
    CAUTION: Locks should only be broken when you are sure that the process
4852
4324
    holding the lock has been stopped.
4853
4325
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
4856
 
 
 
4326
    You can get information on what locks are open via the 'bzr info' command.
 
4327
    
4857
4328
    :Examples:
4858
4329
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
4330
    """
4861
4331
    takes_args = ['location?']
4862
4332
 
4868
4338
            control.break_lock()
4869
4339
        except NotImplementedError:
4870
4340
            pass
4871
 
 
 
4341
        
4872
4342
 
4873
4343
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4344
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
4345
 
4876
4346
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
4347
    """
4885
4355
 
4886
4356
 
4887
4357
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
4358
    """Run the bzr server."""
4889
4359
 
4890
4360
    aliases = ['server']
4891
4361
 
4892
4362
    takes_options = [
4893
4363
        Option('inet',
4894
4364
               help='Serve on stdin/out for use from inetd or sshd.'),
4895
 
        RegistryOption('protocol',
4896
 
               help="Protocol to serve.",
4897
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4898
 
               value_switches=True),
4899
4365
        Option('port',
4900
4366
               help='Listen for connections on nominated port of the form '
4901
4367
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4902
 
                    'result in a dynamically allocated port.  The default port '
4903
 
                    'depends on the protocol.',
 
4368
                    'result in a dynamically allocated port.  The default port is '
 
4369
                    '4155.',
4904
4370
               type=str),
4905
4371
        Option('directory',
4906
4372
               help='Serve contents of this directory.',
4908
4374
        Option('allow-writes',
4909
4375
               help='By default the server is a readonly server.  Supplying '
4910
4376
                    '--allow-writes enables write access to the contents of '
4911
 
                    'the served directory and below.  Note that ``bzr serve`` '
4912
 
                    'does not perform authentication, so unless some form of '
4913
 
                    'external authentication is arranged supplying this '
4914
 
                    'option leads to global uncontrolled write access to your '
4915
 
                    'file system.'
 
4377
                    'the served directory and below.'
4916
4378
                ),
4917
4379
        ]
4918
4380
 
 
4381
    def run_smart_server(self, smart_server):
 
4382
        """Run 'smart_server' forever, with no UI output at all."""
 
4383
        # For the duration of this server, no UI output is permitted. note
 
4384
        # that this may cause problems with blackbox tests. This should be
 
4385
        # changed with care though, as we dont want to use bandwidth sending
 
4386
        # progress over stderr to smart server clients!
 
4387
        from bzrlib import lockdir
 
4388
        old_factory = ui.ui_factory
 
4389
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4390
        try:
 
4391
            ui.ui_factory = ui.SilentUIFactory()
 
4392
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4393
            smart_server.serve()
 
4394
        finally:
 
4395
            ui.ui_factory = old_factory
 
4396
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4397
 
4919
4398
    def get_host_and_port(self, port):
4920
4399
        """Return the host and port to run the smart server on.
4921
4400
 
4922
 
        If 'port' is None, None will be returned for the host and port.
 
4401
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4402
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
4923
4403
 
4924
4404
        If 'port' has a colon in it, the string before the colon will be
4925
4405
        interpreted as the host.
4928
4408
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4929
4409
            and port is an integer TCP/IP port.
4930
4410
        """
4931
 
        host = None
4932
 
        if port is not None:
 
4411
        from bzrlib.smart import medium
 
4412
        host = medium.BZR_DEFAULT_INTERFACE
 
4413
        if port is None:
 
4414
            port = medium.BZR_DEFAULT_PORT
 
4415
        else:
4933
4416
            if ':' in port:
4934
4417
                host, port = port.split(':')
4935
4418
            port = int(port)
4936
4419
        return host, port
4937
4420
 
4938
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4939
 
            protocol=None):
4940
 
        from bzrlib.transport import get_transport, transport_server_registry
 
4421
    def get_smart_server(self, transport, inet, port):
 
4422
        """Construct a smart server.
 
4423
 
 
4424
        :param transport: The base transport from which branches will be
 
4425
            served.
 
4426
        :param inet: If True, serve over stdin and stdout. Used for running
 
4427
            from inet.
 
4428
        :param port: The port to listen on. By default, it's `
 
4429
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4430
            information.
 
4431
        :return: A smart server.
 
4432
        """
 
4433
        from bzrlib.smart import medium, server
 
4434
        if inet:
 
4435
            smart_server = medium.SmartServerPipeStreamMedium(
 
4436
                sys.stdin, sys.stdout, transport)
 
4437
        else:
 
4438
            host, port = self.get_host_and_port(port)
 
4439
            smart_server = server.SmartTCPServer(
 
4440
                transport, host=host, port=port)
 
4441
            note('listening on port: %s' % smart_server.port)
 
4442
        return smart_server
 
4443
 
 
4444
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4445
        from bzrlib.transport import get_transport
 
4446
        from bzrlib.transport.chroot import ChrootServer
4941
4447
        if directory is None:
4942
4448
            directory = os.getcwd()
4943
 
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
4945
 
        host, port = self.get_host_and_port(port)
4946
4449
        url = urlutils.local_path_to_url(directory)
4947
4450
        if not allow_writes:
4948
4451
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
4452
        chroot_server = ChrootServer(get_transport(url))
 
4453
        chroot_server.setUp()
 
4454
        t = get_transport(chroot_server.get_url())
 
4455
        smart_server = self.get_smart_server(t, inet, port)
 
4456
        self.run_smart_server(smart_server)
4951
4457
 
4952
4458
 
4953
4459
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
4955
 
 
4956
 
    This command requires the target tree to be in a rich-root format.
 
4460
    """Combine a subtree into its containing tree.
 
4461
    
 
4462
    This command is for experimental use only.  It requires the target tree
 
4463
    to be in dirstate-with-subtree format, which cannot be converted into
 
4464
    earlier formats.
4957
4465
 
4958
4466
    The TREE argument should be an independent tree, inside another tree, but
4959
4467
    not part of it.  (Such trees can be produced by "bzr split", but also by
4962
4470
    The result is a combined tree, with the subtree no longer an independant
4963
4471
    part.  This is marked as a merge of the subtree into the containing tree,
4964
4472
    and all history is preserved.
 
4473
 
 
4474
    If --reference is specified, the subtree retains its independence.  It can
 
4475
    be branched by itself, and can be part of multiple projects at the same
 
4476
    time.  But operations performed in the containing tree, such as commit
 
4477
    and merge, will recurse into the subtree.
4965
4478
    """
4966
4479
 
4967
4480
    _see_also = ['split']
4968
4481
    takes_args = ['tree']
4969
4482
    takes_options = [
4970
 
            Option('reference', help='Join by reference.', hidden=True),
 
4483
            Option('reference', help='Join by reference.'),
4971
4484
            ]
 
4485
    hidden = True
4972
4486
 
4973
4487
    def run(self, tree, reference=False):
4974
4488
        sub_tree = WorkingTree.open(tree)
4992
4506
            try:
4993
4507
                containing_tree.subsume(sub_tree)
4994
4508
            except errors.BadSubsumeSource, e:
4995
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4509
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
4996
4510
                                             (tree, e.reason))
4997
4511
 
4998
4512
 
4999
4513
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4514
    """Split a subdirectory of a tree into a separate tree.
5001
4515
 
5002
4516
    This command will produce a target tree in a format that supports
5003
4517
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5008
4522
    branch.  Commits in the top-level tree will not apply to the new subtree.
5009
4523
    """
5010
4524
 
5011
 
    _see_also = ['join']
 
4525
    # join is not un-hidden yet
 
4526
    #_see_also = ['join']
5012
4527
    takes_args = ['tree']
5013
4528
 
5014
4529
    def run(self, tree):
5019
4534
        try:
5020
4535
            containing_tree.extract(sub_id)
5021
4536
        except errors.RootNotRich:
5022
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4537
            raise errors.UpgradeRequired(containing_tree.branch.base)
5023
4538
 
5024
4539
 
5025
4540
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4541
    """Generate a merge directive for auto-merge tools.
5027
4542
 
5028
4543
    A directive requests a merge to be performed, and also provides all the
5029
4544
    information necessary to do so.  This means it must either include a
5122
4637
 
5123
4638
 
5124
4639
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4640
    """Mail or create a merge-directive for submitting changes.
5126
4641
 
5127
4642
    A merge directive provides many things needed for requesting merges:
5128
4643
 
5134
4649
      directly from the merge directive, without retrieving data from a
5135
4650
      branch.
5136
4651
 
5137
 
    `bzr send` creates a compact data set that, when applied using bzr
5138
 
    merge, has the same effect as merging from the source branch.  
5139
 
    
5140
 
    By default the merge directive is self-contained and can be applied to any
5141
 
    branch containing submit_branch in its ancestory without needing access to
5142
 
    the source branch.
5143
 
    
5144
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5145
 
    revisions, but only a structured request to merge from the
5146
 
    public_location.  In that case the public_branch is needed and it must be
5147
 
    up-to-date and accessible to the recipient.  The public_branch is always
5148
 
    included if known, so that people can check it later.
5149
 
 
5150
 
    The submit branch defaults to the parent of the source branch, but can be
5151
 
    overridden.  Both submit branch and public branch will be remembered in
5152
 
    branch.conf the first time they are used for a particular branch.  The
5153
 
    source branch defaults to that containing the working directory, but can
5154
 
    be changed using --from.
5155
 
 
5156
 
    In order to calculate those changes, bzr must analyse the submit branch.
5157
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5158
 
    If a public location is known for the submit_branch, that location is used
5159
 
    in the merge directive.
5160
 
 
5161
 
    The default behaviour is to send the merge directive by mail, unless -o is
5162
 
    given, in which case it is sent to a file.
 
4652
    If --no-bundle is specified, then public_branch is needed (and must be
 
4653
    up-to-date), so that the receiver can perform the merge using the
 
4654
    public_branch.  The public_branch is always included if known, so that
 
4655
    people can check it later.
 
4656
 
 
4657
    The submit branch defaults to the parent, but can be overridden.  Both
 
4658
    submit branch and public branch will be remembered if supplied.
 
4659
 
 
4660
    If a public_branch is known for the submit_branch, that public submit
 
4661
    branch is used in the merge instructions.  This means that a local mirror
 
4662
    can be used as your actual submit branch, once you have set public_branch
 
4663
    for that mirror.
5163
4664
 
5164
4665
    Mail is sent using your preferred mail program.  This should be transparent
5165
4666
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5166
4667
    If the preferred client can't be found (or used), your editor will be used.
5167
 
 
 
4668
    
5168
4669
    To use a specific mail program, set the mail_client configuration option.
5169
4670
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5170
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5171
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5172
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5173
 
    supported clients.
 
4671
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4672
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4673
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5174
4674
 
5175
4675
    If mail is being sent, a to address is required.  This can be supplied
5176
4676
    either on the commandline, by setting the submit_to configuration
5177
 
    option in the branch itself or the child_submit_to configuration option
 
4677
    option in the branch itself or the child_submit_to configuration option 
5178
4678
    in the submit branch.
5179
4679
 
5180
4680
    Two formats are currently supported: "4" uses revision bundle format 4 and
5182
4682
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5183
4683
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5184
4684
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
5185
 
 
5186
 
    The merge directives created by bzr send may be applied using bzr merge or
5187
 
    bzr pull by specifying a file containing a merge directive as the location.
5188
 
 
5189
 
    bzr send makes extensive use of public locations to map local locations into
5190
 
    URLs that can be used by other people.  See `bzr help configuration` to
5191
 
    set them, and use `bzr info` to display them.
 
4685
    
 
4686
    Merge directives are applied using the merge command or the pull command.
5192
4687
    """
5193
4688
 
5194
4689
    encoding_type = 'exact'
5210
4705
               short_name='f',
5211
4706
               type=unicode),
5212
4707
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
4708
               help='Write merge directive to this file; '
5214
4709
                    'use - for stdout.',
5215
4710
               type=unicode),
5216
 
        Option('strict',
5217
 
               help='Refuse to send if there are uncommitted changes in'
5218
 
               ' the working tree, --no-strict disables the check.'),
5219
4711
        Option('mail-to', help='Mail the request to this address.',
5220
4712
               type=unicode),
5221
4713
        'revision',
5222
4714
        'message',
5223
 
        Option('body', help='Body for the email.', type=unicode),
5224
 
        RegistryOption('format',
5225
 
                       help='Use the specified output format.',
5226
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4715
        RegistryOption.from_kwargs('format',
 
4716
        'Use the specified output format.',
 
4717
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4718
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5227
4719
        ]
5228
4720
 
5229
4721
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
4722
            no_patch=False, revision=None, remember=False, output=None,
5231
 
            format=None, mail_to=None, message=None, body=None,
5232
 
            strict=None, **kwargs):
5233
 
        from bzrlib.send import send
5234
 
        return send(submit_branch, revision, public_branch, remember,
5235
 
                    format, no_bundle, no_patch, output,
5236
 
                    kwargs.get('from', '.'), mail_to, message, body,
5237
 
                    self.outf,
5238
 
                    strict=strict)
 
4723
            format='4', mail_to=None, message=None, **kwargs):
 
4724
        return self._run(submit_branch, revision, public_branch, remember,
 
4725
                         format, no_bundle, no_patch, output,
 
4726
                         kwargs.get('from', '.'), mail_to, message)
 
4727
 
 
4728
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4729
             no_bundle, no_patch, output, from_, mail_to, message):
 
4730
        from bzrlib.revision import NULL_REVISION
 
4731
        branch = Branch.open_containing(from_)[0]
 
4732
        if output is None:
 
4733
            outfile = cStringIO.StringIO()
 
4734
        elif output == '-':
 
4735
            outfile = self.outf
 
4736
        else:
 
4737
            outfile = open(output, 'wb')
 
4738
        # we may need to write data into branch's repository to calculate
 
4739
        # the data to send.
 
4740
        branch.lock_write()
 
4741
        try:
 
4742
            if output is None:
 
4743
                config = branch.get_config()
 
4744
                if mail_to is None:
 
4745
                    mail_to = config.get_user_option('submit_to')
 
4746
                mail_client = config.get_mail_client()
 
4747
            if remember and submit_branch is None:
 
4748
                raise errors.BzrCommandError(
 
4749
                    '--remember requires a branch to be specified.')
 
4750
            stored_submit_branch = branch.get_submit_branch()
 
4751
            remembered_submit_branch = None
 
4752
            if submit_branch is None:
 
4753
                submit_branch = stored_submit_branch
 
4754
                remembered_submit_branch = "submit"
 
4755
            else:
 
4756
                if stored_submit_branch is None or remember:
 
4757
                    branch.set_submit_branch(submit_branch)
 
4758
            if submit_branch is None:
 
4759
                submit_branch = branch.get_parent()
 
4760
                remembered_submit_branch = "parent"
 
4761
            if submit_branch is None:
 
4762
                raise errors.BzrCommandError('No submit branch known or'
 
4763
                                             ' specified')
 
4764
            if remembered_submit_branch is not None:
 
4765
                note('Using saved %s location "%s" to determine what '
 
4766
                        'changes to submit.', remembered_submit_branch,
 
4767
                        submit_branch)
 
4768
 
 
4769
            if mail_to is None:
 
4770
                submit_config = Branch.open(submit_branch).get_config()
 
4771
                mail_to = submit_config.get_user_option("child_submit_to")
 
4772
 
 
4773
            stored_public_branch = branch.get_public_branch()
 
4774
            if public_branch is None:
 
4775
                public_branch = stored_public_branch
 
4776
            elif stored_public_branch is None or remember:
 
4777
                branch.set_public_branch(public_branch)
 
4778
            if no_bundle and public_branch is None:
 
4779
                raise errors.BzrCommandError('No public branch specified or'
 
4780
                                             ' known')
 
4781
            base_revision_id = None
 
4782
            revision_id = None
 
4783
            if revision is not None:
 
4784
                if len(revision) > 2:
 
4785
                    raise errors.BzrCommandError('bzr send takes '
 
4786
                        'at most two one revision identifiers')
 
4787
                revision_id = revision[-1].as_revision_id(branch)
 
4788
                if len(revision) == 2:
 
4789
                    base_revision_id = revision[0].as_revision_id(branch)
 
4790
            if revision_id is None:
 
4791
                revision_id = branch.last_revision()
 
4792
            if revision_id == NULL_REVISION:
 
4793
                raise errors.BzrCommandError('No revisions to submit.')
 
4794
            if format == '4':
 
4795
                directive = merge_directive.MergeDirective2.from_objects(
 
4796
                    branch.repository, revision_id, time.time(),
 
4797
                    osutils.local_time_offset(), submit_branch,
 
4798
                    public_branch=public_branch, include_patch=not no_patch,
 
4799
                    include_bundle=not no_bundle, message=message,
 
4800
                    base_revision_id=base_revision_id)
 
4801
            elif format == '0.9':
 
4802
                if not no_bundle:
 
4803
                    if not no_patch:
 
4804
                        patch_type = 'bundle'
 
4805
                    else:
 
4806
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4807
                            ' permit bundle with no patch')
 
4808
                else:
 
4809
                    if not no_patch:
 
4810
                        patch_type = 'diff'
 
4811
                    else:
 
4812
                        patch_type = None
 
4813
                directive = merge_directive.MergeDirective.from_objects(
 
4814
                    branch.repository, revision_id, time.time(),
 
4815
                    osutils.local_time_offset(), submit_branch,
 
4816
                    public_branch=public_branch, patch_type=patch_type,
 
4817
                    message=message)
 
4818
 
 
4819
            outfile.writelines(directive.to_lines())
 
4820
            if output is None:
 
4821
                subject = '[MERGE] '
 
4822
                if message is not None:
 
4823
                    subject += message
 
4824
                else:
 
4825
                    revision = branch.repository.get_revision(revision_id)
 
4826
                    subject += revision.get_summary()
 
4827
                basename = directive.get_disk_name(branch)
 
4828
                mail_client.compose_merge_request(mail_to, subject,
 
4829
                                                  outfile.getvalue(), basename)
 
4830
        finally:
 
4831
            if output != '-':
 
4832
                outfile.close()
 
4833
            branch.unlock()
5239
4834
 
5240
4835
 
5241
4836
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4837
 
 
4838
    """Create a merge-directive for submitting changes.
5243
4839
 
5244
4840
    A merge directive provides many things needed for requesting merges:
5245
4841
 
5285
4881
               type=unicode),
5286
4882
        Option('output', short_name='o', help='Write directive to this file.',
5287
4883
               type=unicode),
5288
 
        Option('strict',
5289
 
               help='Refuse to bundle revisions if there are uncommitted'
5290
 
               ' changes in the working tree, --no-strict disables the check.'),
5291
4884
        'revision',
5292
 
        RegistryOption('format',
5293
 
                       help='Use the specified output format.',
5294
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4885
        RegistryOption.from_kwargs('format',
 
4886
        'Use the specified output format.',
 
4887
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4888
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5295
4889
        ]
5296
4890
    aliases = ['bundle']
5297
4891
 
5301
4895
 
5302
4896
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5303
4897
            no_patch=False, revision=None, remember=False, output=None,
5304
 
            format=None, strict=None, **kwargs):
 
4898
            format='4', **kwargs):
5305
4899
        if output is None:
5306
4900
            output = '-'
5307
 
        from bzrlib.send import send
5308
 
        return send(submit_branch, revision, public_branch, remember,
 
4901
        return self._run(submit_branch, revision, public_branch, remember,
5309
4902
                         format, no_bundle, no_patch, output,
5310
 
                         kwargs.get('from', '.'), None, None, None,
5311
 
                         self.outf, strict=strict)
 
4903
                         kwargs.get('from', '.'), None, None)
5312
4904
 
5313
4905
 
5314
4906
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
5316
 
 
 
4907
    """Create, remove or modify a tag naming a revision.
 
4908
    
5317
4909
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
4910
    (--revision) option can be given -rtag:X, where X is any previously
5319
4911
    created tag.
5321
4913
    Tags are stored in the branch.  Tags are copied from one branch to another
5322
4914
    along when you branch, push, pull or merge.
5323
4915
 
5324
 
    It is an error to give a tag name that already exists unless you pass
 
4916
    It is an error to give a tag name that already exists unless you pass 
5325
4917
    --force, in which case the tag is moved to point to the new revision.
5326
4918
 
5327
4919
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
4920
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5329
 
 
5330
 
    If no tag name is specified it will be determined through the 
5331
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5332
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5333
 
    details.
5334
4921
    """
5335
4922
 
5336
4923
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
4924
    takes_args = ['tag_name']
5338
4925
    takes_options = [
5339
4926
        Option('delete',
5340
4927
            help='Delete this tag rather than placing it.',
5350
4937
        'revision',
5351
4938
        ]
5352
4939
 
5353
 
    def run(self, tag_name=None,
 
4940
    def run(self, tag_name,
5354
4941
            delete=None,
5355
4942
            directory='.',
5356
4943
            force=None,
5358
4945
            ):
5359
4946
        branch, relpath = Branch.open_containing(directory)
5360
4947
        branch.lock_write()
5361
 
        self.add_cleanup(branch.unlock)
5362
 
        if delete:
5363
 
            if tag_name is None:
5364
 
                raise errors.BzrCommandError("No tag specified to delete.")
5365
 
            branch.tags.delete_tag(tag_name)
5366
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5367
 
        else:
5368
 
            if revision:
5369
 
                if len(revision) != 1:
5370
 
                    raise errors.BzrCommandError(
5371
 
                        "Tags can only be placed on a single revision, "
5372
 
                        "not on a range")
5373
 
                revision_id = revision[0].as_revision_id(branch)
 
4948
        try:
 
4949
            if delete:
 
4950
                branch.tags.delete_tag(tag_name)
 
4951
                self.outf.write('Deleted tag %s.\n' % tag_name)
5374
4952
            else:
5375
 
                revision_id = branch.last_revision()
5376
 
            if tag_name is None:
5377
 
                tag_name = branch.automatic_tag_name(revision_id)
5378
 
                if tag_name is None:
5379
 
                    raise errors.BzrCommandError(
5380
 
                        "Please specify a tag name.")
5381
 
            if (not force) and branch.tags.has_tag(tag_name):
5382
 
                raise errors.TagAlreadyExists(tag_name)
5383
 
            branch.tags.set_tag(tag_name, revision_id)
5384
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
4953
                if revision:
 
4954
                    if len(revision) != 1:
 
4955
                        raise errors.BzrCommandError(
 
4956
                            "Tags can only be placed on a single revision, "
 
4957
                            "not on a range")
 
4958
                    revision_id = revision[0].as_revision_id(branch)
 
4959
                else:
 
4960
                    revision_id = branch.last_revision()
 
4961
                if (not force) and branch.tags.has_tag(tag_name):
 
4962
                    raise errors.TagAlreadyExists(tag_name)
 
4963
                branch.tags.set_tag(tag_name, revision_id)
 
4964
                self.outf.write('Created tag %s.\n' % tag_name)
 
4965
        finally:
 
4966
            branch.unlock()
5385
4967
 
5386
4968
 
5387
4969
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
4970
    """List tags.
5389
4971
 
5390
4972
    This command shows a table of tag names and the revisions they reference.
5391
4973
    """
5419
5001
        if not tags:
5420
5002
            return
5421
5003
 
5422
 
        branch.lock_read()
5423
 
        self.add_cleanup(branch.unlock)
5424
5004
        if revision:
5425
 
            graph = branch.repository.get_graph()
5426
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5427
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5428
 
            # only show revisions between revid1 and revid2 (inclusive)
5429
 
            tags = [(tag, revid) for tag, revid in tags if
5430
 
                graph.is_between(revid, revid1, revid2)]
 
5005
            branch.lock_read()
 
5006
            try:
 
5007
                graph = branch.repository.get_graph()
 
5008
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5009
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5010
                # only show revisions between revid1 and revid2 (inclusive)
 
5011
                tags = [(tag, revid) for tag, revid in tags if
 
5012
                    graph.is_between(revid, revid1, revid2)]
 
5013
            finally:
 
5014
                branch.unlock()
5431
5015
        if sort == 'alpha':
5432
5016
            tags.sort()
5433
5017
        elif sort == 'time':
5443
5027
            tags.sort(key=lambda x: timestamps[x[1]])
5444
5028
        if not show_ids:
5445
5029
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5446
 
            for index, (tag, revid) in enumerate(tags):
5447
 
                try:
5448
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5449
 
                    if isinstance(revno, tuple):
5450
 
                        revno = '.'.join(map(str, revno))
5451
 
                except errors.NoSuchRevision:
5452
 
                    # Bad tag data/merges can lead to tagged revisions
5453
 
                    # which are not in this branch. Fail gracefully ...
5454
 
                    revno = '?'
5455
 
                tags[index] = (tag, revno)
5456
 
        self.cleanup_now()
 
5030
            revno_map = branch.get_revision_id_to_revno_map()
 
5031
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5032
                        for tag, revid in tags ]
5457
5033
        for tag, revspec in tags:
5458
5034
            self.outf.write('%-20s %s\n' % (tag, revspec))
5459
5035
 
5460
5036
 
5461
5037
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5038
    """Reconfigure the type of a bzr directory.
5463
5039
 
5464
5040
    A target configuration must be specified.
5465
5041
 
5495
5071
            ),
5496
5072
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5497
5073
        Option('force',
5498
 
            help='Perform reconfiguration even if local changes'
5499
 
            ' will be lost.'),
5500
 
        Option('stacked-on',
5501
 
            help='Reconfigure a branch to be stacked on another branch.',
5502
 
            type=unicode,
5503
 
            ),
5504
 
        Option('unstacked',
5505
 
            help='Reconfigure a branch to be unstacked.  This '
5506
 
                'may require copying substantial data into it.',
5507
 
            ),
 
5074
               help='Perform reconfiguration even if local changes'
 
5075
               ' will be lost.')
5508
5076
        ]
5509
5077
 
5510
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5511
 
            stacked_on=None,
5512
 
            unstacked=None):
 
5078
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5513
5079
        directory = bzrdir.BzrDir.open(location)
5514
 
        if stacked_on and unstacked:
5515
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5516
 
        elif stacked_on is not None:
5517
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5518
 
        elif unstacked:
5519
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5520
 
        # At the moment you can use --stacked-on and a different
5521
 
        # reconfiguration shape at the same time; there seems no good reason
5522
 
        # to ban it.
5523
5080
        if target_type is None:
5524
 
            if stacked_on or unstacked:
5525
 
                return
5526
 
            else:
5527
 
                raise errors.BzrCommandError('No target configuration '
5528
 
                    'specified')
 
5081
            raise errors.BzrCommandError('No target configuration specified')
5529
5082
        elif target_type == 'branch':
5530
5083
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5531
5084
        elif target_type == 'tree':
5550
5103
 
5551
5104
 
5552
5105
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
5554
 
 
 
5106
    """Set the branch of a checkout and update.
 
5107
    
5555
5108
    For lightweight checkouts, this changes the branch being referenced.
5556
5109
    For heavyweight checkouts, this checks that there are no local commits
5557
5110
    versus the current bound branch, then it makes the local branch a mirror
5568
5121
    /path/to/newbranch.
5569
5122
 
5570
5123
    Bound branches use the nickname of its master branch unless it is set
5571
 
    locally, in which case switching will update the local nickname to be
 
5124
    locally, in which case switching will update the the local nickname to be
5572
5125
    that of the master.
5573
5126
    """
5574
5127
 
5575
 
    takes_args = ['to_location?']
 
5128
    takes_args = ['to_location']
5576
5129
    takes_options = [Option('force',
5577
 
                        help='Switch even if local commits will be lost.'),
5578
 
                     'revision',
5579
 
                     Option('create-branch', short_name='b',
5580
 
                        help='Create the target branch from this one before'
5581
 
                             ' switching to it.'),
5582
 
                    ]
 
5130
                        help='Switch even if local commits will be lost.')
 
5131
                     ]
5583
5132
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
5133
    def run(self, to_location, force=False):
5586
5134
        from bzrlib import switch
5587
5135
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
5136
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5590
 
        if to_location is None:
5591
 
            if revision is None:
5592
 
                raise errors.BzrCommandError('You must supply either a'
5593
 
                                             ' revision or a location')
5594
 
            to_location = '.'
 
5137
        branch = control_dir.open_branch()
5595
5138
        try:
5596
 
            branch = control_dir.open_branch()
5597
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5139
            to_branch = Branch.open(to_location)
5598
5140
        except errors.NotBranchError:
5599
 
            branch = None
5600
 
            had_explicit_nick = False
5601
 
        if create_branch:
5602
 
            if branch is None:
5603
 
                raise errors.BzrCommandError('cannot create branch without'
5604
 
                                             ' source branch')
5605
 
            to_location = directory_service.directories.dereference(
5606
 
                              to_location)
5607
 
            if '/' not in to_location and '\\' not in to_location:
5608
 
                # This path is meant to be relative to the existing branch
5609
 
                this_url = self._get_branch_location(control_dir)
5610
 
                to_location = urlutils.join(this_url, '..', to_location)
5611
 
            to_branch = branch.bzrdir.sprout(to_location,
5612
 
                                 possible_transports=[branch.bzrdir.root_transport],
5613
 
                                 source_branch=branch).open_branch()
5614
 
        else:
5615
 
            try:
5616
 
                to_branch = Branch.open(to_location)
5617
 
            except errors.NotBranchError:
5618
 
                this_url = self._get_branch_location(control_dir)
5619
 
                to_branch = Branch.open(
5620
 
                    urlutils.join(this_url, '..', to_location))
5621
 
        if revision is not None:
5622
 
            revision = revision.as_revision_id(to_branch)
5623
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5624
 
        if had_explicit_nick:
 
5141
            this_branch = control_dir.open_branch()
 
5142
            # This may be a heavy checkout, where we want the master branch
 
5143
            this_url = this_branch.get_bound_location()
 
5144
            # If not, use a local sibling
 
5145
            if this_url is None:
 
5146
                this_url = this_branch.base
 
5147
            to_branch = Branch.open(
 
5148
                urlutils.join(this_url, '..', to_location))
 
5149
        switch.switch(control_dir, to_branch, force)
 
5150
        if branch.get_config().has_explicit_nickname():
5625
5151
            branch = control_dir.open_branch() #get the new branch!
5626
5152
            branch.nick = to_branch.nick
5627
5153
        note('Switched to branch: %s',
5628
5154
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5629
5155
 
5630
 
    def _get_branch_location(self, control_dir):
5631
 
        """Return location of branch for this control dir."""
5632
 
        try:
5633
 
            this_branch = control_dir.open_branch()
5634
 
            # This may be a heavy checkout, where we want the master branch
5635
 
            master_location = this_branch.get_bound_location()
5636
 
            if master_location is not None:
5637
 
                return master_location
5638
 
            # If not, use a local sibling
5639
 
            return this_branch.base
5640
 
        except errors.NotBranchError:
5641
 
            format = control_dir.find_branch_format()
5642
 
            if getattr(format, 'get_reference', None) is not None:
5643
 
                return format.get_reference(control_dir)
5644
 
            else:
5645
 
                return control_dir.root_transport.base
5646
 
 
5647
5156
 
5648
5157
class cmd_view(Command):
5649
 
    __doc__ = """Manage filtered views.
 
5158
    """Manage filtered views.
5650
5159
 
5651
5160
    Views provide a mask over the tree so that users can focus on
5652
5161
    a subset of a tree when doing their work. After creating a view,
5800
5309
 
5801
5310
 
5802
5311
class cmd_hooks(Command):
5803
 
    __doc__ = """Show hooks."""
 
5312
    """Show a branch's currently registered hooks.
 
5313
    """
5804
5314
 
5805
5315
    hidden = True
5806
 
 
5807
 
    def run(self):
5808
 
        for hook_key in sorted(hooks.known_hooks.keys()):
5809
 
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
5810
 
            self.outf.write("%s:\n" % type(some_hooks).__name__)
5811
 
            for hook_name, hook_point in sorted(some_hooks.items()):
5812
 
                self.outf.write("  %s:\n" % (hook_name,))
5813
 
                found_hooks = list(hook_point)
5814
 
                if found_hooks:
5815
 
                    for hook in found_hooks:
5816
 
                        self.outf.write("    %s\n" %
5817
 
                                        (some_hooks.get_hook_name(hook),))
5818
 
                else:
5819
 
                    self.outf.write("    <no hooks installed>\n")
5820
 
 
5821
 
 
5822
 
class cmd_remove_branch(Command):
5823
 
    __doc__ = """Remove a branch.
5824
 
 
5825
 
    This will remove the branch from the specified location but 
5826
 
    will keep any working tree or repository in place.
5827
 
 
5828
 
    :Examples:
5829
 
 
5830
 
      Remove the branch at repo/trunk::
5831
 
 
5832
 
        bzr remove-branch repo/trunk
5833
 
 
5834
 
    """
5835
 
 
5836
 
    takes_args = ["location?"]
5837
 
 
5838
 
    aliases = ["rmbranch"]
5839
 
 
5840
 
    def run(self, location=None):
5841
 
        if location is None:
5842
 
            location = "."
5843
 
        branch = Branch.open_containing(location)[0]
5844
 
        branch.bzrdir.destroy_branch()
5845
 
        
 
5316
    takes_args = ['path?']
 
5317
 
 
5318
    def run(self, path=None):
 
5319
        if path is None:
 
5320
            path = '.'
 
5321
        branch_hooks = Branch.open(path).hooks
 
5322
        for hook_type in branch_hooks:
 
5323
            hooks = branch_hooks[hook_type]
 
5324
            self.outf.write("%s:\n" % (hook_type,))
 
5325
            if hooks:
 
5326
                for hook in hooks:
 
5327
                    self.outf.write("  %s\n" %
 
5328
                                    (branch_hooks.get_hook_name(hook),))
 
5329
            else:
 
5330
                self.outf.write("  <no hooks installed>\n")
 
5331
 
5846
5332
 
5847
5333
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5334
    """Temporarily set aside some changes from the current tree.
5849
5335
 
5850
5336
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
5337
    ie. out of the way, until a later time when you can bring them back from
5880
5366
                       value_switches=True, enum_switch=False),
5881
5367
 
5882
5368
        Option('list', help='List shelved changes.'),
5883
 
        Option('destroy',
5884
 
               help='Destroy removed changes instead of shelving them.'),
5885
5369
    ]
5886
5370
    _see_also = ['unshelve']
5887
5371
 
5888
5372
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
 
5373
            writer=None, list=False):
5890
5374
        if list:
5891
5375
            return self.run_for_list()
5892
5376
        from bzrlib.shelf_ui import Shelver
5893
5377
        if writer is None:
5894
5378
            writer = bzrlib.option.diff_writer_registry.get()
5895
5379
        try:
5896
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5897
 
                file_list, message, destroy=destroy)
5898
 
            try:
5899
 
                shelver.run()
5900
 
            finally:
5901
 
                shelver.finalize()
 
5380
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5381
                              message).run()
5902
5382
        except errors.UserAbort:
5903
5383
            return 0
5904
5384
 
5905
5385
    def run_for_list(self):
5906
5386
        tree = WorkingTree.open_containing('.')[0]
5907
5387
        tree.lock_read()
5908
 
        self.add_cleanup(tree.unlock)
5909
 
        manager = tree.get_shelf_manager()
5910
 
        shelves = manager.active_shelves()
5911
 
        if len(shelves) == 0:
5912
 
            note('No shelved changes.')
5913
 
            return 0
5914
 
        for shelf_id in reversed(shelves):
5915
 
            message = manager.get_metadata(shelf_id).get('message')
5916
 
            if message is None:
5917
 
                message = '<no message>'
5918
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5919
 
        return 1
 
5388
        try:
 
5389
            manager = tree.get_shelf_manager()
 
5390
            shelves = manager.active_shelves()
 
5391
            if len(shelves) == 0:
 
5392
                note('No shelved changes.')
 
5393
                return 0
 
5394
            for shelf_id in reversed(shelves):
 
5395
                message = manager.get_metadata(shelf_id).get('message')
 
5396
                if message is None:
 
5397
                    message = '<no message>'
 
5398
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5399
            return 1
 
5400
        finally:
 
5401
            tree.unlock()
5920
5402
 
5921
5403
 
5922
5404
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
 
5405
    """Restore shelved changes.
5924
5406
 
5925
5407
    By default, the most recently shelved changes are restored. However if you
5926
5408
    specify a shelf by id those changes will be restored instead.  This works
5934
5416
            enum_switch=False, value_switches=True,
5935
5417
            apply="Apply changes and remove from the shelf.",
5936
5418
            dry_run="Show changes, but do not apply or remove them.",
5937
 
            preview="Instead of unshelving the changes, show the diff that "
5938
 
                    "would result from unshelving.",
5939
 
            delete_only="Delete changes without applying them.",
5940
 
            keep="Apply changes but don't delete them.",
 
5419
            delete_only="Delete changes without applying them."
5941
5420
        )
5942
5421
    ]
5943
5422
    _see_also = ['shelve']
5944
5423
 
5945
5424
    def run(self, shelf_id=None, action='apply'):
5946
5425
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
5426
        Unshelver.from_args(shelf_id, action).run()
 
5427
 
 
5428
 
 
5429
def _create_prefix(cur_transport):
 
5430
    needed = [cur_transport]
 
5431
    # Recurse upwards until we can create a directory successfully
 
5432
    while True:
 
5433
        new_transport = cur_transport.clone('..')
 
5434
        if new_transport.base == cur_transport.base:
 
5435
            raise errors.BzrCommandError(
 
5436
                "Failed to create path prefix for %s."
 
5437
                % cur_transport.base)
5948
5438
        try:
5949
 
            unshelver.run()
5950
 
        finally:
5951
 
            unshelver.tree.unlock()
5952
 
 
5953
 
 
5954
 
class cmd_clean_tree(Command):
5955
 
    __doc__ = """Remove unwanted files from working tree.
5956
 
 
5957
 
    By default, only unknown files, not ignored files, are deleted.  Versioned
5958
 
    files are never deleted.
5959
 
 
5960
 
    Another class is 'detritus', which includes files emitted by bzr during
5961
 
    normal operations and selftests.  (The value of these files decreases with
5962
 
    time.)
5963
 
 
5964
 
    If no options are specified, unknown files are deleted.  Otherwise, option
5965
 
    flags are respected, and may be combined.
5966
 
 
5967
 
    To check what clean-tree will do, use --dry-run.
5968
 
    """
5969
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5970
 
                     Option('detritus', help='Delete conflict files, merge'
5971
 
                            ' backups, and failed selftest dirs.'),
5972
 
                     Option('unknown',
5973
 
                            help='Delete files unknown to bzr (default).'),
5974
 
                     Option('dry-run', help='Show files to delete instead of'
5975
 
                            ' deleting them.'),
5976
 
                     Option('force', help='Do not prompt before deleting.')]
5977
 
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5978
 
            force=False):
5979
 
        from bzrlib.clean_tree import clean_tree
5980
 
        if not (unknown or ignored or detritus):
5981
 
            unknown = True
5982
 
        if dry_run:
5983
 
            force = True
5984
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5985
 
                   dry_run=dry_run, no_prompt=force)
5986
 
 
5987
 
 
5988
 
class cmd_reference(Command):
5989
 
    __doc__ = """list, view and set branch locations for nested trees.
5990
 
 
5991
 
    If no arguments are provided, lists the branch locations for nested trees.
5992
 
    If one argument is provided, display the branch location for that tree.
5993
 
    If two arguments are provided, set the branch location for that tree.
5994
 
    """
5995
 
 
5996
 
    hidden = True
5997
 
 
5998
 
    takes_args = ['path?', 'location?']
5999
 
 
6000
 
    def run(self, path=None, location=None):
6001
 
        branchdir = '.'
6002
 
        if path is not None:
6003
 
            branchdir = path
6004
 
        tree, branch, relpath =(
6005
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6006
 
        if path is not None:
6007
 
            path = relpath
6008
 
        if tree is None:
6009
 
            tree = branch.basis_tree()
6010
 
        if path is None:
6011
 
            info = branch._get_all_reference_info().iteritems()
6012
 
            self._display_reference_info(tree, branch, info)
 
5439
            new_transport.mkdir('.')
 
5440
        except errors.NoSuchFile:
 
5441
            needed.append(new_transport)
 
5442
            cur_transport = new_transport
6013
5443
        else:
6014
 
            file_id = tree.path2id(path)
6015
 
            if file_id is None:
6016
 
                raise errors.NotVersionedError(path)
6017
 
            if location is None:
6018
 
                info = [(file_id, branch.get_reference_info(file_id))]
6019
 
                self._display_reference_info(tree, branch, info)
6020
 
            else:
6021
 
                branch.set_reference_info(file_id, path, location)
6022
 
 
6023
 
    def _display_reference_info(self, tree, branch, info):
6024
 
        ref_list = []
6025
 
        for file_id, (path, location) in info:
6026
 
            try:
6027
 
                path = tree.id2path(file_id)
6028
 
            except errors.NoSuchId:
6029
 
                pass
6030
 
            ref_list.append((path, location))
6031
 
        for path, location in sorted(ref_list):
6032
 
            self.outf.write('%s %s\n' % (path, location))
6033
 
 
6034
 
 
6035
 
def _register_lazy_builtins():
6036
 
    # register lazy builtins from other modules; called at startup and should
6037
 
    # be only called once.
6038
 
    for (name, aliases, module_name) in [
6039
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6040
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6041
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6042
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6043
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6044
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6045
 
        ]:
6046
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5444
            break
 
5445
    # Now we only need to create child directories
 
5446
    while needed:
 
5447
        cur_transport = needed.pop()
 
5448
        cur_transport.ensure_base()
 
5449
 
 
5450
 
 
5451
# these get imported and then picked up by the scan for cmd_*
 
5452
# TODO: Some more consistent way to split command definitions across files;
 
5453
# we do need to load at least some information about them to know of 
 
5454
# aliases.  ideally we would avoid loading the implementation until the
 
5455
# details were needed.
 
5456
from bzrlib.cmd_version_info import cmd_version_info
 
5457
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5458
from bzrlib.bundle.commands import (
 
5459
    cmd_bundle_info,
 
5460
    )
 
5461
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5462
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5463
        cmd_weave_plan_merge, cmd_weave_merge_text