← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-07-22 06:00:45 UTC
  • mfrom: (4557 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4558.
  • Revision ID: mbp@sourcefrog.net-20090722060045-035t1zgpicwfyk93
merge trunk

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
20
20
 
21
21
from bzrlib.lazy_import import lazy_import
22
22
lazy_import(globals(), """
 
23
import codecs
23
24
import cStringIO
24
25
import sys
25
26
import time
30
31
    bundle,
31
32
    btree_index,
32
33
    bzrdir,
33
 
    directory_service,
34
34
    delta,
35
35
    config,
36
36
    errors,
43
43
    reconfigure,
44
44
    rename_map,
45
45
    revision as _mod_revision,
46
 
    static_tuple,
47
46
    symbol_versioning,
48
 
    timestamp,
49
47
    transport,
50
48
    ui,
51
49
    urlutils,
53
51
    )
54
52
from bzrlib.branch import Branch
55
53
from bzrlib.conflicts import ConflictList
56
 
from bzrlib.transport import memory
57
54
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
55
from bzrlib.smtp_connection import SMTPConnection
59
56
from bzrlib.workingtree import WorkingTree
60
57
""")
61
58
 
62
 
from bzrlib.commands import (
63
 
    Command,
64
 
    builtin_command_registry,
65
 
    display_command,
66
 
    )
 
59
from bzrlib.commands import Command, display_command
67
60
from bzrlib.option import (
68
61
    ListOption,
69
62
    Option,
74
67
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
68
 
76
69
 
77
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
78
70
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
71
    apply_view=True):
80
 
    return internal_tree_files(file_list, default_branch, canonicalize,
81
 
        apply_view)
 
72
    try:
 
73
        return internal_tree_files(file_list, default_branch, canonicalize,
 
74
            apply_view)
 
75
    except errors.FileInWrongBranch, e:
 
76
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
77
                                     (e.path, file_list[0]))
82
78
 
83
79
 
84
80
def tree_files_for_add(file_list):
124
120
 
125
121
 
126
122
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
127
 
    """Get a revision tree. Not suitable for commands that change the tree.
128
 
    
129
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
130
 
    and doing a commit/uncommit/pull will at best fail due to changing the
131
 
    basis revision data.
132
 
 
133
 
    If tree is passed in, it should be already locked, for lifetime management
134
 
    of the trees internal cached state.
135
 
    """
136
123
    if branch is None:
137
124
        branch = tree.branch
138
125
    if revisions is None:
148
135
 
149
136
# XXX: Bad function name; should possibly also be a class method of
150
137
# WorkingTree rather than a function.
151
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
152
138
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
153
139
    apply_view=True):
154
140
    """Convert command-line paths to a WorkingTree and relative paths.
155
141
 
156
 
    Deprecated: use WorkingTree.open_containing_paths instead.
157
 
 
158
142
    This is typically used for command-line processors that take one or
159
143
    more filenames, and infer the workingtree that contains them.
160
144
 
170
154
 
171
155
    :return: workingtree, [relative_paths]
172
156
    """
173
 
    return WorkingTree.open_containing_paths(
174
 
        file_list, default_directory='.',
175
 
        canonicalize=True,
176
 
        apply_view=True)
 
157
    if file_list is None or len(file_list) == 0:
 
158
        tree = WorkingTree.open_containing(default_branch)[0]
 
159
        if tree.supports_views() and apply_view:
 
160
            view_files = tree.views.lookup_view()
 
161
            if view_files:
 
162
                file_list = view_files
 
163
                view_str = views.view_display_str(view_files)
 
164
                note("Ignoring files outside view. View is %s" % view_str)
 
165
        return tree, file_list
 
166
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
167
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
168
        apply_view=apply_view)
 
169
 
 
170
 
 
171
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
172
    """Convert file_list into a list of relpaths in tree.
 
173
 
 
174
    :param tree: A tree to operate on.
 
175
    :param file_list: A list of user provided paths or None.
 
176
    :param apply_view: if True and a view is set, apply it or check that
 
177
        specified files are within it
 
178
    :return: A list of relative paths.
 
179
    :raises errors.PathNotChild: When a provided path is in a different tree
 
180
        than tree.
 
181
    """
 
182
    if file_list is None:
 
183
        return None
 
184
    if tree.supports_views() and apply_view:
 
185
        view_files = tree.views.lookup_view()
 
186
    else:
 
187
        view_files = []
 
188
    new_list = []
 
189
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
190
    # doesn't - fix that up here before we enter the loop.
 
191
    if canonicalize:
 
192
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
193
    else:
 
194
        fixer = tree.relpath
 
195
    for filename in file_list:
 
196
        try:
 
197
            relpath = fixer(osutils.dereference_path(filename))
 
198
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
199
                raise errors.FileOutsideView(filename, view_files)
 
200
            new_list.append(relpath)
 
201
        except errors.PathNotChild:
 
202
            raise errors.FileInWrongBranch(tree.branch, filename)
 
203
    return new_list
177
204
 
178
205
 
179
206
def _get_view_info_for_change_reporter(tree):
188
215
    return view_info
189
216
 
190
217
 
191
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
192
 
    """Open the tree or branch containing the specified file, unless
193
 
    the --directory option is used to specify a different branch."""
194
 
    if directory is not None:
195
 
        return (None, Branch.open(directory), filename)
196
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
197
 
 
198
 
 
199
218
# TODO: Make sure no commands unconditionally use the working directory as a
200
219
# branch.  If a filename argument is used, the first of them should be used to
201
220
# specify the branch.  (Perhaps this can be factored out into some kind of
203
222
# opens the branch?)
204
223
 
205
224
class cmd_status(Command):
206
 
    __doc__ = """Display status summary.
 
225
    """Display status summary.
207
226
 
208
227
    This reports on versioned and unknown files, reporting them
209
228
    grouped by state.  Possible states are:
229
248
    unknown
230
249
        Not versioned and not matching an ignore pattern.
231
250
 
232
 
    Additionally for directories, symlinks and files with an executable
233
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
234
 
    or '*' respectively.
235
 
 
236
251
    To see ignored files use 'bzr ignored'.  For details on the
237
252
    changes to file texts, use 'bzr diff'.
238
253
 
279
294
            raise errors.BzrCommandError('bzr status --revision takes exactly'
280
295
                                         ' one or two revision specifiers')
281
296
 
282
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
297
        tree, relfile_list = tree_files(file_list)
283
298
        # Avoid asking for specific files when that is not needed.
284
299
        if relfile_list == ['']:
285
300
            relfile_list = None
296
311
 
297
312
 
298
313
class cmd_cat_revision(Command):
299
 
    __doc__ = """Write out metadata for a revision.
 
314
    """Write out metadata for a revision.
300
315
 
301
316
    The revision to print can either be specified by a specific
302
317
    revision identifier, or you can use --revision.
304
319
 
305
320
    hidden = True
306
321
    takes_args = ['revision_id?']
307
 
    takes_options = ['directory', 'revision']
 
322
    takes_options = ['revision']
308
323
    # cat-revision is more for frontends so should be exact
309
324
    encoding = 'strict'
310
325
 
311
 
    def print_revision(self, revisions, revid):
312
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
313
 
        record = stream.next()
314
 
        if record.storage_kind == 'absent':
315
 
            raise errors.NoSuchRevision(revisions, revid)
316
 
        revtext = record.get_bytes_as('fulltext')
317
 
        self.outf.write(revtext.decode('utf-8'))
318
 
 
319
326
    @display_command
320
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
327
    def run(self, revision_id=None, revision=None):
321
328
        if revision_id is not None and revision is not None:
322
329
            raise errors.BzrCommandError('You can only supply one of'
323
330
                                         ' revision_id or --revision')
324
331
        if revision_id is None and revision is None:
325
332
            raise errors.BzrCommandError('You must supply either'
326
333
                                         ' --revision or a revision_id')
327
 
        b = WorkingTree.open_containing(directory)[0].branch
328
 
 
329
 
        revisions = b.repository.revisions
330
 
        if revisions is None:
331
 
            raise errors.BzrCommandError('Repository %r does not support '
332
 
                'access to raw revision texts')
333
 
 
334
 
        b.repository.lock_read()
335
 
        try:
336
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
337
 
            if revision_id is not None:
338
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
339
 
                try:
340
 
                    self.print_revision(revisions, revision_id)
341
 
                except errors.NoSuchRevision:
342
 
                    msg = "The repository %s contains no revision %s." % (
343
 
                        b.repository.base, revision_id)
344
 
                    raise errors.BzrCommandError(msg)
345
 
            elif revision is not None:
346
 
                for rev in revision:
347
 
                    if rev is None:
348
 
                        raise errors.BzrCommandError(
349
 
                            'You cannot specify a NULL revision.')
350
 
                    rev_id = rev.as_revision_id(b)
351
 
                    self.print_revision(revisions, rev_id)
352
 
        finally:
353
 
            b.repository.unlock()
354
 
        
 
334
        b = WorkingTree.open_containing(u'.')[0].branch
 
335
 
 
336
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
337
        if revision_id is not None:
 
338
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
339
            try:
 
340
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
341
            except errors.NoSuchRevision:
 
342
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
343
                    revision_id)
 
344
                raise errors.BzrCommandError(msg)
 
345
        elif revision is not None:
 
346
            for rev in revision:
 
347
                if rev is None:
 
348
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
349
                                                 ' revision.')
 
350
                rev_id = rev.as_revision_id(b)
 
351
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
352
 
355
353
 
356
354
class cmd_dump_btree(Command):
357
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
355
    """Dump the contents of a btree index file to stdout.
358
356
 
359
357
    PATH is a btree index file, it can be any URL. This includes things like
360
358
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
424
422
        for node in bt.iter_all_entries():
425
423
            # Node is made up of:
426
424
            # (index, key, value, [references])
427
 
            try:
428
 
                refs = node[3]
429
 
            except IndexError:
430
 
                refs_as_tuples = None
431
 
            else:
432
 
                refs_as_tuples = static_tuple.as_tuples(refs)
433
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
434
 
            self.outf.write('%s\n' % (as_tuple,))
 
425
            self.outf.write('%s\n' % (node[1:],))
435
426
 
436
427
 
437
428
class cmd_remove_tree(Command):
438
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
429
    """Remove the working tree from a given branch/checkout.
439
430
 
440
431
    Since a lightweight checkout is little more than a working tree
441
432
    this will refuse to run against one.
443
434
    To re-create the working tree, use "bzr checkout".
444
435
    """
445
436
    _see_also = ['checkout', 'working-trees']
446
 
    takes_args = ['location*']
 
437
    takes_args = ['location?']
447
438
    takes_options = [
448
439
        Option('force',
449
440
               help='Remove the working tree even if it has '
450
 
                    'uncommitted or shelved changes.'),
 
441
                    'uncommitted changes.'),
451
442
        ]
452
443
 
453
 
    def run(self, location_list, force=False):
454
 
        if not location_list:
455
 
            location_list=['.']
456
 
 
457
 
        for location in location_list:
458
 
            d = bzrdir.BzrDir.open(location)
459
 
            
460
 
            try:
461
 
                working = d.open_workingtree()
462
 
            except errors.NoWorkingTree:
463
 
                raise errors.BzrCommandError("No working tree to remove")
464
 
            except errors.NotLocalUrl:
465
 
                raise errors.BzrCommandError("You cannot remove the working tree"
466
 
                                             " of a remote path")
467
 
            if not force:
468
 
                if (working.has_changes()):
469
 
                    raise errors.UncommittedChanges(working)
470
 
                if working.get_shelf_manager().last_shelf() is not None:
471
 
                    raise errors.ShelvedChanges(working)
472
 
 
473
 
            if working.user_url != working.branch.user_url:
474
 
                raise errors.BzrCommandError("You cannot remove the working tree"
475
 
                                             " from a lightweight checkout")
476
 
 
477
 
            d.destroy_workingtree()
 
444
    def run(self, location='.', force=False):
 
445
        d = bzrdir.BzrDir.open(location)
 
446
 
 
447
        try:
 
448
            working = d.open_workingtree()
 
449
        except errors.NoWorkingTree:
 
450
            raise errors.BzrCommandError("No working tree to remove")
 
451
        except errors.NotLocalUrl:
 
452
            raise errors.BzrCommandError("You cannot remove the working tree"
 
453
                                         " of a remote path")
 
454
        if not force:
 
455
            # XXX: What about pending merges ? -- vila 20090629
 
456
            if working.has_changes(working.basis_tree()):
 
457
                raise errors.UncommittedChanges(working)
 
458
 
 
459
        working_path = working.bzrdir.root_transport.base
 
460
        branch_path = working.branch.bzrdir.root_transport.base
 
461
        if working_path != branch_path:
 
462
            raise errors.BzrCommandError("You cannot remove the working tree"
 
463
                                         " from a lightweight checkout")
 
464
 
 
465
        d.destroy_workingtree()
478
466
 
479
467
 
480
468
class cmd_revno(Command):
481
 
    __doc__ = """Show current revision number.
 
469
    """Show current revision number.
482
470
 
483
471
    This is equal to the number of revisions on this branch.
484
472
    """
494
482
        if tree:
495
483
            try:
496
484
                wt = WorkingTree.open_containing(location)[0]
497
 
                self.add_cleanup(wt.lock_read().unlock)
 
485
                wt.lock_read()
498
486
            except (errors.NoWorkingTree, errors.NotLocalUrl):
499
487
                raise errors.NoWorkingTree(location)
500
 
            revid = wt.last_revision()
501
488
            try:
502
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
503
 
            except errors.NoSuchRevision:
504
 
                revno_t = ('???',)
505
 
            revno = ".".join(str(n) for n in revno_t)
 
489
                revid = wt.last_revision()
 
490
                try:
 
491
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
492
                except errors.NoSuchRevision:
 
493
                    revno_t = ('???',)
 
494
                revno = ".".join(str(n) for n in revno_t)
 
495
            finally:
 
496
                wt.unlock()
506
497
        else:
507
498
            b = Branch.open_containing(location)[0]
508
 
            self.add_cleanup(b.lock_read().unlock)
509
 
            revno = b.revno()
510
 
        self.cleanup_now()
 
499
            b.lock_read()
 
500
            try:
 
501
                revno = b.revno()
 
502
            finally:
 
503
                b.unlock()
 
504
 
511
505
        self.outf.write(str(revno) + '\n')
512
506
 
513
507
 
514
508
class cmd_revision_info(Command):
515
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
509
    """Show revision number and revision id for a given revision identifier.
516
510
    """
517
511
    hidden = True
518
512
    takes_args = ['revision_info*']
519
513
    takes_options = [
520
514
        'revision',
521
 
        custom_help('directory',
 
515
        Option('directory',
522
516
            help='Branch to examine, '
523
 
                 'rather than the one containing the working directory.'),
 
517
                 'rather than the one containing the working directory.',
 
518
            short_name='d',
 
519
            type=unicode,
 
520
            ),
524
521
        Option('tree', help='Show revno of working tree'),
525
522
        ]
526
523
 
531
528
        try:
532
529
            wt = WorkingTree.open_containing(directory)[0]
533
530
            b = wt.branch
534
 
            self.add_cleanup(wt.lock_read().unlock)
 
531
            wt.lock_read()
535
532
        except (errors.NoWorkingTree, errors.NotLocalUrl):
536
533
            wt = None
537
534
            b = Branch.open_containing(directory)[0]
538
 
            self.add_cleanup(b.lock_read().unlock)
539
 
        revision_ids = []
540
 
        if revision is not None:
541
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
542
 
        if revision_info_list is not None:
543
 
            for rev_str in revision_info_list:
544
 
                rev_spec = RevisionSpec.from_string(rev_str)
545
 
                revision_ids.append(rev_spec.as_revision_id(b))
546
 
        # No arguments supplied, default to the last revision
547
 
        if len(revision_ids) == 0:
548
 
            if tree:
549
 
                if wt is None:
550
 
                    raise errors.NoWorkingTree(directory)
551
 
                revision_ids.append(wt.last_revision())
 
535
            b.lock_read()
 
536
        try:
 
537
            revision_ids = []
 
538
            if revision is not None:
 
539
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
540
            if revision_info_list is not None:
 
541
                for rev_str in revision_info_list:
 
542
                    rev_spec = RevisionSpec.from_string(rev_str)
 
543
                    revision_ids.append(rev_spec.as_revision_id(b))
 
544
            # No arguments supplied, default to the last revision
 
545
            if len(revision_ids) == 0:
 
546
                if tree:
 
547
                    if wt is None:
 
548
                        raise errors.NoWorkingTree(directory)
 
549
                    revision_ids.append(wt.last_revision())
 
550
                else:
 
551
                    revision_ids.append(b.last_revision())
 
552
 
 
553
            revinfos = []
 
554
            maxlen = 0
 
555
            for revision_id in revision_ids:
 
556
                try:
 
557
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
558
                    revno = '.'.join(str(i) for i in dotted_revno)
 
559
                except errors.NoSuchRevision:
 
560
                    revno = '???'
 
561
                maxlen = max(maxlen, len(revno))
 
562
                revinfos.append([revno, revision_id])
 
563
        finally:
 
564
            if wt is None:
 
565
                b.unlock()
552
566
            else:
553
 
                revision_ids.append(b.last_revision())
554
 
 
555
 
        revinfos = []
556
 
        maxlen = 0
557
 
        for revision_id in revision_ids:
558
 
            try:
559
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
560
 
                revno = '.'.join(str(i) for i in dotted_revno)
561
 
            except errors.NoSuchRevision:
562
 
                revno = '???'
563
 
            maxlen = max(maxlen, len(revno))
564
 
            revinfos.append([revno, revision_id])
565
 
 
566
 
        self.cleanup_now()
 
567
                wt.unlock()
 
568
 
567
569
        for ri in revinfos:
568
570
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
569
571
 
570
572
 
571
573
class cmd_add(Command):
572
 
    __doc__ = """Add specified files or directories.
 
574
    """Add specified files or directories.
573
575
 
574
576
    In non-recursive mode, all the named items are added, regardless
575
577
    of whether they were previously ignored.  A warning is given if
601
603
    branches that will be merged later (without showing the two different
602
604
    adds as a conflict). It is also useful when merging another project
603
605
    into a subdirectory of this one.
604
 
    
605
 
    Any files matching patterns in the ignore list will not be added
606
 
    unless they are explicitly mentioned.
607
606
    """
608
607
    takes_args = ['file*']
609
608
    takes_options = [
617
616
               help='Lookup file ids from this tree.'),
618
617
        ]
619
618
    encoding_type = 'replace'
620
 
    _see_also = ['remove', 'ignore']
 
619
    _see_also = ['remove']
621
620
 
622
621
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
623
622
            file_ids_from=None):
640
639
                should_print=(not is_quiet()))
641
640
 
642
641
        if base_tree:
643
 
            self.add_cleanup(base_tree.lock_read().unlock)
644
 
        tree, file_list = tree_files_for_add(file_list)
645
 
        added, ignored = tree.smart_add(file_list, not
646
 
            no_recurse, action=action, save=not dry_run)
647
 
        self.cleanup_now()
 
642
            base_tree.lock_read()
 
643
        try:
 
644
            file_list = self._maybe_expand_globs(file_list)
 
645
            tree, file_list = tree_files_for_add(file_list)
 
646
            added, ignored = tree.smart_add(file_list, not
 
647
                no_recurse, action=action, save=not dry_run)
 
648
        finally:
 
649
            if base_tree is not None:
 
650
                base_tree.unlock()
648
651
        if len(ignored) > 0:
649
652
            if verbose:
650
653
                for glob in sorted(ignored.keys()):
651
654
                    for path in ignored[glob]:
652
655
                        self.outf.write("ignored %s matching \"%s\"\n"
653
656
                                        % (path, glob))
 
657
            else:
 
658
                match_len = 0
 
659
                for glob, paths in ignored.items():
 
660
                    match_len += len(paths)
 
661
                self.outf.write("ignored %d file(s).\n" % match_len)
 
662
            self.outf.write("If you wish to add ignored files, "
 
663
                            "please add them explicitly by name. "
 
664
                            "(\"bzr ignored\" gives a list)\n")
654
665
 
655
666
 
656
667
class cmd_mkdir(Command):
657
 
    __doc__ = """Create a new versioned directory.
 
668
    """Create a new versioned directory.
658
669
 
659
670
    This is equivalent to creating the directory and then adding it.
660
671
    """
664
675
 
665
676
    def run(self, dir_list):
666
677
        for d in dir_list:
 
678
            os.mkdir(d)
667
679
            wt, dd = WorkingTree.open_containing(d)
668
 
            base = os.path.dirname(dd)
669
 
            id = wt.path2id(base)
670
 
            if id != None:
671
 
                os.mkdir(d)
672
 
                wt.add([dd])
673
 
                self.outf.write('added %s\n' % d)
674
 
            else:
675
 
                raise errors.NotVersionedError(path=base)
 
680
            wt.add([dd])
 
681
            self.outf.write('added %s\n' % d)
676
682
 
677
683
 
678
684
class cmd_relpath(Command):
679
 
    __doc__ = """Show path of a file relative to root"""
 
685
    """Show path of a file relative to root"""
680
686
 
681
687
    takes_args = ['filename']
682
688
    hidden = True
691
697
 
692
698
 
