~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2009-06-19 21:16:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4481.
  • Revision ID: aaron@aaronbentley.com-20090619211631-4fnkv2uui98xj7ux
Provide control over switch and shelver messaging.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2011 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
 
    config as _mod_config,
 
35
    config,
36
36
    errors,
37
37
    globbing,
38
38
    hooks,
43
43
    reconfigure,
44
44
    rename_map,
45
45
    revision as _mod_revision,
46
 
    static_tuple,
47
 
    timestamp,
 
46
    symbol_versioning,
48
47
    transport,
 
48
    tree as _mod_tree,
49
49
    ui,
50
50
    urlutils,
51
51
    views,
52
 
    gpg,
53
52
    )
54
53
from bzrlib.branch import Branch
55
54
from bzrlib.conflicts import ConflictList
56
 
from bzrlib.transport import memory
57
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
56
from bzrlib.smtp_connection import SMTPConnection
59
57
from bzrlib.workingtree import WorkingTree
60
58
""")
61
59
 
62
 
from bzrlib.commands import (
63
 
    Command,
64
 
    builtin_command_registry,
65
 
    display_command,
66
 
    )
 
60
from bzrlib.commands import Command, display_command
67
61
from bzrlib.option import (
68
62
    ListOption,
69
63
    Option,
72
66
    _parse_revision_str,
73
67
    )
74
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
 
from bzrlib import (
76
 
    symbol_versioning,
77
 
    )
78
 
 
79
 
 
80
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
 
69
 
 
70
 
81
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
82
72
    apply_view=True):
83
 
    return internal_tree_files(file_list, default_branch, canonicalize,
84
 
        apply_view)
 
73
    try:
 
74
        return internal_tree_files(file_list, default_branch, canonicalize,
 
75
            apply_view)
 
76
    except errors.FileInWrongBranch, e:
 
77
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
78
                                     (e.path, file_list[0]))
85
79
 
86
80
 
87
81
def tree_files_for_add(file_list):
127
121
 
128
122
 
129
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
130
 
    """Get a revision tree. Not suitable for commands that change the tree.
131
 
    
132
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
133
 
    and doing a commit/uncommit/pull will at best fail due to changing the
134
 
    basis revision data.
135
 
 
136
 
    If tree is passed in, it should be already locked, for lifetime management
137
 
    of the trees internal cached state.
138
 
    """
139
124
    if branch is None:
140
125
        branch = tree.branch
141
126
    if revisions is None:
151
136
 
152
137
# XXX: Bad function name; should possibly also be a class method of
153
138
# WorkingTree rather than a function.
154
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
139
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
140
    apply_view=True):
157
141
    """Convert command-line paths to a WorkingTree and relative paths.
158
142
 
159
 
    Deprecated: use WorkingTree.open_containing_paths instead.
160
 
 
161
143
    This is typically used for command-line processors that take one or
162
144
    more filenames, and infer the workingtree that contains them.
163
145
 
173
155
 
174
156
    :return: workingtree, [relative_paths]
175
157
    """
176
 
    return WorkingTree.open_containing_paths(
177
 
        file_list, default_directory='.',
178
 
        canonicalize=True,
179
 
        apply_view=True)
 
158
    if file_list is None or len(file_list) == 0:
 
159
        tree = WorkingTree.open_containing(default_branch)[0]
 
160
        if tree.supports_views() and apply_view:
 
161
            view_files = tree.views.lookup_view()
 
162
            if view_files:
 
163
                file_list = view_files
 
164
                view_str = views.view_display_str(view_files)
 
165
                note("Ignoring files outside view. View is %s" % view_str)
 
166
        return tree, file_list
 
167
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
168
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
169
        apply_view=apply_view)
 
170
 
 
171
 
 
172
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
173
    """Convert file_list into a list of relpaths in tree.
 
174
 
 
175
    :param tree: A tree to operate on.
 
176
    :param file_list: A list of user provided paths or None.
 
177
    :param apply_view: if True and a view is set, apply it or check that
 
178
        specified files are within it
 
179
    :return: A list of relative paths.
 
180
    :raises errors.PathNotChild: When a provided path is in a different tree
 
181
        than tree.
 
182
    """
 
183
    if file_list is None:
 
184
        return None
 
185
    if tree.supports_views() and apply_view:
 
186
        view_files = tree.views.lookup_view()
 
187
    else:
 
188
        view_files = []
 
189
    new_list = []
 
190
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
191
    # doesn't - fix that up here before we enter the loop.
 
192
    if canonicalize:
 
193
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
194
    else:
 
195
        fixer = tree.relpath
 
196
    for filename in file_list:
 
197
        try:
 
198
            relpath = fixer(osutils.dereference_path(filename))
 
199
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
200
                raise errors.FileOutsideView(filename, view_files)
 
201
            new_list.append(relpath)
 
202
        except errors.PathNotChild:
 
203
            raise errors.FileInWrongBranch(tree.branch, filename)
 
204
    return new_list
180
205
 
181
206
 
182
207
def _get_view_info_for_change_reporter(tree):
191
216
    return view_info
192
217
 
193
218
 
194
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
195
 
    """Open the tree or branch containing the specified file, unless
196
 
    the --directory option is used to specify a different branch."""
197
 
    if directory is not None:
198
 
        return (None, Branch.open(directory), filename)
199
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
200
 
 
201
 
 
202
219
# TODO: Make sure no commands unconditionally use the working directory as a
203
220
# branch.  If a filename argument is used, the first of them should be used to
204
221
# specify the branch.  (Perhaps this can be factored out into some kind of
206
223
# opens the branch?)
207
224
 
208
225
class cmd_status(Command):
209
 
    __doc__ = """Display status summary.
 
226
    """Display status summary.
210
227
 
211
228
    This reports on versioned and unknown files, reporting them
212
229
    grouped by state.  Possible states are:
232
249
    unknown
233
250
        Not versioned and not matching an ignore pattern.
234
251
 
235
 
    Additionally for directories, symlinks and files with a changed
236
 
    executable bit, Bazaar indicates their type using a trailing
237
 
    character: '/', '@' or '*' respectively. These decorations can be
238
 
    disabled using the '--no-classify' option.
239
 
 
240
252
    To see ignored files use 'bzr ignored'.  For details on the
241
253
    changes to file texts, use 'bzr diff'.
242
254
 
254
266
    To skip the display of pending merge information altogether, use
255
267
    the no-pending option or specify a file/directory.
256
268
 
257
 
    To compare the working directory to a specific revision, pass a
258
 
    single revision to the revision argument.
259
 
 
260
 
    To see which files have changed in a specific revision, or between
261
 
    two revisions, pass a revision range to the revision argument.
262
 
    This will produce the same results as calling 'bzr diff --summarize'.
 
269
    If a revision argument is given, the status is calculated against
 
270
    that revision, or between two revisions if two are provided.
263
271
    """
264
272
 
265
273
    # TODO: --no-recurse, --recurse options
272
280
                            short_name='V'),
273
281
                     Option('no-pending', help='Don\'t show pending merges.',
274
282
                           ),
275
 
                     Option('no-classify',
276
 
                            help='Do not mark object type using indicator.',
277
 
                           ),
278
283
                     ]
279
284
    aliases = ['st', 'stat']
280
285
 
283
288
 
284
289
    @display_command
285
290
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
286
 
            versioned=False, no_pending=False, verbose=False,
287
 
            no_classify=False):
 
291
            versioned=False, no_pending=False, verbose=False):
288
292
        from bzrlib.status import show_tree_status
289
293
 
290
294
        if revision and len(revision) > 2:
291
295
            raise errors.BzrCommandError('bzr status --revision takes exactly'
292
296
                                         ' one or two revision specifiers')
293
297
 
294
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
298
        tree, relfile_list = tree_files(file_list)
295
299
        # Avoid asking for specific files when that is not needed.
296
300
        if relfile_list == ['']:
297
301
            relfile_list = None
304
308
        show_tree_status(tree, show_ids=show_ids,
305
309
                         specific_files=relfile_list, revision=revision,
306
310
                         to_file=self.outf, short=short, versioned=versioned,
307
 
                         show_pending=(not no_pending), verbose=verbose,
308
 
                         classify=not no_classify)
 
311
                         show_pending=(not no_pending), verbose=verbose)
309
312
 
310
313
 
311
314
class cmd_cat_revision(Command):
312
 
    __doc__ = """Write out metadata for a revision.
 
315
    """Write out metadata for a revision.
313
316
 
314
317
    The revision to print can either be specified by a specific
315
318
    revision identifier, or you can use --revision.
317
320
 
318
321
    hidden = True
319
322
    takes_args = ['revision_id?']
320
 
    takes_options = ['directory', 'revision']
 
323
    takes_options = ['revision']
321
324
    # cat-revision is more for frontends so should be exact
322
325
    encoding = 'strict'
323
326
 
324
 
    def print_revision(self, revisions, revid):
325
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
326
 
        record = stream.next()
327
 
        if record.storage_kind == 'absent':
328
 
            raise errors.NoSuchRevision(revisions, revid)
329
 
        revtext = record.get_bytes_as('fulltext')
330
 
        self.outf.write(revtext.decode('utf-8'))
331
 
 
332
327
    @display_command
333
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
328
    def run(self, revision_id=None, revision=None):
334
329
        if revision_id is not None and revision is not None:
335
330
            raise errors.BzrCommandError('You can only supply one of'
336
331
                                         ' revision_id or --revision')
337
332
        if revision_id is None and revision is None:
338
333
            raise errors.BzrCommandError('You must supply either'
339
334
                                         ' --revision or a revision_id')
340
 
 
341
 
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
342
 
 
343
 
        revisions = b.repository.revisions
344
 
        if revisions is None:
345
 
            raise errors.BzrCommandError('Repository %r does not support '
346
 
                'access to raw revision texts')
347
 
 
348
 
        b.repository.lock_read()
349
 
        try:
350
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
351
 
            if revision_id is not None:
352
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
353
 
                try:
354
 
                    self.print_revision(revisions, revision_id)
355
 
                except errors.NoSuchRevision:
356
 
                    msg = "The repository %s contains no revision %s." % (
357
 
                        b.repository.base, revision_id)
358
 
                    raise errors.BzrCommandError(msg)
359
 
            elif revision is not None:
360
 
                for rev in revision:
361
 
                    if rev is None:
362
 
                        raise errors.BzrCommandError(
363
 
                            'You cannot specify a NULL revision.')
364
 
                    rev_id = rev.as_revision_id(b)
365
 
                    self.print_revision(revisions, rev_id)
366
 
        finally:
367
 
            b.repository.unlock()
368
 
        
 
335
        b = WorkingTree.open_containing(u'.')[0].branch
 
336
 
 
337
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
338
        if revision_id is not None:
 
339
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
340
            try:
 
341
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
342
            except errors.NoSuchRevision:
 
343
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
344
                    revision_id)
 
345
                raise errors.BzrCommandError(msg)
 
346
        elif revision is not None:
 
347
            for rev in revision:
 
348
                if rev is None:
 
349
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
350
                                                 ' revision.')
 
351
                rev_id = rev.as_revision_id(b)
 
352
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
353
 
369
354
 
370
355
class cmd_dump_btree(Command):
371
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
356
    """Dump the contents of a btree index file to stdout.
372
357
 
373
358
    PATH is a btree index file, it can be any URL. This includes things like
374
359
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
407
                self.outf.write(page_bytes[:header_end])
423
408
                page_bytes = data
424
409
            self.outf.write('\nPage %d\n' % (page_idx,))
425
 
            if len(page_bytes) == 0:
426
 
                self.outf.write('(empty)\n');
427
 
            else:
428
 
                decomp_bytes = zlib.decompress(page_bytes)
429
 
                self.outf.write(decomp_bytes)
430
 
                self.outf.write('\n')
 
410
            decomp_bytes = zlib.decompress(page_bytes)
 
411
            self.outf.write(decomp_bytes)
 
412
            self.outf.write('\n')
431
413
 
432
414
    def _dump_entries(self, trans, basename):
433
415
        try:
441
423
        for node in bt.iter_all_entries():
442
424
            # Node is made up of:
443
425
            # (index, key, value, [references])
444
 
            try:
445
 
                refs = node[3]
446
 
            except IndexError:
447
 
                refs_as_tuples = None
448
 
            else:
449
 
                refs_as_tuples = static_tuple.as_tuples(refs)
450
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
451
 
            self.outf.write('%s\n' % (as_tuple,))
 
426
            self.outf.write('%s\n' % (node[1:],))
452
427
 
453
428
 
454
429
class cmd_remove_tree(Command):
455
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
430
    """Remove the working tree from a given branch/checkout.
456
431
 
457
432
    Since a lightweight checkout is little more than a working tree
458
433
    this will refuse to run against one.
460
435
    To re-create the working tree, use "bzr checkout".
461
436
    """
462
437
    _see_also = ['checkout', 'working-trees']
463
 
    takes_args = ['location*']
 
438
    takes_args = ['location?']
464
439
    takes_options = [
465
440
        Option('force',
466
441
               help='Remove the working tree even if it has '
467
 
                    'uncommitted or shelved changes.'),
 
442
                    'uncommitted changes.'),
468
443
        ]
469
444
 
470
 
    def run(self, location_list, force=False):
471
 
        if not location_list:
472
 
            location_list=['.']
473
 
 
474
 
        for location in location_list:
475
 
            d = bzrdir.BzrDir.open(location)
476
 
            
477
 
            try:
478
 
                working = d.open_workingtree()
479
 
            except errors.NoWorkingTree:
480
 
                raise errors.BzrCommandError("No working tree to remove")
481
 
            except errors.NotLocalUrl:
482
 
                raise errors.BzrCommandError("You cannot remove the working tree"
483
 
                                             " of a remote path")
484
 
            if not force:
485
 
                if (working.has_changes()):
486
 
                    raise errors.UncommittedChanges(working)
487
 
                if working.get_shelf_manager().last_shelf() is not None:
488
 
                    raise errors.ShelvedChanges(working)
489
 
 
490
 
            if working.user_url != working.branch.user_url:
491
 
                raise errors.BzrCommandError("You cannot remove the working tree"
492
 
                                             " from a lightweight checkout")
493
 
 
494
 
            d.destroy_workingtree()
495
 
 
496
 
 
497
 
class cmd_repair_workingtree(Command):
498
 
    __doc__ = """Reset the working tree state file.
499
 
 
500
 
    This is not meant to be used normally, but more as a way to recover from
501
 
    filesystem corruption, etc. This rebuilds the working inventory back to a
502
 
    'known good' state. Any new modifications (adding a file, renaming, etc)
503
 
    will be lost, though modified files will still be detected as such.
504
 
 
505
 
    Most users will want something more like "bzr revert" or "bzr update"
506
 
    unless the state file has become corrupted.
507
 
 
508
 
    By default this attempts to recover the current state by looking at the
509
 
    headers of the state file. If the state file is too corrupted to even do
510
 
    that, you can supply --revision to force the state of the tree.
511
 
    """
512
 
 
513
 
    takes_options = ['revision', 'directory',
514
 
        Option('force',
515
 
               help='Reset the tree even if it doesn\'t appear to be'
516
 
                    ' corrupted.'),
517
 
    ]
518
 
    hidden = True
519
 
 
520
 
    def run(self, revision=None, directory='.', force=False):
521
 
        tree, _ = WorkingTree.open_containing(directory)
522
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
445
    def run(self, location='.', force=False):
 
446
        d = bzrdir.BzrDir.open(location)
 
447
 
 
448
        try:
 
449
            working = d.open_workingtree()
 
450
        except errors.NoWorkingTree:
 
451
            raise errors.BzrCommandError("No working tree to remove")
 
452
        except errors.NotLocalUrl:
 
453
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
454
                                         "remote path")
523
455
        if not force:
524
 
            try:
525
 
                tree.check_state()
526
 
            except errors.BzrError:
527
 
                pass # There seems to be a real error here, so we'll reset
528
 
            else:
529
 
                # Refuse
530
 
                raise errors.BzrCommandError(
531
 
                    'The tree does not appear to be corrupt. You probably'
532
 
                    ' want "bzr revert" instead. Use "--force" if you are'
533
 
                    ' sure you want to reset the working tree.')
534
 
        if revision is None:
535
 
            revision_ids = None
536
 
        else:
537
 
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
538
 
        try:
539
 
            tree.reset_state(revision_ids)
540
 
        except errors.BzrError, e:
541
 
            if revision_ids is None:
542
 
                extra = (', the header appears corrupt, try passing -r -1'
543
 
                         ' to set the state to the last commit')
544
 
            else:
545
 
                extra = ''
546
 
            raise errors.BzrCommandError('failed to reset the tree state'
547
 
                                         + extra)
 
456
            changes = working.changes_from(working.basis_tree())
 
457
            if changes.has_changed():
 
458
                raise errors.UncommittedChanges(working)
 
459
 
 
460
        working_path = working.bzrdir.root_transport.base
 
461
        branch_path = working.branch.bzrdir.root_transport.base
 
462
        if working_path != branch_path:
 
463
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
464
                                         "a lightweight checkout")
 
465
 
 
466
        d.destroy_workingtree()
548
467
 
549
468
 
550
469
class cmd_revno(Command):
551
 
    __doc__ = """Show current revision number.
 
470
    """Show current revision number.
552
471
 
553
472
    This is equal to the number of revisions on this branch.
554
473
    """
555
474
 
556
475
    _see_also = ['info']
557
476
    takes_args = ['location?']
558
 
    takes_options = [
559
 
        Option('tree', help='Show revno of working tree'),
560
 
        ]
561
477
 
562
478
    @display_command
563
 
    def run(self, tree=False, location=u'.'):
564
 
        if tree:
565
 
            try:
566
 
                wt = WorkingTree.open_containing(location)[0]
567
 
                self.add_cleanup(wt.lock_read().unlock)
568
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
569
 
                raise errors.NoWorkingTree(location)
570
 
            revid = wt.last_revision()
571
 
            try:
572
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
573
 
            except errors.NoSuchRevision:
574
 
                revno_t = ('???',)
575
 
            revno = ".".join(str(n) for n in revno_t)
576
 
        else:
577
 
            b = Branch.open_containing(location)[0]
578
 
            self.add_cleanup(b.lock_read().unlock)
579
 
            revno = b.revno()
580
 
        self.cleanup_now()
581
 
        self.outf.write(str(revno) + '\n')
 
479
    def run(self, location=u'.'):
 
480
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
481
        self.outf.write('\n')
582
482
 
583
483
 
584
484
class cmd_revision_info(Command):
585
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
586
486
    """
587
487
    hidden = True
588
488
    takes_args = ['revision_info*']
589
489
    takes_options = [
590
490
        'revision',
591
 
        custom_help('directory',
 
491
        Option('directory',
592
492
            help='Branch to examine, '
593
 
                 'rather than the one containing the working directory.'),
594
 
        Option('tree', help='Show revno of working tree'),
 
493
                 'rather than the one containing the working directory.',
 
494
            short_name='d',
 
495
            type=unicode,
 
496
            ),
595
497
        ]
596
498
 
597
499
    @display_command
598
 
    def run(self, revision=None, directory=u'.', tree=False,
599
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
600
501
 
601
 
        try:
602
 
            wt = WorkingTree.open_containing(directory)[0]
603
 
            b = wt.branch
604
 
            self.add_cleanup(wt.lock_read().unlock)
605
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
606
 
            wt = None
607
 
            b = Branch.open_containing(directory)[0]
608
 
            self.add_cleanup(b.lock_read().unlock)
609
 
        revision_ids = []
 
502
        revs = []
610
503
        if revision is not None:
611
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
612
505
        if revision_info_list is not None:
613
 
            for rev_str in revision_info_list:
614
 
                rev_spec = RevisionSpec.from_string(rev_str)
615
 
                revision_ids.append(rev_spec.as_revision_id(b))
616
 
        # No arguments supplied, default to the last revision
617
 
        if len(revision_ids) == 0:
618
 
            if tree:
619
 
                if wt is None:
620
 
                    raise errors.NoWorkingTree(directory)
621
 
                revision_ids.append(wt.last_revision())
622
 
            else:
623
 
                revision_ids.append(b.last_revision())
624
 
 
625
 
        revinfos = []
626
 
        maxlen = 0
627
 
        for revision_id in revision_ids:
 
506
            for rev in revision_info_list:
 
507
                revs.append(RevisionSpec.from_string(rev))
 
508
 
 
509
        b = Branch.open_containing(directory)[0]
 
510
 
 
511
        if len(revs) == 0:
 
512
            revs.append(RevisionSpec.from_string('-1'))
 
513
 
 
514
        for rev in revs:
 
515
            revision_id = rev.as_revision_id(b)
628
516
            try:
629
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
630
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
631
518
            except errors.NoSuchRevision:
632
 
                revno = '???'
633
 
            maxlen = max(maxlen, len(revno))
634
 
            revinfos.append([revno, revision_id])
635
 
 
636
 
        self.cleanup_now()
637
 
        for ri in revinfos:
638
 
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
519
                dotted_map = b.get_revision_id_to_revno_map()
 
520
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
521
            print '%s %s' % (revno, revision_id)
639
522
 
640
523
 
641
524
class cmd_add(Command):
642
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
643
526
 
644
527
    In non-recursive mode, all the named items are added, regardless
645
528
    of whether they were previously ignored.  A warning is given if
671
554
    branches that will be merged later (without showing the two different
672
555
    adds as a conflict). It is also useful when merging another project
673
556
    into a subdirectory of this one.
674
 
    
675
 
    Any files matching patterns in the ignore list will not be added
676
 
    unless they are explicitly mentioned.
677
557
    """
678
558
    takes_args = ['file*']
679
559
    takes_options = [
687
567
               help='Lookup file ids from this tree.'),
688
568
        ]
689
569
    encoding_type = 'replace'
690
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
691
571
 
692
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
693
573
            file_ids_from=None):
710
590
                should_print=(not is_quiet()))
711
591
 
712
592
        if base_tree:
713
 
            self.add_cleanup(base_tree.lock_read().unlock)
714
 
        tree, file_list = tree_files_for_add(file_list)
715
 
        added, ignored = tree.smart_add(file_list, not
716
 
            no_recurse, action=action, save=not dry_run)
717
 
        self.cleanup_now()
 
593
            base_tree.lock_read()
 
594
        try:
 
595
            file_list = self._maybe_expand_globs(file_list)
 
596
            tree, file_list = tree_files_for_add(file_list)
 
597
            added, ignored = tree.smart_add(file_list, not
 
598
                no_recurse, action=action, save=not dry_run)
 
599
        finally:
 
600
            if base_tree is not None:
 
601
                base_tree.unlock()
718
602
        if len(ignored) > 0:
719
603
            if verbose:
720
604
                for glob in sorted(ignored.keys()):
721
605
                    for path in ignored[glob]:
722
606
                        self.outf.write("ignored %s matching \"%s\"\n"
723
607
                                        % (path, glob))
 
608
            else:
 
609
                match_len = 0
 
610
                for glob, paths in ignored.items():
 
611
                    match_len += len(paths)
 
612
                self.outf.write("ignored %d file(s).\n" % match_len)
 
613
            self.outf.write("If you wish to add ignored files, "
 
614
                            "please add them explicitly by name. "
 
615
                            "(\"bzr ignored\" gives a list)\n")
724
616
 
725
617
 
726
618
class cmd_mkdir(Command):
727
 
    __doc__ = """Create a new versioned directory.
 
619
    """Create a new versioned directory.
728
620
 
729
621
    This is equivalent to creating the directory and then adding it.
730
622
    """
734
626
 
735
627
    def run(self, dir_list):
736
628
        for d in dir_list:
 
629
            os.mkdir(d)
737
630
            wt, dd = WorkingTree.open_containing(d)
738
 
            base = os.path.dirname(dd)
739
 
            id = wt.path2id(base)
740
 
            if id != None:
741
 
                os.mkdir(d)
742
 
                wt.add([dd])
743
 
                self.outf.write('added %s\n' % d)
744
 
            else:
745
 
                raise errors.NotVersionedError(path=base)
 
631
            wt.add([dd])
 
632
            self.outf.write('added %s\n' % d)
746
633
 
747
634
 
748
635
class cmd_relpath(Command):
749
 
    __doc__ = """Show path of a file relative to root"""
 
636
    """Show path of a file relative to root"""
750
637
 
751
638
    takes_args = ['filename']
752
639
    hidden = True
761
648
 
762
649
 
763
650
class cmd_inventory(Command):
764
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
651
    """Show inventory of the current working copy or a revision.
765
652
 
766
653
    It is possible to limit the output to a particular entry
767
654
    type using the --kind option.  For example: --kind file.
787
674
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
788
675
 
789
676
        revision = _get_one_revision('inventory', revision)
790
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
791
 
        self.add_cleanup(work_tree.lock_read().unlock)
792
 
        if revision is not None:
793
 
            tree = revision.as_tree(work_tree.branch)
794
 
 
795
 
            extra_trees = [work_tree]
796
 
            self.add_cleanup(tree.lock_read().unlock)
797
 
        else:
798
 
            tree = work_tree
799
 
            extra_trees = []
800
 
 
801
 
        if file_list is not None:
802
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
803
 
                                      require_versioned=True)
804
 
            # find_ids_across_trees may include some paths that don't
805
 
            # exist in 'tree'.
806
 
            entries = sorted(
807
 
                (tree.id2path(file_id), tree.inventory[file_id])
808
 
                for file_id in file_ids if tree.has_id(file_id))
809
 
        else:
810
 
            entries = tree.inventory.entries()
811
 
 
812
 
        self.cleanup_now()
 
677
        work_tree, file_list = tree_files(file_list)
 
678
        work_tree.lock_read()
 
679
        try:
 
680
            if revision is not None:
 
681
                tree = revision.as_tree(work_tree.branch)
 
682
 
 
683
                extra_trees = [work_tree]
 
684
                tree.lock_read()
 
685
            else:
 
686
                tree = work_tree
 
687
                extra_trees = []
 
688
 
 
689
            if file_list is not None:
 
690
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
691
                                          require_versioned=True)
 
692
                # find_ids_across_trees may include some paths that don't
 
693
                # exist in 'tree'.
 
694
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
695
                                 for file_id in file_ids if file_id in tree)
 
696
            else:
 
697
                entries = tree.inventory.entries()
 
698
        finally:
 
699
            tree.unlock()
 
700
            if tree is not work_tree:
 
701
                work_tree.unlock()
 
702
 
813
703
        for path, entry in entries:
814
704
            if kind and kind != entry.kind:
815
705
                continue
821
711
 
822
712
 
823
713
class cmd_mv(Command):
824
 
    __doc__ = """Move or rename a file.
 
714
    """Move or rename a file.
825
715
 
826
716
    :Usage:
827
717
        bzr mv OLDNAME NEWNAME
859
749
            names_list = []
860
750
        if len(names_list) < 2:
861
751
            raise errors.BzrCommandError("missing file argument")
862
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
863
 
        self.add_cleanup(tree.lock_tree_write().unlock)
864
 
        self._run(tree, names_list, rel_names, after)
 
752
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
753
        tree.lock_write()
 
754
        try:
 
755
            self._run(tree, names_list, rel_names, after)
 
756
        finally:
 
757
            tree.unlock()
865
758
 
866
759
    def run_auto(self, names_list, after, dry_run):
867
760
        if names_list is not None and len(names_list) > 1:
870
763
        if after:
871
764
            raise errors.BzrCommandError('--after cannot be specified with'
872
765
                                         ' --auto.')
873
 
        work_tree, file_list = WorkingTree.open_containing_paths(
874
 
            names_list, default_directory='.')
875
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
876
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
766
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
767
        work_tree.lock_write()
 
768
        try:
 
769
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
770
        finally:
 
771
            work_tree.unlock()
877
772
 