693
699
class cmd_inventory(Command):
694
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
700
    """Show inventory of the current working copy or a revision.
695
701
 
696
702
    It is possible to limit the output to a particular entry
697
703
    type using the --kind option.  For example: --kind file.
717
723
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
718
724
 
719
725
        revision = _get_one_revision('inventory', revision)
720
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
721
 
        self.add_cleanup(work_tree.lock_read().unlock)
722
 
        if revision is not None:
723
 
            tree = revision.as_tree(work_tree.branch)
724
 
 
725
 
            extra_trees = [work_tree]
726
 
            self.add_cleanup(tree.lock_read().unlock)
727
 
        else:
728
 
            tree = work_tree
729
 
            extra_trees = []
730
 
 
731
 
        if file_list is not None:
732
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
733
 
                                      require_versioned=True)
734
 
            # find_ids_across_trees may include some paths that don't
735
 
            # exist in 'tree'.
736
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
737
 
                             for file_id in file_ids if file_id in tree)
738
 
        else:
739
 
            entries = tree.inventory.entries()
740
 
 
741
 
        self.cleanup_now()
 
726
        work_tree, file_list = tree_files(file_list)
 
727
        work_tree.lock_read()
 
728
        try:
 
729
            if revision is not None:
 
730
                tree = revision.as_tree(work_tree.branch)
 
731
 
 
732
                extra_trees = [work_tree]
 
733
                tree.lock_read()
 
734
            else:
 
735
                tree = work_tree
 
736
                extra_trees = []
 
737
 
 
738
            if file_list is not None:
 
739
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
740
                                          require_versioned=True)
 
741
                # find_ids_across_trees may include some paths that don't
 
742
                # exist in 'tree'.
 
743
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
744
                                 for file_id in file_ids if file_id in tree)
 
745
            else:
 
746
                entries = tree.inventory.entries()
 
747
        finally:
 
748
            tree.unlock()
 
749
            if tree is not work_tree:
 
750
                work_tree.unlock()
 
751
 
742
752
        for path, entry in entries:
743
753
            if kind and kind != entry.kind:
744
754
                continue
750
760
 
751
761
 
752
762
class cmd_mv(Command):
753
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
754
764
 
755
765
    :Usage:
756
766
        bzr mv OLDNAME NEWNAME
788
798
            names_list = []
789
799
        if len(names_list) < 2:
790
800
            raise errors.BzrCommandError("missing file argument")
791
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
792
 
        self.add_cleanup(tree.lock_tree_write().unlock)
793
 
        self._run(tree, names_list, rel_names, after)
 
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
802
        tree.lock_tree_write()
 
803
        try:
 
804
            self._run(tree, names_list, rel_names, after)
 
805
        finally:
 
806
            tree.unlock()
794
807
 
795
808
    def run_auto(self, names_list, after, dry_run):
796
809
        if names_list is not None and len(names_list) > 1:
799
812
        if after:
800
813
            raise errors.BzrCommandError('--after cannot be specified with'
801
814
                                         ' --auto.')
802
 
        work_tree, file_list = WorkingTree.open_containing_paths(
803
 
            names_list, default_directory='.')
804
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
805
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
815
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
816
        work_tree.lock_tree_write()
 
817
        try:
 
818
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
819
        finally:
 
820
            work_tree.unlock()
806
821
 
807
822
    def _run(self, tree, names_list, rel_names, after):
808
823
        into_existing = osutils.isdir(names_list[-1])
829
844
            # All entries reference existing inventory items, so fix them up
830
845
            # for cicp file-systems.
831
846
            rel_names = tree.get_canonical_inventory_paths(rel_names)
832
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
833
 
                if not is_quiet():
834
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
847
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
848
                self.outf.write("%s => %s\n" % pair)
835
849
        else:
836
850
            if len(names_list) != 2:
837
851
                raise errors.BzrCommandError('to mv multiple files the'
881
895
            dest = osutils.pathjoin(dest_parent, dest_tail)
882
896
            mutter("attempting to move %s => %s", src, dest)
883
897
            tree.rename_one(src, dest, after=after)
884
 
            if not is_quiet():
885
 
                self.outf.write("%s => %s\n" % (src, dest))
 
898
            self.outf.write("%s => %s\n" % (src, dest))
886
899
 
887
900
 
888
901
class cmd_pull(Command):
889
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
902
    """Turn this branch into a mirror of another branch.
890
903
 
891
 
    By default, this command only works on branches that have not diverged.
892
 
    Branches are considered diverged if the destination branch's most recent 
893
 
    commit is one that has not been merged (directly or indirectly) into the 
894
 
    parent.
 
904
    This command only works on branches that have not diverged.  Branches are
 
905
    considered diverged if the destination branch's most recent commit is one
 
906
    that has not been merged (directly or indirectly) into the parent.
895
907
 
896
908
    If branches have diverged, you can use 'bzr merge' to integrate the changes
897
909
    from one into the other.  Once one branch has merged, the other should
898
910
    be able to pull it again.
899
911
 
900
 
    If you want to replace your local changes and just want your branch to
901
 
    match the remote one, use pull --overwrite. This will work even if the two
902
 
    branches have diverged.
 
912
    If you want to forget your local changes and just update your branch to
 
913
    match the remote one, use pull --overwrite.
903
914
 
904
915
    If there is no default location set, the first pull will set it.  After
905
916
    that, you can omit the location to use the default.  To change the