878
773
    def _run(self, tree, names_list, rel_names, after):
879
774
        into_existing = osutils.isdir(names_list[-1])
900
795
            # All entries reference existing inventory items, so fix them up
901
796
            # for cicp file-systems.
902
797
            rel_names = tree.get_canonical_inventory_paths(rel_names)
903
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
904
 
                if not is_quiet():
905
 
                    self.outf.write("%s => %s\n" % (src, dest))
 
798
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
799
                self.outf.write("%s => %s\n" % pair)
906
800
        else:
907
801
            if len(names_list) != 2:
908
802
                raise errors.BzrCommandError('to mv multiple files the'
952
846
            dest = osutils.pathjoin(dest_parent, dest_tail)
953
847
            mutter("attempting to move %s => %s", src, dest)
954
848
            tree.rename_one(src, dest, after=after)
955
 
            if not is_quiet():
956
 
                self.outf.write("%s => %s\n" % (src, dest))
 
849
            self.outf.write("%s => %s\n" % (src, dest))
957
850
 
958
851
 
959
852
class cmd_pull(Command):
960
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
853
    """Turn this branch into a mirror of another branch.
961
854
 
962
 
    By default, this command only works on branches that have not diverged.
963
 
    Branches are considered diverged if the destination branch's most recent 
964
 
    commit is one that has not been merged (directly or indirectly) into the 
965
 
    parent.
 
855
    This command only works on branches that have not diverged.  Branches are
 
856
    considered diverged if the destination branch's most recent commit is one
 
857
    that has not been merged (directly or indirectly) into the parent.
966
858
 
967
859
    If branches have diverged, you can use 'bzr merge' to integrate the changes
968
860
    from one into the other.  Once one branch has merged, the other should
969
861
    be able to pull it again.
970
862
 
971
 
    If you want to replace your local changes and just want your branch to
972
 
    match the remote one, use pull --overwrite. This will work even if the two
973
 
    branches have diverged.
 
863
    If you want to forget your local changes and just update your branch to
 
864
    match the remote one, use pull --overwrite.
974
865
 
975
 
    If there is no default location set, the first pull will set it (use
976
 
    --no-remember to avoid settting it). After that, you can omit the
977
 
    location to use the default.  To change the default, use --remember. The
978
 
    value will only be saved if the remote location can be accessed.
 
866
    If there is no default location set, the first pull will set it.  After
 
867
    that, you can omit the location to use the default.  To change the
 
868
    default, use --remember. The value will only be saved if the remote
 
869
    location can be accessed.
979
870
 
980
871
    Note: The location can be specified either in the form of a branch,
981
872
    or in the form of a path to a file containing a merge directive generated
986
877
    takes_options = ['remember', 'overwrite', 'revision',
987
878
        custom_help('verbose',
988
879
            help='Show logs of pulled revisions.'),
989
 
        custom_help('directory',
 
880
        Option('directory',
990
881
            help='Branch to pull into, '
991
 
                 'rather than the one containing the working directory.'),
 
882
                 'rather than the one containing the working directory.',
 
883
            short_name='d',
 
884
            type=unicode,
 
885
            ),
992
886
        Option('local',
993
887
            help="Perform a local pull in a bound "
994
888
                 "branch.  Local pulls are not applied to "
995
889
                 "the master branch."
996
890
            ),
997
 
        Option('show-base',
998
 
            help="Show base revision text in conflicts.")
999
891
        ]
1000
892
    takes_args = ['location?']
1001
893
    encoding_type = 'replace'
1002
894
 
1003
 
    def run(self, location=None, remember=None, overwrite=False,
 
895
    def run(self, location=None, remember=False, overwrite=False,
1004
896
            revision=None, verbose=False,
1005
 
            directory=None, local=False,
1006
 
            show_base=False):
 
897
            directory=None, local=False):
1007
898
        # FIXME: too much stuff is in the command class
1008
899
        revision_id = None
1009
900
        mergeable = None
1012
903
        try:
1013
904
            tree_to = WorkingTree.open_containing(directory)[0]
1014
905
            branch_to = tree_to.branch
1015
 
            self.add_cleanup(tree_to.lock_write().unlock)
1016
906
        except errors.NoWorkingTree:
1017
907
            tree_to = None
1018
908
            branch_to = Branch.open_containing(directory)[0]
1019
 
            self.add_cleanup(branch_to.lock_write().unlock)
1020
 
 
1021
 
        if tree_to is None and show_base:
1022
 
            raise errors.BzrCommandError("Need working tree for --show-base.")
1023
 
 
 
909
        
1024
910
        if local and not branch_to.get_bound_location():
1025
911
            raise errors.LocalRequiresBoundBranch()
1026
912
 
1056
942
        else:
1057
943
            branch_from = Branch.open(location,
1058
944
                possible_transports=possible_transports)
1059
 
            self.add_cleanup(branch_from.lock_read().unlock)
1060
 
            # Remembers if asked explicitly or no previous location is set
1061
 
            if (remember
1062
 
                or (remember is None and branch_to.get_parent() is None)):
 
945
 
 
946
            if branch_to.get_parent() is None or remember:
1063
947
                branch_to.set_parent(branch_from.base)
1064
948
 
1065
 
        if revision is not None:
1066
 
            revision_id = revision.as_revision_id(branch_from)
1067
 
 
1068
 
        if tree_to is not None:
1069
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1070
 
            change_reporter = delta._ChangeReporter(
1071
 
                unversioned_filter=tree_to.is_ignored,
1072
 
                view_info=view_info)
1073
 
            result = tree_to.pull(
1074
 
                branch_from, overwrite, revision_id, change_reporter,
1075
 
                possible_transports=possible_transports, local=local,
1076
 
                show_base=show_base)
1077
 
        else:
1078
 
            result = branch_to.pull(
1079
 
                branch_from, overwrite, revision_id, local=local)
1080
 
 
1081
 
        result.report(self.outf)
1082
 
        if verbose and result.old_revid != result.new_revid:
1083
 
            log.show_branch_change(
1084
 
                branch_to, self.outf, result.old_revno,
1085
 
                result.old_revid)
1086
 
        if getattr(result, 'tag_conflicts', None):
1087
 
            return 1
1088
 
        else:
1089
 
            return 0
 
949
        if branch_from is not branch_to:
 
950
            branch_from.lock_read()
 
951
        try:
 
952
            if revision is not None:
 
953
                revision_id = revision.as_revision_id(branch_from)
 
954
 
 
955
            branch_to.lock_write()
 
956
            try:
 
957
                if tree_to is not None:
 
958
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
959
                    change_reporter = delta._ChangeReporter(
 
960
                        unversioned_filter=tree_to.is_ignored,
 
961
                        view_info=view_info)
 
962
                    result = tree_to.pull(
 
963
                        branch_from, overwrite, revision_id, change_reporter,
 
964
                        possible_transports=possible_transports, local=local)
 
965
                else:
 
966
                    result = branch_to.pull(
 
967
                        branch_from, overwrite, revision_id, local=local)
 
968
 
 
969
                result.report(self.outf)
 
970
                if verbose and result.old_revid != result.new_revid:
 
971
                    log.show_branch_change(
 
972
                        branch_to, self.outf, result.old_revno,
 
973
                        result.old_revid)
 
974
            finally:
 
975
                branch_to.unlock()
 
976
        finally:
 
977
            if branch_from is not branch_to:
 
978
                branch_from.unlock()
1090
979
 
1091
980
 
1092
981
class cmd_push(Command):
1093
 
    __doc__ = """Update a mirror of this branch.
 
982
    """Update a mirror of this branch.
1094
983
 
1095
984
    The target branch will not have its working tree populated because this
1096
985
    is both expensive, and is not supported on remote file systems.
1109
998
    do a merge (see bzr help merge) from the other branch, and commit that.
1110
999
    After that you will be able to do a push without '--overwrite'.
1111
1000
 
1112
 
    If there is no default push location set, the first push will set it (use
1113
 
    --no-remember to avoid settting it).  After that, you can omit the
1114
 
    location to use the default.  To change the default, use --remember. The
1115
 
    value will only be saved if the remote location can be accessed.
 
1001
    If there is no default push location set, the first push will set it.
 
1002
    After that, you can omit the location to use the default.  To change the
 
1003
    default, use --remember. The value will only be saved if the remote
 
1004
    location can be accessed.
1116
1005
    """
1117
1006
 
1118
1007
    _see_also = ['pull', 'update', 'working-trees']
1120
1009
        Option('create-prefix',
1121
1010
               help='Create the path leading up to the branch '
1122
1011
                    'if it does not already exist.'),
1123
 
        custom_help('directory',
 
1012
        Option('directory',
1124
1013
            help='Branch to push from, '
1125
 
                 'rather than the one containing the working directory.'),
 
1014
                 'rather than the one containing the working directory.',
 
1015
            short_name='d',
 
1016
            type=unicode,
 
1017
            ),
1126
1018
        Option('use-existing-dir',
1127
1019
               help='By default push will fail if the target'
1128
1020
                    ' directory exists, but does not already'
1138
1030
            type=unicode),
1139
1031
        Option('strict',
1140
1032
               help='Refuse to push if there are uncommitted changes in'
1141
 
               ' the working tree, --no-strict disables the check.'),
1142
 
        Option('no-tree',
1143
 
               help="Don't populate the working tree, even for protocols"
1144
 
               " that support it."),
 
1033
               ' the working tree.'),
1145
1034
        ]
1146
1035
    takes_args = ['location?']
1147
1036
    encoding_type = 'replace'
1148
1037
 
1149
 
    def run(self, location=None, remember=None, overwrite=False,
 
1038
    def run(self, location=None, remember=False, overwrite=False,
1150
1039
        create_prefix=False, verbose=False, revision=None,
1151
1040
        use_existing_dir=False, directory=None, stacked_on=None,
1152
 
        stacked=False, strict=None, no_tree=False):
 
1041
        stacked=False, strict=None):
1153
1042
        from bzrlib.push import _show_push_branch
1154
1043
 
1155
1044
        if directory is None:
1156
1045
            directory = '.'
1157
1046
        # Get the source branch
1158
 
        (tree, br_from,
1159
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1047
        tree, br_from = bzrdir.BzrDir.open_tree_or_branch(directory)
 
1048
        if strict is None:
 
1049
            strict = br_from.get_config().get_user_option('push_strict')
 
1050
            if strict is not None:
 
1051
                # FIXME: This should be better supported by config
 
1052
                # -- vila 20090611
 
1053
                bools = dict(yes=True, no=False, on=True, off=False,
 
1054
                             true=True, false=False)
 
1055
                try:
 
1056
                    strict = bools[strict.lower()]
 
1057
                except KeyError:
 
1058
                    strict = None
 
1059
        if strict:
 
1060
            changes = tree.changes_from(tree.basis_tree())
 
1061
            if changes.has_changed():
 
1062
                raise errors.UncommittedChanges(tree)
1160
1063
        # Get the tip's revision_id
1161
1064
        revision = _get_one_revision('push', revision)
1162
1065
        if revision is not None:
1163
1066
            revision_id = revision.in_history(br_from).rev_id
1164
1067
        else:
1165
1068
            revision_id = None
1166
 
        if tree is not None and revision_id is None:
1167
 
            tree.check_changed_or_out_of_date(
1168
 
                strict, 'push_strict',
1169
 
                more_error='Use --no-strict to force the push.',
1170
 
                more_warning='Uncommitted changes will not be pushed.')
 
1069
 
1171
1070
        # Get the stacked_on branch, if any
1172
1071
        if stacked_on is not None:
1173
1072
            stacked_on = urlutils.normalize_url(stacked_on)
1195
1094
            else:
1196
1095
                display_url = urlutils.unescape_for_display(stored_loc,
1197
1096
                        self.outf.encoding)
1198
 
                note("Using saved push location: %s" % display_url)
 
1097
                self.outf.write("Using saved push location: %s\n" % display_url)
1199
1098
                location = stored_loc
1200
1099
 
1201
1100
        _show_push_branch(br_from, revision_id, location, self.outf,
1202
1101
            verbose=verbose, overwrite=overwrite, remember=remember,
1203
1102
            stacked_on=stacked_on, create_prefix=create_prefix,
1204
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1103
            use_existing_dir=use_existing_dir)
1205
1104
 
1206
1105
 
1207
1106
class cmd_branch(Command):
1208
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1107
    """Create a new branch that is a copy of an existing branch.
1209
1108
 
1210
1109
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1211
1110
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1216
1115
 
1217
1116
    To retrieve the branch as of a particular revision, supply the --revision
1218
1117
    parameter, as in "branch foo/bar -r 5".
1219
 
 
1220
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1221
1118
    """
1222
1119
 
1223
1120
    _see_also = ['checkout']
1224
1121
    takes_args = ['from_location', 'to_location?']
1225
 
    takes_options = ['revision',
1226
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1227
 
        Option('files-from', type=str,
1228
 
               help="Get file contents from this tree."),
 
1122
    takes_options = ['revision', Option('hardlink',
 
1123
        help='Hard-link working tree files where possible.'),
1229
1124
        Option('no-tree',
1230
1125
            help="Create a branch without a working-tree."),
1231
 
        Option('switch',
1232
 
            help="Switch the checkout in the current directory "
1233
 
                 "to the new branch."),
1234
1126
        Option('stacked',
1235
1127
            help='Create a stacked branch referring to the source branch. '
1236
1128
                'The new branch will depend on the availability of the source '
1237
1129
                'branch for all operations.'),
1238
1130
        Option('standalone',
1239
1131
               help='Do not use a shared repository, even if available.'),
1240
 
        Option('use-existing-dir',
1241
 
               help='By default branch will fail if the target'
1242
 
                    ' directory exists, but does not already'
1243
 
                    ' have a control directory.  This flag will'
1244
 
                    ' allow branch to proceed.'),
1245
 
        Option('bind',
1246
 
            help="Bind new branch to from location."),
1247
1132
        ]
1248
1133
    aliases = ['get', 'clone']
1249
1134
 
1250
1135
    def run(self, from_location, to_location=None, revision=None,
1251
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1252
 
            use_existing_dir=False, switch=False, bind=False,
1253
 
            files_from=None):
1254
 
        from bzrlib import switch as _mod_switch
 
1136
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1255
1137
        from bzrlib.tag import _merge_tags_if_possible
1256
 
        if self.invoked_as in ['get', 'clone']:
1257
 
            ui.ui_factory.show_user_warning(
1258
 
                'deprecated_command',
1259
 
                deprecated_name=self.invoked_as,
1260
 
                recommended_name='branch',
1261
 
                deprecated_in_version='2.4')
 
1138
 
1262
1139
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1263
1140
            from_location)
1264
 
        if not (hardlink or files_from):
1265
 
            # accelerator_tree is usually slower because you have to read N
1266
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1267
 
            # explicitly request it
 
1141
        if (accelerator_tree is not None and
 
1142
            accelerator_tree.supports_content_filtering()):
1268
1143
            accelerator_tree = None
1269
 
        if files_from is not None and files_from != from_location:
1270
 
            accelerator_tree = WorkingTree.open(files_from)
1271
1144
        revision = _get_one_revision('branch', revision)
1272
 
        self.add_cleanup(br_from.lock_read().unlock)
1273
 
        if revision is not None:
1274
 
            revision_id = revision.as_revision_id(br_from)
1275
 
        else:
1276
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1277
 
            # None or perhaps NULL_REVISION to mean copy nothing
1278
 
            # RBC 20060209
1279
 
            revision_id = br_from.last_revision()
1280
 
        if to_location is None:
1281
 
            to_location = urlutils.derive_to_location(from_location)
1282
 
        to_transport = transport.get_transport(to_location)
 
1145
        br_from.lock_read()
1283
1146
        try:
1284
 
            to_transport.mkdir('.')
1285
 
        except errors.FileExists:
1286
 
            if not use_existing_dir:
1287
 
                raise errors.BzrCommandError('Target directory "%s" '
1288
 
                    'already exists.' % to_location)
 
1147
            if revision is not None:
 
1148
                revision_id = revision.as_revision_id(br_from)
1289
1149
            else:
1290
 
                try:
1291
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1292
 
                except errors.NotBranchError:
1293
 
                    pass
1294
 
                else:
1295
 
                    raise errors.AlreadyBranchError(to_location)
1296
 
        except errors.NoSuchFile:
1297
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1298
 
                                         % to_location)
1299
 
        try:
1300
 
            # preserve whatever source format we have.
1301
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1302
 
                                        possible_transports=[to_transport],
1303
 
                                        accelerator_tree=accelerator_tree,
1304
 
                                        hardlink=hardlink, stacked=stacked,
1305
 
                                        force_new_repo=standalone,
1306
 
                                        create_tree_if_local=not no_tree,
1307
 
                                        source_branch=br_from)
1308
 
            branch = dir.open_branch()
1309
 
        except errors.NoSuchRevision:
1310
 
            to_transport.delete_tree('.')
1311
 
            msg = "The branch %s has no revision %s." % (from_location,
1312
 
                revision)
1313
 
            raise errors.BzrCommandError(msg)
1314
 
        _merge_tags_if_possible(br_from, branch)
1315
 
        # If the source branch is stacked, the new branch may
1316
 
        # be stacked whether we asked for that explicitly or not.
1317
 
        # We therefore need a try/except here and not just 'if stacked:'
1318
 
        try:
1319
 
            note('Created new stacked branch referring to %s.' %
1320
 
                branch.get_stacked_on_url())
1321
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1322
 
            errors.UnstackableRepositoryFormat), e:
1323
 
            note('Branched %d revision(s).' % branch.revno())
1324
 
        if bind:
1325
 
            # Bind to the parent
1326
 
            parent_branch = Branch.open(from_location)
1327
 
            branch.bind(parent_branch)
1328
 
            note('New branch bound to %s' % from_location)
1329
 
        if switch:
1330
 
            # Switch to the new branch
1331
 
            wt, _ = WorkingTree.open_containing('.')
1332
 
            _mod_switch.switch(wt.bzrdir, branch)
1333
 
            note('Switched to branch: %s',
1334
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1150
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1151
                # None or perhaps NULL_REVISION to mean copy nothing
 
1152
                # RBC 20060209
 
1153
                revision_id = br_from.last_revision()
 
1154
            if to_location is None:
 
1155
                to_location = urlutils.derive_to_location(from_location)
 
1156
            to_transport = transport.get_transport(to_location)
 
1157
            try:
 
1158
                to_transport.mkdir('.')
 
1159
            except errors.FileExists:
 
1160
                raise errors.BzrCommandError('Target directory "%s" already'
 
1161
                                             ' exists.' % to_location)
 
1162
            except errors.NoSuchFile:
 
1163
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1164
                                             % to_location)
 
1165
            try:
 
1166
                # preserve whatever source format we have.
 
1167
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1168
                                            possible_transports=[to_transport],
 
1169
                                            accelerator_tree=accelerator_tree,
 
1170
                                            hardlink=hardlink, stacked=stacked,
 
1171
                                            force_new_repo=standalone,
 
1172
                                            create_tree_if_local=not no_tree,
 
1173
                                            source_branch=br_from)
 
1174
                branch = dir.open_branch()
 
1175
            except errors.NoSuchRevision:
 
1176
                to_transport.delete_tree('.')
 
1177
                msg = "The branch %s has no revision %s." % (from_location,
 
1178
                    revision)
 
1179
                raise errors.BzrCommandError(msg)
 
1180
            _merge_tags_if_possible(br_from, branch)
 
1181
            # If the source branch is stacked, the new branch may
 
1182
            # be stacked whether we asked for that explicitly or not.
 
1183
            # We therefore need a try/except here and not just 'if stacked:'
 
1184
            try:
 
1185
                note('Created new stacked branch referring to %s.' %
 
1186
                    branch.get_stacked_on_url())
 
1187
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1188
                errors.UnstackableRepositoryFormat), e:
 
1189
                note('Branched %d revision(s).' % branch.revno())
 
1190
        finally:
 
1191
            br_from.unlock()
1335
1192
 
1336
1193
 
1337
1194
class cmd_checkout(Command):
1338
 
    __doc__ = """Create a new checkout of an existing branch.
 
1195
    """Create a new checkout of an existing branch.
1339
1196
 
1340
1197
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1341
1198
    the branch found in '.'. This is useful if you have removed the working tree
1380
1237
            to_location = branch_location
1381
1238
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1382
1239
            branch_location)
1383
 
        if not (hardlink or files_from):
1384
 
            # accelerator_tree is usually slower because you have to read N
1385
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1386
 
            # explicitly request it
1387
 
            accelerator_tree = None
1388
1240
        revision = _get_one_revision('checkout', revision)
1389
 
        if files_from is not None and files_from != branch_location:
 
1241
        if files_from is not None:
1390
1242
            accelerator_tree = WorkingTree.open(files_from)
1391
1243
        if revision is not None:
1392
1244
            revision_id = revision.as_revision_id(source)
1409
1261
 
1410
1262
 
1411
1263
class cmd_renames(Command):
1412
 
    __doc__ = """Show list of renamed files.
 
1264
    """Show list of renamed files.
1413
1265
    """
1414
1266
    # TODO: Option to show renames between two historical versions.
1415
1267
 
1420
1272
    @display_command
1421
1273
    def run(self, dir=u'.'):
1422
1274
        tree = WorkingTree.open_containing(dir)[0]
1423
 
        self.add_cleanup(tree.lock_read().unlock)
1424
 
        new_inv = tree.inventory
1425
 
        old_tree = tree.basis_tree()
1426
 
        self.add_cleanup(old_tree.lock_read().unlock)
1427
 
        old_inv = old_tree.inventory
1428
 
        renames = []
1429
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1430
 
        for f, paths, c, v, p, n, k, e in iterator:
1431
 
            if paths[0] == paths[1]:
1432
 
                continue
1433
 
            if None in (paths):
1434
 
                continue
1435
 
            renames.append(paths)
1436
 
        renames.sort()
1437
 
        for old_name, new_name in renames:
1438
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1275
        tree.lock_read()
 
1276
        try:
 
1277
            new_inv = tree.inventory
 
1278
            old_tree = tree.basis_tree()
 
1279
            old_tree.lock_read()
 
1280
            try:
 
1281
                old_inv = old_tree.inventory
 
1282
                renames = []
 
1283
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1284
                for f, paths, c, v, p, n, k, e in iterator:
 
1285
                    if paths[0] == paths[1]:
 
1286
                        continue
 
1287
                    if None in (paths):
 
1288
                        continue
 
1289
                    renames.append(paths)
 
1290
                renames.sort()
 
1291
                for old_name, new_name in renames:
 
1292
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1293
            finally:
 
1294
                old_tree.unlock()
 
1295
        finally:
 
1296
            tree.unlock()
1439
1297
 
1440
1298
 
1441
1299
class cmd_update(Command):
1442
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1300
    """Update a tree to have the latest code committed to its branch.
1443
1301
 
1444
1302
    This will perform a merge into the working tree, and may generate
1445
1303
    conflicts. If you have any local changes, you will still
1447
1305
 
1448
1306
    If you want to discard your local changes, you can just do a
1449
1307
    'bzr revert' instead of 'bzr commit' after the update.
1450
 
 
1451
 
    If you want to restore a file that has been removed locally, use
1452
 
    'bzr revert' instead of 'bzr update'.
1453
 
 
1454
 
    If the tree's branch is bound to a master branch, it will also update
1455
 
    the branch from the master.
1456
1308
    """
1457
1309
 
1458
1310
    _see_also = ['pull', 'working-trees', 'status-flags']
1459
1311
    takes_args = ['dir?']
1460
 
    takes_options = ['revision',
1461
 
                     Option('show-base',
1462
 
                            help="Show base revision text in conflicts."),
1463
 
                     ]
1464
1312
    aliases = ['up']
1465
1313
 
1466
 
    def run(self, dir='.', revision=None, show_base=None):
1467
 
        if revision is not None and len(revision) != 1:
1468
 
            raise errors.BzrCommandError(
1469
 
                        "bzr update --revision takes exactly one revision")
 
1314
    def run(self, dir='.'):
1470
1315
        tree = WorkingTree.open_containing(dir)[0]
1471
 
        branch = tree.branch
1472
1316
        possible_transports = []
1473
 
        master = branch.get_master_branch(
 
1317
        master = tree.branch.get_master_branch(
1474
1318
            possible_transports=possible_transports)
1475
1319
        if master is not None:
1476
 
            branch_location = master.base
1477
1320
            tree.lock_write()
1478
1321
        else:
1479
 
            branch_location = tree.branch.base
1480
1322
            tree.lock_tree_write()
1481
 
        self.add_cleanup(tree.unlock)
1482
 
        # get rid of the final '/' and be ready for display
1483
 
        branch_location = urlutils.unescape_for_display(
1484
 
            branch_location.rstrip('/'),
1485
 
            self.outf.encoding)
1486
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1487
 
        if master is None:
1488
 
            old_tip = None
1489
 
        else:
1490
 
            # may need to fetch data into a heavyweight checkout
1491
 
            # XXX: this may take some time, maybe we should display a
1492
 
            # message
1493
 
            old_tip = branch.update(possible_transports)
1494
 
        if revision is not None:
1495
 
            revision_id = revision[0].as_revision_id(branch)
1496
 
        else:
1497
 
            revision_id = branch.last_revision()
1498
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1499
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1500
 
            note("Tree is up to date at revision %s of branch %s" %
1501
 
                ('.'.join(map(str, revno)), branch_location))
1502
 
            return 0
1503
 
        view_info = _get_view_info_for_change_reporter(tree)
1504
 
        change_reporter = delta._ChangeReporter(
1505
 
            unversioned_filter=tree.is_ignored,
1506
 
            view_info=view_info)
1507
1323
        try:
 
1324
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1325
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1326
            if last_rev == _mod_revision.ensure_null(
 
1327
                tree.branch.last_revision()):
 
1328
                # may be up to date, check master too.
 
1329
                if master is None or last_rev == _mod_revision.ensure_null(
 
1330
                    master.last_revision()):
 
1331
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1332
                    note("Tree is up to date at revision %d." % (revno,))
 
1333
                    return 0
 
1334
            view_info = _get_view_info_for_change_reporter(tree)
1508
1335
            conflicts = tree.update(
1509
 
                change_reporter,
1510
 
                possible_transports=possible_transports,
1511
 
                revision=revision_id,
1512
 
                old_tip=old_tip,
1513
 
                show_base=show_base)
1514
 
        except errors.NoSuchRevision, e:
1515
 
            raise errors.BzrCommandError(
1516
 
                                  "branch has no revision %s\n"
1517
 
                                  "bzr update --revision only works"
1518
 
                                  " for a revision in the branch history"
1519
 
                                  % (e.revision))
1520
 
        revno = tree.branch.revision_id_to_dotted_revno(
1521
 
            _mod_revision.ensure_null(tree.last_revision()))
1522
 
        note('Updated to revision %s of branch %s' %
1523
 
             ('.'.join(map(str, revno)), branch_location))
1524
 
        parent_ids = tree.get_parent_ids()
1525
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1526
 
            note('Your local commits will now show as pending merges with '
1527
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1528
 
        if conflicts != 0:
1529
 
            return 1
1530
 
        else:
1531
 
            return 0
 
1336
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1337
                view_info=view_info), possible_transports=possible_transports)
 
1338
            revno = tree.branch.revision_id_to_revno(
 
1339
                _mod_revision.ensure_null(tree.last_revision()))
 
1340
            note('Updated to revision %d.' % (revno,))
 
1341
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1342
                note('Your local commits will now show as pending merges with '
 
1343
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1344
            if conflicts != 0:
 
1345
                return 1
 
1346
            else:
 
1347
                return 0
 
1348
        finally:
 
1349
            tree.unlock()
1532
1350
 
1533
1351
 
1534
1352
class cmd_info(Command):
1535
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1353
    """Show information about a working tree, branch or repository.