915
926
    takes_options = ['remember', 'overwrite', 'revision',
916
927
        custom_help('verbose',
917
928
            help='Show logs of pulled revisions.'),
918
 
        custom_help('directory',
 
929
        Option('directory',
919
930
            help='Branch to pull into, '
920
 
                 'rather than the one containing the working directory.'),
 
931
                 'rather than the one containing the working directory.',
 
932
            short_name='d',
 
933
            type=unicode,
 
934
            ),
921
935
        Option('local',
922
936
            help="Perform a local pull in a bound "
923
937
                 "branch.  Local pulls are not applied to "
938
952
        try:
939
953
            tree_to = WorkingTree.open_containing(directory)[0]
940
954
            branch_to = tree_to.branch
941
 
            self.add_cleanup(tree_to.lock_write().unlock)
942
955
        except errors.NoWorkingTree:
943
956
            tree_to = None
944
957
            branch_to = Branch.open_containing(directory)[0]
945
 
            self.add_cleanup(branch_to.lock_write().unlock)
946
 
 
 
958
        
947
959
        if local and not branch_to.get_bound_location():
948
960
            raise errors.LocalRequiresBoundBranch()
949
961
 
979
991
        else:
980
992
            branch_from = Branch.open(location,
981
993
                possible_transports=possible_transports)
982
 
            self.add_cleanup(branch_from.lock_read().unlock)
983
994
 
984
995
            if branch_to.get_parent() is None or remember:
985
996
                branch_to.set_parent(branch_from.base)
986
997
 
987
 
        if revision is not None:
988
 
            revision_id = revision.as_revision_id(branch_from)
989
 
 
990
 
        if tree_to is not None:
991
 
            view_info = _get_view_info_for_change_reporter(tree_to)
992
 
            change_reporter = delta._ChangeReporter(
993
 
                unversioned_filter=tree_to.is_ignored,
994
 
                view_info=view_info)
995
 
            result = tree_to.pull(
996
 
                branch_from, overwrite, revision_id, change_reporter,
997
 
                possible_transports=possible_transports, local=local)
998
 
        else:
999
 
            result = branch_to.pull(
1000
 
                branch_from, overwrite, revision_id, local=local)
1001
 
 
1002
 
        result.report(self.outf)
1003
 
        if verbose and result.old_revid != result.new_revid:
1004
 
            log.show_branch_change(
1005
 
                branch_to, self.outf, result.old_revno,
1006
 
                result.old_revid)
 
998
        if branch_from is not branch_to:
 
999
            branch_from.lock_read()
 
1000
        try:
 
1001
            if revision is not None:
 
1002
                revision_id = revision.as_revision_id(branch_from)
 
1003
 
 
1004
            branch_to.lock_write()
 
1005
            try:
 
1006
                if tree_to is not None:
 
1007
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
1008
                    change_reporter = delta._ChangeReporter(
 
1009
                        unversioned_filter=tree_to.is_ignored,
 
1010
                        view_info=view_info)
 
1011
                    result = tree_to.pull(
 
1012
                        branch_from, overwrite, revision_id, change_reporter,
 
1013
                        possible_transports=possible_transports, local=local)
 
1014
                else:
 
1015
                    result = branch_to.pull(
 
1016
                        branch_from, overwrite, revision_id, local=local)
 
1017
 
 
1018
                result.report(self.outf)
 
1019
                if verbose and result.old_revid != result.new_revid:
 
1020
                    log.show_branch_change(
 
1021
                        branch_to, self.outf, result.old_revno,
 
1022
                        result.old_revid)
 
1023
            finally:
 
1024
                branch_to.unlock()
 
1025
        finally:
 
1026
            if branch_from is not branch_to:
 
1027
                branch_from.unlock()
1007
1028
 
1008
1029
 
1009
1030
class cmd_push(Command):
1010
 
    __doc__ = """Update a mirror of this branch.
 
1031
    """Update a mirror of this branch.
1011
1032
 
1012
1033
    The target branch will not have its working tree populated because this
1013
1034
    is both expensive, and is not supported on remote file systems.
1037
1058
        Option('create-prefix',
1038
1059
               help='Create the path leading up to the branch '
1039
1060
                    'if it does not already exist.'),
1040
 
        custom_help('directory',
 
1061
        Option('directory',
1041
1062
            help='Branch to push from, '
1042
 
                 'rather than the one containing the working directory.'),
 
1063
                 'rather than the one containing the working directory.',
 
1064
            short_name='d',
 
1065
            type=unicode,
 
1066
            ),
1043
1067
        Option('use-existing-dir',
1044
1068
               help='By default push will fail if the target'
1045
1069
                    ' directory exists, but does not already'
1071
1095
        # Get the source branch
1072
1096
        (tree, br_from,
1073
1097
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1098
        if strict is None:
 
1099
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1100
        if strict is None: strict = True # default value
1074
1101
        # Get the tip's revision_id
1075
1102
        revision = _get_one_revision('push', revision)
1076
1103
        if revision is not None:
1077
1104
            revision_id = revision.in_history(br_from).rev_id
1078
1105
        else:
1079
1106
            revision_id = None
1080
 
        if tree is not None and revision_id is None:
1081
 
            tree.check_changed_or_out_of_date(
1082
 
                strict, 'push_strict',
1083
 
                more_error='Use --no-strict to force the push.',
1084
 
                more_warning='Uncommitted changes will not be pushed.')
 
1107
        if strict and tree is not None and revision_id is None:
 
1108
            if (tree.has_changes(tree.basis_tree())
 
1109
                or len(tree.get_parent_ids()) > 1):
 
1110
                raise errors.UncommittedChanges(
 
1111
                    tree, more='Use --no-strict to force the push.')
 
1112
            if tree.last_revision() != tree.branch.last_revision():
 
1113
                # The tree has lost sync with its branch, there is little
 
1114
                # chance that the user is aware of it but he can still force
 
1115
                # the push with --no-strict
 
1116
                raise errors.OutOfDateTree(
 
1117
                    tree, more='Use --no-strict to force the push.')
 
1118
 
1085
1119
        # Get the stacked_on branch, if any
1086
1120
        if stacked_on is not None:
1087
1121
            stacked_on = urlutils.normalize_url(stacked_on)
1119
1153
 
1120
1154
 
1121
1155
class cmd_branch(Command):
1122
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1156
    """Create a new branch that is a copy of an existing branch.
1123
1157
 
1124
1158
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1125
1159
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1134
1168
 
1135
1169
    _see_also = ['checkout']
1136
1170
    takes_args = ['from_location', 'to_location?']
1137
 
    takes_options = ['revision',
1138
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1139
 
        Option('files-from', type=str,
1140
 
               help="Get file contents from this tree."),
 
1171
    takes_options = ['revision', Option('hardlink',
 
1172
        help='Hard-link working tree files where possible.'),
1141
1173
        Option('no-tree',
1142
1174
            help="Create a branch without a working-tree."),
1143
 
        Option('switch',
1144
 
            help="Switch the checkout in the current directory "
1145
 
                 "to the new branch."),
1146
1175
        Option('stacked',
1147
1176
            help='Create a stacked branch referring to the source branch. '
1148
1177
                'The new branch will depend on the availability of the source '
1154
1183
                    ' directory exists, but does not already'
1155
1184
                    ' have a control directory.  This flag will'
1156
1185
                    ' allow branch to proceed.'),
1157
 
        Option('bind',
1158
 
            help="Bind new branch to from location."),
1159
1186
        ]
1160
1187
    aliases = ['get', 'clone']
1161
1188
 
1162
1189
    def run(self, from_location, to_location=None, revision=None,
1163
1190
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1164
 
            use_existing_dir=False, switch=False, bind=False,
1165
 
            files_from=None):
1166
 
        from bzrlib import switch as _mod_switch
 
1191
            use_existing_dir=False):
1167
1192
        from bzrlib.tag import _merge_tags_if_possible
 
1193
 
1168
1194
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1169
1195
            from_location)
1170
 
        if not (hardlink or files_from):
1171
 
            # accelerator_tree is usually slower because you have to read N
1172
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1173
 
            # explicitly request it
 
1196
        if (accelerator_tree is not None and
 
1197
            accelerator_tree.supports_content_filtering()):
1174
1198
            accelerator_tree = None
1175
 
        if files_from is not None and files_from != from_location:
1176
 
            accelerator_tree = WorkingTree.open(files_from)
1177
1199
        revision = _get_one_revision('branch', revision)
1178
 
        self.add_cleanup(br_from.lock_read().unlock)
1179
 
        if revision is not None:
1180
 
            revision_id = revision.as_revision_id(br_from)
1181
 
        else:
1182
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1183
 
            # None or perhaps NULL_REVISION to mean copy nothing
1184
 
            # RBC 20060209
1185
 
            revision_id = br_from.last_revision()
1186
 
        if to_location is None:
1187
 
            to_location = urlutils.derive_to_location(from_location)
1188
 
        to_transport = transport.get_transport(to_location)
 
1200
        br_from.lock_read()
1189
1201
        try:
1190
 
            to_transport.mkdir('.')
1191
 
        except errors.FileExists:
1192
 
            if not use_existing_dir:
1193
 
                raise errors.BzrCommandError('Target directory "%s" '
1194
 
                    'already exists.' % to_location)
 
1202
            if revision is not None:
 
1203
                revision_id = revision.as_revision_id(br_from)
1195
1204
            else:
1196
 
                try:
1197
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1198
 
                except errors.NotBranchError:
1199
 
                    pass
 
1205
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1206
                # None or perhaps NULL_REVISION to mean copy nothing
 
1207
                # RBC 20060209
 
1208
                revision_id = br_from.last_revision()
 
1209
            if to_location is None:
 
1210
                to_location = urlutils.derive_to_location(from_location)
 
1211
            to_transport = transport.get_transport(to_location)
 
1212
            try:
 
1213
                to_transport.mkdir('.')
 
1214
            except errors.FileExists:
 
1215
                if not use_existing_dir:
 
1216
                    raise errors.BzrCommandError('Target directory "%s" '
 
1217
                        'already exists.' % to_location)
1200
1218
                else:
1201
 
                    raise errors.AlreadyBranchError(to_location)
1202
 
        except errors.NoSuchFile:
1203
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1204
 
                                         % to_location)
1205
 
        try:
1206
 
            # preserve whatever source format we have.
1207
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1208
 
                                        possible_transports=[to_transport],
1209
 
                                        accelerator_tree=accelerator_tree,
1210
 
                                        hardlink=hardlink, stacked=stacked,
1211
 
                                        force_new_repo=standalone,
1212
 
                                        create_tree_if_local=not no_tree,
1213
 
                                        source_branch=br_from)
1214
 
            branch = dir.open_branch()
1215
 
        except errors.NoSuchRevision:
1216
 
            to_transport.delete_tree('.')
1217
 
            msg = "The branch %s has no revision %s." % (from_location,
1218
 
                revision)
1219
 
            raise errors.BzrCommandError(msg)
1220
 
        _merge_tags_if_possible(br_from, branch)
1221
 
        # If the source branch is stacked, the new branch may
1222
 
        # be stacked whether we asked for that explicitly or not.
1223
 
        # We therefore need a try/except here and not just 'if stacked:'
1224
 
        try:
1225
 
            note('Created new stacked branch referring to %s.' %
1226
 
                branch.get_stacked_on_url())
1227
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1228
 
            errors.UnstackableRepositoryFormat), e:
1229
 
            note('Branched %d revision(s).' % branch.revno())
1230
 
        if bind:
1231
 
            # Bind to the parent
1232
 
            parent_branch = Branch.open(from_location)
1233
 
            branch.bind(parent_branch)
1234
 
            note('New branch bound to %s' % from_location)
1235
 
        if switch:
1236
 
            # Switch to the new branch
1237
 
            wt, _ = WorkingTree.open_containing('.')
1238
 
            _mod_switch.switch(wt.bzrdir, branch)
1239
 
            note('Switched to branch: %s',
1240
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1219
                    try:
 
1220
                        bzrdir.BzrDir.open_from_transport(to_transport)
 
1221
                    except errors.NotBranchError:
 
1222
                        pass
 
1223
                    else:
 
1224
                        raise errors.AlreadyBranchError(to_location)
 
1225
            except errors.NoSuchFile:
 
1226
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1227
                                             % to_location)
 
1228
            try:
 
1229
                # preserve whatever source format we have.
 
1230
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1231
                                            possible_transports=[to_transport],
 
1232
                                            accelerator_tree=accelerator_tree,
 
1233
                                            hardlink=hardlink, stacked=stacked,
 
1234
                                            force_new_repo=standalone,
 
1235
                                            create_tree_if_local=not no_tree,
 
1236
                                            source_branch=br_from)
 
1237
                branch = dir.open_branch()
 
1238
            except errors.NoSuchRevision:
 
1239
                to_transport.delete_tree('.')
 
1240
                msg = "The branch %s has no revision %s." % (from_location,
 
1241
                    revision)
 
1242
                raise errors.BzrCommandError(msg)
 
1243
            _merge_tags_if_possible(br_from, branch)
 
1244
            # If the source branch is stacked, the new branch may
 
1245
            # be stacked whether we asked for that explicitly or not.
 
1246
            # We therefore need a try/except here and not just 'if stacked:'
 
1247
            try:
 
1248
                note('Created new stacked branch referring to %s.' %
 
1249
                    branch.get_stacked_on_url())
 
1250
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1251
                errors.UnstackableRepositoryFormat), e:
 
1252
                note('Branched %d revision(s).' % branch.revno())
 
1253
        finally:
 
1254
            br_from.unlock()
1241
1255
 
1242
1256
 
1243
1257
class cmd_checkout(Command):
1244
 
    __doc__ = """Create a new checkout of an existing branch.
 
1258
    """Create a new checkout of an existing branch.
1245
1259
 
1246
1260
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1247
1261
    the branch found in '.'. This is useful if you have removed the working tree
1286
1300
            to_location = branch_location
1287
1301
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1288
1302
            branch_location)
1289
 
        if not (hardlink or files_from):
1290
 
            # accelerator_tree is usually slower because you have to read N
1291
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1292
 
            # explicitly request it
1293
 
            accelerator_tree = None
1294
1303
        revision = _get_one_revision('checkout', revision)
1295
 
        if files_from is not None and files_from != branch_location:
 
1304
        if files_from is not None:
1296
1305
            accelerator_tree = WorkingTree.open(files_from)
1297
1306
        if revision is not None:
1298
1307
            revision_id = revision.as_revision_id(source)
1315
1324
 
1316
1325
 
1317
1326
class cmd_renames(Command):
1318
 
    __doc__ = """Show list of renamed files.
 
1327
    """Show list of renamed files.
1319
1328
    """
1320
1329
    # TODO: Option to show renames between two historical versions.
1321
1330
 
1326
1335
    @display_command
1327
1336
    def run(self, dir=u'.'):
1328
1337
        tree = WorkingTree.open_containing(dir)[0]
1329
 
        self.add_cleanup(tree.lock_read().unlock)
1330
 
        new_inv = tree.inventory
1331
 
        old_tree = tree.basis_tree()
1332
 
        self.add_cleanup(old_tree.lock_read().unlock)
1333
 
        old_inv = old_tree.inventory
1334
 
        renames = []
1335
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1336
 
        for f, paths, c, v, p, n, k, e in iterator:
1337
 
            if paths[0] == paths[1]:
1338
 
                continue
1339
 
            if None in (paths):
1340
 
                continue
1341
 
            renames.append(paths)
1342
 
        renames.sort()
1343
 
        for old_name, new_name in renames:
1344
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1338
        tree.lock_read()
 
1339
        try:
 
1340
            new_inv = tree.inventory
 
1341
            old_tree = tree.basis_tree()
 
1342
            old_tree.lock_read()
 
1343
            try:
 
1344
                old_inv = old_tree.inventory
 
1345
                renames = []
 
1346
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1347
                for f, paths, c, v, p, n, k, e in iterator:
 
1348
                    if paths[0] == paths[1]:
 
1349
                        continue
 
1350
                    if None in (paths):
 
1351
                        continue
 
1352
                    renames.append(paths)
 
1353
                renames.sort()
 
1354
                for old_name, new_name in renames:
 
1355
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1356
            finally:
 
1357
                old_tree.unlock()
 
1358
        finally:
 
1359
            tree.unlock()
1345
1360
 
1346
1361
 
1347
1362
class cmd_update(Command):
1348
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1363
    """Update a tree to have the latest code committed to its branch.
1349
1364
 
1350
1365
    This will perform a merge into the working tree, and may generate
1351
1366
    conflicts. If you have any local changes, you will still
1353
1368
 
1354
1369
    If you want to discard your local changes, you can just do a
1355
1370
    'bzr revert' instead of 'bzr commit' after the update.
1356
 
 
1357
 
    If the tree's branch is bound to a master branch, it will also update
1358
 
    the branch from the master.
1359
1371
    """
1360
1372
 
1361
1373
    _see_also = ['pull', 'working-trees', 'status-flags']
1362
1374
    takes_args = ['dir?']
1363
 
    takes_options = ['revision']
1364
1375
    aliases = ['up']
1365
1376
 
1366
 
    def run(self, dir='.', revision=None):
1367
 
        if revision is not None and len(revision) != 1:
1368
 
            raise errors.BzrCommandError(
1369
 
                        "bzr update --revision takes exactly one revision")
 
1377
    def run(self, dir='.'):
1370
1378
        tree = WorkingTree.open_containing(dir)[0]
1371
 
        branch = tree.branch
1372
1379
        possible_transports = []
1373
 
        master = branch.get_master_branch(
 
1380
        master = tree.branch.get_master_branch(
1374
1381
            possible_transports=possible_transports)
1375
1382
        if master is not None:
1376
 
            branch_location = master.base
1377
1383
            tree.lock_write()
1378
1384
        else:
1379
 
            branch_location = tree.branch.base
1380
1385
            tree.lock_tree_write()
1381
 
        self.add_cleanup(tree.unlock)
1382
 
        # get rid of the final '/' and be ready for display
1383
 
        branch_location = urlutils.unescape_for_display(
1384
 
            branch_location.rstrip('/'),
1385
 
            self.outf.encoding)
1386
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1387
 
        if master is None:
1388
 
            old_tip = None
1389
 
        else:
1390
 
            # may need to fetch data into a heavyweight checkout
1391
 
            # XXX: this may take some time, maybe we should display a
1392
 
            # message
1393
 
            old_tip = branch.update(possible_transports)
1394
 
        if revision is not None:
1395
 
            revision_id = revision[0].as_revision_id(branch)
1396
 
        else:
1397
 
            revision_id = branch.last_revision()
1398
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1399
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1400
 
            note("Tree is up to date at revision %s of branch %s" %
1401
 
                ('.'.join(map(str, revno)), branch_location))
1402
 
            return 0
1403
 
        view_info = _get_view_info_for_change_reporter(tree)
1404
 
        change_reporter = delta._ChangeReporter(
1405
 
            unversioned_filter=tree.is_ignored,
1406
 
            view_info=view_info)
1407
1386
        try:
 
1387
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1388
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1389
            if last_rev == _mod_revision.ensure_null(
 
1390
                tree.branch.last_revision()):
 
1391
                # may be up to date, check master too.
 
1392
                if master is None or last_rev == _mod_revision.ensure_null(
 
1393
                    master.last_revision()):
 
1394
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1395
                    note("Tree is up to date at revision %d." % (revno,))
 
1396
                    return 0
 
1397
            view_info = _get_view_info_for_change_reporter(tree)
1408
1398
            conflicts = tree.update(
1409
 
                change_reporter,
1410
 
                possible_transports=possible_transports,
1411
 
                revision=revision_id,
1412
 
                old_tip=old_tip)
1413
 
        except errors.NoSuchRevision, e:
1414
 
            raise errors.BzrCommandError(
1415
 
                                  "branch has no revision %s\n"
1416
 
                                  "bzr update --revision only works"
1417
 
                                  " for a revision in the branch history"
1418
 
                                  % (e.revision))
1419
 
        revno = tree.branch.revision_id_to_dotted_revno(
1420
 
            _mod_revision.ensure_null(tree.last_revision()))
1421
 
        note('Updated to revision %s of branch %s' %
1422
 
             ('.'.join(map(str, revno)), branch_location))
1423
 
        parent_ids = tree.get_parent_ids()
1424
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1425
 
            note('Your local commits will now show as pending merges with '
1426
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1427
 
        if conflicts != 0:
1428
 
            return 1
1429
 
        else:
1430
 
            return 0
 
1399
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1400
                view_info=view_info), possible_transports=possible_transports)
 
1401
            revno = tree.branch.revision_id_to_revno(
 
1402
                _mod_revision.ensure_null(tree.last_revision()))
 
1403
            note('Updated to revision %d.' % (revno,))
 
1404
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1405
                note('Your local commits will now show as pending merges with '
 
1406
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1407
            if conflicts != 0:
 
1408
                return 1
 
1409
            else:
 
1410
                return 0
 
1411
        finally:
 
1412
            tree.unlock()
1431
1413
 
1432
1414
 
1433
1415
class cmd_info(Command):
1434
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1416
    """Show information about a working tree, branch or repository.
1435
1417
 
1436
1418
    This command will show all known locations and formats associated to the
1437
1419
    tree, branch or repository.
1475
1457
 
1476
1458
 
1477
1459
class cmd_remove(Command):
1478
 
    __doc__ = """Remove files or directories.
 
1460
    """Remove files or directories.
1479
1461
 
1480
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1481
 
    delete them if they can easily be recovered using revert otherwise they
1482
 
    will be backed up (adding an extention of the form .~#~). If no options or
1483
 
    parameters are given Bazaar will scan for files that are being tracked by
1484
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1462
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1463
    them if they can easily be recovered using revert. If no options or
 
1464
    parameters are given bzr will scan for files that are being tracked by bzr
 
1465
    but missing in your tree and stop tracking them for you.
1485
1466
    """
1486
1467
    takes_args = ['file*']
1487
1468
    takes_options = ['verbose',
1489
1470
        RegistryOption.from_kwargs('file-deletion-strategy',
1490
1471
            'The file deletion mode to be used.',
1491
1472
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1492
 
            safe='Backup changed files (default).',
1493
 
            keep='Delete from bzr but leave the working copy.',
 
1473
            safe='Only delete files if they can be'
 
1474
                 ' safely recovered (default).',
 
1475
            keep="Don't delete any files.",
1494
1476
            force='Delete all the specified files, even if they can not be '
1495
1477
                'recovered and even if they are non-empty directories.')]
1496
1478
    aliases = ['rm', 'del']
1498
1480
 
1499
1481
    def run(self, file_list, verbose=False, new=False,
1500
1482
        file_deletion_strategy='safe'):
1501
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1483
        tree, file_list = tree_files(file_list)
1502
1484
 
1503
1485
        if file_list is not None:
1504
1486
            file_list = [f for f in file_list]
1505
1487
 
1506
 
        self.add_cleanup(tree.lock_write().unlock)
1507
 
        # Heuristics should probably all move into tree.remove_smart or
1508
 
        # some such?
1509
 
        if new:
1510
 
            added = tree.changes_from(tree.basis_tree(),
1511
 
                specific_files=file_list).added
1512
 
            file_list = sorted([f[0] for f in added], reverse=True)
1513
 
            if len(file_list) == 0:
1514
 
                raise errors.BzrCommandError('No matching files.')
1515
 
        elif file_list is None:
1516
 
            # missing files show up in iter_changes(basis) as
1517
 
            # versioned-with-no-kind.
1518
 
            missing = []
1519
 
            for change in tree.iter_changes(tree.basis_tree()):
1520
 
                # Find paths in the working tree that have no kind:
1521
 
                if change[1][1] is not None and change[6][1] is None:
1522
 
                    missing.append(change[1][1])
1523
 
            file_list = sorted(missing, reverse=True)
1524
 
            file_deletion_strategy = 'keep'
1525
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1526
 
            keep_files=file_deletion_strategy=='keep',
1527
 
            force=file_deletion_strategy=='force')
 
1488
        tree.lock_write()
 
1489
        try:
 
1490
            # Heuristics should probably all move into tree.remove_smart or
 
1491
            # some such?
 
1492
            if new:
 
1493
                added = tree.changes_from(tree.basis_tree(),
 
1494
                    specific_files=file_list).added
 
1495
                file_list = sorted([f[0] for f in added], reverse=True)
 
1496
                if len(file_list) == 0:
 
1497
                    raise errors.BzrCommandError('No matching files.')
 
1498
            elif file_list is None:
 
1499
                # missing files show up in iter_changes(basis) as
 
1500
                # versioned-with-no-kind.
 
1501
                missing = []
 
1502
                for change in tree.iter_changes(tree.basis_tree()):
 
1503
                    # Find paths in the working tree that have no kind:
 
1504
                    if change[1][1] is not None and change[6][1] is None:
 
1505
                        missing.append(change[1][1])
 
1506
                file_list = sorted(missing, reverse=True)
 
1507
                file_deletion_strategy = 'keep'
 
1508
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1509
                keep_files=file_deletion_strategy=='keep',
 
1510
                force=file_deletion_strategy=='force')
 
1511
        finally:
 
1512
            tree.unlock()
1528
1513
 
1529
1514
 
1530
1515
class cmd_file_id(Command):
1531
 
    __doc__ = """Print file_id of a particular file or directory.
 
1516
    """Print file_id of a particular file or directory.
1532
1517
 
1533
1518
    The file_id is assigned when the file is first added and remains the
1534
1519
    same through all revisions where the file exists, even when it is
1550
1535
 
1551
1536
 
1552
1537
class cmd_file_path(Command):
1553
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1538
    """Print path of file_ids to a file or directory.
1554
1539
 
1555
1540
    This prints one line for each directory down to the target,
1556
1541
    starting at the branch root.
1572
1557
 
1573
1558
 
1574
1559
class cmd_reconcile(Command):
1575
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1560
    """Reconcile bzr metadata in a branch.
1576
1561
 
1577
1562
    This can correct data mismatches that may have been caused by
1578
1563
    previous ghost operations or bzr upgrades. You should only
1592
1577
 
1593
1578
    _see_also = ['check']
1594
1579
    takes_args = ['branch?']
1595
 
    takes_options = [
1596
 
        Option('canonicalize-chks',
1597
 
               help='Make sure CHKs are in canonical form (repairs '
1598
 
                    'bug 522637).',
1599
 
               hidden=True),
1600
 
        ]
1601
1580
 
1602
 
    def run(self, branch=".", canonicalize_chks=False):
 
1581
    def run(self, branch="."):
1603
1582
        from bzrlib.reconcile import reconcile
1604
1583
        dir = bzrdir.BzrDir.open(branch)
1605
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1584
        reconcile(dir)
1606
1585
 
1607
1586
 
1608
1587
class cmd_revision_history(Command):
1609
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1588
    """Display the list of revision ids on a branch."""
1610
1589
 
1611
1590
    _see_also = ['log']
1612
1591
    takes_args = ['location?']
1622
1601
 
1623
1602
 
1624
1603
class cmd_ancestry(Command):
1625
 
    __doc__ = """List all revisions merged into this branch."""
 
1604
    """List all revisions merged into this branch."""
1626
1605
 
1627
1606
    _see_also = ['log', 'revision-history']
1628
1607
    takes_args = ['location?']
1647
1626
 
1648
1627
 
1649
1628
class cmd_init(Command):
1650
 
    __doc__ = """Make a directory into a versioned branch.
 
1629
    """Make a directory into a versioned branch.
1651
1630
 
1652
1631
    Use this to create an empty branch, or before importing an
1653
1632
    existing project.
1681
1660
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1682
1661
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1683
1662
                value_switches=True,
1684
 
                title="Branch format",
 
1663
                title="Branch Format",
1685
1664
                ),
1686
1665
         Option('append-revisions-only',
1687
1666
                help='Never change revnos or the existing log.'
1756
1735
 
1757
1736
 
1758
1737
class cmd_init_repository(Command):
1759
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1738
    """Create a shared repository to hold branches.
1760
1739
 
1761
1740
    New branches created under the repository directory will store their
1762
 
    revisions in the repository, not in the branch directory.  For branches
1763
 
    with shared history, this reduces the amount of storage needed and 
1764
 
    speeds up the creation of new branches.
 
1741
    revisions in the repository, not in the branch directory.
1765
1742
 
1766
 
    If the --no-trees option is given then the branches in the repository
1767
 
    will not have working trees by default.  They will still exist as 
1768
 
    directories on disk, but they will not have separate copies of the 
1769
 
    files at a certain revision.  This can be useful for repositories that
1770
 
    store branches which are interacted with through checkouts or remote
1771
 
    branches, such as on a server.
 
1743
    If the --no-trees option is used then the branches in the repository
 
1744
    will not have working trees by default.
1772
1745
 
1773
1746
    :Examples:
1774
 
        Create a shared repository holding just branches::
 
1747
        Create a shared repositories holding just branches::
1775
1748
 
1776
1749
            bzr init-repo --no-trees repo
1777
1750
            bzr init repo/trunk
1816
1789
 
1817
1790
 
1818
1791
class cmd_diff(Command):
1819
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1792
    """Show differences in the working tree, between revisions or branches.
1820
1793
 
1821
1794
    If no arguments are given, all changes for the current tree are listed.
1822
1795
    If files are given, only the changes in those files are listed.
1843
1816
 
1844
1817
            bzr diff -r1
1845
1818
 
1846
 
        Difference between revision 3 and revision 1::
1847
 
 
1848
 
            bzr diff -r1..3
1849
 
 
1850
 
        Difference between revision 3 and revision 1 for branch xxx::
1851
 
 
1852
 
            bzr diff -r1..3 xxx
1853
 
 
1854
 
        To see the changes introduced in revision X::
1855
 
        
1856
 
            bzr diff -cX
1857
 
 
1858
 
        Note that in the case of a merge, the -c option shows the changes
1859
 
        compared to the left hand parent. To see the changes against
1860
 
        another parent, use::
1861
 
 
1862
 
            bzr diff -r<chosen_parent>..X
1863
 
 
1864
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1865
 
 
1866
 
            bzr diff -c2
 
1819
        Difference between revision 2 and revision 1::
 
1820
 
 
1821
            bzr diff -r1..2
 
1822
 
 
1823
        Difference between revision 2 and revision 1 for branch xxx::
 
1824
 
 
1825
            bzr diff -r1..2 xxx
1867
1826
 
1868
1827
        Show just the differences for file NEWS::
1869
1828
 
1884
1843
        Same as 'bzr diff' but prefix paths with old/ and new/::
1885
1844
 
1886
1845
            bzr diff --prefix old/:new/
1887
 
            
1888
 
        Show the differences using a custom diff program with options::
1889
 
        
1890
 
            bzr diff --using /usr/bin/diff --diff-options -wu
1891
1846
    """
1892
1847
    _see_also = ['status']
1893
1848
    takes_args = ['file*']
1912
1867
            help='Use this command to compare files.',
1913
1868
            type=unicode,
1914
1869
            ),
1915
 
        RegistryOption('format',
1916
 
            help='Diff format to use.',
1917
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1918
 
            value_switches=False, title='Diff format'),
1919
1870
        ]
1920
1871
    aliases = ['di', 'dif']
1921
1872
    encoding_type = 'exact'
1922
1873
 
1923
1874
    @display_command
1924
1875
    def run(self, revision=None, file_list=None, diff_options=None,
1925
 
            prefix=None, old=None, new=None, using=None, format=None):
1926
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1927
 
            show_diff_trees)
 
1876
            prefix=None, old=None, new=None, using=None):
 
1877
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1928
1878
 
1929
1879
        if (prefix is None) or (prefix == '0'):
1930
1880
            # diff -p0 format
1944
1894
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1945
1895
                                         ' one or two revision specifiers')
1946
1896
 
1947
 
        if using is not None and format is not None:
1948
 
            raise errors.BzrCommandError('--using and --format are mutually '
1949
 
                'exclusive.')
1950
 
 
1951
 
        (old_tree, new_tree,
1952
 
         old_branch, new_branch,
1953
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
1954
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
1955
 
        # GNU diff on Windows uses ANSI encoding for filenames
1956
 
        path_encoding = osutils.get_diff_header_encoding()
 
1897
        old_tree, new_tree, specific_files, extra_trees = \
 
1898
                _get_trees_to_diff(file_list, revision, old, new,
 
1899
                apply_view=True)
1957
1900
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1958
1901
                               specific_files=specific_files,
1959
1902
                               external_diff_options=diff_options,
1960
1903
                               old_label=old_label, new_label=new_label,
1961
 
                               extra_trees=extra_trees,
1962
 
                               path_encoding=path_encoding,
1963
 
                               using=using,
1964
 
                               format_cls=format)
 
1904
                               extra_trees=extra_trees, using=using)
1965
1905
 
1966
1906
 
1967
1907
class cmd_deleted(Command):
1968
 
    __doc__ = """List files deleted in the working tree.
 
1908
    """List files deleted in the working tree.
1969
1909
    """
1970
1910
    # TODO: Show files deleted since a previous revision, or
1971
1911
    # between two revisions.
1974
1914
    # level of effort but possibly much less IO.  (Or possibly not,
1975
1915
    # if the directories are very large...)
1976
1916
    _see_also = ['status', 'ls']
1977
 
    takes_options = ['directory', 'show-ids']
 
1917
    takes_options = ['show-ids']
1978
1918
 
1979
1919
    @display_command
1980
 
    def run(self, show_ids=False, directory=u'.'):
1981
 
        tree = WorkingTree.open_containing(directory)[0]
1982
 
        self.add_cleanup(tree.lock_read().unlock)
1983
 
        old = tree.basis_tree()
1984
 
        self.add_cleanup(old.lock_read().unlock)
1985
 
        for path, ie in old.inventory.iter_entries():
1986
 
            if not tree.has_id(ie.file_id):
1987
 
                self.outf.write(path)
1988
 
                if show_ids:
1989
 
                    self.outf.write(' ')
1990
 
                    self.outf.write(ie.file_id)
1991
 
                self.outf.write('\n')
 
1920
    def run(self, show_ids=False):
 
1921
        tree = WorkingTree.open_containing(u'.')[0]
 
1922
        tree.lock_read()
 
1923
        try:
 
1924
            old = tree.basis_tree()
 
1925
            old.lock_read()
 
1926
            try:
 
1927
                for path, ie in old.inventory.iter_entries():
 
1928
                    if not tree.has_id(ie.file_id):
 
1929
                        self.outf.write(path)
 
1930
                        if show_ids:
 
1931
                            self.outf.write(' ')
 
1932
                            self.outf.write(ie.file_id)
 
1933
                        self.outf.write('\n')
 
1934
            finally:
 
1935
                old.unlock()
 
1936
        finally:
 
1937
            tree.unlock()
1992
1938
 
1993
1939
 
1994
1940
class cmd_modified(Command):
1995
 
    __doc__ = """List files modified in working tree.
 
1941
    """List files modified in working tree.
1996
1942
    """
1997
1943
 
1998
1944
    hidden = True
1999
1945
    _see_also = ['status', 'ls']
2000
 
    takes_options = ['directory', 'null']
 
1946
    takes_options = [
 
1947
            Option('null',
 
1948
                   help='Write an ascii NUL (\\0) separator '
 
1949
                   'between files rather than a newline.')
 
1950
            ]
2001
1951
 
2002
1952
    @display_command
2003
 
    def run(self, null=False, directory=u'.'):
2004
 
        tree = WorkingTree.open_containing(directory)[0]
 
1953
    def run(self, null=False):
 
1954
        tree = WorkingTree.open_containing(u'.')[0]
2005
1955
        td = tree.changes_from(tree.basis_tree())
2006
1956
        for path, id, kind, text_modified, meta_modified in td.modified:
2007
1957
            if null:
2011
1961
 
2012
1962
 
2013
1963
class cmd_added(Command):
2014
 
    __doc__ = """List files added in working tree.
 
1964
    """List files added in working tree.
2015
1965
    """
2016
1966
 
2017
1967
    hidden = True
2018
1968
    _see_also = ['status', 'ls']
2019
 
    takes_options = ['directory', 'null']
 
1969
    takes_options = [
 
1970
            Option('null',
 
1971
                   help='Write an ascii NUL (\\0) separator '
 
1972
                   'between files rather than a newline.')
 
1973
            ]
2020
1974
 
2021
1975
    @display_command
2022
 
    def run(self, null=False, directory=u'.'):
2023
 
        wt = WorkingTree.open_containing(directory)[0]
2024
 
        self.add_cleanup(wt.lock_read().unlock)
2025
 
        basis = wt.basis_tree()
2026
 
        self.add_cleanup(basis.lock_read().unlock)
2027
 
        basis_inv = basis.inventory
2028
 
        inv = wt.inventory
2029
 
        for file_id in inv:
2030
 
            if file_id in basis_inv:
2031
 
                continue
2032
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2033
 
                continue
2034
 
            path = inv.id2path(file_id)
2035
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2036
 
                continue
2037
 
            if null:
2038
 
                self.outf.write(path + '\0')
2039
 
            else:
2040
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1976
    def run(self, null=False):
 
1977
        wt = WorkingTree.open_containing(u'.')[0]
 
1978
        wt.lock_read()
 
1979
        try:
 
1980
            basis = wt.basis_tree()
 
1981
            basis.lock_read()
 
1982
            try:
 
1983
                basis_inv = basis.inventory
 
1984
                inv = wt.inventory
 
1985
                for file_id in inv:
 
1986
                    if file_id in basis_inv:
 
1987
                        continue
 
1988
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1989
                        continue
 
1990
                    path = inv.id2path(file_id)
 
1991
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1992
                        continue
 
1993
                    if null:
 
1994
                        self.outf.write(path + '\0')
 
1995
                    else:
 
1996
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1997
            finally:
 
1998
                basis.unlock()
 
1999
        finally:
 
2000
            wt.unlock()
2041
2001
 
2042
2002
 
2043
2003
class cmd_root(Command):
2044
 
    __doc__ = """Show the tree root directory.
 
2004
    """Show the tree root directory.
2045
2005
 
2046
2006
    The root is the nearest enclosing directory with a .bzr control
2047
2007
    directory."""
2071
2031
 
2072
2032
 
2073
2033
class cmd_log(Command):
2074
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2034
    """Show historical log for a branch or subset of a branch.
2075
2035
 
2076
2036
    log is bzr's default tool for exploring the history of a branch.
2077
2037
    The branch to use is taken from the first parameter. If no parameters
2188
2148
    :Tips & tricks:
2189
2149
 
2190
2150
      GUI tools and IDEs are often better at exploring history than command
2191
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2192
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2193
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2194
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2151
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2152
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2153
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2154
 
 
2155
      Web interfaces are often better at exploring history than command line
 
2156
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2157
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2195
2158
 
2196
2159
      You may find it useful to add the aliases below to ``bazaar.conf``::
2197
2160
 
2238
2201
                   help='Show just the specified revision.'
2239
2202
                   ' See also "help revisionspec".'),
2240
2203
            'log-format',
2241
 
            RegistryOption('authors',
2242
 
                'What names to list as authors - first, all or committer.',
2243
 
                title='Authors',
2244
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2245
 
            ),
2246
2204
            Option('levels',
2247
2205
                   short_name='n',
2248
2206
                   help='Number of levels to display - 0 for all, 1 for flat.',
2263
2221
                   help='Show changes made in each revision as a patch.'),
2264
2222
            Option('include-merges',
2265
2223
                   help='Show merged revisions like --levels 0 does.'),
2266
 
            Option('exclude-common-ancestry',
2267
 
                   help='Display only the revisions that are not part'
2268
 
                   ' of both ancestries (require -rX..Y)'
2269
 
                   )
2270
2224
            ]
2271
2225
    encoding_type = 'replace'
2272
2226
 
2282
2236
            message=None,
2283
2237
            limit=None,
2284
2238
            show_diff=False,
2285
 
            include_merges=False,
2286
 
            authors=None,
2287
 
            exclude_common_ancestry=False,
2288
 
            ):
 
2239
            include_merges=False):
2289
2240
        from bzrlib.log import (
2290
2241
            Logger,
2291
2242
            make_log_request_dict,
2292
2243
            _get_info_for_log_files,
2293
2244
            )
2294
2245
        direction = (forward and 'forward') or 'reverse'
2295
 
        if (exclude_common_ancestry
2296
 
            and (revision is None or len(revision) != 2)):
2297
 
            raise errors.BzrCommandError(
2298
 
                '--exclude-common-ancestry requires -r with two revisions')
2299
2246
        if include_merges:
2300
2247
            if levels is None:
2301
2248
                levels = 0
2316
2263
        filter_by_dir = False
2317
2264
        if file_list:
2318
2265
            # find the file ids to log and check for directory filtering
2319
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2320
 
                revision, file_list, self.add_cleanup)
 
2266
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2267
                file_list)
2321
2268
            for relpath, file_id, kind in file_info_list:
2322
2269
                if file_id is None:
2323
2270
                    raise errors.BzrCommandError(
2341
2288
                location = '.'
2342
2289
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2343
2290
            b = dir.open_branch()
2344
 
            self.add_cleanup(b.lock_read().unlock)
2345
2291
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2346
2292
 
2347
2293
        # Decide on the type of delta & diff filtering to use
2357
2303
        else:
2358
2304
            diff_type = 'full'
2359
2305
 
2360
 
        # Build the log formatter
2361
 
        if log_format is None:
2362
 
            log_format = log.log_formatter_registry.get_default(b)
2363
 
        # Make a non-encoding output to include the diffs - bug 328007
2364
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2365
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2366
 
                        to_exact_file=unencoded_output,
2367
 
                        show_timezone=timezone,
2368
 
                        delta_format=get_verbosity_level(),
2369
 
                        levels=levels,
2370
 
                        show_advice=levels is None,
2371
 
                        author_list_handler=authors)
2372
 
 
2373
 
        # Choose the algorithm for doing the logging. It's annoying
2374
 
        # having multiple code paths like this but necessary until
2375
 
        # the underlying repository format is faster at generating
2376
 
        # deltas or can provide everything we need from the indices.
2377
 
        # The default algorithm - match-using-deltas - works for
2378
 
        # multiple files and directories and is faster for small
2379
 
        # amounts of history (200 revisions say). However, it's too
2380
 
        # slow for logging a single file in a repository with deep
2381
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2382
 
        # evil when adding features", we continue to use the
2383
 
        # original algorithm - per-file-graph - for the "single
2384
 
        # file that isn't a directory without showing a delta" case.
2385
 
        partial_history = revision and b.repository._format.supports_chks
2386
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2387
 
            or delta_type or partial_history)
2388
 
 
2389
 
        # Build the LogRequest and execute it
2390
 
        if len(file_ids) == 0:
2391
 
            file_ids = None
2392
 
        rqst = make_log_request_dict(
2393
 
            direction=direction, specific_fileids=file_ids,
2394
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2395
 
            message_search=message, delta_type=delta_type,
2396
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2397
 
            exclude_common_ancestry=exclude_common_ancestry,
2398
 
            )
2399
 
        Logger(b, rqst).show(lf)
 
2306
        b.lock_read()
 
2307
        try:
 
2308
            # Build the log formatter
 
2309
            if log_format is None:
 
2310
                log_format = log.log_formatter_registry.get_default(b)
 
2311
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2312
                            show_timezone=timezone,
 
2313
                            delta_format=get_verbosity_level(),
 
2314
                            levels=levels,
 
2315
                            show_advice=levels is None)
 
2316
 
 
2317
            # Choose the algorithm for doing the logging. It's annoying
 
2318
            # having multiple code paths like this but necessary until
 
2319
            # the underlying repository format is faster at generating
 
2320
            # deltas or can provide everything we need from the indices.
 
2321
            # The default algorithm - match-using-deltas - works for
 
2322
            # multiple files and directories and is faster for small
 
2323
            # amounts of history (200 revisions say). However, it's too
 
2324
            # slow for logging a single file in a repository with deep
 
2325
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2326
            # evil when adding features", we continue to use the
 
2327
            # original algorithm - per-file-graph - for the "single
 
2328
            # file that isn't a directory without showing a delta" case.
 
2329
            partial_history = revision and b.repository._format.supports_chks
 
2330
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2331
                or delta_type or partial_history)
 
2332
 
 
2333
            # Build the LogRequest and execute it
 
2334
            if len(file_ids) == 0:
 
2335
                file_ids = None
 
2336
            rqst = make_log_request_dict(
 
2337
                direction=direction, specific_fileids=file_ids,
 
2338
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2339
                message_search=message, delta_type=delta_type,
 
2340
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2341
            Logger(b, rqst).show(lf)
 
2342
        finally:
 
2343
            b.unlock()
2400
2344
 
2401
2345
 
2402
2346
def _get_revision_range(revisionspec_list, branch, command_name):
2420
2364
            raise errors.BzrCommandError(
2421
2365
                "bzr %s doesn't accept two revisions in different"
2422
2366
                " branches." % command_name)
2423
 
        if start_spec.spec is None:
2424
 
            # Avoid loading all the history.
2425
 
            rev1 = RevisionInfo(branch, None, None)
2426
 
        else:
2427
 
            rev1 = start_spec.in_history(branch)
 
2367
        rev1 = start_spec.in_history(branch)
2428
2368
        # Avoid loading all of history when we know a missing
2429
2369
        # end of range means the last revision ...
2430
2370
        if end_spec.spec is None:
2459
2399
 
2460
2400
 
2461
2401
class cmd_touching_revisions(Command):
2462
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2402
    """Return revision-ids which affected a particular file.
2463
2403
 
2464
2404
    A more user-friendly interface is "bzr log FILE".
2465
2405
    """
2470
2410
    @display_command
2471
2411
    def run(self, filename):
2472
2412
        tree, relpath = WorkingTree.open_containing(filename)
 
2413
        b = tree.branch
2473
2414
        file_id = tree.path2id(relpath)
2474
 
        b = tree.branch
2475
 
        self.add_cleanup(b.lock_read().unlock)
2476
 
        touching_revs = log.find_touching_revisions(b, file_id)
2477
 
        for revno, revision_id, what in touching_revs:
 
2415
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2478
2416
            self.outf.write("%6d %s\n" % (revno, what))
2479
2417
 
2480
2418
 
2481
2419
class cmd_ls(Command):
2482
 
    __doc__ = """List files in a tree.
 
2420
    """List files in a tree.
2483
2421
    """
2484
2422
 
2485
2423
    _see_also = ['status', 'cat']
2491
2429
                   help='Recurse into subdirectories.'),
2492
2430
            Option('from-root',
2493
2431
                   help='Print paths relative to the root of the branch.'),
2494
 
            Option('unknown', short_name='u',
2495
 
                help='Print unknown files.'),
 
2432
            Option('unknown', help='Print unknown files.'),
2496
2433
            Option('versioned', help='Print versioned files.',
2497
2434
                   short_name='V'),
2498
 
            Option('ignored', short_name='i',
2499
 
                help='Print ignored files.'),
2500
 
            Option('kind', short_name='k',
 
2435
            Option('ignored', help='Print ignored files.'),
 
2436
            Option('null',
 
2437
                   help='Write an ascii NUL (\\0) separator '
 
2438
                   'between files rather than a newline.'),
 
2439
            Option('kind',
2501
2440
                   help='List entries of a particular kind: file, directory, symlink.',
2502
2441
                   type=unicode),
2503
 
            'null',
2504
2442
            'show-ids',
2505
 
            'directory',
2506
2443
            ]
2507
2444
    @display_command
2508
2445
    def run(self, revision=None, verbose=False,
2509
2446
            recursive=False, from_root=False,
2510
2447
            unknown=False, versioned=False, ignored=False,
2511
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2448
            null=False, kind=None, show_ids=False, path=None):
2512
2449
 
2513
2450
        if kind and kind not in ('file', 'directory', 'symlink'):
2514
2451
            raise errors.BzrCommandError('invalid kind specified')
2526
2463
                raise errors.BzrCommandError('cannot specify both --from-root'
2527
2464
                                             ' and PATH')
2528
2465
            fs_path = path
2529
 
        tree, branch, relpath = \
2530
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2466
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2467
            fs_path)
2531
2468
 
2532
2469
        # Calculate the prefix to use
2533
2470
        prefix = None
2534
2471
        if from_root:
2535
2472
            if relpath:
2536
2473
                prefix = relpath + '/'
2537
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2474
        elif fs_path != '.':
2538
2475
            prefix = fs_path + '/'
2539
2476
 
2540
2477
        if revision is not None or tree is None:
2548
2485
                view_str = views.view_display_str(view_files)
2549
2486
                note("Ignoring files outside view. View is %s" % view_str)
2550
2487
 
2551
 
        self.add_cleanup(tree.lock_read().unlock)
2552
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2553
 
            from_dir=relpath, recursive=recursive):
2554
 
            # Apply additional masking
2555
 
            if not all and not selection[fc]:
2556
 
                continue
2557
 
            if kind is not None and fkind != kind:
2558
 
                continue
2559
 
            if apply_view:
2560
 
                try:
2561
 
                    if relpath:
2562
 
                        fullpath = osutils.pathjoin(relpath, fp)
2563
 
                    else:
2564
 
                        fullpath = fp
2565
 
                    views.check_path_in_view(tree, fullpath)
2566
 
                except errors.FileOutsideView:
2567
 
                    continue
 
2488
        tree.lock_read()
 
2489
        try:
 
2490
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2491
                from_dir=relpath, recursive=recursive):
 
2492
                # Apply additional masking
 
2493
                if not all and not selection[fc]:
 
2494
                    continue
 
2495
                if kind is not None and fkind != kind:
 
2496
                    continue
 
2497
                if apply_view:
 
2498
                    try:
 
2499
                        if relpath:
 
2500
                            fullpath = osutils.pathjoin(relpath, fp)
 
2501
                        else:
 
2502
                            fullpath = fp
 
2503
                        views.check_path_in_view(tree, fullpath)
 
2504
                    except errors.FileOutsideView:
 
2505
                        continue
2568
2506
 
2569
 
            # Output the entry
2570
 
            if prefix:
2571
 
                fp = osutils.pathjoin(prefix, fp)
2572
 
            kindch = entry.kind_character()
2573
 
            outstring = fp + kindch
2574
 
            ui.ui_factory.clear_term()
2575
 
            if verbose:
2576
 
                outstring = '%-8s %s' % (fc, outstring)
2577
 
                if show_ids and fid is not None:
2578
 
                    outstring = "%-50s %s" % (outstring, fid)
2579
 
                self.outf.write(outstring + '\n')
2580
 
            elif null:
2581
 
                self.outf.write(fp + '\0')
2582
 
                if show_ids:
2583
 
                    if fid is not None:
2584
 
                        self.outf.write(fid)
2585
 
                    self.outf.write('\0')
2586
 
                self.outf.flush()
2587
 
            else:
2588
 
                if show_ids:
2589
 
                    if fid is not None:
2590
 
                        my_id = fid
2591
 
                    else:
2592
 
                        my_id = ''
2593
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2594
 
                else:
 
2507
                # Output the entry
 
2508
                if prefix:
 
2509
                    fp = osutils.pathjoin(prefix, fp)
 
2510
                kindch = entry.kind_character()
 
2511
                outstring = fp + kindch
 
2512
                ui.ui_factory.clear_term()
 
2513
                if verbose:
 
2514
                    outstring = '%-8s %s' % (fc, outstring)
 
2515
                    if show_ids and fid is not None:
 
2516
                        outstring = "%-50s %s" % (outstring, fid)
2595
2517
                    self.outf.write(outstring + '\n')
 
2518
                elif null:
 
2519
                    self.outf.write(fp + '\0')
 
2520
                    if show_ids:
 
2521
                        if fid is not None:
 
2522
                            self.outf.write(fid)
 
2523
                        self.outf.write('\0')
 
2524
                    self.outf.flush()
 
2525
                else:
 
2526
                    if show_ids:
 
2527
                        if fid is not None:
 
2528
                            my_id = fid
 
2529
                        else:
 
2530
                            my_id = ''
 
2531
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2532
                    else:
 
2533
                        self.outf.write(outstring + '\n')
 
2534
        finally:
 
2535
            tree.unlock()
2596
2536
 
2597
2537
 
2598
2538
class cmd_unknowns(Command):
2599
 
    __doc__ = """List unknown files.
 
2539
    """List unknown files.
2600
2540
    """
2601
2541
 
2602
2542
    hidden = True
2603
2543
    _see_also = ['ls']
2604
 
    takes_options = ['directory']
2605
2544
 
2606
2545
    @display_command
2607
 
    def run(self, directory=u'.'):
2608
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2546
    def run(self):
 
2547
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2609
2548
            self.outf.write(osutils.quotefn(f) + '\n')
2610
2549
 
2611
2550
 
2612
2551
class cmd_ignore(Command):
2613
 
    __doc__ = """Ignore specified files or patterns.
 
2552
    """Ignore specified files or patterns.
2614
2553
 
2615
2554
    See ``bzr help patterns`` for details on the syntax of patterns.
2616
2555
 
2617
 
    If a .bzrignore file does not exist, the ignore command
2618
 
    will create one and add the specified files or patterns to the newly
2619
 
    created file. The ignore command will also automatically add the 
2620
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2621
 
    the use of the ignore command will require an explicit add command.
2622
 
 
2623
2556
    To remove patterns from the ignore list, edit the .bzrignore file.
2624
2557
    After adding, editing or deleting that file either indirectly by
2625
2558
    using this command or directly by using an editor, be sure to commit
2626
2559
    it.
2627
 
    
2628
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2629
 
    the global ignore file can be found in the application data directory as
2630
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2631
 
    Global ignores are not touched by this command. The global ignore file
2632
 
    can be edited directly using an editor.
2633
 
 
2634
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2635
 
    precedence over regular ignores.  Such exceptions are used to specify
2636
 
    files that should be versioned which would otherwise be ignored.
2637
 
    
2638
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2639
 
    precedence over the '!' exception patterns.
2640
2560
 
2641
2561
    Note: ignore patterns containing shell wildcards must be quoted from
2642
2562
    the shell on Unix.
2646
2566
 
2647
2567
            bzr ignore ./Makefile
2648
2568
 
2649
 
        Ignore .class files in all directories...::
 
2569
        Ignore class files in all directories::
2650
2570
 
2651
2571
            bzr ignore "*.class"
2652
2572
 
2653
 
        ...but do not ignore "special.class"::
2654
 
 
2655
 
            bzr ignore "!special.class"
2656
 
 
2657
2573
        Ignore .o files under the lib directory::
2658
2574
 
2659
2575
            bzr ignore "lib/**/*.o"
2665
2581
        Ignore everything but the "debian" toplevel directory::
2666
2582
 
2667
2583
            bzr ignore "RE:(?!debian/).*"
2668
 
        
2669
 
        Ignore everything except the "local" toplevel directory,
2670
 
        but always ignore "*~" autosave files, even under local/::
2671
 
        
2672
 
            bzr ignore "*"
2673
 
            bzr ignore "!./local"
2674
 
            bzr ignore "!!*~"
2675
2584
    """
2676
2585
 
2677
2586
    _see_also = ['status', 'ignored', 'patterns']
2678
2587
    takes_args = ['name_pattern*']
2679
 
    takes_options = ['directory',
2680
 
        Option('default-rules',
2681
 
               help='Display the default ignore rules that bzr uses.')
 
2588
    takes_options = [
 
2589
        Option('old-default-rules',
 
2590
               help='Write out the ignore rules bzr < 0.9 always used.')
2682
2591
        ]
2683
2592
 
2684
 
    def run(self, name_pattern_list=None, default_rules=None,
2685
 
            directory=u'.'):
 
2593
    def run(self, name_pattern_list=None, old_default_rules=None):
2686
2594
        from bzrlib import ignores
2687
 
        if default_rules is not None:
2688
 
            # dump the default rules and exit
2689
 
            for pattern in ignores.USER_DEFAULTS:
2690
 
                self.outf.write("%s\n" % pattern)
 
2595
        if old_default_rules is not None:
 
2596
            # dump the rules and exit
 
2597
            for pattern in ignores.OLD_DEFAULTS:
 
2598
                print pattern
2691
2599
            return
2692
2600
        if not name_pattern_list:
2693
2601
            raise errors.BzrCommandError("ignore requires at least one "
2694
 
                "NAME_PATTERN or --default-rules.")
 
2602
                                  "NAME_PATTERN or --old-default-rules")
2695
2603
        name_pattern_list = [globbing.normalize_pattern(p)
2696
2604
                             for p in name_pattern_list]
2697
 
        bad_patterns = ''
2698
 
        for p in name_pattern_list:
2699
 
            if not globbing.Globster.is_pattern_valid(p):
2700
 
                bad_patterns += ('\n  %s' % p)
2701
 
        if bad_patterns:
2702
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2703
 
            ui.ui_factory.show_error(msg)
2704
 
            raise errors.InvalidPattern('')
2705
2605
        for name_pattern in name_pattern_list:
2706
2606
            if (name_pattern[0] == '/' or
2707
2607
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2708
2608
                raise errors.BzrCommandError(
2709
2609
                    "NAME_PATTERN should not be an absolute path")
2710
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2610
        tree, relpath = WorkingTree.open_containing(u'.')
2711
2611
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2712
2612
        ignored = globbing.Globster(name_pattern_list)
2713
2613
        matches = []
2714
 
        self.add_cleanup(tree.lock_read().unlock)
 
2614
        tree.lock_read()
2715
2615
        for entry in tree.list_files():
2716
2616
            id = entry[3]
2717
2617
            if id is not None:
2718
2618
                filename = entry[0]
2719
2619
                if ignored.match(filename):
2720
 
                    matches.append(filename)
 
2620
                    matches.append(filename.encode('utf-8'))
 
2621
        tree.unlock()
2721
2622
        if len(matches) > 0:
2722
 
            self.outf.write("Warning: the following files are version controlled and"
2723
 
                  " match your ignore pattern:\n%s"
2724
 
                  "\nThese files will continue to be version controlled"
2725
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2623
            print "Warning: the following files are version controlled and" \
 
2624
                  " match your ignore pattern:\n%s" \
 
2625
                  "\nThese files will continue to be version controlled" \
 
2626
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2726
2627
 
2727
2628
 
2728
2629
class cmd_ignored(Command):
2729
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2630
    """List ignored files and the patterns that matched them.
2730
2631
 
2731
2632
    List all the ignored files and the ignore pattern that caused the file to
2732
2633
    be ignored.
2738
2639
 
2739
2640
    encoding_type = 'replace'
2740
2641
    _see_also = ['ignore', 'ls']
2741
 
    takes_options = ['directory']
2742
2642
 
2743
2643
    @display_command
2744
 
    def run(self, directory=u'.'):
2745
 
        tree = WorkingTree.open_containing(directory)[0]
2746
 
        self.add_cleanup(tree.lock_read().unlock)
2747
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2748
 
            if file_class != 'I':
2749
 
                continue
2750
 
            ## XXX: Slightly inefficient since this was already calculated
2751
 
            pat = tree.is_ignored(path)
2752
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2644
    def run(self):
 
2645
        tree = WorkingTree.open_containing(u'.')[0]
 
2646
        tree.lock_read()
 
2647
        try:
 
2648
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2649
                if file_class != 'I':
 
2650
                    continue
 
2651
                ## XXX: Slightly inefficient since this was already calculated
 
2652
                pat = tree.is_ignored(path)
 
2653
                self.outf.write('%-50s %s\n' % (path, pat))
 
2654
        finally:
 
2655
            tree.unlock()
2753
2656
 
2754
2657
 
2755
2658
class cmd_lookup_revision(Command):
2756
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2659
    """Lookup the revision-id from a revision-number
2757
2660
 
2758
2661
    :Examples:
2759
2662
        bzr lookup-revision 33
2760
2663
    """
2761
2664
    hidden = True
2762
2665
    takes_args = ['revno']
2763
 
    takes_options = ['directory']
2764
2666
 
2765
2667
    @display_command
2766
 
    def run(self, revno, directory=u'.'):
 
2668
    def run(self, revno):
2767
2669
        try:
2768
2670
            revno = int(revno)
2769
2671
        except ValueError:
2770
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2771
 
                                         % revno)
2772
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2773
 
        self.outf.write("%s\n" % revid)
 
2672
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2673
 
 
2674
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2774
2675
 
2775
2676
 
2776
2677
class cmd_export(Command):
2777
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2678
    """Export current or past revision to a destination directory or archive.
2778
2679
 
2779
2680
    If no revision is specified this exports the last committed revision.
2780
2681
 
2802
2703
      =================       =========================
2803
2704
    """
2804
2705
    takes_args = ['dest', 'branch_or_subdir?']
2805
 
    takes_options = ['directory',
 
2706
    takes_options = [
2806
2707
        Option('format',
2807
2708
               help="Type of file to export to.",
2808
2709
               type=unicode),
2812
2713
        Option('root',
2813
2714
               type=str,
2814
2715
               help="Name of the root directory inside the exported file."),
2815
 
        Option('per-file-timestamps',
2816
 
               help='Set modification time of files to that of the last '
2817
 
                    'revision in which it was changed.'),
2818
2716
        ]
2819
2717
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2820
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2718
        root=None, filters=False):
2821
2719
        from bzrlib.export import export
2822
2720
 
2823
2721
        if branch_or_subdir is None:
2824
 
            tree = WorkingTree.open_containing(directory)[0]
 
2722
            tree = WorkingTree.open_containing(u'.')[0]
2825
2723
            b = tree.branch
2826
2724
            subdir = None
2827
2725
        else:
2830
2728
 
2831
2729
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2832
2730
        try:
2833
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2834
 
                   per_file_timestamps=per_file_timestamps)
 
2731
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2835
2732
        except errors.NoSuchExportFormat, e:
2836
2733
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2837
2734
 
2838
2735
 
2839
2736
class cmd_cat(Command):
2840
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2737
    """Write the contents of a file as of a given revision to standard output.
2841
2738
 
2842
2739
    If no revision is nominated, the last revision is used.
2843
2740
 
2846
2743
    """
2847
2744
 
2848
2745
    _see_also = ['ls']
2849
 
    takes_options = ['directory',
 
2746
    takes_options = [
2850
2747
        Option('name-from-revision', help='The path name in the old tree.'),
2851
2748
        Option('filters', help='Apply content filters to display the '
2852
2749
                'convenience form.'),
2857
2754
 
2858
2755
    @display_command
2859
2756
    def run(self, filename, revision=None, name_from_revision=False,
2860
 
            filters=False, directory=None):
 
2757
            filters=False):
2861
2758
        if revision is not None and len(revision) != 1:
2862
2759
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2863
2760
                                         " one revision specifier")
2864
2761
        tree, branch, relpath = \
2865
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2866
 
        self.add_cleanup(branch.lock_read().unlock)
2867
 
        return self._run(tree, branch, relpath, filename, revision,
2868
 
                         name_from_revision, filters)
 
2762
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2763
        branch.lock_read()
 
2764
        try:
 
2765
            return self._run(tree, branch, relpath, filename, revision,
 
2766
                             name_from_revision, filters)
 
2767
        finally:
 
2768
            branch.unlock()
2869
2769
 
2870
2770
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2871
2771
        filtered):
2872
2772
        if tree is None:
2873
2773
            tree = b.basis_tree()
2874
2774
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2875
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2876
2775
 
2877
2776
        old_file_id = rev_tree.path2id(relpath)
2878
2777
 
2913
2812
            chunks = content.splitlines(True)
2914
2813
            content = filtered_output_bytes(chunks, filters,
2915
2814
                ContentFilterContext(relpath, rev_tree))
2916
 
            self.cleanup_now()
2917
2815
            self.outf.writelines(content)
2918
2816
        else:
2919
 
            self.cleanup_now()
2920
2817
            self.outf.write(content)
2921
2818
 
2922
2819
 
2923
2820
class cmd_local_time_offset(Command):
2924
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2821
    """Show the offset in seconds from GMT to local time."""
2925
2822
    hidden = True
2926
2823
    @display_command
2927
2824
    def run(self):
2928
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2825
        print osutils.local_time_offset()
2929
2826
 
2930
2827
 
2931
2828
 
2932
2829
class cmd_commit(Command):
2933
 
    __doc__ = """Commit changes into a new revision.
 
2830
    """Commit changes into a new revision.
2934
2831
 
2935
2832
    An explanatory message needs to be given for each commit. This is
2936
2833
    often done by using the --message option (getting the message from the
3029
2926
             Option('strict',
3030
2927
                    help="Refuse to commit if there are unknown "
3031
2928
                    "files in the working tree."),
3032
 
             Option('commit-time', type=str,
3033
 
                    help="Manually set a commit time using commit date "
3034
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3035
2929
             ListOption('fixes', type=str,
3036
2930
                    help="Mark a bug as being fixed by this revision "
3037
2931
                         "(see \"bzr help bugs\")."),
3044
2938
                         "the master branch until a normal commit "
3045
2939
                         "is performed."
3046
2940
                    ),
3047
 
             Option('show-diff', short_name='p',
3048
 
                    help='When no message is supplied, show the diff along'
3049
 
                    ' with the status summary in the message editor.'),
 
2941
              Option('show-diff',
 
2942
                     help='When no message is supplied, show the diff along'
 
2943
                     ' with the status summary in the message editor.'),
3050
2944
             ]
3051
2945
    aliases = ['ci', 'checkin']
3052
2946
 
3071
2965
 
3072
2966
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3073
2967
            unchanged=False, strict=False, local=False, fixes=None,
3074
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2968
            author=None, show_diff=False, exclude=None):
3075
2969
        from bzrlib.errors import (
3076
2970
            PointlessCommit,
3077
2971
            ConflictsInTree,
3083
2977
            make_commit_message_template_encoded
3084
2978
        )
3085
2979
 
3086
 
        commit_stamp = offset = None
3087
 
        if commit_time is not None:
3088
 
            try:
3089
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3090
 
            except ValueError, e:
3091
 
                raise errors.BzrCommandError(
3092
 
                    "Could not parse --commit-time: " + str(e))
3093
 
 
3094
2980
        # TODO: Need a blackbox test for invoking the external editor; may be
3095
2981
        # slightly problematic to run this cross-platform.
3096
2982
 
3099
2985
 
3100
2986
        properties = {}
3101
2987
 
3102
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
2988
        tree, selected_list = tree_files(selected_list)
3103
2989
        if selected_list == ['']:
3104
2990
            # workaround - commit of root of tree should be exactly the same
3105
2991
            # as just default commit in that tree, and succeed even though
3116
3002
        if local and not tree.branch.get_bound_location():
3117
3003
            raise errors.LocalRequiresBoundBranch()
3118
3004
 
3119
 
        if message is not None:
3120
 
            try:
3121
 
                file_exists = osutils.lexists(message)
3122
 
            except UnicodeError:
3123
 
                # The commit message contains unicode characters that can't be
3124
 
                # represented in the filesystem encoding, so that can't be a
3125
 
                # file.
3126
 
                file_exists = False
3127
 
            if file_exists:
3128
 
                warning_msg = (
3129
 
                    'The commit message is a file name: "%(f)s".\n'
3130
 
                    '(use --file "%(f)s" to take commit message from that file)'
3131
 
                    % { 'f': message })
3132
 
                ui.ui_factory.show_warning(warning_msg)
3133
 
            if '\r' in message:
3134
 
                message = message.replace('\r\n', '\n')
3135
 
                message = message.replace('\r', '\n')
3136
 
            if file:
3137
 
                raise errors.BzrCommandError(
3138
 
                    "please specify either --message or --file")
3139
 
 
3140
3005
        def get_message(commit_obj):
3141
3006
            """Callback to get commit message"""
3142
 
            if file:
3143
 
                f = open(file)
3144
 
                try:
3145
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3146
 
                finally:
3147
 
                    f.close()
3148
 
            elif message is not None:
3149
 
                my_message = message
3150
 
            else:
3151
 
                # No message supplied: make one up.
3152
 
                # text is the status of the tree