1536
1354
 
1537
1355
    This command will show all known locations and formats associated to the
1538
1356
    tree, branch or repository.
1576
1394
 
1577
1395
 
1578
1396
class cmd_remove(Command):
1579
 
    __doc__ = """Remove files or directories.
 
1397
    """Remove files or directories.
1580
1398
 
1581
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1582
 
    delete them if they can easily be recovered using revert otherwise they
1583
 
    will be backed up (adding an extention of the form .~#~). If no options or
1584
 
    parameters are given Bazaar will scan for files that are being tracked by
1585
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1399
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1400
    them if they can easily be recovered using revert. If no options or
 
1401
    parameters are given bzr will scan for files that are being tracked by bzr
 
1402
    but missing in your tree and stop tracking them for you.
1586
1403
    """
1587
1404
    takes_args = ['file*']
1588
1405
    takes_options = ['verbose',
1590
1407
        RegistryOption.from_kwargs('file-deletion-strategy',
1591
1408
            'The file deletion mode to be used.',
1592
1409
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1593
 
            safe='Backup changed files (default).',
1594
 
            keep='Delete from bzr but leave the working copy.',
1595
 
            no_backup='Don\'t backup changed files.',
 
1410
            safe='Only delete files if they can be'
 
1411
                 ' safely recovered (default).',
 
1412
            keep="Don't delete any files.",
1596
1413
            force='Delete all the specified files, even if they can not be '
1597
 
                'recovered and even if they are non-empty directories. '
1598
 
                '(deprecated, use no-backup)')]
 
1414
                'recovered and even if they are non-empty directories.')]
1599
1415
    aliases = ['rm', 'del']
1600
1416
    encoding_type = 'replace'
1601
1417
 
1602
1418
    def run(self, file_list, verbose=False, new=False,
1603
1419
        file_deletion_strategy='safe'):
1604
 
        if file_deletion_strategy == 'force':
1605
 
            note("(The --force option is deprecated, rather use --no-backup "
1606
 
                "in future.)")
1607
 
            file_deletion_strategy = 'no-backup'
1608
 
 
1609
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1420
        tree, file_list = tree_files(file_list)
1610
1421
 
1611
1422
        if file_list is not None:
1612
1423
            file_list = [f for f in file_list]
1613
1424
 
1614
 
        self.add_cleanup(tree.lock_write().unlock)
1615
 
        # Heuristics should probably all move into tree.remove_smart or
1616
 
        # some such?
1617
 
        if new:
1618
 
            added = tree.changes_from(tree.basis_tree(),
1619
 
                specific_files=file_list).added
1620
 
            file_list = sorted([f[0] for f in added], reverse=True)
1621
 
            if len(file_list) == 0:
1622
 
                raise errors.BzrCommandError('No matching files.')
1623
 
        elif file_list is None:
1624
 
            # missing files show up in iter_changes(basis) as
1625
 
            # versioned-with-no-kind.
1626
 
            missing = []
1627
 
            for change in tree.iter_changes(tree.basis_tree()):
1628
 
                # Find paths in the working tree that have no kind:
1629
 
                if change[1][1] is not None and change[6][1] is None:
1630
 
                    missing.append(change[1][1])
1631
 
            file_list = sorted(missing, reverse=True)
1632
 
            file_deletion_strategy = 'keep'
1633
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1634
 
            keep_files=file_deletion_strategy=='keep',
1635
 
            force=(file_deletion_strategy=='no-backup'))
 
1425
        tree.lock_write()
 
1426
        try:
 
1427
            # Heuristics should probably all move into tree.remove_smart or
 
1428
            # some such?
 
1429
            if new:
 
1430
                added = tree.changes_from(tree.basis_tree(),
 
1431
                    specific_files=file_list).added
 
1432
                file_list = sorted([f[0] for f in added], reverse=True)
 
1433
                if len(file_list) == 0:
 
1434
                    raise errors.BzrCommandError('No matching files.')
 
1435
            elif file_list is None:
 
1436
                # missing files show up in iter_changes(basis) as
 
1437
                # versioned-with-no-kind.
 
1438
                missing = []
 
1439
                for change in tree.iter_changes(tree.basis_tree()):
 
1440
                    # Find paths in the working tree that have no kind:
 
1441
                    if change[1][1] is not None and change[6][1] is None:
 
1442
                        missing.append(change[1][1])
 
1443
                file_list = sorted(missing, reverse=True)
 
1444
                file_deletion_strategy = 'keep'
 
1445
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1446
                keep_files=file_deletion_strategy=='keep',
 
1447
                force=file_deletion_strategy=='force')
 
1448
        finally:
 
1449
            tree.unlock()
1636
1450
 
1637
1451
 
1638
1452
class cmd_file_id(Command):
1639
 
    __doc__ = """Print file_id of a particular file or directory.
 
1453
    """Print file_id of a particular file or directory.
1640
1454
 
1641
1455
    The file_id is assigned when the file is first added and remains the
1642
1456
    same through all revisions where the file exists, even when it is
1658
1472
 
1659
1473
 
1660
1474
class cmd_file_path(Command):
1661
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1475
    """Print path of file_ids to a file or directory.
1662
1476
 
1663
1477
    This prints one line for each directory down to the target,
1664
1478
    starting at the branch root.
1680
1494
 
1681
1495
 
1682
1496
class cmd_reconcile(Command):
1683
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1497
    """Reconcile bzr metadata in a branch.
1684
1498
 
1685
1499
    This can correct data mismatches that may have been caused by
1686
1500
    previous ghost operations or bzr upgrades. You should only
1700
1514
 
1701
1515
    _see_also = ['check']
1702
1516
    takes_args = ['branch?']
1703
 
    takes_options = [
1704
 
        Option('canonicalize-chks',
1705
 
               help='Make sure CHKs are in canonical form (repairs '
1706
 
                    'bug 522637).',
1707
 
               hidden=True),
1708
 
        ]
1709
1517
 
1710
 
    def run(self, branch=".", canonicalize_chks=False):
 
1518
    def run(self, branch="."):
1711
1519
        from bzrlib.reconcile import reconcile
1712
1520
        dir = bzrdir.BzrDir.open(branch)
1713
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1521
        reconcile(dir)
1714
1522
 
1715
1523
 
1716
1524
class cmd_revision_history(Command):
1717
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1525
    """Display the list of revision ids on a branch."""
1718
1526
 
1719
1527
    _see_also = ['log']
1720
1528
    takes_args = ['location?']
1730
1538
 
1731
1539
 
1732
1540
class cmd_ancestry(Command):
1733
 
    __doc__ = """List all revisions merged into this branch."""
 
1541
    """List all revisions merged into this branch."""
1734
1542
 
1735
1543
    _see_also = ['log', 'revision-history']
1736
1544
    takes_args = ['location?']
1748
1556
            b = wt.branch
1749
1557
            last_revision = wt.last_revision()
1750
1558
 
1751
 
        self.add_cleanup(b.repository.lock_read().unlock)
1752
 
        graph = b.repository.get_graph()
1753
 
        revisions = [revid for revid, parents in
1754
 
            graph.iter_ancestry([last_revision])]
1755
 
        for revision_id in reversed(revisions):
1756
 
            if _mod_revision.is_null(revision_id):
1757
 
                continue
 
1559
        revision_ids = b.repository.get_ancestry(last_revision)
 
1560
        revision_ids.pop(0)
 
1561
        for revision_id in revision_ids:
1758
1562
            self.outf.write(revision_id + '\n')
1759
1563
 
1760
1564
 
1761
1565
class cmd_init(Command):
1762
 
    __doc__ = """Make a directory into a versioned branch.
 
1566
    """Make a directory into a versioned branch.
1763
1567
 
1764
1568
    Use this to create an empty branch, or before importing an
1765
1569
    existing project.
1793
1597
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1794
1598
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1795
1599
                value_switches=True,
1796
 
                title="Branch format",
 
1600
                title="Branch Format",
1797
1601
                ),
1798
1602
         Option('append-revisions-only',
1799
1603
                help='Never change revnos or the existing log.'
1800
 
                '  Append revisions to it only.'),
1801
 
         Option('no-tree',
1802
 
                'Create a branch without a working tree.')
 
1604
                '  Append revisions to it only.')
1803
1605
         ]
1804
1606
    def run(self, location=None, format=None, append_revisions_only=False,
1805
 
            create_prefix=False, no_tree=False):
 
1607
            create_prefix=False):
1806
1608
        if format is None:
1807
1609
            format = bzrdir.format_registry.make_bzrdir('default')
1808
1610
        if location is None:
1831
1633
        except errors.NotBranchError:
1832
1634
            # really a NotBzrDir error...
1833
1635
            create_branch = bzrdir.BzrDir.create_branch_convenience
1834
 
            if no_tree:
1835
 
                force_new_tree = False
1836
 
            else:
1837
 
                force_new_tree = None
1838
1636
            branch = create_branch(to_transport.base, format=format,
1839
 
                                   possible_transports=[to_transport],
1840
 
                                   force_new_tree=force_new_tree)
 
1637
                                   possible_transports=[to_transport])
1841
1638
            a_bzrdir = branch.bzrdir
1842
1639
        else:
1843
1640
            from bzrlib.transport.local import LocalTransport
1847
1644
                        raise errors.BranchExistsWithoutWorkingTree(location)
1848
1645
                raise errors.AlreadyBranchError(location)
1849
1646
            branch = a_bzrdir.create_branch()
1850
 
            if not no_tree:
1851
 
                a_bzrdir.create_workingtree()
 
1647
            a_bzrdir.create_workingtree()
1852
1648
        if append_revisions_only:
1853
1649
            try:
1854
1650
                branch.set_append_revisions_only(True)
1876
1672
 
1877
1673
 
1878
1674
class cmd_init_repository(Command):
1879
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1675
    """Create a shared repository to hold branches.
1880
1676
 
1881
1677
    New branches created under the repository directory will store their
1882
 
    revisions in the repository, not in the branch directory.  For branches
1883
 
    with shared history, this reduces the amount of storage needed and 
1884
 
    speeds up the creation of new branches.
 
1678
    revisions in the repository, not in the branch directory.
1885
1679
 
1886
 
    If the --no-trees option is given then the branches in the repository
1887
 
    will not have working trees by default.  They will still exist as 
1888
 
    directories on disk, but they will not have separate copies of the 
1889
 
    files at a certain revision.  This can be useful for repositories that
1890
 
    store branches which are interacted with through checkouts or remote
1891
 
    branches, such as on a server.
 
1680
    If the --no-trees option is used then the branches in the repository
 
1681
    will not have working trees by default.
1892
1682
 
1893
1683
    :Examples:
1894
 
        Create a shared repository holding just branches::
 
1684
        Create a shared repositories holding just branches::
1895
1685
 
1896
1686
            bzr init-repo --no-trees repo
1897
1687
            bzr init repo/trunk
1936
1726
 
1937
1727
 
1938
1728
class cmd_diff(Command):
1939
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1729
    """Show differences in the working tree, between revisions or branches.
1940
1730
 
1941
1731
    If no arguments are given, all changes for the current tree are listed.
1942
1732
    If files are given, only the changes in those files are listed.
1948
1738
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1949
1739
    produces patches suitable for "patch -p1".
1950
1740
 
1951
 
    Note that when using the -r argument with a range of revisions, the
1952
 
    differences are computed between the two specified revisions.  That
1953
 
    is, the command does not show the changes introduced by the first 
1954
 
    revision in the range.  This differs from the interpretation of 
1955
 
    revision ranges used by "bzr log" which includes the first revision
1956
 
    in the range.
1957
 
 
1958
1741
    :Exit values:
1959
1742
        1 - changed
1960
1743
        2 - unrepresentable changes
1970
1753
 
1971
1754
            bzr diff -r1
1972
1755
 
1973
 
        Difference between revision 3 and revision 1::
1974
 
 
1975
 
            bzr diff -r1..3
1976
 
 
1977
 
        Difference between revision 3 and revision 1 for branch xxx::
1978
 
 
1979
 
            bzr diff -r1..3 xxx
1980
 
 
1981
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1982
 
 
1983
 
            bzr diff -c2
1984
 
 
1985
 
        To see the changes introduced by revision X::
1986
 
        
1987
 
            bzr diff -cX
1988
 
 
1989
 
        Note that in the case of a merge, the -c option shows the changes
1990
 
        compared to the left hand parent. To see the changes against
1991
 
        another parent, use::
1992
 
 
1993
 
            bzr diff -r<chosen_parent>..X
1994
 
 
1995
 
        The changes between the current revision and the previous revision
1996
 
        (equivalent to -c-1 and -r-2..-1)
1997
 
 
1998
 
            bzr diff -r-2..
 
1756
        Difference between revision 2 and revision 1::
 
1757
 
 
1758
            bzr diff -r1..2
 
1759
 
 
1760
        Difference between revision 2 and revision 1 for branch xxx::
 
1761
 
 
1762
            bzr diff -r1..2 xxx
1999
1763
 
2000
1764
        Show just the differences for file NEWS::
2001
1765
 
2016
1780
        Same as 'bzr diff' but prefix paths with old/ and new/::
2017
1781
 
2018
1782
            bzr diff --prefix old/:new/
2019
 
            
2020
 
        Show the differences using a custom diff program with options::
2021
 
        
2022
 
            bzr diff --using /usr/bin/diff --diff-options -wu
2023
1783
    """
2024
1784
    _see_also = ['status']
2025
1785
    takes_args = ['file*']
2044
1804
            help='Use this command to compare files.',
2045
1805
            type=unicode,
2046
1806
            ),
2047
 
        RegistryOption('format',
2048
 
            short_name='F',
2049
 
            help='Diff format to use.',
2050
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
2051
 
            title='Diff format'),
2052
1807
        ]
2053
1808
    aliases = ['di', 'dif']
2054
1809
    encoding_type = 'exact'
2055
1810
 
2056
1811
    @display_command
2057
1812
    def run(self, revision=None, file_list=None, diff_options=None,
2058
 
            prefix=None, old=None, new=None, using=None, format=None):
2059
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2060
 
            show_diff_trees)
 
1813
            prefix=None, old=None, new=None, using=None):
 
1814
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
2061
1815
 
2062
1816
        if (prefix is None) or (prefix == '0'):
2063
1817
            # diff -p0 format
2077
1831
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
2078
1832
                                         ' one or two revision specifiers')
2079
1833
 
2080
 
        if using is not None and format is not None:
2081
 
            raise errors.BzrCommandError('--using and --format are mutually '
2082
 
                'exclusive.')
2083
 
 
2084
 
        (old_tree, new_tree,
2085
 
         old_branch, new_branch,
2086
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2087
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
2088
 
        # GNU diff on Windows uses ANSI encoding for filenames
2089
 
        path_encoding = osutils.get_diff_header_encoding()
 
1834
        old_tree, new_tree, specific_files, extra_trees = \
 
1835
                _get_trees_to_diff(file_list, revision, old, new,
 
1836
                apply_view=True)
2090
1837
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2091
1838
                               specific_files=specific_files,
2092
1839
                               external_diff_options=diff_options,
2093
1840
                               old_label=old_label, new_label=new_label,
2094
 
                               extra_trees=extra_trees,
2095
 
                               path_encoding=path_encoding,
2096
 
                               using=using,
2097
 
                               format_cls=format)
 
1841
                               extra_trees=extra_trees, using=using)
2098
1842
 
2099
1843
 
2100
1844
class cmd_deleted(Command):
2101
 
    __doc__ = """List files deleted in the working tree.
 
1845
    """List files deleted in the working tree.
2102
1846
    """
2103
1847
    # TODO: Show files deleted since a previous revision, or
2104
1848
    # between two revisions.
2107
1851
    # level of effort but possibly much less IO.  (Or possibly not,
2108
1852
    # if the directories are very large...)
2109
1853
    _see_also = ['status', 'ls']
2110
 
    takes_options = ['directory', 'show-ids']
 
1854
    takes_options = ['show-ids']
2111
1855
 
2112
1856
    @display_command
2113
 
    def run(self, show_ids=False, directory=u'.'):
2114
 
        tree = WorkingTree.open_containing(directory)[0]
2115
 
        self.add_cleanup(tree.lock_read().unlock)
2116
 
        old = tree.basis_tree()
2117
 
        self.add_cleanup(old.lock_read().unlock)
2118
 
        for path, ie in old.inventory.iter_entries():
2119
 
            if not tree.has_id(ie.file_id):
2120
 
                self.outf.write(path)
2121
 
                if show_ids:
2122
 
                    self.outf.write(' ')
2123
 
                    self.outf.write(ie.file_id)
2124
 
                self.outf.write('\n')
 
1857
    def run(self, show_ids=False):
 
1858
        tree = WorkingTree.open_containing(u'.')[0]
 
1859
        tree.lock_read()
 
1860
        try:
 
1861
            old = tree.basis_tree()
 
1862
            old.lock_read()
 
1863
            try:
 
1864
                for path, ie in old.inventory.iter_entries():
 
1865
                    if not tree.has_id(ie.file_id):
 
1866
                        self.outf.write(path)
 
1867
                        if show_ids:
 
1868
                            self.outf.write(' ')
 
1869
                            self.outf.write(ie.file_id)
 
1870
                        self.outf.write('\n')
 
1871
            finally:
 
1872
                old.unlock()
 
1873
        finally:
 
1874
            tree.unlock()
2125
1875
 
2126
1876
 
2127
1877
class cmd_modified(Command):
2128
 
    __doc__ = """List files modified in working tree.
 
1878
    """List files modified in working tree.
2129
1879
    """
2130
1880
 
2131
1881
    hidden = True
2132
1882
    _see_also = ['status', 'ls']
2133
 
    takes_options = ['directory', 'null']
 
1883
    takes_options = [
 
1884
            Option('null',
 
1885
                   help='Write an ascii NUL (\\0) separator '
 
1886
                   'between files rather than a newline.')
 
1887
            ]
2134
1888
 
2135
1889
    @display_command
2136
 
    def run(self, null=False, directory=u'.'):
2137
 
        tree = WorkingTree.open_containing(directory)[0]
2138
 
        self.add_cleanup(tree.lock_read().unlock)
 
1890
    def run(self, null=False):
 
1891
        tree = WorkingTree.open_containing(u'.')[0]
2139
1892
        td = tree.changes_from(tree.basis_tree())
2140
 
        self.cleanup_now()
2141
1893
        for path, id, kind, text_modified, meta_modified in td.modified:
2142
1894
            if null:
2143
1895
                self.outf.write(path + '\0')
2146
1898
 
2147
1899
 
2148
1900
class cmd_added(Command):
2149
 
    __doc__ = """List files added in working tree.
 
1901
    """List files added in working tree.
2150
1902
    """
2151
1903
 
2152
1904
    hidden = True
2153
1905
    _see_also = ['status', 'ls']
2154
 
    takes_options = ['directory', 'null']
 
1906
    takes_options = [
 
1907
            Option('null',
 
1908
                   help='Write an ascii NUL (\\0) separator '
 
1909
                   'between files rather than a newline.')
 
1910
            ]
2155
1911
 
2156
1912
    @display_command
2157
 
    def run(self, null=False, directory=u'.'):
2158
 
        wt = WorkingTree.open_containing(directory)[0]
2159
 
        self.add_cleanup(wt.lock_read().unlock)
2160
 
        basis = wt.basis_tree()
2161
 
        self.add_cleanup(basis.lock_read().unlock)
2162
 
        basis_inv = basis.inventory
2163
 
        inv = wt.inventory
2164
 
        for file_id in inv:
2165
 
            if basis_inv.has_id(file_id):
2166
 
                continue
2167
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2168
 
                continue
2169
 
            path = inv.id2path(file_id)
2170
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2171
 
                continue
2172
 
            if null:
2173
 
                self.outf.write(path + '\0')
2174
 
            else:
2175
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1913
    def run(self, null=False):
 
1914
        wt = WorkingTree.open_containing(u'.')[0]
 
1915
        wt.lock_read()
 
1916
        try:
 
1917
            basis = wt.basis_tree()
 
1918
            basis.lock_read()
 
1919
            try:
 
1920
                basis_inv = basis.inventory
 
1921
                inv = wt.inventory
 
1922
                for file_id in inv:
 
1923
                    if file_id in basis_inv:
 
1924
                        continue
 
1925
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1926
                        continue
 
1927
                    path = inv.id2path(file_id)
 
1928
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1929
                        continue
 
1930
                    if null:
 
1931
                        self.outf.write(path + '\0')
 
1932
                    else:
 
1933
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1934
            finally:
 
1935
                basis.unlock()
 
1936
        finally:
 
1937
            wt.unlock()
2176
1938
 
2177
1939
 
2178
1940
class cmd_root(Command):
2179
 
    __doc__ = """Show the tree root directory.
 
1941
    """Show the tree root directory.
2180
1942
 
2181
1943
    The root is the nearest enclosing directory with a .bzr control
2182
1944
    directory."""
2206
1968
 
2207
1969
 
2208
1970
class cmd_log(Command):
2209
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1971
    """Show historical log for a branch or subset of a branch.
2210
1972
 
2211
1973
    log is bzr's default tool for exploring the history of a branch.
2212
1974
    The branch to use is taken from the first parameter. If no parameters
2317
2079
 
2318
2080
    :Other filtering:
2319
2081
 
2320
 
      The --match option can be used for finding revisions that match a
2321
 
      regular expression in a commit message, committer, author or bug.
2322
 
      Specifying the option several times will match any of the supplied
2323
 
      expressions. --match-author, --match-bugs, --match-committer and
2324
 
      --match-message can be used to only match a specific field.
 
2082
      The --message option can be used for finding revisions that match a
 
2083
      regular expression in a commit message.
2325
2084
 
2326
2085
    :Tips & tricks:
2327
2086
 
2328
2087
      GUI tools and IDEs are often better at exploring history than command
2329
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2330
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2331
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2332
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2088
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2089
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2090
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2091
 
 
2092
      Web interfaces are often better at exploring history than command line
 
2093
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2094
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2333
2095
 
2334
2096
      You may find it useful to add the aliases below to ``bazaar.conf``::
2335
2097
 
2376
2138
                   help='Show just the specified revision.'
2377
2139
                   ' See also "help revisionspec".'),
2378
2140
            'log-format',
2379
 
            RegistryOption('authors',
2380
 
                'What names to list as authors - first, all or committer.',
2381
 
                title='Authors',
2382
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2383
 
            ),
2384
2141
            Option('levels',
2385
2142
                   short_name='n',
2386
2143
                   help='Number of levels to display - 0 for all, 1 for flat.',
2387
2144
                   argname='N',
2388
2145
                   type=_parse_levels),
2389
2146
            Option('message',
 
2147
                   short_name='m',
2390
2148
                   help='Show revisions whose message matches this '
2391
2149
                        'regular expression.',
2392
 
                   type=str,
2393
 
                   hidden=True),
 
2150
                   type=str),
2394
2151
            Option('limit',
2395
2152
                   short_name='l',
2396
2153
                   help='Limit the output to the first N revisions.',
2401
2158
                   help='Show changes made in each revision as a patch.'),
2402
2159
            Option('include-merges',
2403
2160
                   help='Show merged revisions like --levels 0 does.'),
2404
 
            Option('exclude-common-ancestry',
2405
 
                   help='Display only the revisions that are not part'
2406
 
                   ' of both ancestries (require -rX..Y)'
2407
 
                   ),
2408
 
            Option('signatures',
2409
 
                   help='Show digital signature validity'),
2410
 
            ListOption('match',
2411
 
                short_name='m',
2412
 
                help='Show revisions whose properties match this '
2413
 
                'expression.',
2414
 
                type=str),
2415
 
            ListOption('match-message',
2416
 
                   help='Show revisions whose message matches this '
2417
 
                   'expression.',
2418
 
                type=str),
2419
 
            ListOption('match-committer',
2420
 
                   help='Show revisions whose committer matches this '
2421
 
                   'expression.',
2422
 
                type=str),
2423
 
            ListOption('match-author',
2424
 
                   help='Show revisions whose authors match this '
2425
 
                   'expression.',
2426
 
                type=str),
2427
 
            ListOption('match-bugs',
2428
 
                   help='Show revisions whose bugs match this '
2429
 
                   'expression.',
2430
 
                type=str)
2431
2161
            ]
2432
2162
    encoding_type = 'replace'
2433
2163
 
2443
2173
            message=None,
2444
2174
            limit=None,
2445
2175
            show_diff=False,
2446
 
            include_merges=False,
2447
 
            authors=None,
2448
 
            exclude_common_ancestry=False,
2449
 
            signatures=False,
2450
 
            match=None,
2451
 
            match_message=None,
2452
 
            match_committer=None,
2453
 
            match_author=None,
2454
 
            match_bugs=None,
2455
 
            ):
 
2176
            include_merges=False):
2456
2177
        from bzrlib.log import (
2457
2178
            Logger,
2458
2179
            make_log_request_dict,
2459
2180
            _get_info_for_log_files,
2460
2181
            )
2461
2182
        direction = (forward and 'forward') or 'reverse'
2462
 
        if (exclude_common_ancestry
2463
 
            and (revision is None or len(revision) != 2)):
2464
 
            raise errors.BzrCommandError(
2465
 
                '--exclude-common-ancestry requires -r with two revisions')
2466
2183
        if include_merges:
2467
2184
            if levels is None:
2468
2185
                levels = 0
2483
2200
        filter_by_dir = False
2484
2201
        if file_list:
2485
2202
            # find the file ids to log and check for directory filtering
2486
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2487
 
                revision, file_list, self.add_cleanup)
 
2203
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2204
                file_list)
2488
2205
            for relpath, file_id, kind in file_info_list:
2489
2206
                if file_id is None:
2490
2207
                    raise errors.BzrCommandError(
2508
2225
                location = '.'
2509
2226
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2510
2227
            b = dir.open_branch()
2511
 
            self.add_cleanup(b.lock_read().unlock)
2512
2228
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2513
2229
 
2514
 
        if b.get_config().validate_signatures_in_log():
2515
 
            signatures = True
2516
 
 
2517
 
        if signatures:
2518
 
            if not gpg.GPGStrategy.verify_signatures_available():
2519
 
                raise errors.GpgmeNotInstalled(None)
2520
 
 
2521
2230
        # Decide on the type of delta & diff filtering to use
2522
2231
        # TODO: add an --all-files option to make this configurable & consistent
2523
2232
        if not verbose:
2531
2240
        else:
2532
2241
            diff_type = 'full'
2533
2242
 
2534
 
        # Build the log formatter
2535
 
        if log_format is None:
2536
 
            log_format = log.log_formatter_registry.get_default(b)
2537
 
        # Make a non-encoding output to include the diffs - bug 328007
2538
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2539
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2540
 
                        to_exact_file=unencoded_output,
2541
 
                        show_timezone=timezone,
2542
 
                        delta_format=get_verbosity_level(),
2543
 
                        levels=levels,
2544
 
                        show_advice=levels is None,
2545
 
                        author_list_handler=authors)
2546
 
 
2547
 
        # Choose the algorithm for doing the logging. It's annoying
2548
 
        # having multiple code paths like this but necessary until
2549
 
        # the underlying repository format is faster at generating
2550
 
        # deltas or can provide everything we need from the indices.
2551
 
        # The default algorithm - match-using-deltas - works for
2552
 
        # multiple files and directories and is faster for small
2553
 
        # amounts of history (200 revisions say). However, it's too
2554
 
        # slow for logging a single file in a repository with deep
2555
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2556
 
        # evil when adding features", we continue to use the
2557
 
        # original algorithm - per-file-graph - for the "single
2558
 
        # file that isn't a directory without showing a delta" case.
2559
 
        partial_history = revision and b.repository._format.supports_chks
2560
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2561
 
            or delta_type or partial_history)
2562
 
 
2563
 
        match_dict = {}
2564
 
        if match:
2565
 
            match_dict[''] = match
2566
 
        if match_message:
2567
 
            match_dict['message'] = match_message
2568
 
        if match_committer:
2569
 
            match_dict['committer'] = match_committer
2570
 
        if match_author:
2571
 
            match_dict['author'] = match_author
2572
 
        if match_bugs:
2573
 
            match_dict['bugs'] = match_bugs
2574
 
            
2575
 
        # Build the LogRequest and execute it
2576
 
        if len(file_ids) == 0:
2577
 
            file_ids = None
2578
 
        rqst = make_log_request_dict(
2579
 
            direction=direction, specific_fileids=file_ids,
2580
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2581
 
            message_search=message, delta_type=delta_type,
2582
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2583
 
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2584
 
            signature=signatures
2585
 
            )
2586
 
        Logger(b, rqst).show(lf)
 
2243
        b.lock_read()
 
2244
        try:
 
2245
            # Build the log formatter
 
2246
            if log_format is None:
 
2247
                log_format = log.log_formatter_registry.get_default(b)
 
2248
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2249
                            show_timezone=timezone,
 
2250
                            delta_format=get_verbosity_level(),
 
2251
                            levels=levels,
 
2252
                            show_advice=levels is None)
 
2253
 
 
2254
            # Choose the algorithm for doing the logging. It's annoying
 
2255
            # having multiple code paths like this but necessary until
 
2256
            # the underlying repository format is faster at generating
 
2257
            # deltas or can provide everything we need from the indices.
 
2258
            # The default algorithm - match-using-deltas - works for
 
2259
            # multiple files and directories and is faster for small
 
2260
            # amounts of history (200 revisions say). However, it's too
 
2261
            # slow for logging a single file in a repository with deep
 
2262
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2263
            # evil when adding features", we continue to use the
 
2264
            # original algorithm - per-file-graph - for the "single
 
2265
            # file that isn't a directory without showing a delta" case.
 
2266
            partial_history = revision and b.repository._format.supports_chks
 
2267
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2268
                or delta_type or partial_history)
 
2269
 
 
2270
            # Build the LogRequest and execute it
 
2271
            if len(file_ids) == 0:
 
2272
                file_ids = None
 
2273
            rqst = make_log_request_dict(
 
2274
                direction=direction, specific_fileids=file_ids,
 
2275
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2276
                message_search=message, delta_type=delta_type,
 
2277
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2278
            Logger(b, rqst).show(lf)
 
2279
        finally:
 
2280
            b.unlock()
2587
2281
 
2588
2282
 
2589
2283
def _get_revision_range(revisionspec_list, branch, command_name):
2607
2301
            raise errors.BzrCommandError(
2608
2302
                "bzr %s doesn't accept two revisions in different"
2609
2303
                " branches." % command_name)
2610
 
        if start_spec.spec is None:
2611
 
            # Avoid loading all the history.
2612
 
            rev1 = RevisionInfo(branch, None, None)
2613
 
        else:
2614
 
            rev1 = start_spec.in_history(branch)
 
2304
        rev1 = start_spec.in_history(branch)
2615
2305
        # Avoid loading all of history when we know a missing
2616
2306
        # end of range means the last revision ...
2617
2307
        if end_spec.spec is None:
2646
2336
 
2647
2337
 
2648
2338
class cmd_touching_revisions(Command):
2649
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2339
    """Return revision-ids which affected a particular file.
2650
2340
 
2651
2341
    A more user-friendly interface is "bzr log FILE".
2652
2342
    """
2657
2347
    @display_command
2658
2348
    def run(self, filename):
2659
2349
        tree, relpath = WorkingTree.open_containing(filename)
 
2350
        b = tree.branch
2660
2351
        file_id = tree.path2id(relpath)
2661
 
        b = tree.branch
2662
 
        self.add_cleanup(b.lock_read().unlock)
2663
 
        touching_revs = log.find_touching_revisions(b, file_id)
2664
 
        for revno, revision_id, what in touching_revs:
 
2352
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2665
2353
            self.outf.write("%6d %s\n" % (revno, what))
2666
2354
 
2667
2355
 
2668
2356
class cmd_ls(Command):
2669
 
    __doc__ = """List files in a tree.
 
2357
    """List files in a tree.
2670
2358
    """
2671
2359
 
2672
2360
    _see_also = ['status', 'cat']
2678
2366
                   help='Recurse into subdirectories.'),
2679
2367
            Option('from-root',
2680
2368
                   help='Print paths relative to the root of the branch.'),
2681
 
            Option('unknown', short_name='u',
2682
 
                help='Print unknown files.'),
 
2369
            Option('unknown', help='Print unknown files.'),
2683
2370
            Option('versioned', help='Print versioned files.',
2684
2371
                   short_name='V'),
2685
 
            Option('ignored', short_name='i',
2686
 
                help='Print ignored files.'),
2687
 
            Option('kind', short_name='k',
 
2372
            Option('ignored', help='Print ignored files.'),
 
2373
            Option('null',
 
2374
                   help='Write an ascii NUL (\\0) separator '
 
2375
                   'between files rather than a newline.'),
 
2376
            Option('kind',
2688
2377
                   help='List entries of a particular kind: file, directory, symlink.',
2689
2378
                   type=unicode),
2690
 
            'null',
2691
2379
            'show-ids',
2692
 
            'directory',
2693
2380
            ]
2694
2381
    @display_command
2695
2382
    def run(self, revision=None, verbose=False,
2696
2383
            recursive=False, from_root=False,
2697
2384
            unknown=False, versioned=False, ignored=False,
2698
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2385
            null=False, kind=None, show_ids=False, path=None):
2699
2386
 
2700
2387
        if kind and kind not in ('file', 'directory', 'symlink'):
2701
2388
            raise errors.BzrCommandError('invalid kind specified')
2713
2400
                raise errors.BzrCommandError('cannot specify both --from-root'
2714
2401
                                             ' and PATH')
2715
2402
            fs_path = path
2716
 
        tree, branch, relpath = \
2717
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2403
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2404
            fs_path)
2718
2405
 
2719
2406
        # Calculate the prefix to use
2720
2407
        prefix = None
2721
2408
        if from_root:
2722
2409
            if relpath:
2723
2410
                prefix = relpath + '/'
2724
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2411
        elif fs_path != '.':
2725
2412
            prefix = fs_path + '/'
2726
2413
 
2727
2414
        if revision is not None or tree is None:
2735
2422
                view_str = views.view_display_str(view_files)
2736
2423
                note("Ignoring files outside view. View is %s" % view_str)
2737
2424
 
2738
 
        self.add_cleanup(tree.lock_read().unlock)
2739
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2740
 
            from_dir=relpath, recursive=recursive):
2741
 
            # Apply additional masking
2742
 
            if not all and not selection[fc]:
2743
 
                continue
2744
 
            if kind is not None and fkind != kind:
2745
 
                continue
2746
 
            if apply_view:
2747
 
                try:
2748
 
                    if relpath:
2749
 
                        fullpath = osutils.pathjoin(relpath, fp)
2750
 
                    else:
2751
 
                        fullpath = fp
2752
 
                    views.check_path_in_view(tree, fullpath)
2753
 
                except errors.FileOutsideView:
2754
 
                    continue
 
2425
        tree.lock_read()
 
2426
        try:
 
2427
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2428
                from_dir=relpath, recursive=recursive):
 
2429
                # Apply additional masking
 
2430
                if not all and not selection[fc]:
 
2431
                    continue
 
2432
                if kind is not None and fkind != kind:
 
2433
                    continue
 
2434
                if apply_view:
 
2435
                    try:
 
2436
                        if relpath:
 
2437
                            fullpath = osutils.pathjoin(relpath, fp)
 
2438
                        else:
 
2439
                            fullpath = fp
 
2440
                        views.check_path_in_view(tree, fullpath)
 
2441
                    except errors.FileOutsideView:
 
2442
                        continue
2755
2443
 
2756
 
            # Output the entry
2757
 
            if prefix:
2758
 
                fp = osutils.pathjoin(prefix, fp)
2759
 
            kindch = entry.kind_character()
2760
 
            outstring = fp + kindch
2761
 
            ui.ui_factory.clear_term()
2762
 
            if verbose:
2763
 
                outstring = '%-8s %s' % (fc, outstring)
2764
 
                if show_ids and fid is not None:
2765
 
                    outstring = "%-50s %s" % (outstring, fid)
2766
 
                self.outf.write(outstring + '\n')
2767
 
            elif null:
2768
 
                self.outf.write(fp + '\0')
2769
 
                if show_ids:
2770
 
                    if fid is not None:
2771
 
                        self.outf.write(fid)
2772
 
                    self.outf.write('\0')
2773
 
                self.outf.flush()
2774
 
            else:
2775
 
                if show_ids:
2776
 
                    if fid is not None:
2777
 
                        my_id = fid
2778
 
                    else:
2779
 
                        my_id = ''
2780
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2781
 
                else:
 
2444
                # Output the entry
 
2445
                if prefix:
 
2446
                    fp = osutils.pathjoin(prefix, fp)
 
2447
                kindch = entry.kind_character()
 
2448
                outstring = fp + kindch
 
2449
                ui.ui_factory.clear_term()
 
2450
                if verbose:
 
2451
                    outstring = '%-8s %s' % (fc, outstring)
 
2452
                    if show_ids and fid is not None:
 
2453
                        outstring = "%-50s %s" % (outstring, fid)
2782
2454
                    self.outf.write(outstring + '\n')
 
2455
                elif null:
 
2456
                    self.outf.write(fp + '\0')
 
2457
                    if show_ids:
 
2458
                        if fid is not None:
 
2459
                            self.outf.write(fid)
 
2460
                        self.outf.write('\0')
 
2461
                    self.outf.flush()
 
2462
                else:
 
2463
                    if show_ids:
 
2464
                        if fid is not None:
 
2465
                            my_id = fid
 
2466
                        else:
 
2467
                            my_id = ''
 
2468
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2469
                    else:
 
2470
                        self.outf.write(outstring + '\n')
 
2471
        finally:
 
2472
            tree.unlock()
2783
2473
 
2784
2474
 
2785
2475
class cmd_unknowns(Command):
2786
 
    __doc__ = """List unknown files.
 
2476
    """List unknown files.
2787
2477
    """
2788
2478
 
2789
2479
    hidden = True
2790
2480
    _see_also = ['ls']
2791
 
    takes_options = ['directory']
2792
2481
 
2793
2482
    @display_command
2794
 
    def run(self, directory=u'.'):
2795
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2483
    def run(self):
 
2484
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2796
2485
            self.outf.write(osutils.quotefn(f) + '\n')
2797
2486
 
2798
2487
 
2799
2488
class cmd_ignore(Command):
2800
 
    __doc__ = """Ignore specified files or patterns.
 
2489
    """Ignore specified files or patterns.
2801
2490
 
2802
2491
    See ``bzr help patterns`` for details on the syntax of patterns.
2803
2492
 
2804
 
    If a .bzrignore file does not exist, the ignore command
2805
 
    will create one and add the specified files or patterns to the newly
2806
 
    created file. The ignore command will also automatically add the 
2807
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2808
 
    the use of the ignore command will require an explicit add command.
2809
 
 
2810
2493
    To remove patterns from the ignore list, edit the .bzrignore file.
2811
2494
    After adding, editing or deleting that file either indirectly by
2812
2495
    using this command or directly by using an editor, be sure to commit
2813
2496
    it.
2814
 
    
2815
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2816
 
    the global ignore file can be found in the application data directory as
2817
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2818
 
    Global ignores are not touched by this command. The global ignore file
2819
 
    can be edited directly using an editor.
2820
 
 
2821
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2822
 
    precedence over regular ignores.  Such exceptions are used to specify
2823
 
    files that should be versioned which would otherwise be ignored.
2824
 
    
2825
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2826
 
    precedence over the '!' exception patterns.
2827
 
 
2828
 
    :Notes: 
2829
 
        
2830
 
    * Ignore patterns containing shell wildcards must be quoted from
2831
 
      the shell on Unix.
2832
 
 
2833
 
    * Ignore patterns starting with "#" act as comments in the ignore file.
2834
 
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
2497
 
 
2498
    Note: ignore patterns containing shell wildcards must be quoted from
 
2499
    the shell on Unix.
2835
2500
 
2836
2501
    :Examples:
2837
2502
        Ignore the top level Makefile::
2838
2503
 
2839
2504
            bzr ignore ./Makefile
2840
2505
 
2841
 
        Ignore .class files in all directories...::
 
2506
        Ignore class files in all directories::
2842
2507
 
2843
2508
            bzr ignore "*.class"
2844
2509
 
2845
 
        ...but do not ignore "special.class"::
2846
 
 
2847
 
            bzr ignore "!special.class"
2848
 
 
2849
 
        Ignore files whose name begins with the "#" character::
2850
 
 
2851
 
            bzr ignore "RE:^#"
2852
 
 
2853
2510
        Ignore .o files under the lib directory::
2854
2511
 
2855
2512
            bzr ignore "lib/**/*.o"
2861
2518
        Ignore everything but the "debian" toplevel directory::
2862
2519
 
2863
2520
            bzr ignore "RE:(?!debian/).*"
2864
 
        
2865
 
        Ignore everything except the "local" toplevel directory,
2866
 
        but always ignore autosave files ending in ~, even under local/::
2867
 
        
2868
 
            bzr ignore "*"
2869
 
            bzr ignore "!./local"
2870
 
            bzr ignore "!!*~"
2871
2521
    """
2872
2522
 
2873
2523
    _see_also = ['status', 'ignored', 'patterns']
2874
2524
    takes_args = ['name_pattern*']
2875
 
    takes_options = ['directory',
2876
 
        Option('default-rules',
2877
 
               help='Display the default ignore rules that bzr uses.')
 
2525
    takes_options = [
 
2526
        Option('old-default-rules',
 
2527
               help='Write out the ignore rules bzr < 0.9 always used.')
2878
2528
        ]
2879
2529
 
2880
 
    def run(self, name_pattern_list=None, default_rules=None,
2881
 
            directory=u'.'):
 
2530
    def run(self, name_pattern_list=None, old_default_rules=None):
2882
2531
        from bzrlib import ignores
2883
 
        if default_rules is not None:
2884
 
            # dump the default rules and exit
2885
 
            for pattern in ignores.USER_DEFAULTS:
2886
 
                self.outf.write("%s\n" % pattern)
 
2532
        if old_default_rules is not None:
 
2533
            # dump the rules and exit
 
2534
            for pattern in ignores.OLD_DEFAULTS:
 
2535
                print pattern
2887
2536
            return
2888
2537
        if not name_pattern_list:
2889
2538
            raise errors.BzrCommandError("ignore requires at least one "
2890
 
                "NAME_PATTERN or --default-rules.")
 
2539
                                  "NAME_PATTERN or --old-default-rules")
2891
2540
        name_pattern_list = [globbing.normalize_pattern(p)
2892
2541
                             for p in name_pattern_list]
2893
 
        bad_patterns = ''
2894
 
        for p in name_pattern_list:
2895
 
            if not globbing.Globster.is_pattern_valid(p):
2896
 
                bad_patterns += ('\n  %s' % p)
2897
 
        if bad_patterns:
2898
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2899
 
            ui.ui_factory.show_error(msg)
2900
 
            raise errors.InvalidPattern('')
2901
2542
        for name_pattern in name_pattern_list:
2902
2543
            if (name_pattern[0] == '/' or
2903
2544
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2904
2545
                raise errors.BzrCommandError(
2905
2546
                    "NAME_PATTERN should not be an absolute path")
2906
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2547
        tree, relpath = WorkingTree.open_containing(u'.')
2907
2548
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2908
2549
        ignored = globbing.Globster(name_pattern_list)
2909
2550
        matches = []
2910
 
        self.add_cleanup(tree.lock_read().unlock)
 
2551
        tree.lock_read()
2911
2552
        for entry in tree.list_files():
2912
2553
            id = entry[3]
2913
2554
            if id is not None:
2914
2555
                filename = entry[0]
2915
2556
                if ignored.match(filename):
2916
 
                    matches.append(filename)
 
2557
                    matches.append(filename.encode('utf-8'))
 
2558
        tree.unlock()
2917
2559
        if len(matches) > 0:
2918
 
            self.outf.write("Warning: the following files are version controlled and"
2919
 
                  " match your ignore pattern:\n%s"
2920
 
                  "\nThese files will continue to be version controlled"
2921
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2560
            print "Warning: the following files are version controlled and" \
 
2561
                  " match your ignore pattern:\n%s" \
 
2562
                  "\nThese files will continue to be version controlled" \
 
2563
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2922
2564
 
2923
2565
 
2924
2566
class cmd_ignored(Command):
2925
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2567
    """List ignored files and the patterns that matched them.
2926
2568
 
2927
2569
    List all the ignored files and the ignore pattern that caused the file to
2928
2570
    be ignored.
2934
2576
 
2935
2577
    encoding_type = 'replace'
2936
2578
    _see_also = ['ignore', 'ls']
2937
 
    takes_options = ['directory']
2938
2579
 
2939
2580
    @display_command
2940
 
    def run(self, directory=u'.'):
2941
 
        tree = WorkingTree.open_containing(directory)[0]
2942
 
        self.add_cleanup(tree.lock_read().unlock)
2943
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2944
 
            if file_class != 'I':
2945
 
                continue
2946
 
            ## XXX: Slightly inefficient since this was already calculated
2947
 
            pat = tree.is_ignored(path)
2948
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2581
    def run(self):
 
2582
        tree = WorkingTree.open_containing(u'.')[0]
 
2583
        tree.lock_read()
 
2584
        try:
 
2585
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2586
                if file_class != 'I':
 
2587
                    continue
 
2588
                ## XXX: Slightly inefficient since this was already calculated
 
2589
                pat = tree.is_ignored(path)
 
2590
                self.outf.write('%-50s %s\n' % (path, pat))
 
2591
        finally:
 
2592
            tree.unlock()
2949
2593
 
2950
2594
 
2951
2595
class cmd_lookup_revision(Command):
2952
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2596
    """Lookup the revision-id from a revision-number
2953
2597
 
2954
2598
    :Examples:
2955
2599
        bzr lookup-revision 33
2956
2600
    """
2957
2601
    hidden = True
2958
2602
    takes_args = ['revno']
2959
 
    takes_options = ['directory']
2960
2603
 
2961
2604
    @display_command
2962
 
    def run(self, revno, directory=u'.'):
 
2605
    def run(self, revno):
2963
2606
        try:
2964
2607
            revno = int(revno)
2965
2608
        except ValueError:
2966
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2967
 
                                         % revno)
2968
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2969
 
        self.outf.write("%s\n" % revid)
 
2609
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2610
 
 
2611
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2970
2612
 
2971
2613
 
2972
2614
class cmd_export(Command):
2973
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2615
    """Export current or past revision to a destination directory or archive.
2974
2616
 
2975
2617
    If no revision is specified this exports the last committed revision.
2976
2618
 
2997
2639
         zip                          .zip
2998
2640
      =================       =========================
2999
2641
    """
3000
 
    encoding = 'exact'
3001
2642
    takes_args = ['dest', 'branch_or_subdir?']
3002
 
    takes_options = ['directory',
 
2643
    takes_options = [
3003
2644
        Option('format',
3004
2645
               help="Type of file to export to.",
3005
2646
               type=unicode),
3009
2650
        Option('root',
3010
2651
               type=str,
3011
2652
               help="Name of the root directory inside the exported file."),
3012
 
        Option('per-file-timestamps',
3013
 
               help='Set modification time of files to that of the last '
3014
 
                    'revision in which it was changed.'),
3015
2653
        ]
3016
2654
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3017
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2655
        root=None, filters=False):
3018
2656
        from bzrlib.export import export
3019
2657
 
3020
2658
        if branch_or_subdir is None:
3021
 
            tree = WorkingTree.open_containing(directory)[0]
 
2659
            tree = WorkingTree.open_containing(u'.')[0]
3022
2660
            b = tree.branch
3023
2661
            subdir = None
3024
2662
        else:
3027
2665
 
3028
2666
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3029
2667
        try:
3030
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
3031
 
                   per_file_timestamps=per_file_timestamps)
 
2668
            export(rev_tree, dest, format, root, subdir, filtered=filters)
3032
2669
        except errors.NoSuchExportFormat, e:
3033
2670
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3034
2671
 
3035
2672
 
3036
2673
class cmd_cat(Command):
3037
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2674
    """Write the contents of a file as of a given revision to standard output.
3038
2675
 
3039
2676
    If no revision is nominated, the last revision is used.
3040
2677
 
3043
2680
    """
3044
2681
 
3045
2682
    _see_also = ['ls']
3046
 
    takes_options = ['directory',
 
2683
    takes_options = [
3047
2684
        Option('name-from-revision', help='The path name in the old tree.'),
3048
2685
        Option('filters', help='Apply content filters to display the '
3049
2686
                'convenience form.'),
3054
2691
 
3055
2692
    @display_command
3056
2693
    def run(self, filename, revision=None, name_from_revision=False,
3057
 
            filters=False, directory=None):
 
2694
            filters=False):
3058
2695
        if revision is not None and len(revision) != 1:
3059
2696
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
3060
2697
                                         " one revision specifier")
3061
2698
        tree, branch, relpath = \
3062
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
3063
 
        self.add_cleanup(branch.lock_read().unlock)
3064
 
        return self._run(tree, branch, relpath, filename, revision,
3065
 
                         name_from_revision, filters)
 
2699
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2700
        branch.lock_read()
 
2701
        try:
 
2702
            return self._run(tree, branch, relpath, filename, revision,
 
2703
                             name_from_revision, filters)
 
2704
        finally:
 
2705
            branch.unlock()
3066
2706
 
3067
2707
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3068
2708
        filtered):
3069
2709
        if tree is None:
3070
2710
            tree = b.basis_tree()
3071
2711
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3072
 
        self.add_cleanup(rev_tree.lock_read().unlock)
3073
2712
 
3074
2713
        old_file_id = rev_tree.path2id(relpath)
3075
2714
 
3076
 
        # TODO: Split out this code to something that generically finds the
3077
 
        # best id for a path across one or more trees; it's like
3078
 
        # find_ids_across_trees but restricted to find just one. -- mbp
3079
 
        # 20110705.
3080
2715
        if name_from_revision:
3081
2716
            # Try in revision if requested
3082
2717
            if old_file_id is None:
3084
2719
                    "%r is not present in revision %s" % (
3085
2720
                        filename, rev_tree.get_revision_id()))
3086
2721
            else:
3087
 
                actual_file_id = old_file_id
 
2722
                content = rev_tree.get_file_text(old_file_id)
3088
2723
        else:
3089
2724
            cur_file_id = tree.path2id(relpath)
3090
 
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3091
 
                actual_file_id = cur_file_id
3092
 
            elif old_file_id is not None:
3093
 
                actual_file_id = old_file_id
3094
 
            else:
 
2725
            found = False
 
2726
            if cur_file_id is not None:
 
2727
                # Then try with the actual file id
 
2728
                try:
 
2729
                    content = rev_tree.get_file_text(cur_file_id)
 
2730
                    found = True
 
2731
                except errors.NoSuchId:
 
2732
                    # The actual file id didn't exist at that time
 
2733
                    pass
 
2734
            if not found and old_file_id is not None:
 
2735
                # Finally try with the old file id
 
2736
                content = rev_tree.get_file_text(old_file_id)
 
2737
                found = True
 
2738
            if not found:
 
2739
                # Can't be found anywhere
3095
2740
                raise errors.BzrCommandError(
3096
2741
                    "%r is not present in revision %s" % (
3097
2742
                        filename, rev_tree.get_revision_id()))
3098
2743
        if filtered:
3099
 
            from bzrlib.filter_tree import ContentFilterTree
3100
 
            filter_tree = ContentFilterTree(rev_tree,
3101
 
                rev_tree._content_filter_stack)
3102
 
            content = filter_tree.get_file_text(actual_file_id)
 
2744
            from bzrlib.filters import (
 
2745
                ContentFilterContext,
 
2746
                filtered_output_bytes,
 
2747
                )
 
2748
            filters = rev_tree._content_filter_stack(relpath)
 
2749
            chunks = content.splitlines(True)
 
2750
            content = filtered_output_bytes(chunks, filters,
 
2751
                ContentFilterContext(relpath, rev_tree))
 
2752
            self.outf.writelines(content)
3103
2753
        else:
3104
 
            content = rev_tree.get_file_text(actual_file_id)
3105
 
        self.cleanup_now()
3106
 
        self.outf.write(content)
 
2754
            self.outf.write(content)
3107
2755
 
3108
2756
 
3109
2757
class cmd_local_time_offset(Command):
3110
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2758
    """Show the offset in seconds from GMT to local time."""
3111
2759
    hidden = True
3112
2760
    @display_command
3113
2761
    def run(self):
3114
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2762
        print osutils.local_time_offset()
3115
2763
 
3116
2764
 
3117
2765
 
3118
2766
class cmd_commit(Command):
3119
 
    __doc__ = """Commit changes into a new revision.
 
2767
    """Commit changes into a new revision.
3120
2768
 
3121
2769
    An explanatory message needs to be given for each commit. This is
3122
2770
    often done by using the --message option (getting the message from the
3170
2818
      to trigger updates to external systems like bug trackers. The --fixes
3171
2819
      option can be used to record the association between a revision and
3172
2820
      one or more bugs. See ``bzr help bugs`` for details.
 
2821
 
 
2822
      A selective commit may fail in some cases where the committed
 
2823
      tree would be invalid. Consider::
 
2824
  
 
2825
        bzr init foo
 
2826
        mkdir foo/bar
 
2827
        bzr add foo/bar
 
2828
        bzr commit foo -m "committing foo"
 
2829
        bzr mv foo/bar foo/baz
 
2830
        mkdir foo/bar
 
2831
        bzr add foo/bar
 
2832
        bzr commit foo/bar -m "committing bar but not baz"
 
2833
  
 
2834
      In the example above, the last commit will fail by design. This gives
 
2835
      the user the opportunity to decide whether they want to commit the
 
2836
      rename at the same time, separately first, or not at all. (As a general
 
2837
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3173
2838
    """
 
2839
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2840
 
 
2841
    # TODO: Strict commit that fails if there are deleted files.
 
2842
    #       (what does "deleted files" mean ??)
 
2843
 
 
2844
    # TODO: Give better message for -s, --summary, used by tla people
 
2845
 
 
2846
    # XXX: verbose currently does nothing
3174
2847
 
3175
2848
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3176
2849
    takes_args = ['selected*']
3190
2863
             Option('strict',
3191
2864
                    help="Refuse to commit if there are unknown "
3192
2865
                    "files in the working tree."),
3193
 
             Option('commit-time', type=str,
3194
 
                    help="Manually set a commit time using commit date "
3195
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3196
2866
             ListOption('fixes', type=str,
3197
2867
                    help="Mark a bug as being fixed by this revision "
3198
2868
                         "(see \"bzr help bugs\")."),
3205
2875
                         "the master branch until a normal commit "
3206
2876
                         "is performed."
3207
2877
                    ),
3208
 
             Option('show-diff', short_name='p',
3209
 
                    help='When no message is supplied, show the diff along'
3210
 
                    ' with the status summary in the message editor.'),
3211
 
             Option('lossy', 
3212
 
                    help='When committing to a foreign version control '
3213
 
                    'system do not push data that can not be natively '
3214
 
                    'represented.'),
 
2878
              Option('show-diff',
 
2879
                     help='When no message is supplied, show the diff along'
 
2880
                     ' with the status summary in the message editor.'),
3215
2881
             ]
3216
2882
    aliases = ['ci', 'checkin']
3217
2883
 
3236
2902
 
3237
2903
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3238
2904
            unchanged=False, strict=False, local=False, fixes=None,
3239
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3240
 
            lossy=False):
 