3153
 
                text = make_commit_message_template_encoded(tree,
 
3007
            my_message = message
 
3008
            if my_message is None and not file:
 
3009
                t = make_commit_message_template_encoded(tree,
3154
3010
                        selected_list, diff=show_diff,
3155
3011
                        output_encoding=osutils.get_user_encoding())
3156
 
                # start_message is the template generated from hooks
3157
 
                # XXX: Warning - looks like hooks return unicode,
3158
 
                # make_commit_message_template_encoded returns user encoding.
3159
 
                # We probably want to be using edit_commit_message instead to
3160
 
                # avoid this.
3161
3012
                start_message = generate_commit_message_template(commit_obj)
3162
 
                my_message = edit_commit_message_encoded(text,
 
3013
                my_message = edit_commit_message_encoded(t,
3163
3014
                    start_message=start_message)
3164
3015
                if my_message is None:
3165
3016
                    raise errors.BzrCommandError("please specify a commit"
3166
3017
                        " message with either --message or --file")
 
3018
            elif my_message and file:
 
3019
                raise errors.BzrCommandError(
 
3020
                    "please specify either --message or --file")
 
3021
            if file:
 
3022
                my_message = codecs.open(file, 'rt',
 
3023
                                         osutils.get_user_encoding()).read()
3167
3024
            if my_message == "":
3168
3025
                raise errors.BzrCommandError("empty commit message specified")
3169
3026
            return my_message
3170
3027
 
3171
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3172
 
        # but the command line should not do that.
3173
 
        if not selected_list:
3174
 
            selected_list = None
3175
3028
        try:
3176
3029
            tree.commit(message_callback=get_message,
3177
3030
                        specific_files=selected_list,
3178
3031
                        allow_pointless=unchanged, strict=strict, local=local,
3179
3032
                        reporter=None, verbose=verbose, revprops=properties,
3180
 
                        authors=author, timestamp=commit_stamp,
3181
 
                        timezone=offset,
3182
 
                        exclude=tree.safe_relpath_files(exclude))
 
3033
                        authors=author,
 
3034
                        exclude=safe_relpath_files(tree, exclude))
3183
3035
        except PointlessCommit:
 
3036
            # FIXME: This should really happen before the file is read in;
 
3037
            # perhaps prepare the commit; get the message; then actually commit
3184
3038
            raise errors.BzrCommandError("No changes to commit."
3185
3039
                              " Use --unchanged to commit anyhow.")
3186
3040
        except ConflictsInTree:
3191
3045
            raise errors.BzrCommandError("Commit refused because there are"
3192
3046
                              " unknown files in the working tree.")
3193
3047
        except errors.BoundBranchOutOfDate, e:
3194
 
            e.extra_help = ("\n"
3195
 
                'To commit to master branch, run update and then commit.\n'
3196
 
                'You can also pass --local to commit to continue working '
3197
 
                'disconnected.')
3198
 
            raise
 
3048
            raise errors.BzrCommandError(str(e) + "\n"
 
3049
            'To commit to master branch, run update and then commit.\n'
 
3050
            'You can also pass --local to commit to continue working '
 
3051
            'disconnected.')
3199
3052
 
3200
3053
 
3201
3054
class cmd_check(Command):
3202
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3055
    """Validate working tree structure, branch consistency and repository history.
3203
3056
 
3204
3057
    This command checks various invariants about branch and repository storage
3205
3058
    to detect data corruption or bzr bugs.
3269
3122
 
3270
3123
 
3271
3124
class cmd_upgrade(Command):
3272
 
    __doc__ = """Upgrade branch storage to current format.
 
3125
    """Upgrade branch storage to current format.
3273
3126
 
3274
3127
    The check command or bzr developers may sometimes advise you to run
3275
3128
    this command. When the default format has changed you may also be warned
3293
3146
 
3294
3147
 
3295
3148
class cmd_whoami(Command):
3296
 
    __doc__ = """Show or set bzr user id.
 
3149
    """Show or set bzr user id.
3297
3150
 
3298
3151
    :Examples:
3299
3152
        Show the email of the current user::
3304
3157
 
3305
3158
            bzr whoami "Frank Chu <fchu@example.com>"
3306
3159
    """
3307
 
    takes_options = [ 'directory',
3308
 
                      Option('email',
 
3160
    takes_options = [ Option('email',
3309
3161
                             help='Display email address only.'),
3310
3162
                      Option('branch',
3311
3163
                             help='Set identity for the current branch instead of '
3315
3167
    encoding_type = 'replace'
3316
3168
 
3317
3169
    @display_command
3318
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3170
    def run(self, email=False, branch=False, name=None):
3319
3171
        if name is None:
3320
 
            if directory is None:
3321
 
                # use branch if we're inside one; otherwise global config
3322
 
                try:
3323
 
                    c = Branch.open_containing(u'.')[0].get_config()
3324
 
                except errors.NotBranchError:
3325
 
                    c = config.GlobalConfig()
3326
 
            else:
3327
 
                c = Branch.open(directory).get_config()
 
3172
            # use branch if we're inside one; otherwise global config
 
3173
            try:
 
3174
                c = Branch.open_containing('.')[0].get_config()
 
3175
            except errors.NotBranchError:
 
3176
                c = config.GlobalConfig()
3328
3177
            if email:
3329
3178
                self.outf.write(c.user_email() + '\n')
3330
3179
            else:
3340
3189
 
3341
3190
        # use global config unless --branch given
3342
3191
        if branch:
3343
 
            if directory is None:
3344
 
                c = Branch.open_containing(u'.')[0].get_config()
3345
 
            else:
3346
 
                c = Branch.open(directory).get_config()
 
3192
            c = Branch.open_containing('.')[0].get_config()
3347
3193
        else:
3348
3194
            c = config.GlobalConfig()
3349
3195
        c.set_user_option('email', name)
3350
3196
 
3351
3197
 
3352
3198
class cmd_nick(Command):
3353
 
    __doc__ = """Print or set the branch nickname.
 
3199
    """Print or set the branch nickname.
3354
3200
 
3355
3201
    If unset, the tree root directory name is used as the nickname.
3356
3202
    To print the current nickname, execute with no argument.
3361
3207
 
3362
3208
    _see_also = ['info']
3363
3209
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
3210
    def run(self, nickname=None):
 
3211
        branch = Branch.open_containing(u'.')[0]
3367
3212
        if nickname is None:
3368
3213
            self.printme(branch)
3369
3214
        else:
3371
3216
 
3372
3217
    @display_command
3373
3218
    def printme(self, branch):
3374
 
        self.outf.write('%s\n' % branch.nick)
 
3219
        print branch.nick
3375
3220
 
3376
3221
 
3377
3222
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
3223
    """Set/unset and display aliases.
3379
3224
 
3380
3225
    :Examples:
3381
3226
        Show the current aliases::
3445
3290
 
3446
3291
 
3447
3292
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
 
3293
    """Run internal test suite.
3449
3294
 
3450
3295
    If arguments are given, they are regular expressions that say which tests
3451
3296
    should run.  Tests matching any expression are run, and other tests are
3478
3323
    Tests that need working space on disk use a common temporary directory,
3479
3324
    typically inside $TMPDIR or /tmp.
3480
3325
 
3481
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3482
 
    into a pdb postmortem session.
3483
 
 
3484
3326
    :Examples:
3485
3327
        Run only tests relating to 'ignore'::
3486
3328
 
3495
3337
    def get_transport_type(typestring):
3496
3338
        """Parse and return a transport specifier."""
3497
3339
        if typestring == "sftp":
3498
 
            from bzrlib.tests import stub_sftp
3499
 
            return stub_sftp.SFTPAbsoluteServer
 
3340
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3341
            return SFTPAbsoluteServer
3500
3342
        if typestring == "memory":
3501
 
            from bzrlib.tests import test_server
3502
 
            return memory.MemoryServer
 
3343
            from bzrlib.transport.memory import MemoryServer
 
3344
            return MemoryServer
3503
3345
        if typestring == "fakenfs":
3504
 
            from bzrlib.tests import test_server
3505
 
            return test_server.FakeNFSServer
 
3346
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3347
            return FakeNFSServer
3506
3348
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3507
3349
            (typestring)
3508
3350
        raise errors.BzrCommandError(msg)
3519
3361
                                 'throughout the test suite.',
3520
3362
                            type=get_transport_type),
3521
3363
                     Option('benchmark',
3522
 
                            help='Run the benchmarks rather than selftests.',
3523
 
                            hidden=True),
 
3364
                            help='Run the benchmarks rather than selftests.'),
3524
3365
                     Option('lsprof-timed',
3525
3366
                            help='Generate lsprof output for benchmarked'
3526
3367
                                 ' sections of code.'),
3527
 
                     Option('lsprof-tests',
3528
 
                            help='Generate lsprof output for each test.'),
 
3368
                     Option('cache-dir', type=str,
 
3369
                            help='Cache intermediate benchmark output in this '
 
3370
                                 'directory.'),
3529
3371
                     Option('first',
3530
3372
                            help='Run all tests, but run specified tests first.',
3531
3373
                            short_name='f',
3565
3407
 
3566
3408
    def run(self, testspecs_list=None, verbose=False, one=False,
3567
3409
            transport=None, benchmark=None,
3568
 
            lsprof_timed=None,
 
3410
            lsprof_timed=None, cache_dir=None,
3569
3411
            first=False, list_only=False,
3570
3412
            randomize=None, exclude=None, strict=False,
3571
3413
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3572
 
            parallel=None, lsprof_tests=False):
 
3414
            parallel=None):
3573
3415
        from bzrlib.tests import selftest
 
3416
        import bzrlib.benchmarks as benchmarks
 
3417
        from bzrlib.benchmarks import tree_creator
3574
3418
 
3575
3419
        # Make deprecation warnings visible, unless -Werror is set
3576
3420
        symbol_versioning.activate_deprecation_warnings(override=False)
3577
3421
 
 
3422
        if cache_dir is not None:
 
3423
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3578
3424
        if testspecs_list is not None:
3579
3425
            pattern = '|'.join(testspecs_list)
3580
3426
        else:
3586
3432
                raise errors.BzrCommandError("subunit not available. subunit "
3587
3433
                    "needs to be installed to use --subunit.")
3588
3434
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3589
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3590
 
            # stdout, which would corrupt the subunit stream. 
3591
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3592
 
            # following code can be deleted when it's sufficiently deployed
3593
 
            # -- vila/mgz 20100514
3594
 
            if (sys.platform == "win32"
3595
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3596
 
                import msvcrt
3597
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3598
3435
        if parallel:
3599
3436
            self.additional_selftest_args.setdefault(
3600
3437
                'suite_decorators', []).append(parallel)
3601
3438
        if benchmark:
3602
 
            raise errors.BzrCommandError(
3603
 
                "--benchmark is no longer supported from bzr 2.2; "
3604
 
                "use bzr-usertest instead")
3605
 
        test_suite_factory = None
3606
 
        selftest_kwargs = {"verbose": verbose,
3607
 
                          "pattern": pattern,
3608
 
                          "stop_on_failure": one,
3609
 
                          "transport": transport,
3610
 
                          "test_suite_factory": test_suite_factory,
3611
 
                          "lsprof_timed": lsprof_timed,
3612
 
                          "lsprof_tests": lsprof_tests,
3613
 
                          "matching_tests_first": first,
3614
 
                          "list_only": list_only,
3615
 
                          "random_seed": randomize,
3616
 
                          "exclude_pattern": exclude,
3617
 
                          "strict": strict,
3618
 
                          "load_list": load_list,
3619
 
                          "debug_flags": debugflag,
3620
 
                          "starting_with": starting_with
3621
 
                          }
3622
 
        selftest_kwargs.update(self.additional_selftest_args)
3623
 
        result = selftest(**selftest_kwargs)
 
3439
            test_suite_factory = benchmarks.test_suite
 
3440
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3441
            verbose = not is_quiet()
 
3442
            # TODO: should possibly lock the history file...
 
3443
            benchfile = open(".perf_history", "at", buffering=1)
 
3444
        else:
 
3445
            test_suite_factory = None
 
3446
            benchfile = None
 
3447
        try:
 
3448
            selftest_kwargs = {"verbose": verbose,
 
3449
                              "pattern": pattern,
 
3450
                              "stop_on_failure": one,
 
3451
                              "transport": transport,
 
3452
                              "test_suite_factory": test_suite_factory,
 
3453
                              "lsprof_timed": lsprof_timed,
 
3454
                              "bench_history": benchfile,
 
3455
                              "matching_tests_first": first,
 
3456
                              "list_only": list_only,
 
3457
                              "random_seed": randomize,
 
3458
                              "exclude_pattern": exclude,
 
3459
                              "strict": strict,
 
3460
                              "load_list": load_list,
 
3461
                              "debug_flags": debugflag,
 
3462
                              "starting_with": starting_with
 
3463
                              }
 
3464
            selftest_kwargs.update(self.additional_selftest_args)
 
3465
            result = selftest(**selftest_kwargs)
 
3466
        finally:
 
3467
            if benchfile is not None:
 
3468
                benchfile.close()
3624
3469
        return int(not result)
3625
3470
 
3626
3471
 
3627
3472
class cmd_version(Command):
3628
 
    __doc__ = """Show version of bzr."""
 
3473
    """Show version of bzr."""
3629
3474
 
3630
3475
    encoding_type = 'replace'
3631
3476
    takes_options = [
3642
3487
 
3643
3488
 
3644
3489
class cmd_rocks(Command):
3645
 
    __doc__ = """Statement of optimism."""
 
3490
    """Statement of optimism."""
3646
3491
 
3647
3492
    hidden = True
3648
3493
 
3649
3494
    @display_command
3650
3495
    def run(self):
3651
 
        self.outf.write("It sure does!\n")
 
3496
        print "It sure does!"
3652
3497
 
3653
3498
 
3654
3499
class cmd_find_merge_base(Command):
3655
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3500
    """Find and print a base revision for merging two branches."""
3656
3501
    # TODO: Options to specify revisions on either side, as if
3657
3502
    #       merging only part of the history.
3658
3503
    takes_args = ['branch', 'other']
3664
3509
 
3665
3510
        branch1 = Branch.open_containing(branch)[0]
3666
3511
        branch2 = Branch.open_containing(other)[0]
3667
 
        self.add_cleanup(branch1.lock_read().unlock)
3668
 
        self.add_cleanup(branch2.lock_read().unlock)
3669
 
        last1 = ensure_null(branch1.last_revision())
3670
 
        last2 = ensure_null(branch2.last_revision())
3671
 
 
3672
 
        graph = branch1.repository.get_graph(branch2.repository)
3673
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3674
 
 
3675
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3512
        branch1.lock_read()
 
3513
        try:
 
3514
            branch2.lock_read()
 
3515
            try:
 
3516
                last1 = ensure_null(branch1.last_revision())
 
3517
                last2 = ensure_null(branch2.last_revision())
 
3518
 
 
3519
                graph = branch1.repository.get_graph(branch2.repository)
 
3520
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3521
 
 
3522
                print 'merge base is revision %s' % base_rev_id
 
3523
            finally:
 
3524
                branch2.unlock()
 
3525
        finally:
 
3526
            branch1.unlock()
3676
3527
 
3677
3528
 
3678
3529
class cmd_merge(Command):
3679
 
    __doc__ = """Perform a three-way merge.
 
3530
    """Perform a three-way merge.
3680
3531
 
3681
3532
    The source of the merge can be specified either in the form of a branch,
3682
3533
    or in the form of a path to a file containing a merge directive generated
3711
3562
    committed to record the result of the merge.
3712
3563
 
3713
3564
    merge refuses to run if there are any uncommitted changes, unless
3714
 
    --force is given. The --force option can also be used to create a
3715
 
    merge revision which has more than two parents.
3716
 
 
3717
 
    If one would like to merge changes from the working tree of the other
3718
 
    branch without merging any committed revisions, the --uncommitted option
3719
 
    can be given.
 
3565
    --force is given.
3720
3566
 
3721
3567
    To select only some changes to merge, use "merge -i", which will prompt
3722
3568
    you to apply each diff hunk and file change, similar to "shelve".
3734
3580
 
3735
3581
            bzr merge -r 81..82 ../bzr.dev
3736
3582
 
3737
 
        To apply a merge directive contained in /tmp/merge::
 
3583
        To apply a merge directive contained in /tmp/merge:
3738
3584
 
3739
3585
            bzr merge /tmp/merge
3740
 
 
3741
 
        To create a merge revision with three parents from two branches
3742
 
        feature1a and feature1b:
3743
 
 
3744
 
            bzr merge ../feature1a
3745
 
            bzr merge ../feature1b --force
3746
 
            bzr commit -m 'revision with three parents'
3747
3586
    """
3748
3587
 
3749
3588
    encoding_type = 'exact'
3765
3604
                ' completely merged into the source, pull from the'
3766
3605
                ' source rather than merging.  When this happens,'
3767
3606
                ' you do not need to commit the result.'),
3768
 
        custom_help('directory',
 
3607
        Option('directory',
3769
3608
               help='Branch to merge into, '
3770
 
                    'rather than the one containing the working directory.'),
 
3609
                    'rather than the one containing the working directory.',
 
3610
               short_name='d',
 
3611
               type=unicode,
 
3612
               ),
3771
3613
        Option('preview', help='Instead of merging, show a diff of the'
3772
3614
               ' merge.'),
3773
3615
        Option('interactive', help='Select changes interactively.',
3791
3633
        verified = 'inapplicable'
3792
3634
        tree = WorkingTree.open_containing(directory)[0]
3793
3635
 
 
3636
        # die as quickly as possible if there are uncommitted changes
3794
3637
        try:
3795
3638
            basis_tree = tree.revision_tree(tree.last_revision())
3796
3639
        except errors.NoSuchRevision:
3797
3640
            basis_tree = tree.basis_tree()
3798
 
 
3799
 
        # die as quickly as possible if there are uncommitted changes
3800
3641
        if not force:
3801
 
            if tree.has_changes():
 
3642
            if tree.has_changes(basis_tree):
3802
3643
                raise errors.UncommittedChanges(tree)
3803
3644
 
3804
3645
        view_info = _get_view_info_for_change_reporter(tree)
3805
3646
        change_reporter = delta._ChangeReporter(
3806
3647
            unversioned_filter=tree.is_ignored, view_info=view_info)
3807
 
        pb = ui.ui_factory.nested_progress_bar()
3808
 
        self.add_cleanup(pb.finished)
3809
 
        self.add_cleanup(tree.lock_write().unlock)
3810
 
        if location is not None:
3811
 
            try:
3812
 
                mergeable = bundle.read_mergeable_from_url(location,
3813
 
                    possible_transports=possible_transports)
3814
 
            except errors.NotABundle:
3815
 
                mergeable = None
 
3648
        cleanups = []
 
3649
        try:
 
3650
            pb = ui.ui_factory.nested_progress_bar()
 
3651
            cleanups.append(pb.finished)
 
3652
            tree.lock_write()
 
3653
            cleanups.append(tree.unlock)
 
3654
            if location is not None:
 
3655
                try:
 
3656
                    mergeable = bundle.read_mergeable_from_url(location,
 
3657
                        possible_transports=possible_transports)
 
3658
                except errors.NotABundle:
 
3659
                    mergeable = None
 
3660
                else:
 
3661
                    if uncommitted:
 
3662
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3663
                            ' with bundles or merge directives.')
 
3664
 
 
3665
                    if revision is not None:
 
3666
                        raise errors.BzrCommandError(
 
3667
                            'Cannot use -r with merge directives or bundles')
 
3668
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3669
                       mergeable, pb)
 
3670
 
 
3671
            if merger is None and uncommitted:
 
3672
                if revision is not None and len(revision) > 0:
 
3673
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3674
                        ' --revision at the same time.')
 
3675
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3676
                                                          cleanups)
 
3677
                allow_pending = False
 
3678
 
 
3679
            if merger is None:
 
3680
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3681
                    location, revision, remember, possible_transports, pb)
 
3682
 
 
3683
            merger.merge_type = merge_type
 
3684
            merger.reprocess = reprocess
 
3685
            merger.show_base = show_base
 
3686
            self.sanity_check_merger(merger)
 
3687
            if (merger.base_rev_id == merger.other_rev_id and
 
3688
                merger.other_rev_id is not None):
 
3689
                note('Nothing to do.')
 
3690
                return 0
 
3691
            if pull:
 
3692
                if merger.interesting_files is not None:
 
3693
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3694
                if (merger.base_rev_id == tree.last_revision()):
 
3695
                    result = tree.pull(merger.other_branch, False,
 
3696
                                       merger.other_rev_id)
 
3697
                    result.report(self.outf)
 
3698
                    return 0
 
3699
            merger.check_basis(False)
 
3700
            if preview:
 
3701
                return self._do_preview(merger, cleanups)
 
3702
            elif interactive:
 
3703
                return self._do_interactive(merger, cleanups)
3816
3704
            else:
3817
 
                if uncommitted:
3818
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3819
 
                        ' with bundles or merge directives.')
3820
 
 
3821
 
                if revision is not None:
3822
 
                    raise errors.BzrCommandError(
3823
 
                        'Cannot use -r with merge directives or bundles')
3824
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3825
 
                   mergeable, None)
3826
 
 
3827
 
        if merger is None and uncommitted:
3828
 
            if revision is not None and len(revision) > 0:
3829
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3830
 
                    ' --revision at the same time.')
3831
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3832
 
            allow_pending = False
3833
 
 
3834
 
        if merger is None:
3835
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3836
 
                location, revision, remember, possible_transports, None)
3837
 
 
3838
 
        merger.merge_type = merge_type
3839
 
        merger.reprocess = reprocess
3840
 
        merger.show_base = show_base
3841
 
        self.sanity_check_merger(merger)
3842
 
        if (merger.base_rev_id == merger.other_rev_id and
3843
 
            merger.other_rev_id is not None):
3844
 
            note('Nothing to do.')
3845
 
            return 0
3846
 
        if pull:
3847
 
            if merger.interesting_files is not None:
3848
 
                raise errors.BzrCommandError('Cannot pull individual files')
3849
 
            if (merger.base_rev_id == tree.last_revision()):
3850
 
                result = tree.pull(merger.other_branch, False,
3851
 
                                   merger.other_rev_id)
3852
 
                result.report(self.outf)
3853
 
                return 0
3854
 
        if merger.this_basis is None:
3855
 
            raise errors.BzrCommandError(
3856
 
                "This branch has no commits."
3857
 
                " (perhaps you would prefer 'bzr pull')")
3858
 
        if preview:
3859
 
            return self._do_preview(merger)
3860
 
        elif interactive:
3861
 
            return self._do_interactive(merger)
3862
 
        else:
3863
 
            return self._do_merge(merger, change_reporter, allow_pending,
3864
 
                                  verified)
3865
 
 
3866
 
    def _get_preview(self, merger):
 
3705
                return self._do_merge(merger, change_reporter, allow_pending,
 
3706
                                      verified)
 
3707
        finally:
 
3708
            for cleanup in reversed(cleanups):
 
3709
                cleanup()
 
3710
 
 
3711
    def _get_preview(self, merger, cleanups):
3867
3712
        tree_merger = merger.make_merger()
3868
3713
        tt = tree_merger.make_preview_transform()
3869
 
        self.add_cleanup(tt.finalize)
 
3714
        cleanups.append(tt.finalize)
3870
3715
        result_tree = tt.get_preview_tree()
3871
3716
        return result_tree
3872
3717
 
3873
 
    def _do_preview(self, merger):
 
3718
    def _do_preview(self, merger, cleanups):
3874
3719
        from bzrlib.diff import show_diff_trees
3875
 
        result_tree = self._get_preview(merger)
3876
 
        path_encoding = osutils.get_diff_header_encoding()
 
3720
        result_tree = self._get_preview(merger, cleanups)
3877
3721
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3878
 
                        old_label='', new_label='',
3879
 
                        path_encoding=path_encoding)
 
3722
                        old_label='', new_label='')
3880
3723
 
3881
3724
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3882
3725
        merger.change_reporter = change_reporter
3890
3733
        else:
3891
3734
            return 0
3892
3735
 
3893
 
    def _do_interactive(self, merger):
 
3736
    def _do_interactive(self, merger, cleanups):
3894
3737
        """Perform an interactive merge.
3895
3738
 
3896
3739
        This works by generating a preview tree of the merge, then using
3898
3741
        and the preview tree.
3899
3742
        """
3900
3743
        from bzrlib import shelf_ui
3901
 
        result_tree = self._get_preview(merger)
 
3744
        result_tree = self._get_preview(merger, cleanups)
3902
3745
        writer = bzrlib.option.diff_writer_registry.get()
3903
3746
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
3904
3747
                                   reporter=shelf_ui.ApplyReporter(),
3905
3748
                                   diff_writer=writer(sys.stdout))
3906
 
        try:
3907
 
            shelver.run()
3908
 
        finally:
3909
 
            shelver.finalize()
 
3749
        shelver.run()
3910
3750
 
3911
3751
    def sanity_check_merger(self, merger):
3912
3752
        if (merger.show_base and
3972
3812
            allow_pending = True
3973
3813
        return merger, allow_pending
3974
3814
 
3975
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3815
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
3976
3816
        """Get a merger for uncommitted changes.
3977
3817
 
3978
3818
        :param tree: The tree the merger should apply to.
3979
3819
        :param location: The location containing uncommitted changes.
3980
3820
        :param pb: The progress bar to use for showing progress.
 
3821
        :param cleanups: A list of operations to perform to clean up the
 
3822
            temporary directories, unfinalized objects, etc.
3981
3823
        """
3982
3824
        location = self._select_branch_location(tree, location)[0]
3983
3825
        other_tree, other_path = WorkingTree.open_containing(location)
4035
3877
 
4036
3878
 
4037
3879
class cmd_remerge(Command):
4038
 
    __doc__ = """Redo a merge.
 
3880
    """Redo a merge.
4039
3881
 
4040
3882
    Use this if you want to try a different merge technique while resolving
4041
3883
    conflicts.  Some merge techniques are better than others, and remerge
4066
3908
 
4067
3909
    def run(self, file_list=None, merge_type=None, show_base=False,
4068
3910
            reprocess=False):
4069
 
        from bzrlib.conflicts import restore
4070
3911
        if merge_type is None:
4071
3912
            merge_type = _mod_merge.Merge3Merger
4072
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4073
 
        self.add_cleanup(tree.lock_write().unlock)
4074
 
        parents = tree.get_parent_ids()
4075
 
        if len(parents) != 2:
4076
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4077
 
                                         " merges.  Not cherrypicking or"
4078
 
                                         " multi-merges.")
4079
 
        repository = tree.branch.repository
4080
 
        interesting_ids = None
4081
 
        new_conflicts = []
4082
 
        conflicts = tree.conflicts()
4083
 
        if file_list is not None:
4084
 
            interesting_ids = set()
4085
 
            for filename in file_list:
4086
 
                file_id = tree.path2id(filename)
4087
 
                if file_id is None:
4088
 
                    raise errors.NotVersionedError(filename)
4089
 
                interesting_ids.add(file_id)
4090
 
                if tree.kind(file_id) != "directory":
4091
 
                    continue
 
3913
        tree, file_list = tree_files(file_list)
 
3914
        tree.lock_write()
 
3915
        try:
 
3916
            parents = tree.get_parent_ids()
 
3917
            if len(parents) != 2:
 
3918
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3919
                                             " merges.  Not cherrypicking or"
 
3920
                                             " multi-merges.")
 
3921
            repository = tree.branch.repository
 
3922
            interesting_ids = None
 
3923
            new_conflicts = []
 
3924
            conflicts = tree.conflicts()
 
3925
            if file_list is not None:
 
3926
                interesting_ids = set()
 
3927
                for filename in file_list:
 
3928
                    file_id = tree.path2id(filename)
 
3929
                    if file_id is None:
 
3930
                        raise errors.NotVersionedError(filename)
 
3931
                    interesting_ids.add(file_id)
 
3932
                    if tree.kind(file_id) != "directory":
 
3933
                        continue
4092
3934
 
4093
 
                for name, ie in tree.inventory.iter_entries(file_id):
4094
 
                    interesting_ids.add(ie.file_id)
4095
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4096
 
        else:
4097
 
            # Remerge only supports resolving contents conflicts
4098
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4099
 
            restore_files = [c.path for c in conflicts
4100
 
                             if c.typestring in allowed_conflicts]
4101
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4102
 
        tree.set_conflicts(ConflictList(new_conflicts))
4103
 
        if file_list is not None:
4104
 
            restore_files = file_list
4105
 
        for filename in restore_files:
 
3935
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3936
                        interesting_ids.add(ie.file_id)
 
3937
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3938
            else:
 
3939
                # Remerge only supports resolving contents conflicts
 
3940
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3941
                restore_files = [c.path for c in conflicts
 
3942
                                 if c.typestring in allowed_conflicts]
 
3943
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3944
            tree.set_conflicts(ConflictList(new_conflicts))
 
3945
            if file_list is not None:
 
3946
                restore_files = file_list
 
3947
            for filename in restore_files:
 
3948
                try:
 
3949
                    restore(tree.abspath(filename))
 
3950
                except errors.NotConflicted:
 
3951
                    pass
 
3952
            # Disable pending merges, because the file texts we are remerging
 
3953
            # have not had those merges performed.  If we use the wrong parents
 
3954
            # list, we imply that the working tree text has seen and rejected
 
3955
            # all the changes from the other tree, when in fact those changes
 
3956
            # have not yet been seen.
 
3957
            pb = ui.ui_factory.nested_progress_bar()
 
3958
            tree.set_parent_ids(parents[:1])
4106
3959
            try:
4107
 
                restore(tree.abspath(filename))
4108
 
            except errors.NotConflicted:
4109
 
                pass
4110
 
        # Disable pending merges, because the file texts we are remerging
4111
 
        # have not had those merges performed.  If we use the wrong parents
4112
 
        # list, we imply that the working tree text has seen and rejected
4113
 
        # all the changes from the other tree, when in fact those changes
4114
 
        # have not yet been seen.
4115
 
        tree.set_parent_ids(parents[:1])
4116
 
        try:
4117
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4118
 
            merger.interesting_ids = interesting_ids
4119
 
            merger.merge_type = merge_type
4120
 
            merger.show_base = show_base
4121
 
            merger.reprocess = reprocess
4122
 
            conflicts = merger.do_merge()
 
3960
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3961
                                                             tree, parents[1])
 
3962
                merger.interesting_ids = interesting_ids
 
3963
                merger.merge_type = merge_type
 
3964
                merger.show_base = show_base
 
3965
                merger.reprocess = reprocess
 
3966
                conflicts = merger.do_merge()
 
3967
            finally:
 
3968
                tree.set_parent_ids(parents)
 
3969
                pb.finished()
4123
3970
        finally:
4124
 
            tree.set_parent_ids(parents)
 
3971
            tree.unlock()
4125
3972
        if conflicts > 0:
4126
3973
            return 1
4127
3974
        else:
4129
3976
 
4130
3977
 
4131
3978
class cmd_revert(Command):
4132
 
    __doc__ = """Revert files to a previous revision.
 
3979
    """Revert files to a previous revision.
4133
3980
 
4134
3981
    Giving a list of files will revert only those files.  Otherwise, all files
4135
3982
    will be reverted.  If the revision is not specified with '--revision', the
4149
3996
    name.  If you name a directory, all the contents of that directory will be
4150
3997
    reverted.
4151
3998
 
4152
 
    If you have newly added files since the target revision, they will be
4153
 
    removed.  If the files to be removed have been changed, backups will be
4154
 
    created as above.  Directories containing unknown files will not be
4155
 
    deleted.
 
3999
    Any files that have been newly added since that revision will be deleted,
 
4000
    with a backup kept if appropriate.  Directories containing unknown files
 
4001
    will not be deleted.
4156
4002
 
4157
 
    The working tree contains a list of revisions that have been merged but
4158
 
    not yet committed. These revisions will be included as additional parents
4159
 
    of the next commit.  Normally, using revert clears that list as well as
4160
 
    reverting the files.  If any files are specified, revert leaves the list
4161
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4162
 
    .`` in the tree root to revert all files but keep the recorded merges,
4163
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4003
    The working tree contains a list of pending merged revisions, which will
 
4004
    be included as parents in the next commit.  Normally, revert clears that
 
4005
    list as well as reverting the files.  If any files are specified, revert
 
4006
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4007
    revert ." in the tree root to revert all files but keep the merge record,
 
4008
    and "bzr revert --forget-merges" to clear the pending merge list without
4164
4009
    reverting any files.
4165
 
 
4166
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4167
 
    changes from a branch in a single revision.  To do this, perform the merge
4168
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4169
 
    the content of the tree as it was, but it will clear the list of pending
4170
 
    merges.  The next commit will then contain all of the changes that are
4171
 
    present in the other branch, but without any other parent revisions.
4172
 
    Because this technique forgets where these changes originated, it may
4173
 
    cause additional conflicts on later merges involving the same source and
4174
 
    target branches.
4175
4010
    """
4176
4011
 
4177
4012
    _see_also = ['cat', 'export']
4185
4020
 
4186
4021
    def run(self, revision=None, no_backup=False, file_list=None,
4187
4022
            forget_merges=None):
4188
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4189
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4190
 
        if forget_merges:
4191
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4192
 
        else:
4193
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4023
        tree, file_list = tree_files(file_list)
 
4024
        tree.lock_write()
 
4025
        try:
 
4026
            if forget_merges:
 
4027
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4028
            else:
 
4029
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4030
        finally:
 
4031
            tree.unlock()
4194
4032
 
4195
4033
    @staticmethod
4196
4034
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4197
4035
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4198
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4199
 
            report_changes=True)
 
4036
        pb = ui.ui_factory.nested_progress_bar()
 
4037
        try:
 
4038
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4039
                report_changes=True)
 
4040
        finally:
 
4041
            pb.finished()
4200
4042
 
4201
4043
 
4202
4044
class cmd_assert_fail(Command):
4203
 
    __doc__ = """Test reporting of assertion failures"""
 
4045
    """Test reporting of assertion failures"""
4204
4046
    # intended just for use in testing
4205
4047
 
4206
4048
    hidden = True
4210
4052
 
4211
4053
 
4212
4054
class cmd_help(Command):
4213
 
    __doc__ = """Show help on a command or other topic.
 
4055
    """Show help on a command or other topic.
4214
4056
    """
4215
4057
 
4216
4058
    _see_also = ['topics']
4229
4071
 
4230
4072
 
4231
4073
class cmd_shell_complete(Command):
4232
 
    __doc__ = """Show appropriate completions for context.
 
4074
    """Show appropriate completions for context.
4233
4075
 
4234
4076
    For a list of all available commands, say 'bzr shell-complete'.
4235
4077
    """
4244
4086
 
4245
4087
 
4246
4088
class cmd_missing(Command):
4247
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4089
    """Show unmerged/unpulled revisions between two branches.
4248
4090
 
4249
4091
    OTHER_BRANCH may be local or remote.
4250
4092
 
4251
4093
    To filter on a range of revisions, you can use the command -r begin..end
4252
4094
    -r revision requests a specific revision, -r ..end or -r begin.. are
4253
4095
    also valid.
4254
 
            
4255
 
    :Exit values:
4256
 
        1 - some missing revisions
4257
 
        0 - no missing revisions
4258
4096
 
4259
4097
    :Examples:
4260
4098
 
4281
4119
    _see_also = ['merge', 'pull']
4282
4120
    takes_args = ['other_branch?']
4283
4121
    takes_options = [
4284
 
        'directory',
4285
4122
        Option('reverse', 'Reverse the order of revisions.'),
4286
4123
        Option('mine-only',
4287
4124
               'Display changes in the local branch only.'),
4309
4146
            theirs_only=False,
4310
4147
            log_format=None, long=False, short=False, line=False,
4311
4148
            show_ids=False, verbose=False, this=False, other=False,
4312
 
            include_merges=False, revision=None, my_revision=None,
4313
 
            directory=u'.'):
 
4149
            include_merges=False, revision=None, my_revision=None):
4314
4150
        from bzrlib.missing import find_unmerged, iter_log_revisions
4315
4151
        def message(s):
4316
4152
            if not is_quiet():
4329
4165
        elif theirs_only:
4330
4166
            restrict = 'remote'
4331
4167
 
4332
 
        local_branch = Branch.open_containing(directory)[0]
4333
 
        self.add_cleanup(local_branch.lock_read().unlock)
4334
 
 
 
4168
        local_branch = Branch.open_containing(u".")[0]
4335
4169
        parent = local_branch.get_parent()
4336
4170
        if other_branch is None:
4337
4171
            other_branch = parent
4346
4180
        remote_branch = Branch.open(other_branch)
4347
4181
        if remote_branch.base == local_branch.base:
4348
4182
            remote_branch = local_branch
4349
 
        else:
4350
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4351
4183
 
4352
4184
        local_revid_range = _revision_range_to_revid_range(
4353
4185
            _get_revision_range(my_revision, local_branch,
4357
4189
            _get_revision_range(revision,
4358
4190
                remote_branch, self.name()))
4359
4191
 
4360
 
        local_extra, remote_extra = find_unmerged(
4361
 
            local_branch, remote_branch, restrict,
4362
 
            backward=not reverse,
4363
 
            include_merges=include_merges,
4364
 
            local_revid_range=local_revid_range,
4365
 
            remote_revid_range=remote_revid_range)
4366
 
 
4367
 
        if log_format is None:
4368
 
            registry = log.log_formatter_registry
4369
 
            log_format = registry.get_default(local_branch)
4370
 
        lf = log_format(to_file=self.outf,
4371
 
                        show_ids=show_ids,
4372
 
                        show_timezone='original')
4373
 
 
4374
 
        status_code = 0
4375
 
        if local_extra and not theirs_only:
4376
 
            message("You have %d extra revision(s):\n" %
4377
 
                len(local_extra))
4378
 
            for revision in iter_log_revisions(local_extra,
4379
 
                                local_branch.repository,
4380
 
                                verbose):
4381
 
                lf.log_revision(revision)
4382
 
            printed_local = True
4383
 
            status_code = 1
4384
 
        else:
4385
 
            printed_local = False
4386
 
 
4387
 
        if remote_extra and not mine_only:
4388
 
            if printed_local is True:
4389
 
                message("\n\n\n")
4390
 
            message("You are missing %d revision(s):\n" %
4391
 
                len(remote_extra))
4392
 
            for revision in iter_log_revisions(remote_extra,
4393
 
                                remote_branch.repository,
4394
 
                                verbose):
4395
 
                lf.log_revision(revision)
4396
 
            status_code = 1
4397
 
 
4398
 
        if mine_only and not local_extra:
4399
 
            # We checked local, and found nothing extra
4400
 
            message('This branch is up to date.\n')
4401
 
        elif theirs_only and not remote_extra:
4402
 
            # We checked remote, and found nothing extra
4403
 
            message('Other branch is up to date.\n')
4404
 
        elif not (mine_only or theirs_only or local_extra or
4405
 
                  remote_extra):
4406
 
            # We checked both branches, and neither one had extra
4407
 
            # revisions
4408
 
            message("Branches are up to date.\n")
4409
 
        self.cleanup_now()
 
4192
        local_branch.lock_read()
 
4193
        try:
 
4194
            remote_branch.lock_read()
 
4195
            try:
 
4196
                local_extra, remote_extra = find_unmerged(
 
4197
                    local_branch, remote_branch, restrict,
 
4198
                    backward=not reverse,
 
4199
                    include_merges=include_merges,
 
4200
                    local_revid_range=local_revid_range,
 
4201
                    remote_revid_range=remote_revid_range)
 
4202
 
 
4203
                if log_format is None:
 
4204
                    registry = log.log_formatter_registry
 
4205
                    log_format = registry.get_default(local_branch)
 
4206
                lf = log_format(to_file=self.outf,
 
4207
                                show_ids=show_ids,
 
4208
                                show_timezone='original')
 
4209
 
 
4210
                status_code = 0
 
4211
                if local_extra and not theirs_only:
 
4212
                    message("You have %d extra revision(s):\n" %
 
4213
                        len(local_extra))
 
4214
                    for revision in iter_log_revisions(local_extra,
 
4215
                                        local_branch.repository,
 
4216
                                        verbose):
 
4217
                        lf.log_revision(revision)
 
4218
                    printed_local = True
 
4219
                    status_code = 1
 
4220
                else:
 
4221
                    printed_local = False
 
4222
 
 
4223
                if remote_extra and not mine_only:
 
4224
                    if printed_local is True:
 
4225
                        message("\n\n\n")
 
4226
                    message("You are missing %d revision(s):\n" %
 
4227
                        len(remote_extra))
 
4228
                    for revision in iter_log_revisions(remote_extra,
 
4229
                                        remote_branch.repository,
 
4230
                                        verbose):
 
4231
                        lf.log_revision(revision)
 
4232
                    status_code = 1
 
4233
 
 
4234
                if mine_only and not local_extra:
 
4235
                    # We checked local, and found nothing extra
 
4236
                    message('This branch is up to date.\n')
 
4237
                elif theirs_only and not remote_extra:
 
4238
                    # We checked remote, and found nothing extra
 
4239
                    message('Other branch is up to date.\n')
 
4240
                elif not (mine_only or theirs_only or local_extra or
 
4241
                          remote_extra):
 
4242
                    # We checked both branches, and neither one had extra
 
4243
                    # revisions
 
4244
                    message("Branches are up to date.\n")
 
4245
            finally:
 
4246
                remote_branch.unlock()
 
4247
        finally:
 
4248
            local_branch.unlock()
4410
4249
        if not status_code and parent is None and other_branch is not None:
4411
 
            self.add_cleanup(local_branch.lock_write().unlock)
4412
 
            # handle race conditions - a parent might be set while we run.
4413
 
            if local_branch.get_parent() is None:
4414
 
                local_branch.set_parent(remote_branch.base)
 
4250
            local_branch.lock_write()
 
4251
            try:
 
4252
                # handle race conditions - a parent might be set while we run.
 
4253
                if local_branch.get_parent() is None:
 
4254
                    local_branch.set_parent(remote_branch.base)
 
4255
            finally:
 
4256
                local_branch.unlock()
4415
4257
        return status_code
4416
4258
 
4417
4259
 
4418
4260
class cmd_pack(Command):
4419
 
    __doc__ = """Compress the data within a repository.
4420
 
 
4421
 
    This operation compresses the data within a bazaar repository. As
4422
 
    bazaar supports automatic packing of repository, this operation is
4423
 
    normally not required to be done manually.
4424
 
 
4425
 
    During the pack operation, bazaar takes a backup of existing repository
4426
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4427
 
    automatically when it is safe to do so. To save disk space by removing
4428
 
    the backed up pack files, the --clean-obsolete-packs option may be
4429
 
    used.
4430
 
 
4431
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4432
 
    during or immediately after repacking, you may be left with a state
4433
 
    where the deletion has been written to disk but the new packs have not
4434
 
    been. In this case the repository may be unusable.
4435
 
    """
 
4261
    """Compress the data within a repository."""
4436
4262
 
4437
4263
    _see_also = ['repositories']
4438
4264
    takes_args = ['branch_or_repo?']
4439
 
    takes_options = [
4440
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4441
 
        ]
4442
4265
 
4443
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4266
    def run(self, branch_or_repo='.'):
4444
4267
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4445
4268
        try:
4446
4269
            branch = dir.open_branch()
4447
4270
            repository = branch.repository
4448
4271
        except errors.NotBranchError:
4449
4272
            repository = dir.open_repository()
4450
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4273
        repository.pack()
4451
4274
 
4452
4275
 
4453
4276
class cmd_plugins(Command):
4454
 
    __doc__ = """List the installed plugins.
 
4277
    """List the installed plugins.
4455
4278
 
4456
4279
    This command displays the list of installed plugins including
4457
4280
    version of plugin and a short description of each.
4464
4287
    adding new commands, providing additional network transports and
4465
4288
    customizing log output.
4466
4289
 
4467
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4468
 
    for further information on plugins including where to find them and how to
4469
 
    install them. Instructions are also provided there on how to write new
4470
 
    plugins using the Python programming language.
 
4290
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4291
    information on plugins including where to find them and how to
 
4292
    install them. Instructions are also provided there on how to
 
4293
    write new plugins using the Python programming language.
4471
4294
    """
4472
4295
    takes_options = ['verbose']
4473
4296
 
4488
4311
                doc = '(no description)'
4489
4312
            result.append((name_ver, doc, plugin.path()))
4490
4313
        for name_ver, doc, path in sorted(result):
4491
 
            self.outf.write("%s\n" % name_ver)
4492
 
            self.outf.write("   %s\n" % doc)
 
4314
            print name_ver
 
4315
            print '   ', doc
4493
4316
            if verbose:
4494
 
                self.outf.write("   %s\n" % path)
4495
 
            self.outf.write("\n")
 
4317
                print '   ', path
 
4318
            print
4496
4319
 
4497
4320
 
4498
4321
class cmd_testament(Command):
4499
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4322
    """Show testament (signing-form) of a revision."""
4500
4323
    takes_options = [
4501
4324
            'revision',
4502
4325
            Option('long', help='Produce long-format testament.'),
4514
4337
            b = Branch.open_containing(branch)[0]
4515
4338
        else:
4516
4339
            b = Branch.open(branch)
4517
 
        self.add_cleanup(b.lock_read().unlock)
4518
 
        if revision is None:
4519
 
            rev_id = b.last_revision()
4520
 
        else:
4521
 
            rev_id = revision[0].as_revision_id(b)
4522
 
        t = testament_class.from_revision(b.repository, rev_id)
4523
 
        if long:
4524
 
            sys.stdout.writelines(t.as_text_lines())
4525
 
        else:
4526
 
            sys.stdout.write(t.as_short_text())
 
4340
        b.lock_read()
 
4341
        try:
 
4342
            if revision is None:
 
4343
                rev_id = b.last_revision()
 
4344
            else:
 
4345
                rev_id = revision[0].as_revision_id(b)
 
4346
            t = testament_class.from_revision(b.repository, rev_id)
 
4347
            if long:
 
4348
                sys.stdout.writelines(t.as_text_lines())
 
4349
            else:
 
4350
                sys.stdout.write(t.as_short_text())
 
4351
        finally:
 
4352
            b.unlock()
4527
4353
 
4528
4354
 
4529
4355
class cmd_annotate(Command):
4530
 
    __doc__ = """Show the origin of each line in a file.
 
4356
    """Show the origin of each line in a file.
4531
4357
 
4532
4358
    This prints out the given file with an annotation on the left side
4533
4359
    indicating which revision, author and date introduced the change.
4544
4370
                     Option('long', help='Show commit date in annotations.'),
4545
4371
                     'revision',
4546
4372
                     'show-ids',
4547
 
                     'directory',
4548
4373
                     ]
4549
4374
    encoding_type = 'exact'
4550
4375
 
4551
4376
    @display_command
4552
4377
    def run(self, filename, all=False, long=False, revision=None,
4553
 
            show_ids=False, directory=None):
 
4378
            show_ids=False):
4554
4379
        from bzrlib.annotate import annotate_file, annotate_file_tree
4555
4380
        wt, branch, relpath = \
4556
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4557
 
        if wt is not None:
4558
 
            self.add_cleanup(wt.lock_read().unlock)
4559
 
        else:
4560
 
            self.add_cleanup(branch.lock_read().unlock)
4561
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4562
 
        self.add_cleanup(tree.lock_read().unlock)
4563
 
        if wt is not None:
4564
 
            file_id = wt.path2id(relpath)
4565
 
        else:
4566
 
            file_id = tree.path2id(relpath)
4567
 
        if file_id is None:
4568
 
            raise errors.NotVersionedError(filename)
4569
 
        file_version = tree.inventory[file_id].revision
4570
 
        if wt is not None and revision is None:
4571
 
            # If there is a tree and we're not annotating historical
4572
 
            # versions, annotate the working tree's content.
4573
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4574
 
                show_ids=show_ids)
4575
 
        else:
4576
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4577
 
                          show_ids=show_ids)
 