2905
            author=None, show_diff=False, exclude=None):
3241
2906
        from bzrlib.errors import (
3242
2907
            PointlessCommit,
3243
2908
            ConflictsInTree,
3246
2911
        from bzrlib.msgeditor import (
3247
2912
            edit_commit_message_encoded,
3248
2913
            generate_commit_message_template,
3249
 
            make_commit_message_template_encoded,
3250
 
            set_commit_message,
 
2914
            make_commit_message_template_encoded
3251
2915
        )
3252
2916
 
3253
 
        commit_stamp = offset = None
3254
 
        if commit_time is not None:
3255
 
            try:
3256
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3257
 
            except ValueError, e:
3258
 
                raise errors.BzrCommandError(
3259
 
                    "Could not parse --commit-time: " + str(e))
 
2917
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2918
        # slightly problematic to run this cross-platform.
 
2919
 
 
2920
        # TODO: do more checks that the commit will succeed before
 
2921
        # spending the user's valuable time typing a commit message.
3260
2922
 
3261
2923
        properties = {}
3262
2924
 
3263
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
2925
        tree, selected_list = tree_files(selected_list)
3264
2926
        if selected_list == ['']:
3265
2927
            # workaround - commit of root of tree should be exactly the same
3266
2928
            # as just default commit in that tree, and succeed even though
3277
2939
        if local and not tree.branch.get_bound_location():
3278
2940
            raise errors.LocalRequiresBoundBranch()
3279
2941
 
3280
 
        if message is not None:
3281
 
            try:
3282
 
                file_exists = osutils.lexists(message)
3283
 
            except UnicodeError:
3284
 
                # The commit message contains unicode characters that can't be
3285
 
                # represented in the filesystem encoding, so that can't be a
3286
 
                # file.
3287
 
                file_exists = False
3288
 
            if file_exists:
3289
 
                warning_msg = (
3290
 
                    'The commit message is a file name: "%(f)s".\n'
3291
 
                    '(use --file "%(f)s" to take commit message from that file)'
3292
 
                    % { 'f': message })
3293
 
                ui.ui_factory.show_warning(warning_msg)
3294
 
            if '\r' in message:
3295
 
                message = message.replace('\r\n', '\n')
3296
 
                message = message.replace('\r', '\n')
3297
 
            if file:
3298
 
                raise errors.BzrCommandError(
3299
 
                    "please specify either --message or --file")
3300
 
 
3301
2942
        def get_message(commit_obj):
3302
2943
            """Callback to get commit message"""
3303
 
            if file:
3304
 
                f = open(file)
3305
 
                try:
3306
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3307
 
                finally:
3308
 
                    f.close()
3309
 
            elif message is not None:
3310
 
                my_message = message
3311
 
            else:
3312
 
                # No message supplied: make one up.
3313
 
                # text is the status of the tree
3314
 
                text = make_commit_message_template_encoded(tree,
 
2944
            my_message = message
 
2945
            if my_message is None and not file:
 
2946
                t = make_commit_message_template_encoded(tree,
3315
2947
                        selected_list, diff=show_diff,
3316
2948
                        output_encoding=osutils.get_user_encoding())
3317
 
                # start_message is the template generated from hooks
3318
 
                # XXX: Warning - looks like hooks return unicode,
3319
 
                # make_commit_message_template_encoded returns user encoding.
3320
 
                # We probably want to be using edit_commit_message instead to
3321
 
                # avoid this.
3322
 
                my_message = set_commit_message(commit_obj)
3323
 
                if my_message is None:
3324
 
                    start_message = generate_commit_message_template(commit_obj)
3325
 
                    my_message = edit_commit_message_encoded(text,
3326
 
                        start_message=start_message)
 
2949
                start_message = generate_commit_message_template(commit_obj)
 
2950
                my_message = edit_commit_message_encoded(t,
 
2951
                    start_message=start_message)
3327
2952
                if my_message is None:
3328
2953
                    raise errors.BzrCommandError("please specify a commit"
3329
2954
                        " message with either --message or --file")
 
2955
            elif my_message and file:
 
2956
                raise errors.BzrCommandError(
 
2957
                    "please specify either --message or --file")
 
2958
            if file:
 
2959
                my_message = codecs.open(file, 'rt',
 
2960
                                         osutils.get_user_encoding()).read()
3330
2961
            if my_message == "":
3331
 
                raise errors.BzrCommandError("Empty commit message specified."
3332
 
                        " Please specify a commit message with either"
3333
 
                        " --message or --file or leave a blank message"
3334
 
                        " with --message \"\".")
 
2962
                raise errors.BzrCommandError("empty commit message specified")
3335
2963
            return my_message
3336
2964
 
3337
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3338
 
        # but the command line should not do that.
3339
 
        if not selected_list:
3340
 
            selected_list = None
3341
2965
        try:
3342
2966
            tree.commit(message_callback=get_message,
3343
2967
                        specific_files=selected_list,
3344
2968
                        allow_pointless=unchanged, strict=strict, local=local,
3345
2969
                        reporter=None, verbose=verbose, revprops=properties,
3346
 
                        authors=author, timestamp=commit_stamp,
3347
 
                        timezone=offset,
3348
 
                        exclude=tree.safe_relpath_files(exclude),
3349
 
                        lossy=lossy)
 
2970
                        authors=author,
 
2971
                        exclude=safe_relpath_files(tree, exclude))
3350
2972
        except PointlessCommit:
 
2973
            # FIXME: This should really happen before the file is read in;
 
2974
            # perhaps prepare the commit; get the message; then actually commit
3351
2975
            raise errors.BzrCommandError("No changes to commit."
3352
 
                " Please 'bzr add' the files you want to commit, or use"
3353
 
                " --unchanged to force an empty commit.")
 
2976
                              " Use --unchanged to commit anyhow.")
3354
2977
        except ConflictsInTree:
3355
2978
            raise errors.BzrCommandError('Conflicts detected in working '
3356
2979
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3359
2982
            raise errors.BzrCommandError("Commit refused because there are"
3360
2983
                              " unknown files in the working tree.")
3361
2984
        except errors.BoundBranchOutOfDate, e:
3362
 
            e.extra_help = ("\n"
3363
 
                'To commit to master branch, run update and then commit.\n'
3364
 
                'You can also pass --local to commit to continue working '
3365
 
                'disconnected.')
3366
 
            raise
 
2985
            raise errors.BzrCommandError(str(e) + "\n"
 
2986
            'To commit to master branch, run update and then commit.\n'
 
2987
            'You can also pass --local to commit to continue working '
 
2988
            'disconnected.')
3367
2989
 
3368
2990
 
3369
2991
class cmd_check(Command):
3370
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2992
    """Validate working tree structure, branch consistency and repository history.
3371
2993
 
3372
2994
    This command checks various invariants about branch and repository storage
3373
2995
    to detect data corruption or bzr bugs.
3375
2997
    The working tree and branch checks will only give output if a problem is
3376
2998
    detected. The output fields of the repository check are:
3377
2999
 
3378
 
    revisions
3379
 
        This is just the number of revisions checked.  It doesn't
3380
 
        indicate a problem.
3381
 
 
3382
 
    versionedfiles
3383
 
        This is just the number of versionedfiles checked.  It
3384
 
        doesn't indicate a problem.
3385
 
 
3386
 
    unreferenced ancestors
3387
 
        Texts that are ancestors of other texts, but
3388
 
        are not properly referenced by the revision ancestry.  This is a
3389
 
        subtle problem that Bazaar can work around.
3390
 
 
3391
 
    unique file texts
3392
 
        This is the total number of unique file contents
3393
 
        seen in the checked revisions.  It does not indicate a problem.
3394
 
 
3395
 
    repeated file texts
3396
 
        This is the total number of repeated texts seen
3397
 
        in the checked revisions.  Texts can be repeated when their file
3398
 
        entries are modified, but the file contents are not.  It does not
3399
 
        indicate a problem.
 
3000
        revisions: This is just the number of revisions checked.  It doesn't
 
3001
            indicate a problem.
 
3002
        versionedfiles: This is just the number of versionedfiles checked.  It
 
3003
            doesn't indicate a problem.
 
3004
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
3005
            are not properly referenced by the revision ancestry.  This is a
 
3006
            subtle problem that Bazaar can work around.
 
3007
        unique file texts: This is the total number of unique file contents
 
3008
            seen in the checked revisions.  It does not indicate a problem.
 
3009
        repeated file texts: This is the total number of repeated texts seen
 
3010
            in the checked revisions.  Texts can be repeated when their file
 
3011
            entries are modified, but the file contents are not.  It does not
 
3012
            indicate a problem.
3400
3013
 
3401
3014
    If no restrictions are specified, all Bazaar data that is found at the given
3402
3015
    location will be checked.
3437
3050
 
3438
3051
 
3439
3052
class cmd_upgrade(Command):
3440
 
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3441
 
 
3442
 
    When the default format has changed after a major new release of
3443
 
    Bazaar, you may be informed during certain operations that you
3444
 
    should upgrade. Upgrading to a newer format may improve performance
3445
 
    or make new features available. It may however limit interoperability
3446
 
    with older repositories or with older versions of Bazaar.
3447
 
 
3448
 
    If you wish to upgrade to a particular format rather than the
3449
 
    current default, that can be specified using the --format option.
3450
 
    As a consequence, you can use the upgrade command this way to
3451
 
    "downgrade" to an earlier format, though some conversions are
3452
 
    a one way process (e.g. changing from the 1.x default to the
3453
 
    2.x default) so downgrading is not always possible.
3454
 
 
3455
 
    A backup.bzr.~#~ directory is created at the start of the conversion
3456
 
    process (where # is a number). By default, this is left there on
3457
 
    completion. If the conversion fails, delete the new .bzr directory
3458
 
    and rename this one back in its place. Use the --clean option to ask
3459
 
    for the backup.bzr directory to be removed on successful conversion.
3460
 
    Alternatively, you can delete it by hand if everything looks good
3461
 
    afterwards.
3462
 
 
3463
 
    If the location given is a shared repository, dependent branches
3464
 
    are also converted provided the repository converts successfully.
3465
 
    If the conversion of a branch fails, remaining branches are still
3466
 
    tried.
3467
 
 
3468
 
    For more information on upgrades, see the Bazaar Upgrade Guide,
3469
 
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
 
3053
    """Upgrade branch storage to current format.
 
3054
 
 
3055
    The check command or bzr developers may sometimes advise you to run
 
3056
    this command. When the default format has changed you may also be warned
 
3057
    during other operations to upgrade.
3470
3058
    """
3471
3059
 
3472
 
    _see_also = ['check', 'reconcile', 'formats']
 
3060
    _see_also = ['check']
3473
3061
    takes_args = ['url?']
3474
3062
    takes_options = [
3475
 
        RegistryOption('format',
3476
 
            help='Upgrade to a specific format.  See "bzr help'
3477
 
                 ' formats" for details.',
3478
 
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3479
 
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3480
 
            value_switches=True, title='Branch format'),
3481
 
        Option('clean',
3482
 
            help='Remove the backup.bzr directory if successful.'),
3483
 
        Option('dry-run',
3484
 
            help="Show what would be done, but don't actually do anything."),
3485
 
    ]
 
3063
                    RegistryOption('format',
 
3064
                        help='Upgrade to a specific format.  See "bzr help'
 
3065
                             ' formats" for details.',
 
3066
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3067
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3068
                        value_switches=True, title='Branch format'),
 
3069
                    ]
3486
3070
 
3487
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3071
    def run(self, url='.', format=None):
3488
3072
        from bzrlib.upgrade import upgrade
3489
 
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3490
 
        if exceptions:
3491
 
            if len(exceptions) == 1:
3492
 
                # Compatibility with historical behavior
3493
 
                raise exceptions[0]
3494
 
            else:
3495
 
                return 3
 
3073
        upgrade(url, format)
3496
3074
 
3497
3075
 
3498
3076
class cmd_whoami(Command):
3499
 
    __doc__ = """Show or set bzr user id.
 
3077
    """Show or set bzr user id.
3500
3078
 
3501
3079
    :Examples:
3502
3080
        Show the email of the current user::
3507
3085
 
3508
3086
            bzr whoami "Frank Chu <fchu@example.com>"
3509
3087
    """
3510
 
    takes_options = [ 'directory',
3511
 
                      Option('email',
 
3088
    takes_options = [ Option('email',
3512
3089
                             help='Display email address only.'),
3513
3090
                      Option('branch',
3514
3091
                             help='Set identity for the current branch instead of '
3518
3095
    encoding_type = 'replace'
3519
3096
 
3520
3097
    @display_command
3521
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3098
    def run(self, email=False, branch=False, name=None):
3522
3099
        if name is None:
3523
 
            if directory is None:
3524
 
                # use branch if we're inside one; otherwise global config
3525
 
                try:
3526
 
                    c = Branch.open_containing(u'.')[0].get_config()
3527
 
                except errors.NotBranchError:
3528
 
                    c = _mod_config.GlobalConfig()
3529
 
            else:
3530
 
                c = Branch.open(directory).get_config()
 
3100
            # use branch if we're inside one; otherwise global config
 
3101
            try:
 
3102
                c = Branch.open_containing('.')[0].get_config()
 
3103
            except errors.NotBranchError:
 
3104
                c = config.GlobalConfig()
3531
3105
            if email:
3532
3106
                self.outf.write(c.user_email() + '\n')
3533
3107
            else:
3534
3108
                self.outf.write(c.username() + '\n')
3535
3109
            return
3536
3110
 
3537
 
        if email:
3538
 
            raise errors.BzrCommandError("--email can only be used to display existing "
3539
 
                                         "identity")
3540
 
 
3541
3111
        # display a warning if an email address isn't included in the given name.
3542
3112
        try:
3543
 
            _mod_config.extract_email_address(name)
 
3113
            config.extract_email_address(name)
3544
3114
        except errors.NoEmailInUsername, e:
3545
3115
            warning('"%s" does not seem to contain an email address.  '
3546
3116
                    'This is allowed, but not recommended.', name)
3547
3117
 
3548
3118
        # use global config unless --branch given
3549
3119
        if branch:
3550
 
            if directory is None:
3551
 
                c = Branch.open_containing(u'.')[0].get_config()
3552
 
            else:
3553
 
                c = Branch.open(directory).get_config()
 
3120
            c = Branch.open_containing('.')[0].get_config()
3554
3121
        else:
3555
 
            c = _mod_config.GlobalConfig()
 
3122
            c = config.GlobalConfig()
3556
3123
        c.set_user_option('email', name)
3557
3124
 
3558
3125
 
3559
3126
class cmd_nick(Command):
3560
 
    __doc__ = """Print or set the branch nickname.
 
3127
    """Print or set the branch nickname.
3561
3128
 
3562
3129
    If unset, the tree root directory name is used as the nickname.
3563
3130
    To print the current nickname, execute with no argument.
3568
3135
 
3569
3136
    _see_also = ['info']
3570
3137
    takes_args = ['nickname?']
3571
 
    takes_options = ['directory']
3572
 
    def run(self, nickname=None, directory=u'.'):
3573
 
        branch = Branch.open_containing(directory)[0]
 
3138
    def run(self, nickname=None):
 
3139
        branch = Branch.open_containing(u'.')[0]
3574
3140
        if nickname is None:
3575
3141
            self.printme(branch)
3576
3142
        else:
3578
3144
 
3579
3145
    @display_command
3580
3146
    def printme(self, branch):
3581
 
        self.outf.write('%s\n' % branch.nick)
 
3147
        print branch.nick
3582
3148
 
3583
3149
 
3584
3150
class cmd_alias(Command):
3585
 
    __doc__ = """Set/unset and display aliases.
 
3151
    """Set/unset and display aliases.
3586
3152
 
3587
3153
    :Examples:
3588
3154
        Show the current aliases::
3625
3191
                'bzr alias --remove expects an alias to remove.')
3626
3192
        # If alias is not found, print something like:
3627
3193
        # unalias: foo: not found
3628
 
        c = _mod_config.GlobalConfig()
 
3194
        c = config.GlobalConfig()
3629
3195
        c.unset_alias(alias_name)
3630
3196
 
3631
3197
    @display_command
3632
3198
    def print_aliases(self):
3633
3199
        """Print out the defined aliases in a similar format to bash."""
3634
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3200
        aliases = config.GlobalConfig().get_aliases()
3635
3201
        for key, value in sorted(aliases.iteritems()):
3636
3202
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3637
3203
 
3647
3213
 
3648
3214
    def set_alias(self, alias_name, alias_command):
3649
3215
        """Save the alias in the global config."""
3650
 
        c = _mod_config.GlobalConfig()
 
3216
        c = config.GlobalConfig()
3651
3217
        c.set_alias(alias_name, alias_command)
3652
3218
 
3653
3219
 
3654
3220
class cmd_selftest(Command):
3655
 
    __doc__ = """Run internal test suite.
 
3221
    """Run internal test suite.
3656
3222
 
3657
3223
    If arguments are given, they are regular expressions that say which tests
3658
3224
    should run.  Tests matching any expression are run, and other tests are
3685
3251
    Tests that need working space on disk use a common temporary directory,
3686
3252
    typically inside $TMPDIR or /tmp.
3687
3253
 
3688
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3689
 
    into a pdb postmortem session.
3690
 
 
3691
 
    The --coverage=DIRNAME global option produces a report with covered code
3692
 
    indicated.
3693
 
 
3694
3254
    :Examples:
3695
3255
        Run only tests relating to 'ignore'::
3696
3256
 
3705
3265
    def get_transport_type(typestring):
3706
3266
        """Parse and return a transport specifier."""
3707
3267
        if typestring == "sftp":
3708
 
            from bzrlib.tests import stub_sftp
3709
 
            return stub_sftp.SFTPAbsoluteServer
3710
 
        elif typestring == "memory":
3711
 
            from bzrlib.tests import test_server
3712
 
            return memory.MemoryServer
3713
 
        elif typestring == "fakenfs":
3714
 
            from bzrlib.tests import test_server
3715
 
            return test_server.FakeNFSServer
 
3268
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3269
            return SFTPAbsoluteServer
 
3270
        if typestring == "memory":
 
3271
            from bzrlib.transport.memory import MemoryServer
 
3272
            return MemoryServer
 
3273
        if typestring == "fakenfs":
 
3274
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3275
            return FakeNFSServer
3716
3276
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3717
3277
            (typestring)
3718
3278
        raise errors.BzrCommandError(msg)
3729
3289
                                 'throughout the test suite.',
3730
3290
                            type=get_transport_type),
3731
3291
                     Option('benchmark',
3732
 
                            help='Run the benchmarks rather than selftests.',
3733
 
                            hidden=True),
 
3292
                            help='Run the benchmarks rather than selftests.'),
3734
3293
                     Option('lsprof-timed',
3735
3294
                            help='Generate lsprof output for benchmarked'
3736
3295
                                 ' sections of code.'),
3737
 
                     Option('lsprof-tests',
3738
 
                            help='Generate lsprof output for each test.'),
 
3296
                     Option('cache-dir', type=str,
 
3297
                            help='Cache intermediate benchmark output in this '
 
3298
                                 'directory.'),
3739
3299
                     Option('first',
3740
3300
                            help='Run all tests, but run specified tests first.',
3741
3301
                            short_name='f',
3750
3310
                     Option('randomize', type=str, argname="SEED",
3751
3311
                            help='Randomize the order of tests using the given'
3752
3312
                                 ' seed or "now" for the current time.'),
3753
 
                     ListOption('exclude', type=str, argname="PATTERN",
3754
 
                                short_name='x',
3755
 
                                help='Exclude tests that match this regular'
3756
 
                                ' expression.'),
 
3313
                     Option('exclude', type=str, argname="PATTERN",
 
3314
                            short_name='x',
 
3315
                            help='Exclude tests that match this regular'
 
3316
                                 ' expression.'),
3757
3317
                     Option('subunit',
3758
3318
                        help='Output test progress via subunit.'),
3759
3319
                     Option('strict', help='Fail on missing dependencies or '
3775
3335
 
3776
3336
    def run(self, testspecs_list=None, verbose=False, one=False,
3777
3337
            transport=None, benchmark=None,
3778
 
            lsprof_timed=None,
 
3338
            lsprof_timed=None, cache_dir=None,
3779
3339
            first=False, list_only=False,
3780
3340
            randomize=None, exclude=None, strict=False,
3781
3341
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3782
 
            parallel=None, lsprof_tests=False):
3783
 
        from bzrlib import tests
3784
 
 
 
3342
            parallel=None):
 
3343
        from bzrlib.tests import selftest
 
3344
        import bzrlib.benchmarks as benchmarks
 
3345
        from bzrlib.benchmarks import tree_creator
 
3346
 
 
3347
        # Make deprecation warnings visible, unless -Werror is set
 
3348
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3349
 
 
3350
        if cache_dir is not None:
 
3351
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3785
3352
        if testspecs_list is not None:
3786
3353
            pattern = '|'.join(testspecs_list)
3787
3354
        else:
3793
3360
                raise errors.BzrCommandError("subunit not available. subunit "
3794
3361
                    "needs to be installed to use --subunit.")
3795
3362
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3796
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3797
 
            # stdout, which would corrupt the subunit stream. 
3798
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3799
 
            # following code can be deleted when it's sufficiently deployed
3800
 
            # -- vila/mgz 20100514
3801
 
            if (sys.platform == "win32"
3802
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3803
 
                import msvcrt
3804
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3805
3363
        if parallel:
3806
3364
            self.additional_selftest_args.setdefault(
3807
3365
                'suite_decorators', []).append(parallel)
3808
3366
        if benchmark:
3809
 
            raise errors.BzrCommandError(
3810
 
                "--benchmark is no longer supported from bzr 2.2; "
3811
 
                "use bzr-usertest instead")
3812
 
        test_suite_factory = None
3813
 
        if not exclude:
3814
 
            exclude_pattern = None
 
3367
            test_suite_factory = benchmarks.test_suite
 
3368
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3369
            verbose = not is_quiet()
 
3370
            # TODO: should possibly lock the history file...
 
3371
            benchfile = open(".perf_history", "at", buffering=1)
3815
3372
        else:
3816
 
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3817
 
        selftest_kwargs = {"verbose": verbose,
3818
 
                          "pattern": pattern,
3819
 
                          "stop_on_failure": one,
3820
 
                          "transport": transport,
3821
 
                          "test_suite_factory": test_suite_factory,
3822
 
                          "lsprof_timed": lsprof_timed,
3823
 
                          "lsprof_tests": lsprof_tests,
3824
 
                          "matching_tests_first": first,
3825
 
                          "list_only": list_only,
3826
 
                          "random_seed": randomize,
3827
 
                          "exclude_pattern": exclude_pattern,
3828
 
                          "strict": strict,
3829
 
                          "load_list": load_list,
3830
 
                          "debug_flags": debugflag,
3831
 
                          "starting_with": starting_with
3832
 
                          }
3833
 
        selftest_kwargs.update(self.additional_selftest_args)
3834
 
 
3835
 
        # Make deprecation warnings visible, unless -Werror is set
3836
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3837
 
            override=False)
 
3373
            test_suite_factory = None
 
3374
            benchfile = None
3838
3375
        try:
3839
 
            result = tests.selftest(**selftest_kwargs)
 
3376
            selftest_kwargs = {"verbose": verbose,
 
3377
                              "pattern": pattern,
 
3378
                              "stop_on_failure": one,
 
3379
                              "transport": transport,
 
3380
                              "test_suite_factory": test_suite_factory,
 
3381
                              "lsprof_timed": lsprof_timed,
 
3382
                              "bench_history": benchfile,
 
3383
                              "matching_tests_first": first,
 
3384
                              "list_only": list_only,
 
3385
                              "random_seed": randomize,
 
3386
                              "exclude_pattern": exclude,
 
3387
                              "strict": strict,
 
3388
                              "load_list": load_list,
 
3389
                              "debug_flags": debugflag,
 
3390
                              "starting_with": starting_with
 
3391
                              }
 
3392
            selftest_kwargs.update(self.additional_selftest_args)
 
3393
            result = selftest(**selftest_kwargs)
3840
3394
        finally:
3841
 
            cleanup()
 
3395
            if benchfile is not None:
 
3396
                benchfile.close()
3842
3397
        return int(not result)
3843
3398
 
3844
3399
 
3845
3400
class cmd_version(Command):
3846
 
    __doc__ = """Show version of bzr."""
 
3401
    """Show version of bzr."""
3847
3402
 
3848
3403
    encoding_type = 'replace'
3849
3404
    takes_options = [
3860
3415
 
3861
3416
 
3862
3417
class cmd_rocks(Command):
3863
 
    __doc__ = """Statement of optimism."""
 
3418
    """Statement of optimism."""
3864
3419
 
3865
3420
    hidden = True
3866
3421
 
3867
3422
    @display_command
3868
3423
    def run(self):
3869
 
        self.outf.write("It sure does!\n")
 
3424
        print "It sure does!"
3870
3425
 
3871
3426
 
3872
3427
class cmd_find_merge_base(Command):
3873
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3428
    """Find and print a base revision for merging two branches."""
3874
3429
    # TODO: Options to specify revisions on either side, as if
3875
3430
    #       merging only part of the history.
3876
3431
    takes_args = ['branch', 'other']
3882
3437
 
3883
3438
        branch1 = Branch.open_containing(branch)[0]
3884
3439
        branch2 = Branch.open_containing(other)[0]
3885
 
        self.add_cleanup(branch1.lock_read().unlock)
3886
 
        self.add_cleanup(branch2.lock_read().unlock)
3887
 
        last1 = ensure_null(branch1.last_revision())
3888
 
        last2 = ensure_null(branch2.last_revision())
3889
 
 
3890
 
        graph = branch1.repository.get_graph(branch2.repository)
3891
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3892
 
 
3893
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3440
        branch1.lock_read()
 
3441
        try:
 
3442
            branch2.lock_read()
 
3443
            try:
 
3444
                last1 = ensure_null(branch1.last_revision())
 
3445
                last2 = ensure_null(branch2.last_revision())
 
3446
 
 
3447
                graph = branch1.repository.get_graph(branch2.repository)
 
3448
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3449
 
 
3450
                print 'merge base is revision %s' % base_rev_id
 
3451
            finally:
 
3452
                branch2.unlock()
 
3453
        finally:
 
3454
            branch1.unlock()
3894
3455
 
3895
3456
 
3896
3457
class cmd_merge(Command):
3897
 
    __doc__ = """Perform a three-way merge.
 
3458
    """Perform a three-way merge.
3898
3459
 
3899
3460
    The source of the merge can be specified either in the form of a branch,
3900
3461
    or in the form of a path to a file containing a merge directive generated
3901
3462
    with bzr send. If neither is specified, the default is the upstream branch
3902
 
    or the branch most recently merged using --remember.  The source of the
3903
 
    merge may also be specified in the form of a path to a file in another
3904
 
    branch:  in this case, only the modifications to that file are merged into
3905
 
    the current working tree.
3906
 
 
3907
 
    When merging from a branch, by default bzr will try to merge in all new
3908
 
    work from the other branch, automatically determining an appropriate base
3909
 
    revision.  If this fails, you may need to give an explicit base.
3910
 
 
3911
 
    To pick a different ending revision, pass "--revision OTHER".  bzr will
3912
 
    try to merge in all new work up to and including revision OTHER.
3913
 
 
3914
 
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
3915
 
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
3916
 
    causes some revisions to be skipped, i.e. if the destination branch does
3917
 
    not already contain revision BASE, such a merge is commonly referred to as
3918
 
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3919
 
    cherrypicks. The changes look like a normal commit, and the history of the
3920
 
    changes from the other branch is not stored in the commit.
3921
 
 
3922
 
    Revision numbers are always relative to the source branch.
 
3463
    or the branch most recently merged using --remember.
 
3464
 
 
3465
    When merging a branch, by default the tip will be merged. To pick a different
 
3466
    revision, pass --revision. If you specify two values, the first will be used as
 
3467
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3468
    available revisions, like this is commonly referred to as "cherrypicking".
 
3469
 
 
3470
    Revision numbers are always relative to the branch being merged.
 
3471
 
 
3472
    By default, bzr will try to merge in all new work from the other
 
3473
    branch, automatically determining an appropriate base.  If this
 
3474
    fails, you may need to give an explicit base.
3923
3475
 
3924
3476
    Merge will do its best to combine the changes in two branches, but there
3925
3477
    are some kinds of problems only a human can fix.  When it encounters those,
3928
3480
 
3929
3481
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3930
3482
 
3931
 
    If there is no default branch set, the first merge will set it (use
3932
 
    --no-remember to avoid settting it). After that, you can omit the branch
3933
 
    to use the default.  To change the default, use --remember. The value will
3934
 
    only be saved if the remote location can be accessed.
 
3483
    If there is no default branch set, the first merge will set it. After
 
3484
    that, you can omit the branch to use the default.  To change the
 
3485
    default, use --remember. The value will only be saved if the remote
 
3486
    location can be accessed.
3935
3487
 
3936
3488
    The results of the merge are placed into the destination working
3937
3489
    directory, where they can be reviewed (with bzr diff), tested, and then
3938
3490
    committed to record the result of the merge.
3939
3491
 
3940
3492
    merge refuses to run if there are any uncommitted changes, unless
3941
 
    --force is given.  If --force is given, then the changes from the source 
3942
 
    will be merged with the current working tree, including any uncommitted
3943
 
    changes in the tree.  The --force option can also be used to create a
3944
 
    merge revision which has more than two parents.
3945
 
 
3946
 
    If one would like to merge changes from the working tree of the other
3947
 
    branch without merging any committed revisions, the --uncommitted option
3948
 
    can be given.
3949
 
 
3950
 
    To select only some changes to merge, use "merge -i", which will prompt
3951
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3493
    --force is given.
3952
3494
 
3953
3495
    :Examples:
3954
 
        To merge all new revisions from bzr.dev::
 
3496
        To merge the latest revision from bzr.dev::
3955
3497
 
3956
3498
            bzr merge ../bzr.dev
3957
3499
 
3963
3505
 
3964
3506
            bzr merge -r 81..82 ../bzr.dev
3965
3507
 
3966
 
        To apply a merge directive contained in /tmp/merge::
 
3508
        To apply a merge directive contained in /tmp/merge:
3967
3509
 
3968
3510
            bzr merge /tmp/merge
3969
 
 
3970
 
        To create a merge revision with three parents from two branches
3971
 
        feature1a and feature1b:
3972
 
 
3973
 
            bzr merge ../feature1a
3974
 
            bzr merge ../feature1b --force
3975
 
            bzr commit -m 'revision with three parents'
3976
3511
    """
3977
3512
 
3978
3513
    encoding_type = 'exact'
3994
3529
                ' completely merged into the source, pull from the'
3995
3530
                ' source rather than merging.  When this happens,'
3996
3531
                ' you do not need to commit the result.'),
3997
 
        custom_help('directory',
 
3532
        Option('directory',
3998
3533
               help='Branch to merge into, '
3999
 
                    'rather than the one containing the working directory.'),
4000
 
        Option('preview', help='Instead of merging, show a diff of the'
4001
 
               ' merge.'),
4002
 
        Option('interactive', help='Select changes interactively.',
4003
 
            short_name='i')
 
3534
                    'rather than the one containing the working directory.',
 
3535
               short_name='d',
 
3536
               type=unicode,
 
3537
               ),
 
3538
        Option('preview', help='Instead of merging, show a diff of the merge.')
4004
3539
    ]
4005
3540
 
4006
3541
    def run(self, location=None, revision=None, force=False,
4007
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
3542
            merge_type=None, show_base=False, reprocess=None, remember=False,
4008
3543
            uncommitted=False, pull=False,
4009
3544
            directory=None,
4010
3545
            preview=False,
4011
 
            interactive=False,
4012
3546
            ):
4013
3547
        if merge_type is None:
4014
3548
            merge_type = _mod_merge.Merge3Merger
4018
3552
        merger = None
4019
3553
        allow_pending = True
4020
3554
        verified = 'inapplicable'
4021
 
 
4022
3555
        tree = WorkingTree.open_containing(directory)[0]
4023
 
        if tree.branch.revno() == 0:
4024
 
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
4025
 
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
4026
3556
 
 
3557
        # die as quickly as possible if there are uncommitted changes
4027
3558
        try:
4028
3559
            basis_tree = tree.revision_tree(tree.last_revision())
4029
3560
        except errors.NoSuchRevision:
4030
3561
            basis_tree = tree.basis_tree()
4031
 
 
4032
 
        # die as quickly as possible if there are uncommitted changes
4033
3562
        if not force:
4034
 
            if tree.has_changes():
 
3563
            changes = tree.changes_from(basis_tree)
 
3564
            if changes.has_changed():
4035
3565
                raise errors.UncommittedChanges(tree)
4036
3566
 
4037
3567
        view_info = _get_view_info_for_change_reporter(tree)
4038
3568
        change_reporter = delta._ChangeReporter(
4039
3569
            unversioned_filter=tree.is_ignored, view_info=view_info)
4040
 
        pb = ui.ui_factory.nested_progress_bar()
4041
 
        self.add_cleanup(pb.finished)
4042
 
        self.add_cleanup(tree.lock_write().unlock)
4043
 
        if location is not None:
4044
 
            try:
4045
 
                mergeable = bundle.read_mergeable_from_url(location,
4046
 
                    possible_transports=possible_transports)
4047
 
            except errors.NotABundle:
4048
 
                mergeable = None
 
3570
        cleanups = []
 
3571
        try:
 
3572
            pb = ui.ui_factory.nested_progress_bar()
 
3573
            cleanups.append(pb.finished)
 
3574
            tree.lock_write()
 
3575
            cleanups.append(tree.unlock)
 
3576
            if location is not None:
 
3577
                try:
 
3578
                    mergeable = bundle.read_mergeable_from_url(location,
 
3579
                        possible_transports=possible_transports)
 
3580
                except errors.NotABundle:
 
3581
                    mergeable = None
 
3582
                else:
 
3583
                    if uncommitted:
 
3584
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3585
                            ' with bundles or merge directives.')
 
3586
 
 
3587
                    if revision is not None:
 
3588
                        raise errors.BzrCommandError(
 
3589
                            'Cannot use -r with merge directives or bundles')
 
3590
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3591
                       mergeable, pb)
 
3592
 
 
3593
            if merger is None and uncommitted:
 
3594
                if revision is not None and len(revision) > 0:
 
3595
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3596
                        ' --revision at the same time.')
 
3597
                location = self._select_branch_location(tree, location)[0]
 
3598
                other_tree, other_path = WorkingTree.open_containing(location)
 
3599
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3600
                    pb)
 
3601
                allow_pending = False
 
3602
                if other_path != '':
 
3603
                    merger.interesting_files = [other_path]
 
3604
 
 
3605
            if merger is None:
 
3606
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3607
                    location, revision, remember, possible_transports, pb)
 
3608
 
 
3609
            merger.merge_type = merge_type
 
3610
            merger.reprocess = reprocess
 
3611
            merger.show_base = show_base
 
3612
            self.sanity_check_merger(merger)
 
3613
            if (merger.base_rev_id == merger.other_rev_id and
 
3614
                merger.other_rev_id is not None):
 
3615
                note('Nothing to do.')
 
3616
                return 0
 
3617
            if pull:
 
3618
                if merger.interesting_files is not None:
 
3619
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3620
                if (merger.base_rev_id == tree.last_revision()):
 
3621
                    result = tree.pull(merger.other_branch, False,
 
3622
                                       merger.other_rev_id)
 
3623
                    result.report(self.outf)
 
3624
                    return 0
 
3625
            merger.check_basis(False)
 
3626
            if preview:
 
3627
                return self._do_preview(merger)
4049
3628
            else:
4050
 
                if uncommitted:
4051
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
4052
 
                        ' with bundles or merge directives.')
4053
 
 
4054
 
                if revision is not None:
4055
 
                    raise errors.BzrCommandError(
4056
 
                        'Cannot use -r with merge directives or bundles')
4057
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
4058
 
                   mergeable, None)
4059
 
 
4060
 
        if merger is None and uncommitted:
4061
 
            if revision is not None and len(revision) > 0:
4062
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
4063
 
                    ' --revision at the same time.')
4064
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
4065
 
            allow_pending = False
4066
 
 
4067
 
        if merger is None:
4068
 
            merger, allow_pending = self._get_merger_from_branch(tree,
4069
 
                location, revision, remember, possible_transports, None)
4070
 
 
4071
 
        merger.merge_type = merge_type
4072
 
        merger.reprocess = reprocess
4073
 
        merger.show_base = show_base
4074
 
        self.sanity_check_merger(merger)
4075
 
        if (merger.base_rev_id == merger.other_rev_id and
4076
 
            merger.other_rev_id is not None):
4077
 
            # check if location is a nonexistent file (and not a branch) to
4078
 
            # disambiguate the 'Nothing to do'
4079
 
            if merger.interesting_files:
4080
 
                if not merger.other_tree.has_filename(
4081
 
                    merger.interesting_files[0]):
4082
 
                    note("merger: " + str(merger))
4083
 
                    raise errors.PathsDoNotExist([location])
4084
 
            note('Nothing to do.')
4085
 
            return 0
4086
 
        if pull and not preview:
4087
 
            if merger.interesting_files is not None:
4088
 
                raise errors.BzrCommandError('Cannot pull individual files')
4089
 
            if (merger.base_rev_id == tree.last_revision()):
4090
 
                result = tree.pull(merger.other_branch, False,
4091
 
                                   merger.other_rev_id)
4092
 
                result.report(self.outf)
4093
 
                return 0
4094
 
        if merger.this_basis is None:
4095
 
            raise errors.BzrCommandError(
4096
 
                "This branch has no commits."
4097
 
                " (perhaps you would prefer 'bzr pull')")
4098
 
        if preview:
4099
 
            return self._do_preview(merger)
4100
 
        elif interactive:
4101
 
            return self._do_interactive(merger)
4102
 
        else:
4103
 
            return self._do_merge(merger, change_reporter, allow_pending,
4104
 
                                  verified)
4105
 
 
4106
 
    def _get_preview(self, merger):
 
3629
                return self._do_merge(merger, change_reporter, allow_pending,
 
3630
                                      verified)
 
3631
        finally:
 
3632
            for cleanup in reversed(cleanups):
 
3633
                cleanup()
 
3634
 
 
3635
    def _do_preview(self, merger):
 
3636
        from bzrlib.diff import show_diff_trees
4107
3637
        tree_merger = merger.make_merger()
4108
3638
        tt = tree_merger.make_preview_transform()
4109
 
        self.add_cleanup(tt.finalize)
4110
 
        result_tree = tt.get_preview_tree()
4111
 
        return result_tree
4112
 
 
4113
 
    def _do_preview(self, merger):
4114
 
        from bzrlib.diff import show_diff_trees
4115
 
        result_tree = self._get_preview(merger)
4116
 
        path_encoding = osutils.get_diff_header_encoding()
4117
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
4118
 
                        old_label='', new_label='',
4119
 
                        path_encoding=path_encoding)
 
3639
        try:
 
3640
            result_tree = tt.get_preview_tree()
 
3641
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3642
                            old_label='', new_label='')
 
3643
        finally:
 
3644
            tt.finalize()
4120
3645
 
4121
3646
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4122
3647
        merger.change_reporter = change_reporter
4130
3655
        else:
4131
3656
            return 0
4132
3657
 
4133
 
    def _do_interactive(self, merger):
4134
 
        """Perform an interactive merge.
4135
 
 
4136
 
        This works by generating a preview tree of the merge, then using
4137
 
        Shelver to selectively remove the differences between the working tree
4138
 
        and the preview tree.
4139
 
        """
4140
 
        from bzrlib import shelf_ui
4141
 
        result_tree = self._get_preview(merger)
4142
 
        writer = bzrlib.option.diff_writer_registry.get()
4143
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4144
 
                                   reporter=shelf_ui.ApplyReporter(),
4145
 
                                   diff_writer=writer(sys.stdout))
4146
 
        try:
4147
 
            shelver.run()
4148
 
        finally:
4149
 
            shelver.finalize()
4150
 
 
4151
3658
    def sanity_check_merger(self, merger):
4152
3659
        if (merger.show_base and
4153
3660
            not merger.merge_type is _mod_merge.Merge3Merger):
4188
3695
            base_branch, base_path = Branch.open_containing(base_loc,
4189
3696
                possible_transports)
4190
3697
        # Find the revision ids
4191
 
        other_revision_id = None
4192
 
        base_revision_id = None
4193
 
        if revision is not None:
4194
 
            if len(revision) >= 1:
4195
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
4196
 
            if len(revision) == 2:
4197
 
                base_revision_id = revision[0].as_revision_id(base_branch)
4198
 
        if other_revision_id is None:
 
3698
        if revision is None or len(revision) < 1 or revision[-1] is None:
4199
3699
            other_revision_id = _mod_revision.ensure_null(
4200
3700
                other_branch.last_revision())
4201
 
        # Remember where we merge from. We need to remember if:
4202
 
        # - user specify a location (and we don't merge from the parent
4203
 
        #   branch)
4204
 
        # - user ask to remember or there is no previous location set to merge
4205
 
        #   from and user didn't ask to *not* remember
4206
 
        if (user_location is not None
4207
 
            and ((remember
4208
 
                  or (remember is None
4209
 
                      and tree.branch.get_submit_branch() is None)))):
 
3701
        else:
 
3702
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3703
        if (revision is not None and len(revision) == 2
 
3704
            and revision[0] is not None):
 
3705
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3706
        else:
 
3707
            base_revision_id = None
 
3708
        # Remember where we merge from
 
3709
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3710
             user_location is not None):
4210
3711
            tree.branch.set_submit_branch(other_branch.base)
4211
 
        # Merge tags (but don't set them in the master branch yet, the user
4212
 
        # might revert this merge).  Commit will propagate them.
4213
 
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
3712
        _merge_tags_if_possible(other_branch, tree.branch)
4214
3713
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4215
3714
            other_revision_id, base_revision_id, other_branch, base_branch)
4216
3715
        if other_path != '':
4220
3719
            allow_pending = True
4221
3720
        return merger, allow_pending
4222
3721
 
4223
 
    def get_merger_from_uncommitted(self, tree, location, pb):
4224
 
        """Get a merger for uncommitted changes.
4225
 
 
4226
 
        :param tree: The tree the merger should apply to.
4227
 
        :param location: The location containing uncommitted changes.
4228
 
        :param pb: The progress bar to use for showing progress.
4229
 
        """
4230
 
        location = self._select_branch_location(tree, location)[0]
4231
 
        other_tree, other_path = WorkingTree.open_containing(location)
4232
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4233
 
        if other_path != '':
4234
 
            merger.interesting_files = [other_path]
4235
 
        return merger
4236
 
 
4237
3722
    def _select_branch_location(self, tree, user_location, revision=None,
4238
3723
                                index=None):
4239
3724
        """Select a branch location, according to possible inputs.
4283
3768
 
4284
3769
 
4285
3770
class cmd_remerge(Command):
4286
 
    __doc__ = """Redo a merge.
 
3771
    """Redo a merge.
4287
3772
 
4288
3773
    Use this if you want to try a different merge technique while resolving
4289
3774
    conflicts.  Some merge techniques are better than others, and remerge
4314
3799
 
4315
3800
    def run(self, file_list=None, merge_type=None, show_base=False,
4316
3801
            reprocess=False):
4317
 
        from bzrlib.conflicts import restore
4318
3802
        if merge_type is None:
4319
3803
            merge_type = _mod_merge.Merge3Merger
4320
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4321
 
        self.add_cleanup(tree.lock_write().unlock)
4322
 
        parents = tree.get_parent_ids()
4323
 
        if len(parents) != 2:
4324
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4325
 
                                         " merges.  Not cherrypicking or"
4326
 
                                         " multi-merges.")
4327
 
        repository = tree.branch.repository
4328
 
        interesting_ids = None
4329
 
        new_conflicts = []
4330
 
        conflicts = tree.conflicts()
4331
 
        if file_list is not None:
4332
 
            interesting_ids = set()
4333
 
            for filename in file_list:
4334
 
                file_id = tree.path2id(filename)
4335
 
                if file_id is None:
4336
 
                    raise errors.NotVersionedError(filename)
4337
 
                interesting_ids.add(file_id)
4338
 
                if tree.kind(file_id) != "directory":
4339
 
                    continue
 
3804
        tree, file_list = tree_files(file_list)
 
3805
        tree.lock_write()
 
3806
        try:
 
3807
            parents = tree.get_parent_ids()
 
3808
            if len(parents) != 2:
 
3809
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3810
                                             " merges.  Not cherrypicking or"
 
3811
                                             " multi-merges.")
 
3812
            repository = tree.branch.repository
 
3813
            interesting_ids = None
 
3814
            new_conflicts = []
 
3815
            conflicts = tree.conflicts()
 
3816
            if file_list is not None:
 
3817
                interesting_ids = set()
 
3818
                for filename in file_list:
 
3819
                    file_id = tree.path2id(filename)
 
3820
                    if file_id is None:
 
3821
                        raise errors.NotVersionedError(filename)
 
3822
                    interesting_ids.add(file_id)
 
3823
                    if tree.kind(file_id) != "directory":
 
3824
                        continue
4340
3825
 
4341
 
                for name, ie in tree.inventory.iter_entries(file_id):
4342
 
                    interesting_ids.add(ie.file_id)
4343
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4344
 
        else:
4345
 
            # Remerge only supports resolving contents conflicts
4346
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4347
 
            restore_files = [c.path for c in conflicts
4348
 
                             if c.typestring in allowed_conflicts]
4349
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4350
 
        tree.set_conflicts(ConflictList(new_conflicts))
4351
 
        if file_list is not None:
4352
 
            restore_files = file_list
4353
 
        for filename in restore_files:
 
3826
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3827
                        interesting_ids.add(ie.file_id)
 
3828
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3829
            else:
 
3830
                # Remerge only supports resolving contents conflicts
 
3831
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3832
                restore_files = [c.path for c in conflicts
 
3833
                                 if c.typestring in allowed_conflicts]
 
3834
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3835
            tree.set_conflicts(ConflictList(new_conflicts))
 
3836
            if file_list is not None:
 
3837
                restore_files = file_list
 
3838
            for filename in restore_files:
 
3839
                try:
 
3840
                    restore(tree.abspath(filename))
 
3841
                except errors.NotConflicted:
 
3842
                    pass
 
3843
            # Disable pending merges, because the file texts we are remerging
 
3844
            # have not had those merges performed.  If we use the wrong parents
 
3845
            # list, we imply that the working tree text has seen and rejected
 
3846
            # all the changes from the other tree, when in fact those changes
 
3847
            # have not yet been seen.
 
3848
            pb = ui.ui_factory.nested_progress_bar()
 
3849
            tree.set_parent_ids(parents[:1])
4354
3850
            try:
4355
 
                restore(tree.abspath(filename))
4356
 
            except errors.NotConflicted:
4357
 
                pass
4358
 
        # Disable pending merges, because the file texts we are remerging
4359
 
        # have not had those merges performed.  If we use the wrong parents
4360
 
        # list, we imply that the working tree text has seen and rejected
4361
 
        # all the changes from the other tree, when in fact those changes
4362
 
        # have not yet been seen.
4363
 
        tree.set_parent_ids(parents[:1])
4364
 
        try:
4365
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4366
 
            merger.interesting_ids = interesting_ids
4367
 
            merger.merge_type = merge_type
4368
 
            merger.show_base = show_base
4369
 
            merger.reprocess = reprocess
4370
 
            conflicts = merger.do_merge()
 
3851
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3852
                                                             tree, parents[1])
 
3853
                merger.interesting_ids = interesting_ids
 
3854
                merger.merge_type = merge_type
 
3855
                merger.show_base = show_base
 
3856
                merger.reprocess = reprocess
 
3857
                conflicts = merger.do_merge()
 
3858
            finally:
 
3859
                tree.set_parent_ids(parents)
 
3860
                pb.finished()
4371
3861
        finally:
4372
 
            tree.set_parent_ids(parents)
 
3862
            tree.unlock()
4373
3863
        if conflicts > 0:
4374
3864
            return 1
4375
3865
        else:
4377
3867
 
4378
3868
 
4379
3869
class cmd_revert(Command):
4380
 
    __doc__ = """Revert files to a previous revision.
 
3870
    """Revert files to a previous revision.
4381
3871
 
4382
3872
    Giving a list of files will revert only those files.  Otherwise, all files
4383
3873
    will be reverted.  If the revision is not specified with '--revision', the
4384
3874
    last committed revision is used.
4385
3875
 
4386
3876
    To remove only some changes, without reverting to a prior version, use
4387
 
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
4388
 
    will remove the changes introduced by the second last commit (-2), without
4389
 
    affecting the changes introduced by the last commit (-1).  To remove
4390
 
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
3877
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3878
    changes introduced by -2, without affecting the changes introduced by -1.
 
3879
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4391
3880
 
4392
3881
    By default, any files that have been manually changed will be backed up
4393
3882
    first.  (Files changed only by merge are not backed up.)  Backup files have
4398
3887
    name.  If you name a directory, all the contents of that directory will be
4399
3888
    reverted.
4400
3889
 
4401
 
    If you have newly added files since the target revision, they will be
4402
 
    removed.  If the files to be removed have been changed, backups will be
4403
 
    created as above.  Directories containing unknown files will not be
4404
 
    deleted.
 
3890
    Any files that have been newly added since that revision will be deleted,
 
3891
    with a backup kept if appropriate.  Directories containing unknown files
 
3892
    will not be deleted.
4405
3893
 
4406
 
    The working tree contains a list of revisions that have been merged but
4407
 
    not yet committed. These revisions will be included as additional parents
4408
 
    of the next commit.  Normally, using revert clears that list as well as
4409
 
    reverting the files.  If any files are specified, revert leaves the list
4410
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4411
 
    .`` in the tree root to revert all files but keep the recorded merges,
4412
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3894
    The working tree contains a list of pending merged revisions, which will
 
3895
    be included as parents in the next commit.  Normally, revert clears that
 
3896
    list as well as reverting the files.  If any files are specified, revert
 
3897
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3898
    revert ." in the tree root to revert all files but keep the merge record,
 
3899
    and "bzr revert --forget-merges" to clear the pending merge list without
4413
3900
    reverting any files.
4414
 
 
4415
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4416
 
    changes from a branch in a single revision.  To do this, perform the merge
4417
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4418
 
    the content of the tree as it was, but it will clear the list of pending
4419
 
    merges.  The next commit will then contain all of the changes that are
4420
 
    present in the other branch, but without any other parent revisions.
4421
 
    Because this technique forgets where these changes originated, it may
4422
 
    cause additional conflicts on later merges involving the same source and
4423
 
    target branches.
4424
3901
    """
4425
3902
 
4426
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
3903
    _see_also = ['cat', 'export']
4427
3904
    takes_options = [
4428
3905
        'revision',
4429
3906
        Option('no-backup', "Do not save backups of reverted files."),
4434
3911
 
4435
3912
    def run(self, revision=None, no_backup=False, file_list=None,
4436
3913
            forget_merges=None):
4437
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4438
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4439
 
        if forget_merges:
4440
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4441
 
        else:
4442
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3914
        tree, file_list = tree_files(file_list)
 
3915
        tree.lock_write()
 
3916
        try:
 
3917
            if forget_merges:
 
3918
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3919
            else:
 
3920
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3921
        finally:
 
3922
            tree.unlock()
4443
3923
 
4444
3924
    @staticmethod
4445
3925
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4446
3926
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4447
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4448
 
            report_changes=True)
 
3927
        pb = ui.ui_factory.nested_progress_bar()
 
3928
        try:
 
3929
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3930
                report_changes=True)
 
3931
        finally:
 
3932
            pb.finished()
4449
3933
 
4450
3934
 
4451
3935
class cmd_assert_fail(Command):
4452
 
    __doc__ = """Test reporting of assertion failures"""
 
3936
    """Test reporting of assertion failures"""
4453
3937
    # intended just for use in testing
4454
3938
 
4455
3939
    hidden = True
4459
3943
 
4460
3944
 
4461
3945
class cmd_help(Command):
4462
 
    __doc__ = """Show help on a command or other topic.
 
3946
    """Show help on a command or other topic.
4463
3947
    """
4464
3948
 
4465
3949
    _see_also = ['topics']
4478
3962
 
4479
3963
 
4480
3964
class cmd_shell_complete(Command):
4481
 
    __doc__ = """Show appropriate completions for context.
 
3965
    """Show appropriate completions for context.
4482
3966
 
4483
3967
    For a list of all available commands, say 'bzr shell-complete'.
4484
3968
    """
4493
3977
 
4494
3978
 
4495
3979
class cmd_missing(Command):
4496
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3980
    """Show unmerged/unpulled revisions between two branches.
4497
3981
 
4498
3982
    OTHER_BRANCH may be local or remote.
4499
3983
 
4500
3984
    To filter on a range of revisions, you can use the command -r begin..end
4501
3985
    -r revision requests a specific revision, -r ..end or -r begin.. are
4502
3986
    also valid.
4503
 
            
4504
 
    :Exit values:
4505
 
        1 - some missing revisions
4506
 
        0 - no missing revisions
4507
3987
 
4508
3988
    :Examples:
4509
3989
 
4530
4010
    _see_also = ['merge', 'pull']
4531
4011
    takes_args = ['other_branch?']
4532
4012
    takes_options = [
4533
 
        'directory',
4534
4013
        Option('reverse', 'Reverse the order of revisions.'),
4535
4014
        Option('mine-only',
4536
4015
               'Display changes in the local branch only.'),
4558
4037
            theirs_only=False,
4559
4038
            log_format=None, long=False, short=False, line=False,
4560
4039
            show_ids=False, verbose=False, this=False, other=False,
4561
 
            include_merges=False, revision=None, my_revision=None,
4562
 
            directory=u'.'):
 
4040
            include_merges=False, revision=None, my_revision=None):
4563
4041
        from bzrlib.missing import find_unmerged, iter_log_revisions
4564
4042
        def message(s):
4565
4043
            if not is_quiet():
4578
4056
        elif theirs_only:
4579
4057
            restrict = 'remote'
4580
4058
 
4581
 
        local_branch = Branch.open_containing(directory)[0]
4582
 
        self.add_cleanup(local_branch.lock_read().unlock)
4583
 
 
 
4059
        local_branch = Branch.open_containing(u".")[0]
4584
4060
        parent = local_branch.get_parent()
4585
4061
        if other_branch is None:
4586
4062
            other_branch = parent
4595
4071
        remote_branch = Branch.open(other_branch)
4596
4072
        if remote_branch.base == local_branch.base:
4597
4073
            remote_branch = local_branch
4598
 
        else:
4599
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4600
4074
 
4601
4075
        local_revid_range = _revision_range_to_revid_range(
4602
4076
            _get_revision_range(my_revision, local_branch,
4606
4080
            _get_revision_range(revision,
4607
4081
                remote_branch, self.name()))
4608
4082
 
4609
 
        local_extra, remote_extra = find_unmerged(
4610
 
            local_branch, remote_branch, restrict,
4611
 
            backward=not reverse,
4612
 
            include_merges=include_merges,
4613
 
            local_revid_range=local_revid_range,
4614
 
            remote_revid_range=remote_revid_range)
4615
 
 
4616
 
        if log_format is None:
4617
 
            registry = log.log_formatter_registry
4618
 
            log_format = registry.get_default(local_branch)
4619
 
        lf = log_format(to_file=self.outf,
4620
 
                        show_ids=show_ids,
4621
 
                        show_timezone='original')
4622
 
 
4623
 
        status_code = 0
4624
 
        if local_extra and not theirs_only:
4625
 
            message("You have %d extra revision(s):\n" %
4626
 
                len(local_extra))
4627
 
            for revision in iter_log_revisions(local_extra,
4628
 
                                local_branch.repository,
4629
 
                                verbose):
4630
 
                lf.log_revision(revision)
4631
 
            printed_local = True
4632
 
            status_code = 1
4633
 
        else:
4634
 
            printed_local = False
4635
 
 
4636
 
        if remote_extra and not mine_only:
4637
 
            if printed_local is True:
4638
 
                message("\n\n\n")
4639
 
            message("You are missing %d revision(s):\n" %
4640
 
                len(remote_extra))
4641
 
            for revision in iter_log_revisions(remote_extra,
4642
 
                                remote_branch.repository,
4643
 
                                verbose):
4644
 
                lf.log_revision(revision)
4645
 
            status_code = 1
4646
 
 
4647
 
        if mine_only and not local_extra:
4648
 
            # We checked local, and found nothing extra
4649
 
            message('This branch is up to date.\n')
4650
 
        elif theirs_only and not remote_extra:
4651
 
            # We checked remote, and found nothing extra
4652
 
            message('Other branch is up to date.\n')
4653
 
        elif not (mine_only or theirs_only or local_extra or
4654
 
                  remote_extra):
4655
 
            # We checked both branches, and neither one had extra
4656
 
            # revisions
4657
 
            message("Branches are up to date.\n")
4658
 
        self.cleanup_now()
 
4083
        local_branch.lock_read()
 
4084
        try:
 
4085
            remote_branch.lock_read()
 
4086
            try:
 
4087
                local_extra, remote_extra = find_unmerged(
 
4088
                    local_branch, remote_branch, restrict,
 
4089
                    backward=not reverse,
 
4090
                    include_merges=include_merges,
 
4091
                    local_revid_range=local_revid_range,
 
4092
                    remote_revid_range=remote_revid_range)
 
4093
 
 
4094
                if log_format is None:
 
4095
                    registry = log.log_formatter_registry
 
4096
                    log_format = registry.get_default(local_branch)
 
4097
                lf = log_format(to_file=self.outf,
 
4098
                                show_ids=show_ids,
 
4099
                                show_timezone='original')
 
4100
 
 
4101
                status_code = 0
 
4102
                if local_extra and not theirs_only:
 
4103
                    message("You have %d extra revision(s):\n" %
 
4104
                        len(local_extra))
 
4105
                    for revision in iter_log_revisions(local_extra,
 
4106
                                        local_branch.repository,
 
4107
                                        verbose):
 
4108
                        lf.log_revision(revision)
 
4109
                    printed_local = True
 
4110
                    status_code = 1
 
4111
                else:
 
4112
                    printed_local = False
 
4113
 
 
4114
                if remote_extra and not mine_only:
 
4115
                    if printed_local is True:
 
4116
                        message("\n\n\n")
 
4117
                    message("You are missing %d revision(s):\n" %
 
4118
                        len(remote_extra))
 
4119
                    for revision in iter_log_revisions(remote_extra,
 
4120
                                        remote_branch.repository,
 
4121
                                        verbose):
 
4122
                        lf.log_revision(revision)
 
4123
                    status_code = 1
 
4124
 
 
4125
                if mine_only and not local_extra:
 
4126
                    # We checked local, and found nothing extra
 
4127
                    message('This branch is up to date.\n')
 
4128
                elif theirs_only and not remote_extra:
 
4129
                    # We checked remote, and found nothing extra
 
4130
                    message('Other branch is up to date.\n')
 
4131
                elif not (mine_only or theirs_only or local_extra or
 
4132
                          remote_extra):
 
4133
                    # We checked both branches, and neither one had extra
 
4134
                    # revisions
 
4135
                    message("Branches are up to date.\n")
 
4136
            finally:
 
4137
                remote_branch.unlock()
 
4138
        finally:
 
4139
            local_branch.unlock()
4659
4140
        if not status_code and parent is None and other_branch is not None:
4660
 
            self.add_cleanup(local_branch.lock_write().unlock)
4661
 
            # handle race conditions - a parent might be set while we run.
4662
 
            if local_branch.get_parent() is None:
4663
 
                local_branch.set_parent(remote_branch.base)
 
4141
            local_branch.lock_write()
 
4142
            try:
 
4143
                # handle race conditions - a parent might be set while we run.
 
4144
                if local_branch.get_parent() is None:
 
4145
                    local_branch.set_parent(remote_branch.base)
 
4146
            finally:
 
4147
                local_branch.unlock()
4664
4148
        return status_code
4665
4149
 
4666
4150
 
4667
4151
class cmd_pack(Command):
4668
 
    __doc__ = """Compress the data within a repository.
4669
 
 
4670
 
    This operation compresses the data within a bazaar repository. As
4671
 
    bazaar supports automatic packing of repository, this operation is
4672
 
    normally not required to be done manually.
4673
 
 
4674
 
    During the pack operation, bazaar takes a backup of existing repository
4675
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4676
 
    automatically when it is safe to do so. To save disk space by removing
4677
 
    the backed up pack files, the --clean-obsolete-packs option may be
4678
 
    used.
4679
 
 
4680
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4681
 
    during or immediately after repacking, you may be left with a state
4682
 
    where the deletion has been written to disk but the new packs have not
4683
 
    been. In this case the repository may be unusable.
4684
 
    """
 
4152
    """Compress the data within a repository."""
4685
4153
 
4686
4154
    _see_also = ['repositories']
4687
4155
    takes_args = ['branch_or_repo?']
4688
 
    takes_options = [
4689
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4690
 
        ]
4691
4156
 
4692
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4157
    def run(self, branch_or_repo='.'):
4693
4158
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4694
4159
        try:
4695
4160
            branch = dir.open_branch()
4696
4161
            repository = branch.repository
4697
4162
        except errors.NotBranchError:
4698
4163
            repository = dir.open_repository()
4699
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4164
        repository.pack()
4700
4165
 
4701
4166
 
4702
4167
class cmd_plugins(Command):
4703
 
    __doc__ = """List the installed plugins.
 
4168
    """List the installed plugins.
4704
4169
 
4705
4170
    This command displays the list of installed plugins including
4706
4171
    version of plugin and a short description of each.
4713
4178
    adding new commands, providing additional network transports and
4714
4179
    customizing log output.
4715
4180
 
4716
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4717
 
    for further information on plugins including where to find them and how to
4718
 
    install them. Instructions are also provided there on how to write new
4719
 
    plugins using the Python programming language.
 
4181
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4182
    information on plugins including where to find them and how to
 
4183
    install them. Instructions are also provided there on how to
 
4184
    write new plugins using the Python programming language.
4720
4185
    """
4721
4186
    takes_options = ['verbose']
4722
4187
 
4723
4188
    @display_command
4724
4189
    def run(self, verbose=False):
4725
 
        from bzrlib import plugin
4726
 
        # Don't give writelines a generator as some codecs don't like that
4727
 
        self.outf.writelines(
4728
 
            list(plugin.describe_plugins(show_paths=verbose)))
 
4190
        import bzrlib.plugin
 
4191
        from inspect import getdoc
 
4192
        result = []
 
4193
        for name, plugin in bzrlib.plugin.plugins().items():
 
4194
            version = plugin.__version__
 
4195
            if version == 'unknown':
 
4196
                version = ''
 
4197
            name_ver = '%s %s' % (name, version)
 
4198
            d = getdoc(plugin.module)
 
4199
            if d:
 
4200
                doc = d.split('\n')[0]
 
4201
            else:
 
4202
                doc = '(no description)'
 
4203
            result.append((name_ver, doc, plugin.path()))
 
4204
        for name_ver, doc, path in sorted(result):
 
4205
            print name_ver
 
4206
            print '   ', doc
 
4207
            if verbose:
 
4208
                print '   ', path
 
4209
            print
4729
4210
 
4730
4211
 
4731
4212
class cmd_testament(Command):
4732
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4213
    """Show testament (signing-form) of a revision."""
4733
4214
    takes_options = [
4734
4215
            'revision',
4735
4216
            Option('long', help='Produce long-format testament.'),
4747
4228
            b = Branch.open_containing(branch)[0]
4748
4229
        else:
4749
4230
            b = Branch.open(branch)
4750
 
        self.add_cleanup(b.lock_read().unlock)
4751
 
        if revision is None:
4752
 
            rev_id = b.last_revision()
4753
 
        else:
4754
 
            rev_id = revision[0].as_revision_id(b)
4755
 
        t = testament_class.from_revision(b.repository, rev_id)
4756
 
        if long:
4757
 
            sys.stdout.writelines(t.as_text_lines())
4758
 
        else:
4759
 
            sys.stdout.write(t.as_short_text())
 
4231
        b.lock_read()
 
4232
        try:
 
4233
            if revision is None:
 
4234
                rev_id = b.last_revision()
 
4235
            else:
 
4236
                rev_id = revision[0].as_revision_id(b)
 
4237
            t = testament_class.from_revision(b.repository, rev_id)
 
4238
            if long:
 
4239
                sys.stdout.writelines(t.as_text_lines())
 
4240
            else:
 
4241
                sys.stdout.write(t.as_short_text())
 
4242
        finally:
 
4243
            b.unlock()
4760
4244
 
4761
4245
 
4762
4246
class cmd_annotate(Command):
4763
 
    __doc__ = """Show the origin of each line in a file.
 
4247
    """Show the origin of each line in a file.
4764
4248
 
4765
4249
    This prints out the given file with an annotation on the left side
4766
4250
    indicating which revision, author and date introduced the change.
4777
4261
                     Option('long', help='Show commit date in annotations.'),
4778
4262
                     'revision',
4779
4263
                     'show-ids',
4780
 
                     'directory',
4781
4264
                     ]
4782
4265
    encoding_type = 'exact'
4783
4266
 
4784
4267
    @display_command
4785
4268
    def run(self, filename, all=False, long=False, revision=None,
4786
 
            show_ids=False, directory=None):
4787
 
        from bzrlib.annotate import (
4788
 
            annotate_file_tree,
4789
 
            )
 
4269
            show_ids=False):
 
4270
        from bzrlib.annotate import annotate_file, annotate_file_tree
4790
4271
        wt, branch, relpath = \
4791
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4272
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4792
4273
        if wt is not None:
4793
 
            self.add_cleanup(wt.lock_read().unlock)
4794
 
        else:
4795
 
            self.add_cleanup(branch.lock_read().unlock)
4796
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4797
 
        self.add_cleanup(tree.lock_read().unlock)
4798
 
        if wt is not None and revision is None:
4799
 
            file_id = wt.path2id(relpath)
4800
 
        else:
4801
 
            file_id = tree.path2id(relpath)
4802
 
        if file_id is None:
4803
 
            raise errors.NotVersionedError(filename)
4804
 
        if wt is not None and revision is None:
4805
 
            # If there is a tree and we're not annotating historical
4806
 
            # versions, annotate the working tree's content.
4807
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4808
 
                show_ids=show_ids)
4809
 
        else:
4810
 
            annotate_file_tree(tree, file_id, self.outf, long, all,
4811
 
                show_ids=show_ids, branch=branch)
 
4274
            wt.lock_read()
 
4275
        else:
 
4276
            branch.lock_read()
 
4277
        try:
 
4278
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4279
            if wt is not None:
 
4280
                file_id = wt.path2id(relpath)
 
4281
            else:
 
4282
                file_id = tree.path2id(relpath)
 
4283
            if file_id is None:
 
4284
                raise errors.NotVersionedError(filename)
 
4285
            file_version = tree.inventory[file_id].revision
 
4286
            if wt is not None and revision is None:
 
4287
                # If there is a tree and we're not annotating historical
 
4288
                # versions, annotate the working tree's content.
 
4289
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4290
                    show_ids=show_ids)
 
4291
            else:
 
4292
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4293
                              show_ids=show_ids)
 
4294
        finally:
 
4295
            if wt is not None:
 
4296
                wt.unlock()
 
4297
            else:
 
4298
                branch.unlock()
4812
4299
 
4813
4300
 
4814
4301
class cmd_re_sign(Command):
4815
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4302
    """Create a digital signature for an existing revision."""
4816
4303
    # TODO be able to replace existing ones.
4817
4304
 
4818
4305
    hidden = True # is this right ?
4819
4306
    takes_args = ['revision_id*']
4820
 
    takes_options = ['directory', 'revision']
 
4307
    takes_options = ['revision']
4821
4308
 
4822
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4309
    def run(self, revision_id_list=None, revision=None):
4823
4310
        if revision_id_list is not None and revision is not None:
4824
4311
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4825
4312
        if revision_id_list is None and revision is None:
4826
4313
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4827
 
        b = WorkingTree.open_containing(directory)[0].branch
4828
 
        self.add_cleanup(b.lock_write().unlock)
4829
 
        return self._run(b, revision_id_list, revision)
 
4314
        b = WorkingTree.open_containing(u'.')[0].branch
 
4315
        b.lock_write()
 
4316
        try:
 
4317
            return self._run(b, revision_id_list, revision)
 
4318
        finally:
 
4319
            b.unlock()
4830
4320
 
4831
4321
    def _run(self, b, revision_id_list, revision):
4832
4322
        import bzrlib.gpg as gpg
4877
4367
 
4878
4368
 
4879
4369
class cmd_bind(Command):
4880
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4881
 
    If no branch is supplied, rebind to the last bound location.
 
4370
    """Convert the current branch into a checkout of the supplied branch.
4882
4371
 
4883
4372
    Once converted into a checkout, commits must succeed on the master branch
4884
4373
    before they will be applied to the local branch.
4885
4374
 
4886
4375
    Bound branches use the nickname of its master branch unless it is set
4887
 
    locally, in which case binding will update the local nickname to be
 
4376
    locally, in which case binding will update the the local nickname to be
4888
4377
    that of the master.
4889
4378
    """
4890
4379
 
4891
4380
    _see_also = ['checkouts', 'unbind']
4892
4381
    takes_args = ['location?']
4893
 
    takes_options = ['directory']
 
4382
    takes_options = []
4894
4383
 
4895
 
    def run(self, location=None, directory=u'.'):
4896
 
        b, relpath = Branch.open_containing(directory)
 
4384
    def run(self, location=None):
 
4385
        b, relpath = Branch.open_containing(u'.')
4897
4386
        if location is None:
4898
4387
            try:
4899
4388
                location = b.get_old_bound_location()
4902
4391
                    'This format does not remember old locations.')
4903
4392
            else:
4904
4393
                if location is None:
4905
 
                    if b.get_bound_location() is not None:
4906
 
                        raise errors.BzrCommandError('Branch is already bound')
4907
 
                    else:
4908
 
                        raise errors.BzrCommandError('No location supplied '
4909
 
                            'and no previous location known')
 
4394
                    raise errors.BzrCommandError('No location supplied and no '
 
4395
                        'previous location known')
4910
4396
        b_other = Branch.open(location)
4911
4397
        try:
4912
4398
            b.bind(b_other)
4918
4404
 
4919
4405
 
4920
4406
class cmd_unbind(Command):
4921
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4407
    """Convert the current checkout into a regular branch.
4922
4408
 
4923
4409
    After unbinding, the local branch is considered independent and subsequent
4924
4410
    commits will be local only.
4926
4412
 
4927
4413
    _see_also = ['checkouts', 'bind']
4928
4414
    takes_args = []
4929
 
    takes_options = ['directory']
 
4415
    takes_options = []
4930
4416
 
4931
 
    def run(self, directory=u'.'):
4932
 
        b, relpath = Branch.open_containing(directory)
 
4417
    def run(self):
 
4418
        b, relpath = Branch.open_containing(u'.')
4933
4419
        if not b.unbind():
4934
4420
            raise errors.BzrCommandError('Local branch is not bound')
4935
4421
 
4936
4422
 
4937
4423
class cmd_uncommit(Command):
4938
 
    __doc__ = """Remove the last committed revision.
 
4424
    """Remove the last committed revision.
4939
4425
 
4940
4426
    --verbose will print out what is being removed.
4941
4427
    --dry-run will go through all the motions, but not actually
4981
4467
            b = control.open_branch()
4982
4468
 
4983
4469
        if tree is not None:
4984
 
            self.add_cleanup(tree.lock_write().unlock)
 
4470
            tree.lock_write()
4985
4471
        else:
4986
 
            self.add_cleanup(b.lock_write().unlock)
4987
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4472
            b.lock_write()
 
4473
        try:
 
4474
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4475
                             local=local)
 
4476
        finally:
 
4477
            if tree is not None:
 
4478
                tree.unlock()
 
4479
            else:
 
4480
                b.unlock()
4988
4481
 
4989
4482
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4990
4483
        from bzrlib.log import log_formatter, show_log
5022
4515
                 end_revision=last_revno)
5023
4516
 
5024
4517
        if dry_run:
5025
 
            self.outf.write('Dry-run, pretending to remove'
5026
 
                            ' the above revisions.\n')
 
4518
            print 'Dry-run, pretending to remove the above revisions.'
 
4519
            if not force:
 
4520
                val = raw_input('Press <enter> to continue')
5027
4521
        else:
5028
 
            self.outf.write('The above revision(s) will be removed.\n')
5029
 
 
5030
 
        if not force:
5031
 
            if not ui.ui_factory.confirm_action(
5032
 
                    u'Uncommit these revisions',
5033
 
                    'bzrlib.builtins.uncommit',
5034
 
                    {}):
5035
 
                self.outf.write('Canceled\n')
5036
 
                return 0
 
4522
            print 'The above revision(s) will be removed.'
 
4523
            if not force:
 
4524
                val = raw_input('Are you sure [y/N]? ')
 
4525
                if val.lower() not in ('y', 'yes'):
 
4526
                    print 'Canceled'
 
4527
                    return 0
5037
4528
 
5038
4529
        mutter('Uncommitting from {%s} to {%s}',
5039
4530
               last_rev_id, rev_id)
5040
4531
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5041
4532
                 revno=revno, local=local)
5042
 
        self.outf.write('You can restore the old tip by running:\n'
5043
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4533
        note('You can restore the old tip by running:\n'
 
4534
             '  bzr pull . -r revid:%s', last_rev_id)
5044
4535
 
5045
4536
 
5046
4537
class cmd_break_lock(Command):
5047
 
    __doc__ = """Break a dead lock.
5048
 
 
5049
 
    This command breaks a lock on a repository, branch, working directory or
5050
 
    config file.
 
4538
    """Break a dead lock on a repository, branch or working directory.
5051
4539
 
5052
4540
    CAUTION: Locks should only be broken when you are sure that the process
5053
4541
    holding the lock has been stopped.
5054
4542
 
5055
 
    You can get information on what locks are open via the 'bzr info
5056
 
    [location]' command.
 
4543
    You can get information on what locks are open via the 'bzr info' command.
5057
4544
 
5058
4545
    :Examples:
5059
4546
        bzr break-lock
5060
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
5061
 
        bzr break-lock --conf ~/.bazaar
5062
4547
    """
5063
 
 
5064
4548
    takes_args = ['location?']
5065
 
    takes_options = [
5066
 
        Option('config',
5067
 
               help='LOCATION is the directory where the config lock is.'),
5068
 
        Option('force',
5069
 
            help='Do not ask for confirmation before breaking the lock.'),
5070
 
        ]
5071
4549
 
5072
 
    def run(self, location=None, config=False, force=False):
 
4550
    def run(self, location=None, show=False):
5073
4551
        if location is None:
5074
4552
            location = u'.'
5075
 
        if force:
5076
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5077
 
                None,
5078
 
                {'bzrlib.lockdir.break': True})
5079
 
        if config:
5080
 
            conf = _mod_config.LockableConfig(file_name=location)
5081
 
            conf.break_lock()
5082
 
        else:
5083
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
5084
 
            try:
5085
 
                control.break_lock()
5086
 
            except NotImplementedError:
5087
 
                pass
 
4553
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4554
        try:
 
4555
            control.break_lock()
 
4556
        except NotImplementedError:
 
4557
            pass
5088
4558
 
5089
4559
 
5090
4560
class cmd_wait_until_signalled(Command):
5091
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4561
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5092
4562
 
5093
4563
    This just prints a line to signal when it is ready, then blocks on stdin.
5094
4564
    """
5102
4572
 
5103
4573
 
5104
4574
class cmd_serve(Command):
5105
 
    __doc__ = """Run the bzr server."""
 
4575
    """Run the bzr server."""
5106
4576
 
5107
4577
    aliases = ['server']
5108
4578
 
5109
4579
    takes_options = [
5110
4580
        Option('inet',
5111
4581
               help='Serve on stdin/out for use from inetd or sshd.'),
5112
 
        RegistryOption('protocol',
5113
 
               help="Protocol to serve.",
 
4582
        RegistryOption('protocol', 
 
4583
               help="Protocol to serve.", 
5114
4584
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5115
4585
               value_switches=True),
5116
4586
        Option('port',
5119
4589
                    'result in a dynamically allocated port.  The default port '
5120
4590
                    'depends on the protocol.',
5121
4591
               type=str),
5122
 
        custom_help('directory',
5123
 
               help='Serve contents of this directory.'),
 
4592
        Option('directory',
 
4593
               help='Serve contents of this directory.',
 
4594
               type=unicode),
5124
4595
        Option('allow-writes',
5125
4596
               help='By default the server is a readonly server.  Supplying '
5126
4597
                    '--allow-writes enables write access to the contents of '
5127
 
                    'the served directory and below.  Note that ``bzr serve`` '
5128
 
                    'does not perform authentication, so unless some form of '
5129
 
                    'external authentication is arranged supplying this '
5130
 
                    'option leads to global uncontrolled write access to your '
5131
 
                    'file system.'
 
4598
                    'the served directory and below.'
5132
4599
                ),
5133
4600
        ]
5134
4601
 
5153
4620
 
5154
4621
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5155
4622
            protocol=None):
5156
 
        from bzrlib import transport
 
4623
        from bzrlib.transport import get_transport, transport_server_registry
5157
4624
        if directory is None:
5158
4625
            directory = os.getcwd()
5159
4626
        if protocol is None:
5160
 
            protocol = transport.transport_server_registry.get()
 
4627
            protocol = transport_server_registry.get()
5161
4628
        host, port = self.get_host_and_port(port)
5162
4629
        url = urlutils.local_path_to_url(directory)
5163
4630
        if not allow_writes:
5164
4631
            url = 'readonly+' + url
5165
 
        t = transport.get_transport(url)
5166
 
        protocol(t, host, port, inet)
 
4632
        transport = get_transport(url)
 
4633
        protocol(transport, host, port, inet)
5167
4634
 
5168
4635
 
5169
4636
class cmd_join(Command):
5170
 
    __doc__ = """Combine a tree into its containing tree.
 
4637
    """Combine a tree into its containing tree.
5171
4638
 
5172
4639
    This command requires the target tree to be in a rich-root format.
5173
4640
 
5175
4642
    not part of it.  (Such trees can be produced by "bzr split", but also by
5176
4643
    running "bzr branch" with the target inside a tree.)
5177
4644
 
5178
 
    The result is a combined tree, with the subtree no longer an independent
 
4645
    The result is a combined tree, with the subtree no longer an independant
5179
4646
    part.  This is marked as a merge of the subtree into the containing tree,
5180
4647
    and all history is preserved.
5181
4648
    """
5213
4680
 
5214
4681
 
5215
4682
class cmd_split(Command):
5216
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4683
    """Split a subdirectory of a tree into a separate tree.
5217
4684
 
5218
4685
    This command will produce a target tree in a format that supports
5219
4686
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5239
4706
 
5240
4707
 
5241
4708
class cmd_merge_directive(Command):
5242
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4709
    """Generate a merge directive for auto-merge tools.
5243
4710
 
5244
4711
    A directive requests a merge to be performed, and also provides all the
5245
4712
    information necessary to do so.  This means it must either include a
5262
4729
    _see_also = ['send']
5263
4730
 
5264
4731
    takes_options = [
5265
 
        'directory',
5266
4732
        RegistryOption.from_kwargs('patch-type',
5267
4733
            'The type of patch to include in the directive.',
5268
4734
            title='Patch type',
5281
4747
    encoding_type = 'exact'
5282
4748
 
5283
4749
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5284
 
            sign=False, revision=None, mail_to=None, message=None,
5285
 
            directory=u'.'):
 
4750
            sign=False, revision=None, mail_to=None, message=None):
5286
4751
        from bzrlib.revision import ensure_null, NULL_REVISION
5287
4752
        include_patch, include_bundle = {
5288
4753
            'plain': (False, False),
5289
4754
            'diff': (True, False),
5290
4755
            'bundle': (True, True),
5291
4756
            }[patch_type]
5292
 
        branch = Branch.open(directory)
 
4757
        branch = Branch.open('.')
5293
4758
        stored_submit_branch = branch.get_submit_branch()
5294
4759
        if submit_branch is None:
5295
4760
            submit_branch = stored_submit_branch
5340
4805
 
5341
4806
 
5342
4807
class cmd_send(Command):
5343
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4808
    """Mail or create a merge-directive for submitting changes.
5344
4809
 
5345
4810
    A merge directive provides many things needed for requesting merges:
5346
4811
 
5352
4817
      directly from the merge directive, without retrieving data from a
5353
4818
      branch.
5354
4819
 
5355
 
    `bzr send` creates a compact data set that, when applied using bzr
5356
 
    merge, has the same effect as merging from the source branch.  
5357
 
    
5358
 
    By default the merge directive is self-contained and can be applied to any
5359
 
    branch containing submit_branch in its ancestory without needing access to
5360
 
    the source branch.
5361
 
    
5362
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5363
 
    revisions, but only a structured request to merge from the
5364
 
    public_location.  In that case the public_branch is needed and it must be
5365
 
    up-to-date and accessible to the recipient.  The public_branch is always
5366
 
    included if known, so that people can check it later.
5367
 
 
5368
 
    The submit branch defaults to the parent of the source branch, but can be
5369
 
    overridden.  Both submit branch and public branch will be remembered in
5370
 
    branch.conf the first time they are used for a particular branch.  The
5371
 
    source branch defaults to that containing the working directory, but can
5372
 
    be changed using --from.
5373
 
 
5374
 
    Both the submit branch and the public branch follow the usual behavior with
5375
 
    respect to --remember: If there is no default location set, the first send
5376
 
    will set it (use --no-remember to avoid settting it). After that, you can
5377
 
    omit the location to use the default.  To change the default, use
5378
 
    --remember. The value will only be saved if the location can be accessed.
5379
 
 
5380
 
    In order to calculate those changes, bzr must analyse the submit branch.
5381
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5382
 
    If a public location is known for the submit_branch, that location is used
5383
 
    in the merge directive.
5384
 
 
5385
 
    The default behaviour is to send the merge directive by mail, unless -o is
5386
 
    given, in which case it is sent to a file.
 
4820
    If --no-bundle is specified, then public_branch is needed (and must be
 
4821
    up-to-date), so that the receiver can perform the merge using the
 
4822
    public_branch.  The public_branch is always included if known, so that
 
4823
    people can check it later.
 
4824
 
 
4825
    The submit branch defaults to the parent, but can be overridden.  Both
 
4826
    submit branch and public branch will be remembered if supplied.
 
4827
 
 
4828
    If a public_branch is known for the submit_branch, that public submit
 
4829
    branch is used in the merge instructions.  This means that a local mirror
 
4830
    can be used as your actual submit branch, once you have set public_branch
 
4831
    for that mirror.
5387
4832
 
5388
4833
    Mail is sent using your preferred mail program.  This should be transparent
5389
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4834
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5390
4835
    If the preferred client can't be found (or used), your editor will be used.
5391
4836
 
5392
4837
    To use a specific mail program, set the mail_client configuration option.
5393
4838
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5394
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5395
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5396
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5397
 
    supported clients.
 
4839
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4840
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4841
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5398
4842
 
5399
4843
    If mail is being sent, a to address is required.  This can be supplied
5400
4844
    either on the commandline, by setting the submit_to configuration
5409
4853
 
5410
4854
    The merge directives created by bzr send may be applied using bzr merge or
5411
4855
    bzr pull by specifying a file containing a merge directive as the location.
5412
 
 
5413
 
    bzr send makes extensive use of public locations to map local locations into
5414
 
    URLs that can be used by other people.  See `bzr help configuration` to
5415
 
    set them, and use `bzr info` to display them.
5416
4856
    """
5417
4857
 
5418
4858
    encoding_type = 'exact'
5434
4874
               short_name='f',
5435
4875
               type=unicode),
5436
4876
        Option('output', short_name='o',
5437
 
               help='Write merge directive to this file or directory; '
 
4877
               help='Write merge directive to this file; '
5438
4878
                    'use - for stdout.',
5439
4879
               type=unicode),
5440
 
        Option('strict',
5441
 
               help='Refuse to send if there are uncommitted changes in'
5442
 
               ' the working tree, --no-strict disables the check.'),
5443
4880
        Option('mail-to', help='Mail the request to this address.',
5444
4881
               type=unicode),
5445
4882
        'revision',
5446
4883
        'message',
5447
4884
        Option('body', help='Body for the email.', type=unicode),
5448
4885
        RegistryOption('format',
5449
 
                       help='Use the specified output format.',
5450
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4886
                       help='Use the specified output format.', 
 
4887
                       lazy_registry=('bzrlib.send', 'format_registry'))
5451
4888
        ]
5452
4889
 
5453
4890
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5454
 
            no_patch=False, revision=None, remember=None, output=None,
5455
 
            format=None, mail_to=None, message=None, body=None,
5456
 
            strict=None, **kwargs):
 
4891
            no_patch=False, revision=None, remember=False, output=None,
 
4892
            format=None, mail_to=None, message=None, body=None, **kwargs):
5457
4893
        from bzrlib.send import send
5458
4894
        return send(submit_branch, revision, public_branch, remember,
5459
 
                    format, no_bundle, no_patch, output,
5460
 
                    kwargs.get('from', '.'), mail_to, message, body,
5461
 
                    self.outf,
5462
 
                    strict=strict)
 
4895
                         format, no_bundle, no_patch, output,
 
4896
                         kwargs.get('from', '.'), mail_to, message, body,
 
4897
                         self.outf)
5463
4898
 
5464
4899
 
5465
4900
class cmd_bundle_revisions(cmd_send):
5466
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4901
    """Create a merge-directive for submitting changes.
5467
4902
 
5468
4903
    A merge directive provides many things needed for requesting merges:
5469
4904
 
5509
4944
               type=unicode),