4381
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4382
        if wt is not None:
 
4383
            wt.lock_read()
 
4384
        else:
 
4385
            branch.lock_read()
 
4386
        try:
 
4387
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4388
            if wt is not None:
 
4389
                file_id = wt.path2id(relpath)
 
4390
            else:
 
4391
                file_id = tree.path2id(relpath)
 
4392
            if file_id is None:
 
4393
                raise errors.NotVersionedError(filename)
 
4394
            file_version = tree.inventory[file_id].revision
 
4395
            if wt is not None and revision is None:
 
4396
                # If there is a tree and we're not annotating historical
 
4397
                # versions, annotate the working tree's content.
 
4398
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4399
                    show_ids=show_ids)
 
4400
            else:
 
4401
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4402
                              show_ids=show_ids)
 
4403
        finally:
 
4404
            if wt is not None:
 
4405
                wt.unlock()
 
4406
            else:
 
4407
                branch.unlock()
4578
4408
 
4579
4409
 
4580
4410
class cmd_re_sign(Command):
4581
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4411
    """Create a digital signature for an existing revision."""
4582
4412
    # TODO be able to replace existing ones.
4583
4413
 
4584
4414
    hidden = True # is this right ?
4585
4415
    takes_args = ['revision_id*']
4586
 
    takes_options = ['directory', 'revision']
 
4416
    takes_options = ['revision']
4587
4417
 
4588
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4418
    def run(self, revision_id_list=None, revision=None):
4589
4419
        if revision_id_list is not None and revision is not None:
4590
4420
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4591
4421
        if revision_id_list is None and revision is None:
4592
4422
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4593
 
        b = WorkingTree.open_containing(directory)[0].branch
4594
 
        self.add_cleanup(b.lock_write().unlock)
4595
 
        return self._run(b, revision_id_list, revision)
 
4423
        b = WorkingTree.open_containing(u'.')[0].branch
 
4424
        b.lock_write()
 
4425
        try:
 
4426
            return self._run(b, revision_id_list, revision)
 
4427
        finally:
 
4428
            b.unlock()
4596
4429
 
4597
4430
    def _run(self, b, revision_id_list, revision):
4598
4431
        import bzrlib.gpg as gpg
4643
4476
 
4644
4477
 
4645
4478
class cmd_bind(Command):
4646
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4647
 
    If no branch is supplied, rebind to the last bound location.
 
4479
    """Convert the current branch into a checkout of the supplied branch.
4648
4480
 
4649
4481
    Once converted into a checkout, commits must succeed on the master branch
4650
4482
    before they will be applied to the local branch.
4651
4483
 
4652
4484
    Bound branches use the nickname of its master branch unless it is set
4653
 
    locally, in which case binding will update the local nickname to be
 
4485
    locally, in which case binding will update the the local nickname to be
4654
4486
    that of the master.
4655
4487
    """
4656
4488
 
4657
4489
    _see_also = ['checkouts', 'unbind']
4658
4490
    takes_args = ['location?']
4659
 
    takes_options = ['directory']
 
4491
    takes_options = []
4660
4492
 
4661
 
    def run(self, location=None, directory=u'.'):
4662
 
        b, relpath = Branch.open_containing(directory)
 
4493
    def run(self, location=None):
 
4494
        b, relpath = Branch.open_containing(u'.')
4663
4495
        if location is None:
4664
4496
            try:
4665
4497
                location = b.get_old_bound_location()
4668
4500
                    'This format does not remember old locations.')
4669
4501
            else:
4670
4502
                if location is None:
4671
 
                    if b.get_bound_location() is not None:
4672
 
                        raise errors.BzrCommandError('Branch is already bound')
4673
 
                    else:
4674
 
                        raise errors.BzrCommandError('No location supplied '
4675
 
                            'and no previous location known')
 
4503
                    raise errors.BzrCommandError('No location supplied and no '
 
4504
                        'previous location known')
4676
4505
        b_other = Branch.open(location)
4677
4506
        try:
4678
4507
            b.bind(b_other)
4684
4513
 
4685
4514
 
4686
4515
class cmd_unbind(Command):
4687
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4516
    """Convert the current checkout into a regular branch.
4688
4517
 
4689
4518
    After unbinding, the local branch is considered independent and subsequent
4690
4519
    commits will be local only.
4692
4521
 
4693
4522
    _see_also = ['checkouts', 'bind']
4694
4523
    takes_args = []
4695
 
    takes_options = ['directory']
 
4524
    takes_options = []
4696
4525
 
4697
 
    def run(self, directory=u'.'):
4698
 
        b, relpath = Branch.open_containing(directory)
 
4526
    def run(self):
 
4527
        b, relpath = Branch.open_containing(u'.')
4699
4528
        if not b.unbind():
4700
4529
            raise errors.BzrCommandError('Local branch is not bound')
4701
4530
 
4702
4531
 
4703
4532
class cmd_uncommit(Command):
4704
 
    __doc__ = """Remove the last committed revision.
 
4533
    """Remove the last committed revision.
4705
4534
 
4706
4535
    --verbose will print out what is being removed.
4707
4536
    --dry-run will go through all the motions, but not actually
4747
4576
            b = control.open_branch()
4748
4577
 
4749
4578
        if tree is not None:
4750
 
            self.add_cleanup(tree.lock_write().unlock)
 
4579
            tree.lock_write()
4751
4580
        else:
4752
 
            self.add_cleanup(b.lock_write().unlock)
4753
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4581
            b.lock_write()
 
4582
        try:
 
4583
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4584
                             local=local)
 
4585
        finally:
 
4586
            if tree is not None:
 
4587
                tree.unlock()
 
4588
            else:
 
4589
                b.unlock()
4754
4590
 
4755
4591
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4756
4592
        from bzrlib.log import log_formatter, show_log
4788
4624
                 end_revision=last_revno)
4789
4625
 
4790
4626
        if dry_run:
4791
 
            self.outf.write('Dry-run, pretending to remove'
4792
 
                            ' the above revisions.\n')
 
4627
            print 'Dry-run, pretending to remove the above revisions.'
 
4628
            if not force:
 
4629
                val = raw_input('Press <enter> to continue')
4793
4630
        else:
4794
 
            self.outf.write('The above revision(s) will be removed.\n')
4795
 
 
4796
 
        if not force:
4797
 
            if not ui.ui_factory.get_boolean('Are you sure'):
4798
 
                self.outf.write('Canceled')
4799
 
                return 0
 
4631
            print 'The above revision(s) will be removed.'
 
4632
            if not force:
 
4633
                val = raw_input('Are you sure [y/N]? ')
 
4634
                if val.lower() not in ('y', 'yes'):
 
4635
                    print 'Canceled'
 
4636
                    return 0
4800
4637
 
4801
4638
        mutter('Uncommitting from {%s} to {%s}',
4802
4639
               last_rev_id, rev_id)
4803
4640
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4804
4641
                 revno=revno, local=local)
4805
 
        self.outf.write('You can restore the old tip by running:\n'
4806
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4642
        note('You can restore the old tip by running:\n'
 
4643
             '  bzr pull . -r revid:%s', last_rev_id)
4807
4644
 
4808
4645
 
4809
4646
class cmd_break_lock(Command):
4810
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
4647
    """Break a dead lock on a repository, branch or working directory.
4811
4648
 
4812
4649
    CAUTION: Locks should only be broken when you are sure that the process
4813
4650
    holding the lock has been stopped.
4814
4651
 
4815
 
    You can get information on what locks are open via the 'bzr info
4816
 
    [location]' command.
 
4652
    You can get information on what locks are open via the 'bzr info' command.
4817
4653
 
4818
4654
    :Examples:
4819
4655
        bzr break-lock
4820
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4821
4656
    """
4822
4657
    takes_args = ['location?']
4823
4658
 
4832
4667
 
4833
4668
 
4834
4669
class cmd_wait_until_signalled(Command):
4835
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4670
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4836
4671
 
4837
4672
    This just prints a line to signal when it is ready, then blocks on stdin.
4838
4673
    """
4846
4681
 
4847
4682
 
4848
4683
class cmd_serve(Command):
4849
 
    __doc__ = """Run the bzr server."""
 
4684
    """Run the bzr server."""
4850
4685
 
4851
4686
    aliases = ['server']
4852
4687
 
4853
4688
    takes_options = [
4854
4689
        Option('inet',
4855
4690
               help='Serve on stdin/out for use from inetd or sshd.'),
4856
 
        RegistryOption('protocol',
4857
 
               help="Protocol to serve.",
 
4691
        RegistryOption('protocol', 
 
4692
               help="Protocol to serve.", 
4858
4693
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4859
4694
               value_switches=True),
4860
4695
        Option('port',
4863
4698
                    'result in a dynamically allocated port.  The default port '
4864
4699
                    'depends on the protocol.',
4865
4700
               type=str),
4866
 
        custom_help('directory',
4867
 
               help='Serve contents of this directory.'),
 
4701
        Option('directory',
 
4702
               help='Serve contents of this directory.',
 
4703
               type=unicode),
4868
4704
        Option('allow-writes',
4869
4705
               help='By default the server is a readonly server.  Supplying '
4870
4706
                    '--allow-writes enables write access to the contents of '
4871
 
                    'the served directory and below.  Note that ``bzr serve`` '
4872
 
                    'does not perform authentication, so unless some form of '
4873
 
                    'external authentication is arranged supplying this '
4874
 
                    'option leads to global uncontrolled write access to your '
4875
 
                    'file system.'
 
4707
                    'the served directory and below.'
4876
4708
                ),
4877
4709
        ]
4878
4710
 
4897
4729
 
4898
4730
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4899
4731
            protocol=None):
4900
 
        from bzrlib import transport
 
4732
        from bzrlib.transport import get_transport, transport_server_registry
4901
4733
        if directory is None:
4902
4734
            directory = os.getcwd()
4903
4735
        if protocol is None:
4904
 
            protocol = transport.transport_server_registry.get()
 
4736
            protocol = transport_server_registry.get()
4905
4737
        host, port = self.get_host_and_port(port)
4906
4738
        url = urlutils.local_path_to_url(directory)
4907
4739
        if not allow_writes:
4908
4740
            url = 'readonly+' + url
4909
 
        t = transport.get_transport(url)
4910
 
        protocol(t, host, port, inet)
 
4741
        transport = get_transport(url)
 
4742
        protocol(transport, host, port, inet)
4911
4743
 
4912
4744
 
4913
4745
class cmd_join(Command):
4914
 
    __doc__ = """Combine a tree into its containing tree.
 
4746
    """Combine a tree into its containing tree.
4915
4747
 
4916
4748
    This command requires the target tree to be in a rich-root format.
4917
4749
 
4957
4789
 
4958
4790
 
4959
4791
class cmd_split(Command):
4960
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4792
    """Split a subdirectory of a tree into a separate tree.
4961
4793
 
4962
4794
    This command will produce a target tree in a format that supports
4963
4795
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4983
4815
 
4984
4816
 
4985
4817
class cmd_merge_directive(Command):
4986
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4818
    """Generate a merge directive for auto-merge tools.
4987
4819
 
4988
4820
    A directive requests a merge to be performed, and also provides all the
4989
4821
    information necessary to do so.  This means it must either include a
5006
4838
    _see_also = ['send']
5007
4839
 
5008
4840
    takes_options = [
5009
 
        'directory',
5010
4841
        RegistryOption.from_kwargs('patch-type',
5011
4842
            'The type of patch to include in the directive.',
5012
4843
            title='Patch type',
5025
4856
    encoding_type = 'exact'
5026
4857
 
5027
4858
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5028
 
            sign=False, revision=None, mail_to=None, message=None,
5029
 
            directory=u'.'):
 
4859
            sign=False, revision=None, mail_to=None, message=None):
5030
4860
        from bzrlib.revision import ensure_null, NULL_REVISION
5031
4861
        include_patch, include_bundle = {
5032
4862
            'plain': (False, False),
5033
4863
            'diff': (True, False),
5034
4864
            'bundle': (True, True),
5035
4865
            }[patch_type]
5036
 
        branch = Branch.open(directory)
 
4866
        branch = Branch.open('.')
5037
4867
        stored_submit_branch = branch.get_submit_branch()
5038
4868
        if submit_branch is None:
5039
4869
            submit_branch = stored_submit_branch
5084
4914
 
5085
4915
 
5086
4916
class cmd_send(Command):
5087
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4917
    """Mail or create a merge-directive for submitting changes.
5088
4918
 
5089
4919
    A merge directive provides many things needed for requesting merges:
5090
4920
 
5096
4926
      directly from the merge directive, without retrieving data from a
5097
4927
      branch.
5098
4928
 
5099
 
    `bzr send` creates a compact data set that, when applied using bzr
5100
 
    merge, has the same effect as merging from the source branch.  
5101
 
    
5102
 
    By default the merge directive is self-contained and can be applied to any
5103
 
    branch containing submit_branch in its ancestory without needing access to
5104
 
    the source branch.
5105
 
    
5106
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5107
 
    revisions, but only a structured request to merge from the
5108
 
    public_location.  In that case the public_branch is needed and it must be
5109
 
    up-to-date and accessible to the recipient.  The public_branch is always
5110
 
    included if known, so that people can check it later.
5111
 
 
5112
 
    The submit branch defaults to the parent of the source branch, but can be
5113
 
    overridden.  Both submit branch and public branch will be remembered in
5114
 
    branch.conf the first time they are used for a particular branch.  The
5115
 
    source branch defaults to that containing the working directory, but can
5116
 
    be changed using --from.
5117
 
 
5118
 
    In order to calculate those changes, bzr must analyse the submit branch.
5119
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5120
 
    If a public location is known for the submit_branch, that location is used
5121
 
    in the merge directive.
5122
 
 
5123
 
    The default behaviour is to send the merge directive by mail, unless -o is
5124
 
    given, in which case it is sent to a file.
 
4929
    If --no-bundle is specified, then public_branch is needed (and must be
 
4930
    up-to-date), so that the receiver can perform the merge using the
 
4931
    public_branch.  The public_branch is always included if known, so that
 
4932
    people can check it later.
 
4933
 
 
4934
    The submit branch defaults to the parent, but can be overridden.  Both
 
4935
    submit branch and public branch will be remembered if supplied.
 
4936
 
 
4937
    If a public_branch is known for the submit_branch, that public submit
 
4938
    branch is used in the merge instructions.  This means that a local mirror
 
4939
    can be used as your actual submit branch, once you have set public_branch
 
4940
    for that mirror.
5125
4941
 
5126
4942
    Mail is sent using your preferred mail program.  This should be transparent
5127
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4943
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5128
4944
    If the preferred client can't be found (or used), your editor will be used.
5129
4945
 
5130
4946
    To use a specific mail program, set the mail_client configuration option.
5131
4947
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5132
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5133
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5134
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5135
 
    supported clients.
 
4948
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4949
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4950
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5136
4951
 
5137
4952
    If mail is being sent, a to address is required.  This can be supplied
5138
4953
    either on the commandline, by setting the submit_to configuration
5147
4962
 
5148
4963
    The merge directives created by bzr send may be applied using bzr merge or
5149
4964
    bzr pull by specifying a file containing a merge directive as the location.
5150
 
 
5151
 
    bzr send makes extensive use of public locations to map local locations into
5152
 
    URLs that can be used by other people.  See `bzr help configuration` to
5153
 
    set them, and use `bzr info` to display them.
5154
4965
    """