5510
4945
        Option('output', short_name='o', help='Write directive to this file.',
5511
4946
               type=unicode),
5512
 
        Option('strict',
5513
 
               help='Refuse to bundle revisions if there are uncommitted'
5514
 
               ' changes in the working tree, --no-strict disables the check.'),
5515
4947
        'revision',
5516
4948
        RegistryOption('format',
5517
4949
                       help='Use the specified output format.',
5525
4957
 
5526
4958
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5527
4959
            no_patch=False, revision=None, remember=False, output=None,
5528
 
            format=None, strict=None, **kwargs):
 
4960
            format=None, **kwargs):
5529
4961
        if output is None:
5530
4962
            output = '-'
5531
4963
        from bzrlib.send import send
5532
4964
        return send(submit_branch, revision, public_branch, remember,
5533
4965
                         format, no_bundle, no_patch, output,
5534
4966
                         kwargs.get('from', '.'), None, None, None,
5535
 
                         self.outf, strict=strict)
 
4967
                         self.outf)
5536
4968
 
5537
4969
 
5538
4970
class cmd_tag(Command):
5539
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4971
    """Create, remove or modify a tag naming a revision.
5540
4972
 
5541
4973
    Tags give human-meaningful names to revisions.  Commands that take a -r
5542
4974
    (--revision) option can be given -rtag:X, where X is any previously
5550
4982
 
5551
4983
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5552
4984
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5553
 
 
5554
 
    If no tag name is specified it will be determined through the 
5555
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5556
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5557
 
    details.
5558
4985
    """
5559
4986
 
5560
4987
    _see_also = ['commit', 'tags']
5561
 
    takes_args = ['tag_name?']
 
4988
    takes_args = ['tag_name']
5562
4989
    takes_options = [
5563
4990
        Option('delete',
5564
4991
            help='Delete this tag rather than placing it.',
5565
4992
            ),
5566
 
        custom_help('directory',
5567
 
            help='Branch in which to place the tag.'),
 
4993
        Option('directory',
 
4994
            help='Branch in which to place the tag.',
 
4995
            short_name='d',
 
4996
            type=unicode,
 
4997
            ),
5568
4998
        Option('force',
5569
4999
            help='Replace existing tags.',
5570
5000
            ),
5571
5001
        'revision',
5572
5002
        ]
5573
5003
 
5574
 
    def run(self, tag_name=None,
 
5004
    def run(self, tag_name,
5575
5005
            delete=None,
5576
5006
            directory='.',
5577
5007
            force=None,
5578
5008
            revision=None,
5579
5009
            ):
5580
5010
        branch, relpath = Branch.open_containing(directory)
5581
 
        self.add_cleanup(branch.lock_write().unlock)
5582
 
        if delete:
5583
 
            if tag_name is None:
5584
 
                raise errors.BzrCommandError("No tag specified to delete.")
5585
 
            branch.tags.delete_tag(tag_name)
5586
 
            note('Deleted tag %s.' % tag_name)
5587
 
        else:
5588
 
            if revision:
5589
 
                if len(revision) != 1:
5590
 
                    raise errors.BzrCommandError(
5591
 
                        "Tags can only be placed on a single revision, "
5592
 
                        "not on a range")
5593
 
                revision_id = revision[0].as_revision_id(branch)
 
5011
        branch.lock_write()
 
5012
        try:
 
5013
            if delete:
 
5014
                branch.tags.delete_tag(tag_name)
 
5015
                self.outf.write('Deleted tag %s.\n' % tag_name)
5594
5016
            else:
5595
 
                revision_id = branch.last_revision()
5596
 
            if tag_name is None:
5597
 
                tag_name = branch.automatic_tag_name(revision_id)
5598
 
                if tag_name is None:
5599
 
                    raise errors.BzrCommandError(
5600
 
                        "Please specify a tag name.")
5601
 
            if (not force) and branch.tags.has_tag(tag_name):
5602
 
                raise errors.TagAlreadyExists(tag_name)
5603
 
            branch.tags.set_tag(tag_name, revision_id)
5604
 
            note('Created tag %s.' % tag_name)
 
5017
                if revision:
 
5018
                    if len(revision) != 1:
 
5019
                        raise errors.BzrCommandError(
 
5020
                            "Tags can only be placed on a single revision, "
 
5021
                            "not on a range")
 
5022
                    revision_id = revision[0].as_revision_id(branch)
 
5023
                else:
 
5024
                    revision_id = branch.last_revision()
 
5025
                if (not force) and branch.tags.has_tag(tag_name):
 
5026
                    raise errors.TagAlreadyExists(tag_name)
 
5027
                branch.tags.set_tag(tag_name, revision_id)
 
5028
                self.outf.write('Created tag %s.\n' % tag_name)
 
5029
        finally:
 
5030
            branch.unlock()
5605
5031
 
5606
5032
 
5607
5033
class cmd_tags(Command):
5608
 
    __doc__ = """List tags.
 
5034
    """List tags.
5609
5035
 
5610
5036
    This command shows a table of tag names and the revisions they reference.
5611
5037
    """
5612
5038
 
5613
5039
    _see_also = ['tag']
5614
5040
    takes_options = [
5615
 
        custom_help('directory',
5616
 
            help='Branch whose tags should be displayed.'),
5617
 
        RegistryOption('sort',
 
5041
        Option('directory',
 
5042
            help='Branch whose tags should be displayed.',
 
5043
            short_name='d',
 
5044
            type=unicode,
 
5045
            ),
 
5046
        RegistryOption.from_kwargs('sort',
5618
5047
            'Sort tags by different criteria.', title='Sorting',
5619
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
5048
            alpha='Sort tags lexicographically (default).',
 
5049
            time='Sort tags chronologically.',
5620
5050
            ),
5621
5051
        'show-ids',
5622
5052
        'revision',
5623
5053
    ]
5624
5054
 
5625
5055
    @display_command
5626
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5627
 
        from bzrlib.tag import tag_sort_methods
 
5056
    def run(self,
 
5057
            directory='.',
 
5058
            sort='alpha',
 
5059
            show_ids=False,
 
5060
            revision=None,
 
5061
            ):
5628
5062
        branch, relpath = Branch.open_containing(directory)
5629
5063
 
5630
5064
        tags = branch.tags.get_tag_dict().items()
5631
5065
        if not tags:
5632
5066
            return
5633
5067
 
5634
 
        self.add_cleanup(branch.lock_read().unlock)
5635
 
        if revision:
5636
 
            graph = branch.repository.get_graph()
5637
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5638
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5639
 
            # only show revisions between revid1 and revid2 (inclusive)
5640
 
            tags = [(tag, revid) for tag, revid in tags if
5641
 
                graph.is_between(revid, revid1, revid2)]
5642
 
        if sort is None:
5643
 
            sort = tag_sort_methods.get()
5644
 
        sort(branch, tags)
5645
 
        if not show_ids:
5646
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5647
 
            for index, (tag, revid) in enumerate(tags):
5648
 
                try:
5649
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5650
 
                    if isinstance(revno, tuple):
5651
 
                        revno = '.'.join(map(str, revno))
5652
 
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5653
 
                    # Bad tag data/merges can lead to tagged revisions
5654
 
                    # which are not in this branch. Fail gracefully ...
5655
 
                    revno = '?'
5656
 
                tags[index] = (tag, revno)
5657
 
        self.cleanup_now()
 
5068
        branch.lock_read()
 
5069
        try:
 
5070
            if revision:
 
5071
                graph = branch.repository.get_graph()
 
5072
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5073
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5074
                # only show revisions between revid1 and revid2 (inclusive)
 
5075
                tags = [(tag, revid) for tag, revid in tags if
 
5076
                    graph.is_between(revid, revid1, revid2)]
 
5077
            if sort == 'alpha':
 
5078
                tags.sort()
 
5079
            elif sort == 'time':
 
5080
                timestamps = {}
 
5081
                for tag, revid in tags:
 
5082
                    try:
 
5083
                        revobj = branch.repository.get_revision(revid)
 
5084
                    except errors.NoSuchRevision:
 
5085
                        timestamp = sys.maxint # place them at the end
 
5086
                    else:
 
5087
                        timestamp = revobj.timestamp
 
5088
                    timestamps[revid] = timestamp
 
5089
                tags.sort(key=lambda x: timestamps[x[1]])
 
5090
            if not show_ids:
 
5091
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5092
                for index, (tag, revid) in enumerate(tags):
 
5093
                    try:
 
5094
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5095
                        if isinstance(revno, tuple):
 
5096
                            revno = '.'.join(map(str, revno))
 
5097
                    except errors.NoSuchRevision:
 
5098
                        # Bad tag data/merges can lead to tagged revisions
 
5099
                        # which are not in this branch. Fail gracefully ...
 
5100
                        revno = '?'
 
5101
                    tags[index] = (tag, revno)
 
5102
        finally:
 
5103
            branch.unlock()
5658
5104
        for tag, revspec in tags:
5659
5105
            self.outf.write('%-20s %s\n' % (tag, revspec))
5660
5106
 
5661
5107
 
5662
5108
class cmd_reconfigure(Command):
5663
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5109
    """Reconfigure the type of a bzr directory.
5664
5110
 
5665
5111
    A target configuration must be specified.
5666
5112
 
5696
5142
            ),
5697
5143
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5698
5144
        Option('force',
5699
 
            help='Perform reconfiguration even if local changes'
5700
 
            ' will be lost.'),
5701
 
        Option('stacked-on',
5702
 
            help='Reconfigure a branch to be stacked on another branch.',
5703
 
            type=unicode,
5704
 
            ),
5705
 
        Option('unstacked',
5706
 
            help='Reconfigure a branch to be unstacked.  This '
5707
 
                'may require copying substantial data into it.',
5708
 
            ),
 
5145
               help='Perform reconfiguration even if local changes'
 
5146
               ' will be lost.')
5709
5147
        ]
5710
5148
 
5711
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5712
 
            stacked_on=None,
5713
 
            unstacked=None):
 
5149
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5714
5150
        directory = bzrdir.BzrDir.open(location)
5715
 
        if stacked_on and unstacked:
5716
 
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
5717
 
        elif stacked_on is not None:
5718
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5719
 
        elif unstacked:
5720
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5721
 
        # At the moment you can use --stacked-on and a different
5722
 
        # reconfiguration shape at the same time; there seems no good reason
5723
 
        # to ban it.
5724
5151
        if target_type is None:
5725
 
            if stacked_on or unstacked:
5726
 
                return
5727
 
            else:
5728
 
                raise errors.BzrCommandError('No target configuration '
5729
 
                    'specified')
 
5152
            raise errors.BzrCommandError('No target configuration specified')
5730
5153
        elif target_type == 'branch':
5731
5154
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5732
5155
        elif target_type == 'tree':
5751
5174
 
5752
5175
 
5753
5176
class cmd_switch(Command):
5754
 
    __doc__ = """Set the branch of a checkout and update.
 
5177
    """Set the branch of a checkout and update.
5755
5178
 
5756
5179
    For lightweight checkouts, this changes the branch being referenced.
5757
5180
    For heavyweight checkouts, this checks that there are no local commits
5769
5192
    /path/to/newbranch.
5770
5193
 
5771
5194
    Bound branches use the nickname of its master branch unless it is set
5772
 
    locally, in which case switching will update the local nickname to be
 
5195
    locally, in which case switching will update the the local nickname to be
5773
5196
    that of the master.
5774
5197
    """
5775
5198
 
5776
 
    takes_args = ['to_location?']
5777
 
    takes_options = ['directory',
5778
 
                     Option('force',
5779
 
                        help='Switch even if local commits will be lost.'),
5780
 
                     'revision',
5781
 
                     Option('create-branch', short_name='b',
5782
 
                        help='Create the target branch from this one before'
5783
 
                             ' switching to it.'),
5784
 
                    ]
 
5199
    takes_args = ['to_location']
 
5200
    takes_options = [Option('force',
 
5201
                        help='Switch even if local commits will be lost.')
 
5202
                     ]
5785
5203
 
5786
 
    def run(self, to_location=None, force=False, create_branch=False,
5787
 
            revision=None, directory=u'.'):
 
5204
    def run(self, to_location, force=False):
5788
5205
        from bzrlib import switch
5789
 
        tree_location = directory
5790
 
        revision = _get_one_revision('switch', revision)
 
5206
        tree_location = '.'
5791
5207
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5792
 
        if to_location is None:
5793
 
            if revision is None:
5794
 
                raise errors.BzrCommandError('You must supply either a'
5795
 
                                             ' revision or a location')
5796
 
            to_location = tree_location
5797
5208
        try:
5798
5209
            branch = control_dir.open_branch()
5799
5210
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5800
5211
        except errors.NotBranchError:
5801
 
            branch = None
5802
5212
            had_explicit_nick = False
5803
 
        if create_branch:
5804
 
            if branch is None:
5805
 
                raise errors.BzrCommandError('cannot create branch without'
5806
 
                                             ' source branch')
5807
 
            to_location = directory_service.directories.dereference(
5808
 
                              to_location)
5809
 
            if '/' not in to_location and '\\' not in to_location:
5810
 
                # This path is meant to be relative to the existing branch
5811
 
                this_url = self._get_branch_location(control_dir)
5812
 
                to_location = urlutils.join(this_url, '..', to_location)
5813
 
            to_branch = branch.bzrdir.sprout(to_location,
5814
 
                                 possible_transports=[branch.bzrdir.root_transport],
5815
 
                                 source_branch=branch).open_branch()
5816
 
        else:
5817
 
            try:
5818
 
                to_branch = Branch.open(to_location)
5819
 
            except errors.NotBranchError:
5820
 
                this_url = self._get_branch_location(control_dir)
5821
 
                to_branch = Branch.open(
5822
 
                    urlutils.join(this_url, '..', to_location))
5823
 
        if revision is not None:
5824
 
            revision = revision.as_revision_id(to_branch)
5825
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5213
        try:
 
5214
            to_branch = Branch.open(to_location)
 
5215
        except errors.NotBranchError:
 
5216
            this_url = self._get_branch_location(control_dir)
 
5217
            to_branch = Branch.open(
 
5218
                urlutils.join(this_url, '..', to_location))
 
5219
        switch.switch(control_dir, to_branch, force)
5826
5220
        if had_explicit_nick:
5827
5221
            branch = control_dir.open_branch() #get the new branch!
5828
5222
            branch.nick = to_branch.nick
5848
5242
 
5849
5243
 
5850
5244
class cmd_view(Command):
5851
 
    __doc__ = """Manage filtered views.
 
5245
    """Manage filtered views.
5852
5246
 
5853
5247
    Views provide a mask over the tree so that users can focus on
5854
5248
    a subset of a tree when doing their work. After creating a view,
5934
5328
            name=None,
5935
5329
            switch=None,
5936
5330
            ):
5937
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5938
 
            apply_view=False)
 
5331
        tree, file_list = tree_files(file_list, apply_view=False)
5939
5332
        current_view, view_dict = tree.views.get_view_info()
5940
5333
        if name is None:
5941
5334
            name = current_view
6003
5396
 
6004
5397
 
6005
5398
class cmd_hooks(Command):
6006
 
    __doc__ = """Show hooks."""
 
5399
    """Show hooks."""
6007
5400
 
6008
5401
    hidden = True
6009
5402
 
6022
5415
                    self.outf.write("    <no hooks installed>\n")
6023
5416
 
6024
5417
 
6025
 
class cmd_remove_branch(Command):
6026
 
    __doc__ = """Remove a branch.
6027
 
 
6028
 
    This will remove the branch from the specified location but 
6029
 
    will keep any working tree or repository in place.
6030
 
 
6031
 
    :Examples:
6032
 
 
6033
 
      Remove the branch at repo/trunk::
6034
 
 
6035
 
        bzr remove-branch repo/trunk
6036
 
 
6037
 
    """
6038
 
 
6039
 
    takes_args = ["location?"]
6040
 
 
6041
 
    aliases = ["rmbranch"]
6042
 
 
6043
 
    def run(self, location=None):
6044
 
        if location is None:
6045
 
            location = "."
6046
 
        branch = Branch.open_containing(location)[0]
6047
 
        branch.bzrdir.destroy_branch()
6048
 
 
6049
 
 
6050
5418
class cmd_shelve(Command):
6051
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5419
    """Temporarily set aside some changes from the current tree.
6052
5420
 
6053
5421
    Shelve allows you to temporarily put changes you've made "on the shelf",
6054
5422
    ie. out of the way, until a later time when you can bring them back from
6070
5438
 
6071
5439
    You can put multiple items on the shelf, and by default, 'unshelve' will
6072
5440
    restore the most recently shelved changes.
6073
 
 
6074
 
    For complicated changes, it is possible to edit the changes in a separate
6075
 
    editor program to decide what the file remaining in the working copy
6076
 
    should look like.  To do this, add the configuration option
6077
 
 
6078
 
        change_editor = PROGRAM @new_path @old_path
6079
 
 
6080
 
    where @new_path is replaced with the path of the new version of the 
6081
 
    file and @old_path is replaced with the path of the old version of 
6082
 
    the file.  The PROGRAM should save the new file with the desired 
6083
 
    contents of the file in the working tree.
6084
 
        
6085
5441
    """
6086
5442
 
6087
5443
    takes_args = ['file*']
6088
5444
 
6089
5445
    takes_options = [
6090
 
        'directory',
6091
5446
        'revision',
6092
5447
        Option('all', help='Shelve all changes.'),
6093
5448
        'message',
6099
5454
        Option('destroy',
6100
5455
               help='Destroy removed changes instead of shelving them.'),
6101
5456
    ]
6102
 
    _see_also = ['unshelve', 'configuration']
 
5457
    _see_also = ['unshelve']
6103
5458
 
6104
5459
    def run(self, revision=None, all=False, file_list=None, message=None,
6105
 
            writer=None, list=False, destroy=False, directory=None):
 
5460
            writer=None, list=False, destroy=False):
6106
5461
        if list:
6107
 
            return self.run_for_list(directory=directory)
 
5462
            return self.run_for_list()
6108
5463
        from bzrlib.shelf_ui import Shelver
6109
5464
        if writer is None:
6110
5465
            writer = bzrlib.option.diff_writer_registry.get()
6111
5466
        try:
6112
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6113
 
                file_list, message, destroy=destroy, directory=directory)
6114
 
            try:
6115
 
                shelver.run()
6116
 
            finally:
6117
 
                shelver.finalize()
 
5467
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5468
                              message, destroy=destroy).run()
6118
5469
        except errors.UserAbort:
6119
5470
            return 0
6120
5471
 
6121
 
    def run_for_list(self, directory=None):
6122
 
        if directory is None:
6123
 
            directory = u'.'
6124
 
        tree = WorkingTree.open_containing(directory)[0]
6125
 
        self.add_cleanup(tree.lock_read().unlock)
6126
 
        manager = tree.get_shelf_manager()
6127
 
        shelves = manager.active_shelves()
6128
 
        if len(shelves) == 0:
6129
 
            note('No shelved changes.')
6130
 
            return 0
6131
 
        for shelf_id in reversed(shelves):
6132
 
            message = manager.get_metadata(shelf_id).get('message')
6133
 
            if message is None:
6134
 
                message = '<no message>'
6135
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
6136
 
        return 1
 
5472
    def run_for_list(self):
 
5473
        tree = WorkingTree.open_containing('.')[0]
 
5474
        tree.lock_read()
 
5475
        try:
 
5476
            manager = tree.get_shelf_manager()
 
5477
            shelves = manager.active_shelves()
 
5478
            if len(shelves) == 0:
 
5479
                note('No shelved changes.')
 
5480
                return 0
 
5481
            for shelf_id in reversed(shelves):
 
5482
                message = manager.get_metadata(shelf_id).get('message')
 
5483
                if message is None:
 
5484
                    message = '<no message>'
 
5485
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5486
            return 1
 
5487
        finally:
 
5488
            tree.unlock()
6137
5489
 
6138
5490
 
6139
5491
class cmd_unshelve(Command):
6140
 
    __doc__ = """Restore shelved changes.
 
5492
    """Restore shelved changes.
6141
5493
 
6142
5494
    By default, the most recently shelved changes are restored. However if you
6143
5495
    specify a shelf by id those changes will be restored instead.  This works
6146
5498
 
6147
5499
    takes_args = ['shelf_id?']
6148
5500
    takes_options = [
6149
 
        'directory',
6150
5501
        RegistryOption.from_kwargs(
6151
5502
            'action', help="The action to perform.",
6152
5503
            enum_switch=False, value_switches=True,
6153
5504
            apply="Apply changes and remove from the shelf.",
6154
5505
            dry_run="Show changes, but do not apply or remove them.",
6155
 
            preview="Instead of unshelving the changes, show the diff that "
6156
 
                    "would result from unshelving.",
6157
 
            delete_only="Delete changes without applying them.",
6158
 
            keep="Apply changes but don't delete them.",
 
5506
            delete_only="Delete changes without applying them."
6159
5507
        )
6160
5508
    ]
6161
5509
    _see_also = ['shelve']
6162
5510
 
6163
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5511
    def run(self, shelf_id=None, action='apply'):
6164
5512
        from bzrlib.shelf_ui import Unshelver
6165
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6166
 
        try:
6167
 
            unshelver.run()
6168
 
        finally:
6169
 
            unshelver.tree.unlock()
 
5513
        Unshelver.from_args(shelf_id, action).run()
6170
5514
 
6171
5515
 
6172
5516
class cmd_clean_tree(Command):
6173
 
    __doc__ = """Remove unwanted files from working tree.
 
5517
    """Remove unwanted files from working tree.
6174
5518
 
6175
5519
    By default, only unknown files, not ignored files, are deleted.  Versioned
6176
5520
    files are never deleted.
6184
5528
 
6185
5529
    To check what clean-tree will do, use --dry-run.
6186
5530
    """
6187
 
    takes_options = ['directory',
6188
 
                     Option('ignored', help='Delete all ignored files.'),
6189
 
                     Option('detritus', help='Delete conflict files, merge and revert'
 
5531
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5532
                     Option('detritus', help='Delete conflict files, merge'
6190
5533
                            ' backups, and failed selftest dirs.'),
6191
5534
                     Option('unknown',
6192
5535
                            help='Delete files unknown to bzr (default).'),
6194
5537
                            ' deleting them.'),
6195
5538
                     Option('force', help='Do not prompt before deleting.')]
6196
5539
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6197
 
            force=False, directory=u'.'):
 
5540
            force=False):
6198
5541
        from bzrlib.clean_tree import clean_tree
6199
5542
        if not (unknown or ignored or detritus):
6200
5543
            unknown = True
6201
5544
        if dry_run:
6202
5545
            force = True
6203
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6204
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5546
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5547
                   dry_run=dry_run, no_prompt=force)
6205
5548
 
6206
5549
 
6207
5550
class cmd_reference(Command):
6208
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5551
    """list, view and set branch locations for nested trees.
6209
5552
 
6210
5553
    If no arguments are provided, lists the branch locations for nested trees.
6211
5554
    If one argument is provided, display the branch location for that tree.
6251
5594
            self.outf.write('%s %s\n' % (path, location))
6252
5595
 
6253
5596
 
6254
 
class cmd_export_pot(Command):
6255
 
    __doc__ = """Export command helps and error messages in po format."""
6256
 
 
6257
 
    hidden = True
6258
 
 
6259
 
    def run(self):
6260
 
        from bzrlib.export_pot import export_pot
6261
 
        export_pot(self.outf)
6262
 
 
6263
 
 
6264
 
def _register_lazy_builtins():
6265
 
    # register lazy builtins from other modules; called at startup and should
6266
 
    # be only called once.
6267
 
    for (name, aliases, module_name) in [
6268
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6269
 
        ('cmd_config', [], 'bzrlib.config'),
6270
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6271
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6272
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6273
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6274
 
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6275
 
        ('cmd_verify_signatures', [],
6276
 
                                        'bzrlib.commit_signature_commands'),
6277
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6278
 
        ]:
6279
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5597
# these get imported and then picked up by the scan for cmd_*
 
5598
# TODO: Some more consistent way to split command definitions across files;
 
5599
# we do need to load at least some information about them to know of
 
5600
# aliases.  ideally we would avoid loading the implementation until the
 
5601
# details were needed.
 
5602
from bzrlib.cmd_version_info import cmd_version_info
 
5603
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5604
from bzrlib.bundle.commands import (
 
5605
    cmd_bundle_info,
 
5606
    )
 
5607
from bzrlib.foreign import cmd_dpush
 
5608
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5609
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5610
        cmd_weave_plan_merge, cmd_weave_merge_text