5155
4966
 
5156
4967
    encoding_type = 'exact'
5172
4983
               short_name='f',
5173
4984
               type=unicode),
5174
4985
        Option('output', short_name='o',
5175
 
               help='Write merge directive to this file or directory; '
 
4986
               help='Write merge directive to this file; '
5176
4987
                    'use - for stdout.',
5177
4988
               type=unicode),
5178
4989
        Option('strict',
5201
5012
 
5202
5013
 
5203
5014
class cmd_bundle_revisions(cmd_send):
5204
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5015
    """Create a merge-directive for submitting changes.
5205
5016
 
5206
5017
    A merge directive provides many things needed for requesting merges:
5207
5018
 
5274
5085
 
5275
5086
 
5276
5087
class cmd_tag(Command):
5277
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5088
    """Create, remove or modify a tag naming a revision.
5278
5089
 
5279
5090
    Tags give human-meaningful names to revisions.  Commands that take a -r
5280
5091
    (--revision) option can be given -rtag:X, where X is any previously
5288
5099
 
5289
5100
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5290
5101
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5291
 
 
5292
 
    If no tag name is specified it will be determined through the 
5293
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5294
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5295
 
    details.
5296
5102
    """
5297
5103
 
5298
5104
    _see_also = ['commit', 'tags']
5299
 
    takes_args = ['tag_name?']
 
5105
    takes_args = ['tag_name']
5300
5106
    takes_options = [
5301
5107
        Option('delete',
5302
5108
            help='Delete this tag rather than placing it.',
5303
5109
            ),
5304
 
        custom_help('directory',
5305
 
            help='Branch in which to place the tag.'),
 
5110
        Option('directory',
 
5111
            help='Branch in which to place the tag.',
 
5112
            short_name='d',
 
5113
            type=unicode,
 
5114
            ),
5306
5115
        Option('force',
5307
5116
            help='Replace existing tags.',
5308
5117
            ),
5309
5118
        'revision',
5310
5119
        ]
5311
5120
 
5312
 
    def run(self, tag_name=None,
 
5121
    def run(self, tag_name,
5313
5122
            delete=None,
5314
5123
            directory='.',
5315
5124
            force=None,
5316
5125
            revision=None,
5317
5126
            ):
5318
5127
        branch, relpath = Branch.open_containing(directory)
5319
 
        self.add_cleanup(branch.lock_write().unlock)
5320
 
        if delete:
5321
 
            if tag_name is None:
5322
 
                raise errors.BzrCommandError("No tag specified to delete.")
5323
 
            branch.tags.delete_tag(tag_name)
5324
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
5325
 
        else:
5326
 
            if revision:
5327
 
                if len(revision) != 1:
5328
 
                    raise errors.BzrCommandError(
5329
 
                        "Tags can only be placed on a single revision, "
5330
 
                        "not on a range")
5331
 
                revision_id = revision[0].as_revision_id(branch)
 
5128
        branch.lock_write()
 
5129
        try:
 
5130
            if delete:
 
5131
                branch.tags.delete_tag(tag_name)
 
5132
                self.outf.write('Deleted tag %s.\n' % tag_name)
5332
5133
            else:
5333
 
                revision_id = branch.last_revision()
5334
 
            if tag_name is None:
5335
 
                tag_name = branch.automatic_tag_name(revision_id)
5336
 
                if tag_name is None:
5337
 
                    raise errors.BzrCommandError(
5338
 
                        "Please specify a tag name.")
5339
 
            if (not force) and branch.tags.has_tag(tag_name):
5340
 
                raise errors.TagAlreadyExists(tag_name)
5341
 
            branch.tags.set_tag(tag_name, revision_id)
5342
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5134
                if revision:
 
5135
                    if len(revision) != 1:
 
5136
                        raise errors.BzrCommandError(
 
5137
                            "Tags can only be placed on a single revision, "
 
5138
                            "not on a range")
 
5139
                    revision_id = revision[0].as_revision_id(branch)
 
5140
                else:
 
5141
                    revision_id = branch.last_revision()
 
5142
                if (not force) and branch.tags.has_tag(tag_name):
 
5143
                    raise errors.TagAlreadyExists(tag_name)
 
5144
                branch.tags.set_tag(tag_name, revision_id)
 
5145
                self.outf.write('Created tag %s.\n' % tag_name)
 
5146
        finally:
 
5147
            branch.unlock()
5343
5148
 
5344
5149
 
5345
5150
class cmd_tags(Command):
5346
 
    __doc__ = """List tags.
 
5151
    """List tags.
5347
5152
 
5348
5153
    This command shows a table of tag names and the revisions they reference.
5349
5154
    """
5350
5155
 
5351
5156
    _see_also = ['tag']
5352
5157
    takes_options = [
5353
 
        custom_help('directory',
5354
 
            help='Branch whose tags should be displayed.'),
 
5158
        Option('directory',
 
5159
            help='Branch whose tags should be displayed.',
 
5160
            short_name='d',
 
5161
            type=unicode,
 
5162
            ),
5355
5163
        RegistryOption.from_kwargs('sort',
5356
5164
            'Sort tags by different criteria.', title='Sorting',
5357
5165
            alpha='Sort tags lexicographically (default).',
5374
5182
        if not tags:
5375
5183
            return
5376
5184
 
5377
 
        self.add_cleanup(branch.lock_read().unlock)
5378
 
        if revision:
5379
 
            graph = branch.repository.get_graph()
5380
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5381
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5382
 
            # only show revisions between revid1 and revid2 (inclusive)
5383
 
            tags = [(tag, revid) for tag, revid in tags if
5384
 
                graph.is_between(revid, revid1, revid2)]
5385
 
        if sort == 'alpha':
5386
 
            tags.sort()
5387
 
        elif sort == 'time':
5388
 
            timestamps = {}
5389
 
            for tag, revid in tags:
5390
 
                try:
5391
 
                    revobj = branch.repository.get_revision(revid)
5392
 
                except errors.NoSuchRevision:
5393
 
                    timestamp = sys.maxint # place them at the end
5394
 
                else:
5395
 
                    timestamp = revobj.timestamp
5396
 
                timestamps[revid] = timestamp
5397
 
            tags.sort(key=lambda x: timestamps[x[1]])
5398
 
        if not show_ids:
5399
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5400
 
            for index, (tag, revid) in enumerate(tags):
5401
 
                try:
5402
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5403
 
                    if isinstance(revno, tuple):
5404
 
                        revno = '.'.join(map(str, revno))
5405
 
                except errors.NoSuchRevision:
5406
 
                    # Bad tag data/merges can lead to tagged revisions
5407
 
                    # which are not in this branch. Fail gracefully ...
5408
 
                    revno = '?'
5409
 
                tags[index] = (tag, revno)
5410
 
        self.cleanup_now()
 
5185
        branch.lock_read()
 
5186
        try:
 
5187
            if revision:
 
5188
                graph = branch.repository.get_graph()
 
5189
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5190
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5191
                # only show revisions between revid1 and revid2 (inclusive)
 
5192
                tags = [(tag, revid) for tag, revid in tags if
 
5193
                    graph.is_between(revid, revid1, revid2)]
 
5194
            if sort == 'alpha':
 
5195
                tags.sort()
 
5196
            elif sort == 'time':
 
5197
                timestamps = {}
 
5198
                for tag, revid in tags:
 
5199
                    try:
 
5200
                        revobj = branch.repository.get_revision(revid)
 
5201
                    except errors.NoSuchRevision:
 
5202
                        timestamp = sys.maxint # place them at the end
 
5203
                    else:
 
5204
                        timestamp = revobj.timestamp
 
5205
                    timestamps[revid] = timestamp
 
5206
                tags.sort(key=lambda x: timestamps[x[1]])
 
5207
            if not show_ids:
 
5208
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5209
                for index, (tag, revid) in enumerate(tags):
 
5210
                    try:
 
5211
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5212
                        if isinstance(revno, tuple):
 
5213
                            revno = '.'.join(map(str, revno))
 
5214
                    except errors.NoSuchRevision:
 
5215
                        # Bad tag data/merges can lead to tagged revisions
 
5216
                        # which are not in this branch. Fail gracefully ...
 
5217
                        revno = '?'
 
5218
                    tags[index] = (tag, revno)
 
5219
        finally:
 
5220
            branch.unlock()
5411
5221
        for tag, revspec in tags:
5412
5222
            self.outf.write('%-20s %s\n' % (tag, revspec))
5413
5223
 
5414
5224
 
5415
5225
class cmd_reconfigure(Command):
5416
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5226
    """Reconfigure the type of a bzr directory.
5417
5227
 
5418
5228
    A target configuration must be specified.
5419
5229
 
5449
5259
            ),
5450
5260
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5451
5261
        Option('force',
5452
 
            help='Perform reconfiguration even if local changes'
5453
 
            ' will be lost.'),
5454
 
        Option('stacked-on',
5455
 
            help='Reconfigure a branch to be stacked on another branch.',
5456
 
            type=unicode,
5457
 
            ),
5458
 
        Option('unstacked',
5459
 
            help='Reconfigure a branch to be unstacked.  This '
5460
 
                'may require copying substantial data into it.',
5461
 
            ),
 
5262
               help='Perform reconfiguration even if local changes'
 
5263
               ' will be lost.')
5462
5264
        ]
5463
5265
 
5464
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5465
 
            stacked_on=None,
5466
 
            unstacked=None):
 
5266
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5467
5267
        directory = bzrdir.BzrDir.open(location)
5468
 
        if stacked_on and unstacked:
5469
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5470
 
        elif stacked_on is not None:
5471
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5472
 
        elif unstacked:
5473
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5474
 
        # At the moment you can use --stacked-on and a different
5475
 
        # reconfiguration shape at the same time; there seems no good reason
5476
 
        # to ban it.
5477
5268
        if target_type is None:
5478
 
            if stacked_on or unstacked:
5479
 
                return
5480
 
            else:
5481
 
                raise errors.BzrCommandError('No target configuration '
5482
 
                    'specified')
 
5269
            raise errors.BzrCommandError('No target configuration specified')
5483
5270
        elif target_type == 'branch':
5484
5271
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5485
5272
        elif target_type == 'tree':
5504
5291
 
5505
5292
 
5506
5293
class cmd_switch(Command):
5507
 
    __doc__ = """Set the branch of a checkout and update.
 
5294
    """Set the branch of a checkout and update.
5508
5295
 
5509
5296
    For lightweight checkouts, this changes the branch being referenced.
5510
5297
    For heavyweight checkouts, this checks that there are no local commits
5522
5309
    /path/to/newbranch.
5523
5310
 
5524
5311
    Bound branches use the nickname of its master branch unless it is set
5525
 
    locally, in which case switching will update the local nickname to be
 
5312
    locally, in which case switching will update the the local nickname to be
5526
5313
    that of the master.
5527
5314
    """
5528
5315
 
5529
 
    takes_args = ['to_location?']
5530
 
    takes_options = ['directory',
5531
 
                     Option('force',
 
5316
    takes_args = ['to_location']
 
5317
    takes_options = [Option('force',
5532
5318
                        help='Switch even if local commits will be lost.'),
5533
 
                     'revision',
5534
5319
                     Option('create-branch', short_name='b',
5535
5320
                        help='Create the target branch from this one before'
5536
5321
                             ' switching to it.'),
5537
 
                    ]
 
5322
                     ]
5538
5323
 
5539
 
    def run(self, to_location=None, force=False, create_branch=False,
5540
 
            revision=None, directory=u'.'):
 
5324
    def run(self, to_location, force=False, create_branch=False):
5541
5325
        from bzrlib import switch
5542
 
        tree_location = directory
5543
 
        revision = _get_one_revision('switch', revision)
 
5326
        tree_location = '.'
5544
5327
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5545
 
        if to_location is None:
5546
 
            if revision is None:
5547
 
                raise errors.BzrCommandError('You must supply either a'
5548
 
                                             ' revision or a location')
5549
 
            to_location = tree_location
5550
5328
        try:
5551
5329
            branch = control_dir.open_branch()
5552
5330
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5557
5335
            if branch is None:
5558
5336
                raise errors.BzrCommandError('cannot create branch without'
5559
5337
                                             ' source branch')
5560
 
            to_location = directory_service.directories.dereference(
5561
 
                              to_location)
5562
5338
            if '/' not in to_location and '\\' not in to_location:
5563
5339
                # This path is meant to be relative to the existing branch
5564
5340
                this_url = self._get_branch_location(control_dir)
5566
5342
            to_branch = branch.bzrdir.sprout(to_location,
5567
5343
                                 possible_transports=[branch.bzrdir.root_transport],
5568
5344
                                 source_branch=branch).open_branch()
 
5345
            # try:
 
5346
            #     from_branch = control_dir.open_branch()
 
5347
            # except errors.NotBranchError:
 
5348
            #     raise BzrCommandError('Cannot create a branch from this'
 
5349
            #         ' location when we cannot open this branch')
 
5350
            # from_branch.bzrdir.sprout(
 
5351
            pass
5569
5352
        else:
5570
5353
            try:
5571
5354
                to_branch = Branch.open(to_location)
5573
5356
                this_url = self._get_branch_location(control_dir)
5574
5357
                to_branch = Branch.open(
5575
5358
                    urlutils.join(this_url, '..', to_location))
5576
 
        if revision is not None:
5577
 
            revision = revision.as_revision_id(to_branch)
5578
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5359
        switch.switch(control_dir, to_branch, force)
5579
5360
        if had_explicit_nick:
5580
5361
            branch = control_dir.open_branch() #get the new branch!
5581
5362
            branch.nick = to_branch.nick
5601
5382
 
5602
5383
 
5603
5384
class cmd_view(Command):
5604
 
    __doc__ = """Manage filtered views.
 
5385
    """Manage filtered views.
5605
5386
 
5606
5387
    Views provide a mask over the tree so that users can focus on
5607
5388
    a subset of a tree when doing their work. After creating a view,
5687
5468
            name=None,
5688
5469
            switch=None,
5689
5470
            ):
5690
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5691
 
            apply_view=False)
 
5471
        tree, file_list = tree_files(file_list, apply_view=False)
5692
5472
        current_view, view_dict = tree.views.get_view_info()
5693
5473
        if name is None:
5694
5474
            name = current_view
5756
5536
 
5757
5537
 
5758
5538
class cmd_hooks(Command):
5759
 
    __doc__ = """Show hooks."""
 
5539
    """Show hooks."""
5760
5540
 
5761
5541
    hidden = True
5762
5542
 
5775
5555
                    self.outf.write("    <no hooks installed>\n")
5776
5556
 
5777
5557
 
5778
 
class cmd_remove_branch(Command):
5779
 
    __doc__ = """Remove a branch.
5780
 
 
5781
 
    This will remove the branch from the specified location but 
5782
 
    will keep any working tree or repository in place.
5783
 
 
5784
 
    :Examples:
5785
 
 
5786
 
      Remove the branch at repo/trunk::
5787
 
 
5788
 
        bzr remove-branch repo/trunk
5789
 
 
5790
 
    """
5791
 
 
5792
 
    takes_args = ["location?"]
5793
 
 
5794
 
    aliases = ["rmbranch"]
5795
 
 
5796
 
    def run(self, location=None):
5797
 
        if location is None:
5798
 
            location = "."
5799
 
        branch = Branch.open_containing(location)[0]
5800
 
        branch.bzrdir.destroy_branch()
5801
 
        
5802
 
 
5803
5558
class cmd_shelve(Command):
5804
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5559
    """Temporarily set aside some changes from the current tree.
5805
5560
 
5806
5561
    Shelve allows you to temporarily put changes you've made "on the shelf",
5807
5562
    ie. out of the way, until a later time when you can bring them back from
5828
5583
    takes_args = ['file*']
5829
5584
 
5830
5585
    takes_options = [
5831
 
        'directory',
5832
5586
        'revision',
5833
5587
        Option('all', help='Shelve all changes.'),
5834
5588
        'message',
5843
5597
    _see_also = ['unshelve']
5844
5598
 
5845
5599
    def run(self, revision=None, all=False, file_list=None, message=None,
5846
 
            writer=None, list=False, destroy=False, directory=u'.'):
 
5600
            writer=None, list=False, destroy=False):
5847
5601
        if list:
5848
5602
            return self.run_for_list()
5849
5603
        from bzrlib.shelf_ui import Shelver
5850
5604
        if writer is None:
5851
5605
            writer = bzrlib.option.diff_writer_registry.get()
5852
5606
        try:
5853
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5854
 
                file_list, message, destroy=destroy, directory=directory)
5855
 
            try:
5856
 
                shelver.run()
5857
 
            finally:
5858
 
                shelver.finalize()
 
5607
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5608
                              message, destroy=destroy).run()
5859
5609
        except errors.UserAbort:
5860
5610
            return 0
5861
5611
 
5862
5612
    def run_for_list(self):
5863
5613
        tree = WorkingTree.open_containing('.')[0]
5864
 
        self.add_cleanup(tree.lock_read().unlock)
5865
 
        manager = tree.get_shelf_manager()
5866
 
        shelves = manager.active_shelves()
5867
 
        if len(shelves) == 0:
5868
 
            note('No shelved changes.')
5869
 
            return 0
5870
 
        for shelf_id in reversed(shelves):
5871
 
            message = manager.get_metadata(shelf_id).get('message')
5872
 
            if message is None:
5873
 
                message = '<no message>'
5874
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
5875
 
        return 1
 
5614
        tree.lock_read()
 
5615
        try:
 
5616
            manager = tree.get_shelf_manager()
 
5617
            shelves = manager.active_shelves()
 
5618
            if len(shelves) == 0:
 
5619
                note('No shelved changes.')
 
5620
                return 0
 
5621
            for shelf_id in reversed(shelves):
 
5622
                message = manager.get_metadata(shelf_id).get('message')
 
5623
                if message is None:
 
5624
                    message = '<no message>'
 
5625
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5626
            return 1
 
5627
        finally:
 
5628
            tree.unlock()
5876
5629
 
5877
5630
 
5878
5631
class cmd_unshelve(Command):
5879
 
    __doc__ = """Restore shelved changes.
 
5632
    """Restore shelved changes.
5880
5633
 
5881
5634
    By default, the most recently shelved changes are restored. However if you
5882
5635
    specify a shelf by id those changes will be restored instead.  This works
5885
5638
 
5886
5639
    takes_args = ['shelf_id?']
5887
5640
    takes_options = [
5888
 
        'directory',
5889
5641
        RegistryOption.from_kwargs(
5890
5642
            'action', help="The action to perform.",
5891
5643
            enum_switch=False, value_switches=True,
5892
5644
            apply="Apply changes and remove from the shelf.",
5893
5645
            dry_run="Show changes, but do not apply or remove them.",
5894
 
            preview="Instead of unshelving the changes, show the diff that "
5895
 
                    "would result from unshelving.",
5896
 
            delete_only="Delete changes without applying them.",
5897
 
            keep="Apply changes but don't delete them.",
 
5646
            delete_only="Delete changes without applying them."
5898
5647
        )
5899
5648
    ]
5900
5649
    _see_also = ['shelve']
5901
5650
 
5902
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5651
    def run(self, shelf_id=None, action='apply'):
5903
5652
        from bzrlib.shelf_ui import Unshelver
5904
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5905
 
        try:
5906
 
            unshelver.run()
5907
 
        finally:
5908
 
            unshelver.tree.unlock()
 
5653
        Unshelver.from_args(shelf_id, action).run()
5909
5654
 
5910
5655
 
5911
5656
class cmd_clean_tree(Command):
5912
 
    __doc__ = """Remove unwanted files from working tree.
 
5657
    """Remove unwanted files from working tree.
5913
5658
 
5914
5659
    By default, only unknown files, not ignored files, are deleted.  Versioned
5915
5660
    files are never deleted.
5923
5668
 
5924
5669
    To check what clean-tree will do, use --dry-run.
5925
5670
    """
5926
 
    takes_options = ['directory',
5927
 
                     Option('ignored', help='Delete all ignored files.'),
 
5671
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5928
5672
                     Option('detritus', help='Delete conflict files, merge'
5929
5673
                            ' backups, and failed selftest dirs.'),
5930
5674
                     Option('unknown',
5933
5677
                            ' deleting them.'),
5934
5678
                     Option('force', help='Do not prompt before deleting.')]
5935
5679
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5936
 
            force=False, directory=u'.'):
 
5680
            force=False):
5937
5681
        from bzrlib.clean_tree import clean_tree
5938
5682
        if not (unknown or ignored or detritus):
5939
5683
            unknown = True
5940
5684
        if dry_run:
5941
5685
            force = True
5942
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
5943
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5686
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5687
                   dry_run=dry_run, no_prompt=force)
5944
5688
 
5945
5689
 
5946
5690
class cmd_reference(Command):
5947
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5691
    """list, view and set branch locations for nested trees.
5948
5692
 
5949
5693
    If no arguments are provided, lists the branch locations for nested trees.
5950
5694
    If one argument is provided, display the branch location for that tree.
5990
5734
            self.outf.write('%s %s\n' % (path, location))
5991
5735
 
5992
5736
 
5993
 
def _register_lazy_builtins():
5994
 
    # register lazy builtins from other modules; called at startup and should
5995
 
    # be only called once.
5996
 
    for (name, aliases, module_name) in [
5997
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
5998
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
5999
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6000
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6001
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6002
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6003
 
        ]:
6004
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5737
# these get imported and then picked up by the scan for cmd_*
 
5738
# TODO: Some more consistent way to split command definitions across files;
 
5739
# we do need to load at least some information about them to know of
 
5740
# aliases.  ideally we would avoid loading the implementation until the
 
5741
# details were needed.
 
5742
from bzrlib.cmd_version_info import cmd_version_info
 
5743
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5744
from bzrlib.bundle.commands import (
 
5745
    cmd_bundle_info,
 
5746
    )
 
5747
from bzrlib.foreign import cmd_dpush
 
5748
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5749
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5750
        cmd_weave_plan_merge, cmd_weave_merge_text