~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2009-04-02 05:53:12 UTC
  • mto: This revision was merged to the branch mainline in revision 4242.
  • Revision ID: andrew.bennetts@canonical.com-20090402055312-h7mvgumvm7e620mj
Fix nits in spelling and naming.

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):
88
 
    """
89
 
    Return a tree and list of absolute paths from a file list.
90
 
 
91
 
    Similar to tree_files, but add handles files a bit differently, so it a
92
 
    custom implementation.  In particular, MutableTreeTree.smart_add expects
93
 
    absolute paths, which it immediately converts to relative paths.
94
 
    """
95
 
    # FIXME Would be nice to just return the relative paths like
96
 
    # internal_tree_files does, but there are a large number of unit tests
97
 
    # that assume the current interface to mutabletree.smart_add
 
82
    """Add handles files a bit differently so it a custom implementation."""
98
83
    if file_list:
99
 
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
84
        tree = WorkingTree.open_containing(file_list[0])[0]
100
85
        if tree.supports_views():
101
86
            view_files = tree.views.lookup_view()
102
87
            if view_files:
103
88
                for filename in file_list:
104
89
                    if not osutils.is_inside_any(view_files, filename):
105
90
                        raise errors.FileOutsideView(filename, view_files)
106
 
        file_list = file_list[:]
107
 
        file_list[0] = tree.abspath(relpath)
108
91
    else:
109
92
        tree = WorkingTree.open_containing(u'.')[0]
110
93
        if tree.supports_views():
112
95
            if view_files:
113
96
                file_list = view_files
114
97
                view_str = views.view_display_str(view_files)
115
 
                note("Ignoring files outside view. View is %s" % view_str)
 
98
                note("ignoring files outside view: %s" % view_str)
116
99
    return tree, file_list
117
100
 
118
101
 
127
110
 
128
111
 
129
112
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
113
    if branch is None:
140
114
        branch = tree.branch
141
115
    if revisions is None:
151
125
 
152
126
# XXX: Bad function name; should possibly also be a class method of
153
127
# WorkingTree rather than a function.
154
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
128
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
129
    apply_view=True):
157
130
    """Convert command-line paths to a WorkingTree and relative paths.
158
131
 
159
 
    Deprecated: use WorkingTree.open_containing_paths instead.
160
 
 
161
132
    This is typically used for command-line processors that take one or
162
133
    more filenames, and infer the workingtree that contains them.
163
134
 
173
144
 
174
145
    :return: workingtree, [relative_paths]
175
146
    """
176
 
    return WorkingTree.open_containing_paths(
177
 
        file_list, default_directory='.',
178
 
        canonicalize=True,
179
 
        apply_view=True)
 
147
    if file_list is None or len(file_list) == 0:
 
148
        tree = WorkingTree.open_containing(default_branch)[0]
 
149
        if tree.supports_views() and apply_view:
 
150
            view_files = tree.views.lookup_view()
 
151
            if view_files:
 
152
                file_list = view_files
 
153
                view_str = views.view_display_str(view_files)
 
154
                note("ignoring files outside view: %s" % view_str)
 
155
        return tree, file_list
 
156
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
157
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
158
        apply_view=apply_view)
 
159
 
 
160
 
 
161
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
162
    """Convert file_list into a list of relpaths in tree.
 
163
 
 
164
    :param tree: A tree to operate on.
 
165
    :param file_list: A list of user provided paths or None.
 
166
    :param apply_view: if True and a view is set, apply it or check that
 
167
        specified files are within it
 
168
    :return: A list of relative paths.
 
169
    :raises errors.PathNotChild: When a provided path is in a different tree
 
170
        than tree.
 
171
    """
 
172
    if file_list is None:
 
173
        return None
 
174
    if tree.supports_views() and apply_view:
 
175
        view_files = tree.views.lookup_view()
 
176
    else:
 
177
        view_files = []
 
178
    new_list = []
 
179
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
180
    # doesn't - fix that up here before we enter the loop.
 
181
    if canonicalize:
 
182
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
183
    else:
 
184
        fixer = tree.relpath
 
185
    for filename in file_list:
 
186
        try:
 
187
            relpath = fixer(osutils.dereference_path(filename))
 
188
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
189
                raise errors.FileOutsideView(filename, view_files)
 
190
            new_list.append(relpath)
 
191
        except errors.PathNotChild:
 
192
            raise errors.FileInWrongBranch(tree.branch, filename)
 
193
    return new_list
180
194
 
181
195
 
182
196
def _get_view_info_for_change_reporter(tree):
191
205
    return view_info
192
206
 
193
207
 
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
208
# TODO: Make sure no commands unconditionally use the working directory as a
203
209
# branch.  If a filename argument is used, the first of them should be used to
204
210
# specify the branch.  (Perhaps this can be factored out into some kind of
206
212
# opens the branch?)
207
213
 
208
214
class cmd_status(Command):
209
 
    __doc__ = """Display status summary.
 
215
    """Display status summary.
210
216
 
211
217
    This reports on versioned and unknown files, reporting them
212
218
    grouped by state.  Possible states are:
232
238
    unknown
233
239
        Not versioned and not matching an ignore pattern.
234
240
 
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
241
    To see ignored files use 'bzr ignored'.  For details on the
241
242
    changes to file texts, use 'bzr diff'.
242
243
 
254
255
    To skip the display of pending merge information altogether, use
255
256
    the no-pending option or specify a file/directory.
256
257
 
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'.
 
258
    If a revision argument is given, the status is calculated against
 
259
    that revision, or between two revisions if two are provided.
263
260
    """
264
261
 
265
262
    # TODO: --no-recurse, --recurse options
272
269
                            short_name='V'),
273
270
                     Option('no-pending', help='Don\'t show pending merges.',
274
271
                           ),
275
 
                     Option('no-classify',
276
 
                            help='Do not mark object type using indicator.',
277
 
                           ),
278
272
                     ]
279
273
    aliases = ['st', 'stat']
280
274
 
283
277
 
284
278
    @display_command
285
279
    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):
 
280
            versioned=False, no_pending=False, verbose=False):
288
281
        from bzrlib.status import show_tree_status
289
282
 
290
283
        if revision and len(revision) > 2:
291
284
            raise errors.BzrCommandError('bzr status --revision takes exactly'
292
285
                                         ' one or two revision specifiers')
293
286
 
294
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
287
        tree, relfile_list = tree_files(file_list)
295
288
        # Avoid asking for specific files when that is not needed.
296
289
        if relfile_list == ['']:
297
290
            relfile_list = None
304
297
        show_tree_status(tree, show_ids=show_ids,
305
298
                         specific_files=relfile_list, revision=revision,
306
299
                         to_file=self.outf, short=short, versioned=versioned,
307
 
                         show_pending=(not no_pending), verbose=verbose,
308
 
                         classify=not no_classify)
 
300
                         show_pending=(not no_pending), verbose=verbose)
309
301
 
310
302
 
311
303
class cmd_cat_revision(Command):
312
 
    __doc__ = """Write out metadata for a revision.
 
304
    """Write out metadata for a revision.
313
305
 
314
306
    The revision to print can either be specified by a specific
315
307
    revision identifier, or you can use --revision.
317
309
 
318
310
    hidden = True
319
311
    takes_args = ['revision_id?']
320
 
    takes_options = ['directory', 'revision']
 
312
    takes_options = ['revision']
321
313
    # cat-revision is more for frontends so should be exact
322
314
    encoding = 'strict'
323
315
 
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
316
    @display_command
333
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
317
    def run(self, revision_id=None, revision=None):
334
318
        if revision_id is not None and revision is not None:
335
319
            raise errors.BzrCommandError('You can only supply one of'
336
320
                                         ' revision_id or --revision')
337
321
        if revision_id is None and revision is None:
338
322
            raise errors.BzrCommandError('You must supply either'
339
323
                                         ' --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
 
        
 
324
        b = WorkingTree.open_containing(u'.')[0].branch
 
325
 
 
326
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
327
        if revision_id is not None:
 
328
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
329
            try:
 
330
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
331
            except errors.NoSuchRevision:
 
332
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
333
                    revision_id)
 
334
                raise errors.BzrCommandError(msg)
 
335
        elif revision is not None:
 
336
            for rev in revision:
 
337
                if rev is None:
 
338
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
339
                                                 ' revision.')
 
340
                rev_id = rev.as_revision_id(b)
 
341
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
342
 
369
343
 
370
344
class cmd_dump_btree(Command):
371
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
345
    """Dump the contents of a btree index file to stdout.
372
346
 
373
347
    PATH is a btree index file, it can be any URL. This includes things like
374
348
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
396
                self.outf.write(page_bytes[:header_end])
423
397
                page_bytes = data
424
398
            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')
 
399
            decomp_bytes = zlib.decompress(page_bytes)
 
400
            self.outf.write(decomp_bytes)
 
401
            self.outf.write('\n')
431
402
 
432
403
    def _dump_entries(self, trans, basename):
433
404
        try:
441
412
        for node in bt.iter_all_entries():
442
413
            # Node is made up of:
443
414
            # (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,))
 
415
            self.outf.write('%s\n' % (node[1:],))
452
416
 
453
417
 
454
418
class cmd_remove_tree(Command):
455
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
419
    """Remove the working tree from a given branch/checkout.
456
420
 
457
421
    Since a lightweight checkout is little more than a working tree
458
422
    this will refuse to run against one.
460
424
    To re-create the working tree, use "bzr checkout".
461
425
    """
462
426
    _see_also = ['checkout', 'working-trees']
463
 
    takes_args = ['location*']
 
427
    takes_args = ['location?']
464
428
    takes_options = [
465
429
        Option('force',
466
430
               help='Remove the working tree even if it has '
467
 
                    'uncommitted or shelved changes.'),
 
431
                    'uncommitted changes.'),
468
432
        ]
469
433
 
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)
 
434
    def run(self, location='.', force=False):
 
435
        d = bzrdir.BzrDir.open(location)
 
436
 
 
437
        try:
 
438
            working = d.open_workingtree()
 
439
        except errors.NoWorkingTree:
 
440
            raise errors.BzrCommandError("No working tree to remove")
 
441
        except errors.NotLocalUrl:
 
442
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
443
                                         "remote path")
523
444
        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)
 
445
            changes = working.changes_from(working.basis_tree())
 
446
            if changes.has_changed():
 
447
                raise errors.UncommittedChanges(working)
 
448
 
 
449
        working_path = working.bzrdir.root_transport.base
 
450
        branch_path = working.branch.bzrdir.root_transport.base
 
451
        if working_path != branch_path:
 
452
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
453
                                         "a lightweight checkout")
 
454
 
 
455
        d.destroy_workingtree()
548
456
 
549
457
 
550
458
class cmd_revno(Command):
551
 
    __doc__ = """Show current revision number.
 
459
    """Show current revision number.
552
460
 
553
461
    This is equal to the number of revisions on this branch.
554
462
    """
555
463
 
556
464
    _see_also = ['info']
557
465
    takes_args = ['location?']
558
 
    takes_options = [
559
 
        Option('tree', help='Show revno of working tree'),
560
 
        ]
561
466
 
562
467
    @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')
 
468
    def run(self, location=u'.'):
 
469
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
470
        self.outf.write('\n')
582
471
 
583
472
 
584
473
class cmd_revision_info(Command):
585
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
474
    """Show revision number and revision id for a given revision identifier.
586
475
    """
587
476
    hidden = True
588
477
    takes_args = ['revision_info*']
589
478
    takes_options = [
590
479
        'revision',
591
 
        custom_help('directory',
 
480
        Option('directory',
592
481
            help='Branch to examine, '
593
 
                 'rather than the one containing the working directory.'),
594
 
        Option('tree', help='Show revno of working tree'),
 
482
                 'rather than the one containing the working directory.',
 
483
            short_name='d',
 
484
            type=unicode,
 
485
            ),
595
486
        ]
596
487
 
597
488
    @display_command
598
 
    def run(self, revision=None, directory=u'.', tree=False,
599
 
            revision_info_list=[]):
 
489
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
600
490
 
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 = []
 
491
        revs = []
610
492
        if revision is not None:
611
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
493
            revs.extend(revision)
612
494
        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:
 
495
            for rev in revision_info_list:
 
496
                revs.append(RevisionSpec.from_string(rev))
 
497
 
 
498
        b = Branch.open_containing(directory)[0]
 
499
 
 
500
        if len(revs) == 0:
 
501
            revs.append(RevisionSpec.from_string('-1'))
 
502
 
 
503
        for rev in revs:
 
504
            revision_id = rev.as_revision_id(b)
628
505
            try:
629
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
630
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
506
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
631
507
            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]))
 
508
                dotted_map = b.get_revision_id_to_revno_map()
 
509
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
510
            print '%s %s' % (revno, revision_id)
639
511
 
640
512
 
641
513
class cmd_add(Command):
642
 
    __doc__ = """Add specified files or directories.
 
514
    """Add specified files or directories.
643
515
 
644
516
    In non-recursive mode, all the named items are added, regardless
645
517
    of whether they were previously ignored.  A warning is given if
671
543
    branches that will be merged later (without showing the two different
672
544
    adds as a conflict). It is also useful when merging another project
673
545
    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
546
    """
678
547
    takes_args = ['file*']
679
548
    takes_options = [
687
556
               help='Lookup file ids from this tree.'),
688
557
        ]
689
558
    encoding_type = 'replace'
690
 
    _see_also = ['remove', 'ignore']
 
559
    _see_also = ['remove']
691
560
 
692
561
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
693
562
            file_ids_from=None):
710
579
                should_print=(not is_quiet()))
711
580
 
712
581
        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()
 
582
            base_tree.lock_read()
 
583
        try:
 
584
            file_list = self._maybe_expand_globs(file_list)
 
585
            tree, file_list = tree_files_for_add(file_list)
 
586
            added, ignored = tree.smart_add(file_list, not
 
587
                no_recurse, action=action, save=not dry_run)
 
588
        finally:
 
589
            if base_tree is not None:
 
590
                base_tree.unlock()
718
591
        if len(ignored) > 0:
719
592
            if verbose:
720
593
                for glob in sorted(ignored.keys()):
721
594
                    for path in ignored[glob]:
722
595
                        self.outf.write("ignored %s matching \"%s\"\n"
723
596
                                        % (path, glob))
 
597
            else:
 
598
                match_len = 0
 
599
                for glob, paths in ignored.items():
 
600
                    match_len += len(paths)
 
601
                self.outf.write("ignored %d file(s).\n" % match_len)
 
602
            self.outf.write("If you wish to add some of these files,"
 
603
                            " please add them by name.\n")
724
604
 
725
605
 
726
606
class cmd_mkdir(Command):
727
 
    __doc__ = """Create a new versioned directory.
 
607
    """Create a new versioned directory.
728
608
 
729
609
    This is equivalent to creating the directory and then adding it.
730
610
    """
734
614
 
735
615
    def run(self, dir_list):
736
616
        for d in dir_list:
 
617
            os.mkdir(d)
737
618
            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)
 
619
            wt.add([dd])
 
620
            self.outf.write('added %s\n' % d)
746
621
 
747
622
 
748
623
class cmd_relpath(Command):
749
 
    __doc__ = """Show path of a file relative to root"""
 
624
    """Show path of a file relative to root"""
750
625
 
751
626
    takes_args = ['filename']
752
627
    hidden = True
761
636
 
762
637
 
763
638
class cmd_inventory(Command):
764
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
639
    """Show inventory of the current working copy or a revision.
765
640
 
766
641
    It is possible to limit the output to a particular entry
767
642
    type using the --kind option.  For example: --kind file.
787
662
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
788
663
 
789
664
        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()
 
665
        work_tree, file_list = tree_files(file_list)
 
666
        work_tree.lock_read()
 
667
        try:
 
668
            if revision is not None:
 
669
                tree = revision.as_tree(work_tree.branch)
 
670
 
 
671
                extra_trees = [work_tree]
 
672
                tree.lock_read()
 
673
            else:
 
674
                tree = work_tree
 
675
                extra_trees = []
 
676
 
 
677
            if file_list is not None:
 
678
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
679
                                          require_versioned=True)
 
680
                # find_ids_across_trees may include some paths that don't
 
681
                # exist in 'tree'.
 
682
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
683
                                 for file_id in file_ids if file_id in tree)
 
684
            else:
 
685
                entries = tree.inventory.entries()
 
686
        finally:
 
687
            tree.unlock()
 
688
            if tree is not work_tree:
 
689
                work_tree.unlock()
 
690
 
813
691
        for path, entry in entries:
814
692
            if kind and kind != entry.kind:
815
693
                continue
821
699
 
822
700
 
823
701
class cmd_mv(Command):
824
 
    __doc__ = """Move or rename a file.
 
702
    """Move or rename a file.
825
703
 
826
704
    :Usage:
827
705
        bzr mv OLDNAME NEWNAME
844
722
    takes_args = ['names*']
845
723
    takes_options = [Option("after", help="Move only the bzr identifier"
846
724
        " of the file, because the file has already been moved."),
847
 
        Option('auto', help='Automatically guess renames.'),
848
 
        Option('dry-run', help='Avoid making changes when guessing renames.'),
849
725
        ]
850
726
    aliases = ['move', 'rename']
851
727
    encoding_type = 'replace'
852
728
 
853
 
    def run(self, names_list, after=False, auto=False, dry_run=False):
854
 
        if auto:
855
 
            return self.run_auto(names_list, after, dry_run)
856
 
        elif dry_run:
857
 
            raise errors.BzrCommandError('--dry-run requires --auto.')
 
729
    def run(self, names_list, after=False):
858
730
        if names_list is None:
859
731
            names_list = []
 
732
 
860
733
        if len(names_list) < 2:
861
734
            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)
865
 
 
866
 
    def run_auto(self, names_list, after, dry_run):
867
 
        if names_list is not None and len(names_list) > 1:
868
 
            raise errors.BzrCommandError('Only one path may be specified to'
869
 
                                         ' --auto.')
870
 
        if after:
871
 
            raise errors.BzrCommandError('--after cannot be specified with'
872
 
                                         ' --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)
 
735
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
736
        tree.lock_write()
 
737
        try:
 
738
            self._run(tree, names_list, rel_names, after)
 
739
        finally:
 
740
            tree.unlock()
877
741
 
878
742
    def _run(self, tree, names_list, rel_names, after):
879
743
        into_existing = osutils.isdir(names_list[-1])
900
764
            # All entries reference existing inventory items, so fix them up
901
765
            # for cicp file-systems.
902
766
            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))
 
767
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
768
                self.outf.write("%s => %s\n" % pair)
906
769
        else:
907
770
            if len(names_list) != 2:
908
771
                raise errors.BzrCommandError('to mv multiple files the'
952
815
            dest = osutils.pathjoin(dest_parent, dest_tail)
953
816
            mutter("attempting to move %s => %s", src, dest)
954
817
            tree.rename_one(src, dest, after=after)
955
 
            if not is_quiet():
956
 
                self.outf.write("%s => %s\n" % (src, dest))
 
818
            self.outf.write("%s => %s\n" % (src, dest))
957
819
 
958
820
 
959
821
class cmd_pull(Command):
960
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
822
    """Turn this branch into a mirror of another branch.
961
823
 
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.
 
824
    This command only works on branches that have not diverged.  Branches are
 
825
    considered diverged if the destination branch's most recent commit is one
 
826
    that has not been merged (directly or indirectly) into the parent.
966
827
 
967
828
    If branches have diverged, you can use 'bzr merge' to integrate the changes
968
829
    from one into the other.  Once one branch has merged, the other should
969
830
    be able to pull it again.
970
831
 
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.
 
832
    If you want to forget your local changes and just update your branch to
 
833
    match the remote one, use pull --overwrite.
974
834
 
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.
 
835
    If there is no default location set, the first pull will set it.  After
 
836
    that, you can omit the location to use the default.  To change the
 
837
    default, use --remember. The value will only be saved if the remote
 
838
    location can be accessed.
979
839
 
980
840
    Note: The location can be specified either in the form of a branch,
981
841
    or in the form of a path to a file containing a merge directive generated
986
846
    takes_options = ['remember', 'overwrite', 'revision',
987
847
        custom_help('verbose',
988
848
            help='Show logs of pulled revisions.'),
989
 
        custom_help('directory',
 
849
        Option('directory',
990
850
            help='Branch to pull into, '
991
 
                 'rather than the one containing the working directory.'),
992
 
        Option('local',
993
 
            help="Perform a local pull in a bound "
994
 
                 "branch.  Local pulls are not applied to "
995
 
                 "the master branch."
 
851
                 'rather than the one containing the working directory.',
 
852
            short_name='d',
 
853
            type=unicode,
996
854
            ),
997
 
        Option('show-base',
998
 
            help="Show base revision text in conflicts.")
999
855
        ]
1000
856
    takes_args = ['location?']
1001
857
    encoding_type = 'replace'
1002
858
 
1003
 
    def run(self, location=None, remember=None, overwrite=False,
 
859
    def run(self, location=None, remember=False, overwrite=False,
1004
860
            revision=None, verbose=False,
1005
 
            directory=None, local=False,
1006
 
            show_base=False):
 
861
            directory=None):
1007
862
        # FIXME: too much stuff is in the command class
1008
863
        revision_id = None
1009
864
        mergeable = None
1012
867
        try:
1013
868
            tree_to = WorkingTree.open_containing(directory)[0]
1014
869
            branch_to = tree_to.branch
1015
 
            self.add_cleanup(tree_to.lock_write().unlock)
1016
870
        except errors.NoWorkingTree:
1017
871
            tree_to = None
1018
872
            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
 
 
1024
 
        if local and not branch_to.get_bound_location():
1025
 
            raise errors.LocalRequiresBoundBranch()
1026
873
 
1027
874
        possible_transports = []
1028
875
        if location is not None:
1056
903
        else:
1057
904
            branch_from = Branch.open(location,
1058
905
                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)):
 
906
 
 
907
            if branch_to.get_parent() is None or remember:
1063
908
                branch_to.set_parent(branch_from.base)
1064
909
 
1065
910
        if revision is not None:
1066
911
            revision_id = revision.as_revision_id(branch_from)
1067
912
 
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)
 
913
        branch_to.lock_write()
 
914
        try:
 
915
            if tree_to is not None:
 
916
                view_info = _get_view_info_for_change_reporter(tree_to)
 
917
                change_reporter = delta._ChangeReporter(
 
918
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
 
919
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
920
                                      change_reporter,
 
921
                                      possible_transports=possible_transports)
 
922
            else:
 
923
                result = branch_to.pull(branch_from, overwrite, revision_id)
1080
924
 
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
 
925
            result.report(self.outf)
 
926
            if verbose and result.old_revid != result.new_revid:
 
927
                log.show_branch_change(branch_to, self.outf, result.old_revno,
 
928
                                       result.old_revid)
 
929
        finally:
 
930
            branch_to.unlock()
1090
931
 
1091
932
 
1092
933
class cmd_push(Command):
1093
 
    __doc__ = """Update a mirror of this branch.
 
934
    """Update a mirror of this branch.
1094
935
 
1095
936
    The target branch will not have its working tree populated because this
1096
937
    is both expensive, and is not supported on remote file systems.
1109
950
    do a merge (see bzr help merge) from the other branch, and commit that.
1110
951
    After that you will be able to do a push without '--overwrite'.
1111
952
 
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.
 
953
    If there is no default push location set, the first push will set it.
 
954
    After that, you can omit the location to use the default.  To change the
 
955
    default, use --remember. The value will only be saved if the remote
 
956
    location can be accessed.
1116
957
    """
1117
958
 
1118
959
    _see_also = ['pull', 'update', 'working-trees']
1120
961
        Option('create-prefix',
1121
962
               help='Create the path leading up to the branch '
1122
963
                    'if it does not already exist.'),
1123
 
        custom_help('directory',
 
964
        Option('directory',
1124
965
            help='Branch to push from, '
1125
 
                 'rather than the one containing the working directory.'),
 
966
                 'rather than the one containing the working directory.',
 
967
            short_name='d',
 
968
            type=unicode,
 
969
            ),
1126
970
        Option('use-existing-dir',
1127
971
               help='By default push will fail if the target'
1128
972
                    ' directory exists, but does not already'
1136
980
                'for the commit history. Only the work not present in the '
1137
981
                'referenced branch is included in the branch created.',
1138
982
            type=unicode),
1139
 
        Option('strict',
1140
 
               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."),
1145
983
        ]
1146
984
    takes_args = ['location?']
1147
985
    encoding_type = 'replace'
1148
986
 
1149
 
    def run(self, location=None, remember=None, overwrite=False,
 
987
    def run(self, location=None, remember=False, overwrite=False,
1150
988
        create_prefix=False, verbose=False, revision=None,
1151
989
        use_existing_dir=False, directory=None, stacked_on=None,
1152
 
        stacked=False, strict=None, no_tree=False):
 
990
        stacked=False):
1153
991
        from bzrlib.push import _show_push_branch
1154
992
 
 
993
        # Get the source branch and revision_id
1155
994
        if directory is None:
1156
995
            directory = '.'
1157
 
        # Get the source branch
1158
 
        (tree, br_from,
1159
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1160
 
        # Get the tip's revision_id
 
996
        br_from = Branch.open_containing(directory)[0]
1161
997
        revision = _get_one_revision('push', revision)
1162
998
        if revision is not None:
1163
999
            revision_id = revision.in_history(br_from).rev_id
1164
1000
        else:
1165
 
            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.')
 
1001
            revision_id = br_from.last_revision()
 
1002
 
1171
1003
        # Get the stacked_on branch, if any
1172
1004
        if stacked_on is not None:
1173
1005
            stacked_on = urlutils.normalize_url(stacked_on)
1195
1027
            else:
1196
1028
                display_url = urlutils.unescape_for_display(stored_loc,
1197
1029
                        self.outf.encoding)
1198
 
                note("Using saved push location: %s" % display_url)
 
1030
                self.outf.write("Using saved push location: %s\n" % display_url)
1199
1031
                location = stored_loc
1200
1032
 
1201
1033
        _show_push_branch(br_from, revision_id, location, self.outf,
1202
1034
            verbose=verbose, overwrite=overwrite, remember=remember,
1203
1035
            stacked_on=stacked_on, create_prefix=create_prefix,
1204
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1036
            use_existing_dir=use_existing_dir)
1205
1037
 
1206
1038
 
1207
1039
class cmd_branch(Command):
1208
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1040
    """Create a new copy of a branch.
1209
1041
 
1210
1042
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1211
1043
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1216
1048
 
1217
1049
    To retrieve the branch as of a particular revision, supply the --revision
1218
1050
    parameter, as in "branch foo/bar -r 5".
1219
 
 
1220
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1221
1051
    """
1222
1052
 
1223
1053
    _see_also = ['checkout']
1224
1054
    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."),
 
1055
    takes_options = ['revision', Option('hardlink',
 
1056
        help='Hard-link working tree files where possible.'),
1229
1057
        Option('no-tree',
1230
1058
            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
1059
        Option('stacked',
1235
1060
            help='Create a stacked branch referring to the source branch. '
1236
1061
                'The new branch will depend on the availability of the source '
1237
1062
                'branch for all operations.'),
1238
1063
        Option('standalone',
1239
1064
               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
1065
        ]
1248
1066
    aliases = ['get', 'clone']
1249
1067
 
1250
1068
    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
 
1069
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1255
1070
        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')
 
1071
 
1262
1072
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1263
1073
            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
1268
 
            accelerator_tree = None
1269
 
        if files_from is not None and files_from != from_location:
1270
 
            accelerator_tree = WorkingTree.open(files_from)
1271
1074
        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)
 
1075
        br_from.lock_read()
1283
1076
        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)
 
1077
            if revision is not None:
 
1078
                revision_id = revision.as_revision_id(br_from)
1289
1079
            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'))
 
1080
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1081
                # None or perhaps NULL_REVISION to mean copy nothing
 
1082
                # RBC 20060209
 
1083
                revision_id = br_from.last_revision()
 
1084
            if to_location is None:
 
1085
                to_location = urlutils.derive_to_location(from_location)
 
1086
            to_transport = transport.get_transport(to_location)
 
1087
            try:
 
1088
                to_transport.mkdir('.')
 
1089
            except errors.FileExists:
 
1090
                raise errors.BzrCommandError('Target directory "%s" already'
 
1091
                                             ' exists.' % to_location)
 
1092
            except errors.NoSuchFile:
 
1093
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1094
                                             % to_location)
 
1095
            try:
 
1096
                # preserve whatever source format we have.
 
1097
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1098
                                            possible_transports=[to_transport],
 
1099
                                            accelerator_tree=accelerator_tree,
 
1100
                                            hardlink=hardlink, stacked=stacked,
 
1101
                                            force_new_repo=standalone,
 
1102
                                            create_tree_if_local=not no_tree,
 
1103
                                            source_branch=br_from)
 
1104
                branch = dir.open_branch()
 
1105
            except errors.NoSuchRevision:
 
1106
                to_transport.delete_tree('.')
 
1107
                msg = "The branch %s has no revision %s." % (from_location,
 
1108
                    revision)
 
1109
                raise errors.BzrCommandError(msg)
 
1110
            _merge_tags_if_possible(br_from, branch)
 
1111
            # If the source branch is stacked, the new branch may
 
1112
            # be stacked whether we asked for that explicitly or not.
 
1113
            # We therefore need a try/except here and not just 'if stacked:'
 
1114
            try:
 
1115
                note('Created new stacked branch referring to %s.' %
 
1116
                    branch.get_stacked_on_url())
 
1117
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1118
                errors.UnstackableRepositoryFormat), e:
 
1119
                note('Branched %d revision(s).' % branch.revno())
 
1120
        finally:
 
1121
            br_from.unlock()
1335
1122
 
1336
1123
 
1337
1124
class cmd_checkout(Command):
1338
 
    __doc__ = """Create a new checkout of an existing branch.
 
1125
    """Create a new checkout of an existing branch.
1339
1126
 
1340
1127
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1341
1128
    the branch found in '.'. This is useful if you have removed the working tree
1380
1167
            to_location = branch_location
1381
1168
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1382
1169
            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
1170
        revision = _get_one_revision('checkout', revision)
1389
 
        if files_from is not None and files_from != branch_location:
 
1171
        if files_from is not None:
1390
1172
            accelerator_tree = WorkingTree.open(files_from)
1391
1173
        if revision is not None:
1392
1174
            revision_id = revision.as_revision_id(source)
1409
1191
 
1410
1192
 
1411
1193
class cmd_renames(Command):
1412
 
    __doc__ = """Show list of renamed files.
 
1194
    """Show list of renamed files.
1413
1195
    """
1414
1196
    # TODO: Option to show renames between two historical versions.
1415
1197
 
1420
1202
    @display_command
1421
1203
    def run(self, dir=u'.'):
1422
1204
        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))
 
1205
        tree.lock_read()
 
1206
        try:
 
1207
            new_inv = tree.inventory
 
1208
            old_tree = tree.basis_tree()
 
1209
            old_tree.lock_read()
 
1210
            try:
 
1211
                old_inv = old_tree.inventory
 
1212
                renames = []
 
1213
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1214
                for f, paths, c, v, p, n, k, e in iterator:
 
1215
                    if paths[0] == paths[1]:
 
1216
                        continue
 
1217
                    if None in (paths):
 
1218
                        continue
 
1219
                    renames.append(paths)
 
1220
                renames.sort()
 
1221
                for old_name, new_name in renames:
 
1222
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1223
            finally:
 
1224
                old_tree.unlock()
 
1225
        finally:
 
1226
            tree.unlock()
1439
1227
 
1440
1228
 
1441
1229
class cmd_update(Command):
1442
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1230
    """Update a tree to have the latest code committed to its branch.
1443
1231
 
1444
1232
    This will perform a merge into the working tree, and may generate
1445
1233
    conflicts. If you have any local changes, you will still
1447
1235
 
1448
1236
    If you want to discard your local changes, you can just do a
1449
1237
    '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
1238
    """
1457
1239
 
1458
1240
    _see_also = ['pull', 'working-trees', 'status-flags']
1459
1241
    takes_args = ['dir?']
1460
 
    takes_options = ['revision',
1461
 
                     Option('show-base',
1462
 
                            help="Show base revision text in conflicts."),
1463
 
                     ]
1464
1242
    aliases = ['up']
1465
1243
 
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")
 
1244
    def run(self, dir='.'):
1470
1245
        tree = WorkingTree.open_containing(dir)[0]
1471
 
        branch = tree.branch
1472
1246
        possible_transports = []
1473
 
        master = branch.get_master_branch(
 
1247
        master = tree.branch.get_master_branch(
1474
1248
            possible_transports=possible_transports)
1475
1249
        if master is not None:
1476
 
            branch_location = master.base
1477
1250
            tree.lock_write()
1478
1251
        else:
1479
 
            branch_location = tree.branch.base
1480
1252
            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
1253
        try:
 
1254
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1255
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1256
            if last_rev == _mod_revision.ensure_null(
 
1257
                tree.branch.last_revision()):
 
1258
                # may be up to date, check master too.
 
1259
                if master is None or last_rev == _mod_revision.ensure_null(
 
1260
                    master.last_revision()):
 
1261
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1262
                    note("Tree is up to date at revision %d." % (revno,))
 
1263
                    return 0
 
1264
            view_info = _get_view_info_for_change_reporter(tree)
1508
1265
            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
 
1266
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1267
                view_info=view_info), possible_transports=possible_transports)
 
1268
            revno = tree.branch.revision_id_to_revno(
 
1269
                _mod_revision.ensure_null(tree.last_revision()))
 
1270
            note('Updated to revision %d.' % (revno,))
 
1271
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1272
                note('Your local commits will now show as pending merges with '
 
1273
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1274
            if conflicts != 0:
 
1275
                return 1
 
1276
            else:
 
1277
                return 0
 
1278
        finally:
 
1279
            tree.unlock()
1532
1280
 
1533
1281
 
1534
1282
class cmd_info(Command):
1535
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1283
    """Show information about a working tree, branch or repository.
1536
1284
 
1537
1285
    This command will show all known locations and formats associated to the
1538
1286
    tree, branch or repository.
1553
1301
      basic statistics (like the number of files in the working tree and
1554
1302
      number of revisions in the branch and repository):
1555
1303
 
1556
 
        bzr info -v
 
1304
        bzr -v info
1557
1305
 
1558
1306
      Display the above together with number of committers to the branch:
1559
1307
 
1560
 
        bzr info -vv
 
1308
        bzr -vv info
1561
1309
    """
1562
1310
    _see_also = ['revno', 'working-trees', 'repositories']
1563
1311
    takes_args = ['location?']
1576
1324
 
1577
1325
 
1578
1326
class cmd_remove(Command):
1579
 
    __doc__ = """Remove files or directories.
 
1327
    """Remove files or directories.
1580
1328
 
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.
 
1329
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1330
    them if they can easily be recovered using revert. If no options or
 
1331
    parameters are given bzr will scan for files that are being tracked by bzr
 
1332
    but missing in your tree and stop tracking them for you.
1586
1333
    """
1587
1334
    takes_args = ['file*']
1588
1335
    takes_options = ['verbose',
1590
1337
        RegistryOption.from_kwargs('file-deletion-strategy',
1591
1338
            'The file deletion mode to be used.',
1592
1339
            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.',
 
1340
            safe='Only delete files if they can be'
 
1341
                 ' safely recovered (default).',
 
1342
            keep="Don't delete any files.",
1596
1343
            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)')]
 
1344
                'recovered and even if they are non-empty directories.')]
1599
1345
    aliases = ['rm', 'del']
1600
1346
    encoding_type = 'replace'
1601
1347
 
1602
1348
    def run(self, file_list, verbose=False, new=False,
1603
1349
        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)
 
1350
        tree, file_list = tree_files(file_list)
1610
1351
 
1611
1352
        if file_list is not None:
1612
1353
            file_list = [f for f in file_list]
1613
1354
 
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'))
 
1355
        tree.lock_write()
 
1356
        try:
 
1357
            # Heuristics should probably all move into tree.remove_smart or
 
1358
            # some such?
 
1359
            if new:
 
1360
                added = tree.changes_from(tree.basis_tree(),
 
1361
                    specific_files=file_list).added
 
1362
                file_list = sorted([f[0] for f in added], reverse=True)
 
1363
                if len(file_list) == 0:
 
1364
                    raise errors.BzrCommandError('No matching files.')
 
1365
            elif file_list is None:
 
1366
                # missing files show up in iter_changes(basis) as
 
1367
                # versioned-with-no-kind.
 
1368
                missing = []
 
1369
                for change in tree.iter_changes(tree.basis_tree()):
 
1370
                    # Find paths in the working tree that have no kind:
 
1371
                    if change[1][1] is not None and change[6][1] is None:
 
1372
                        missing.append(change[1][1])
 
1373
                file_list = sorted(missing, reverse=True)
 
1374
                file_deletion_strategy = 'keep'
 
1375
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1376
                keep_files=file_deletion_strategy=='keep',
 
1377
                force=file_deletion_strategy=='force')
 
1378
        finally:
 
1379
            tree.unlock()
1636
1380
 
1637
1381
 
1638
1382
class cmd_file_id(Command):
1639
 
    __doc__ = """Print file_id of a particular file or directory.
 
1383
    """Print file_id of a particular file or directory.
1640
1384
 
1641
1385
    The file_id is assigned when the file is first added and remains the
1642
1386
    same through all revisions where the file exists, even when it is
1658
1402
 
1659
1403
 
1660
1404
class cmd_file_path(Command):
1661
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1405
    """Print path of file_ids to a file or directory.
1662
1406
 
1663
1407
    This prints one line for each directory down to the target,
1664
1408
    starting at the branch root.
1680
1424
 
1681
1425
 
1682
1426
class cmd_reconcile(Command):
1683
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1427
    """Reconcile bzr metadata in a branch.
1684
1428
 
1685
1429
    This can correct data mismatches that may have been caused by
1686
1430
    previous ghost operations or bzr upgrades. You should only
1700
1444
 
1701
1445
    _see_also = ['check']
1702
1446
    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
1447
 
1710
 
    def run(self, branch=".", canonicalize_chks=False):
 
1448
    def run(self, branch="."):
1711
1449
        from bzrlib.reconcile import reconcile
1712
1450
        dir = bzrdir.BzrDir.open(branch)
1713
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1451
        reconcile(dir)
1714
1452
 
1715
1453
 
1716
1454
class cmd_revision_history(Command):
1717
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1455
    """Display the list of revision ids on a branch."""
1718
1456
 
1719
1457
    _see_also = ['log']
1720
1458
    takes_args = ['location?']
1730
1468
 
1731
1469
 
1732
1470
class cmd_ancestry(Command):
1733
 
    __doc__ = """List all revisions merged into this branch."""
 
1471
    """List all revisions merged into this branch."""
1734
1472
 
1735
1473
    _see_also = ['log', 'revision-history']
1736
1474
    takes_args = ['location?']
1748
1486
            b = wt.branch
1749
1487
            last_revision = wt.last_revision()
1750
1488
 
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
 
1489
        revision_ids = b.repository.get_ancestry(last_revision)
 
1490
        revision_ids.pop(0)
 
1491
        for revision_id in revision_ids:
1758
1492
            self.outf.write(revision_id + '\n')
1759
1493
 
1760
1494
 
1761
1495
class cmd_init(Command):
1762
 
    __doc__ = """Make a directory into a versioned branch.
 
1496
    """Make a directory into a versioned branch.
1763
1497
 
1764
1498
    Use this to create an empty branch, or before importing an
1765
1499
    existing project.
1793
1527
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1794
1528
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1795
1529
                value_switches=True,
1796
 
                title="Branch format",
 
1530
                title="Branch Format",
1797
1531
                ),
1798
1532
         Option('append-revisions-only',
1799
1533
                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.')
 
1534
                '  Append revisions to it only.')
1803
1535
         ]
1804
1536
    def run(self, location=None, format=None, append_revisions_only=False,
1805
 
            create_prefix=False, no_tree=False):
 
1537
            create_prefix=False):
1806
1538
        if format is None:
1807
1539
            format = bzrdir.format_registry.make_bzrdir('default')
1808
1540
        if location is None:
1824
1556
                    "\nYou may supply --create-prefix to create all"
1825
1557
                    " leading parent directories."
1826
1558
                    % location)
1827
 
            to_transport.create_prefix()
 
1559
            _create_prefix(to_transport)
1828
1560
 
1829
1561
        try:
1830
1562
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1831
1563
        except errors.NotBranchError:
1832
1564
            # really a NotBzrDir error...
1833
1565
            create_branch = bzrdir.BzrDir.create_branch_convenience
1834
 
            if no_tree:
1835
 
                force_new_tree = False
1836
 
            else:
1837
 
                force_new_tree = None
1838
1566
            branch = create_branch(to_transport.base, format=format,
1839
 
                                   possible_transports=[to_transport],
1840
 
                                   force_new_tree=force_new_tree)
 
1567
                                   possible_transports=[to_transport])
1841
1568
            a_bzrdir = branch.bzrdir
1842
1569
        else:
1843
1570
            from bzrlib.transport.local import LocalTransport
1847
1574
                        raise errors.BranchExistsWithoutWorkingTree(location)
1848
1575
                raise errors.AlreadyBranchError(location)
1849
1576
            branch = a_bzrdir.create_branch()
1850
 
            if not no_tree:
1851
 
                a_bzrdir.create_workingtree()
 
1577
            a_bzrdir.create_workingtree()
1852
1578
        if append_revisions_only:
1853
1579
            try:
1854
1580
                branch.set_append_revisions_only(True)
1855
1581
            except errors.UpgradeRequired:
1856
1582
                raise errors.BzrCommandError('This branch format cannot be set'
1857
 
                    ' to append-revisions-only.  Try --default.')
 
1583
                    ' to append-revisions-only.  Try --experimental-branch6')
1858
1584
        if not is_quiet():
1859
1585
            from bzrlib.info import describe_layout, describe_format
1860
1586
            try:
1876
1602
 
1877
1603
 
1878
1604
class cmd_init_repository(Command):
1879
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1605
    """Create a shared repository to hold branches.
1880
1606
 
1881
1607
    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.
 
1608
    revisions in the repository, not in the branch directory.
1885
1609
 
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.
 
1610
    If the --no-trees option is used then the branches in the repository
 
1611
    will not have working trees by default.
1892
1612
 
1893
1613
    :Examples:
1894
 
        Create a shared repository holding just branches::
 
1614
        Create a shared repositories holding just branches::
1895
1615
 
1896
1616
            bzr init-repo --no-trees repo
1897
1617
            bzr init repo/trunk
1936
1656
 
1937
1657
 
1938
1658
class cmd_diff(Command):
1939
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1659
    """Show differences in the working tree, between revisions or branches.
1940
1660
 
1941
1661
    If no arguments are given, all changes for the current tree are listed.
1942
1662
    If files are given, only the changes in those files are listed.
1948
1668
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1949
1669
    produces patches suitable for "patch -p1".
1950
1670
 
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
1671
    :Exit values:
1959
1672
        1 - changed
1960
1673
        2 - unrepresentable changes
1970
1683
 
1971
1684
            bzr diff -r1
1972
1685
 
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..
 
1686
        Difference between revision 2 and revision 1::
 
1687
 
 
1688
            bzr diff -r1..2
 
1689
 
 
1690
        Difference between revision 2 and revision 1 for branch xxx::
 
1691
 
 
1692
            bzr diff -r1..2 xxx
1999
1693
 
2000
1694
        Show just the differences for file NEWS::
2001
1695
 
2016
1710
        Same as 'bzr diff' but prefix paths with old/ and new/::
2017
1711
 
2018
1712
            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
1713
    """
2024
1714
    _see_also = ['status']
2025
1715
    takes_args = ['file*']
2044
1734
            help='Use this command to compare files.',
2045
1735
            type=unicode,
2046
1736
            ),
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
1737
        ]
2053
1738
    aliases = ['di', 'dif']
2054
1739
    encoding_type = 'exact'
2055
1740
 
2056
1741
    @display_command
2057
1742
    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)
 
1743
            prefix=None, old=None, new=None, using=None):
 
1744
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
2061
1745
 
2062
1746
        if (prefix is None) or (prefix == '0'):
2063
1747
            # diff -p0 format
2077
1761
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
2078
1762
                                         ' one or two revision specifiers')
2079
1763
 
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()
 
1764
        old_tree, new_tree, specific_files, extra_trees = \
 
1765
                _get_trees_to_diff(file_list, revision, old, new,
 
1766
                apply_view=True)
2090
1767
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2091
1768
                               specific_files=specific_files,
2092
1769
                               external_diff_options=diff_options,
2093
1770
                               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)
 
1771
                               extra_trees=extra_trees, using=using)
2098
1772
 
2099
1773
 
2100
1774
class cmd_deleted(Command):
2101
 
    __doc__ = """List files deleted in the working tree.
 
1775
    """List files deleted in the working tree.
2102
1776
    """
2103
1777
    # TODO: Show files deleted since a previous revision, or
2104
1778
    # between two revisions.
2107
1781
    # level of effort but possibly much less IO.  (Or possibly not,
2108
1782
    # if the directories are very large...)
2109
1783
    _see_also = ['status', 'ls']
2110
 
    takes_options = ['directory', 'show-ids']
 
1784
    takes_options = ['show-ids']
2111
1785
 
2112
1786
    @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')
 
1787
    def run(self, show_ids=False):
 
1788
        tree = WorkingTree.open_containing(u'.')[0]
 
1789
        tree.lock_read()
 
1790
        try:
 
1791
            old = tree.basis_tree()
 
1792
            old.lock_read()
 
1793
            try:
 
1794
                for path, ie in old.inventory.iter_entries():
 
1795
                    if not tree.has_id(ie.file_id):
 
1796
                        self.outf.write(path)
 
1797
                        if show_ids:
 
1798
                            self.outf.write(' ')
 
1799
                            self.outf.write(ie.file_id)
 
1800
                        self.outf.write('\n')
 
1801
            finally:
 
1802
                old.unlock()
 
1803
        finally:
 
1804
            tree.unlock()
2125
1805
 
2126
1806
 
2127
1807
class cmd_modified(Command):
2128
 
    __doc__ = """List files modified in working tree.
 
1808
    """List files modified in working tree.
2129
1809
    """
2130
1810
 
2131
1811
    hidden = True
2132
1812
    _see_also = ['status', 'ls']
2133
 
    takes_options = ['directory', 'null']
 
1813
    takes_options = [
 
1814
            Option('null',
 
1815
                   help='Write an ascii NUL (\\0) separator '
 
1816
                   'between files rather than a newline.')
 
1817
            ]
2134
1818
 
2135
1819
    @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)
 
1820
    def run(self, null=False):
 
1821
        tree = WorkingTree.open_containing(u'.')[0]
2139
1822
        td = tree.changes_from(tree.basis_tree())
2140
 
        self.cleanup_now()
2141
1823
        for path, id, kind, text_modified, meta_modified in td.modified:
2142
1824
            if null:
2143
1825
                self.outf.write(path + '\0')
2146
1828
 
2147
1829
 
2148
1830
class cmd_added(Command):
2149
 
    __doc__ = """List files added in working tree.
 
1831
    """List files added in working tree.
2150
1832
    """
2151
1833
 
2152
1834
    hidden = True
2153
1835
    _see_also = ['status', 'ls']
2154
 
    takes_options = ['directory', 'null']
 
1836
    takes_options = [
 
1837
            Option('null',
 
1838
                   help='Write an ascii NUL (\\0) separator '
 
1839
                   'between files rather than a newline.')
 
1840
            ]
2155
1841
 
2156
1842
    @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')
 
1843
    def run(self, null=False):
 
1844
        wt = WorkingTree.open_containing(u'.')[0]
 
1845
        wt.lock_read()
 
1846
        try:
 
1847
            basis = wt.basis_tree()
 
1848
            basis.lock_read()
 
1849
            try:
 
1850
                basis_inv = basis.inventory
 
1851
                inv = wt.inventory
 
1852
                for file_id in inv:
 
1853
                    if file_id in basis_inv:
 
1854
                        continue
 
1855
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1856
                        continue
 
1857
                    path = inv.id2path(file_id)
 
1858
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1859
                        continue
 
1860
                    if null:
 
1861
                        self.outf.write(path + '\0')
 
1862
                    else:
 
1863
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1864
            finally:
 
1865
                basis.unlock()
 
1866
        finally:
 
1867
            wt.unlock()
2176
1868
 
2177
1869
 
2178
1870
class cmd_root(Command):
2179
 
    __doc__ = """Show the tree root directory.
 
1871
    """Show the tree root directory.
2180
1872
 
2181
1873
    The root is the nearest enclosing directory with a .bzr control
2182
1874
    directory."""
2206
1898
 
2207
1899
 
2208
1900
class cmd_log(Command):
2209
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1901
    """Show historical log for a branch or subset of a branch.
2210
1902
 
2211
1903
    log is bzr's default tool for exploring the history of a branch.
2212
1904
    The branch to use is taken from the first parameter. If no parameters
2241
1933
        --show-ids  display revision-ids (and file-ids), not just revnos
2242
1934
 
2243
1935
      Note that the default number of levels to display is a function of the
2244
 
      log format. If the -n option is not used, the standard log formats show
2245
 
      just the top level (mainline).
 
1936
      log format. If the -n option is not used, ``short`` and ``line`` show
 
1937
      just the top level (mainline) while ``long`` shows all levels of merged
 
1938
      revisions.
2246
1939
 
2247
1940
      Status summaries are shown using status flags like A, M, etc. To see
2248
1941
      the changes explained using words like ``added`` and ``modified``
2284
1977
 
2285
1978
    :Path filtering:
2286
1979
 
2287
 
      If parameters are given and the first one is not a branch, the log
2288
 
      will be filtered to show only those revisions that changed the
2289
 
      nominated files or directories.
 
1980
      If a parameter is given and it's not a branch, the log will be filtered
 
1981
      to show only those revisions that changed the nominated file or
 
1982
      directory.
2290
1983
 
2291
1984
      Filenames are interpreted within their historical context. To log a
2292
1985
      deleted file, specify a revision range so that the file existed at
2315
2008
      explicitly ask for this (and no way to stop logging a file back
2316
2009
      until it was last renamed).
2317
2010
 
 
2011
      Note: If the path is a directory, only revisions that directly changed
 
2012
      that directory object are currently shown. This is considered a bug.
 
2013
      (Support for filtering against multiple files and for files within a
 
2014
      directory is under development.)
 
2015
 
2318
2016
    :Other filtering:
2319
2017
 
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.
 
2018
      The --message option can be used for finding revisions that match a
 
2019
      regular expression in a commit message.
2325
2020
 
2326
2021
    :Tips & tricks:
2327
2022
 
2328
2023
      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>.  
 
2024
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2025
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2026
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2027
 
 
2028
      Web interfaces are often better at exploring history than command line
 
2029
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2030
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2333
2031
 
2334
2032
      You may find it useful to add the aliases below to ``bazaar.conf``::
2335
2033
 
2336
2034
        [ALIASES]
2337
 
        tip = log -r-1
2338
 
        top = log -l10 --line
2339
 
        show = log -v -p
 
2035
        tip = log -r-1 -n1
 
2036
        top = log -r-10.. --short --forward
 
2037
        show = log -v -p -n1 --long
2340
2038
 
2341
2039
      ``bzr tip`` will then show the latest revision while ``bzr top``
2342
2040
      will show the last 10 mainline revisions. To see the details of a
2343
2041
      particular revision X,  ``bzr show -rX``.
2344
2042
 
2345
 
      If you are interested in looking deeper into a particular merge X,
2346
 
      use ``bzr log -n0 -rX``.
 
2043
      As many GUI tools and Web interfaces do, you may prefer viewing
 
2044
      history collapsed initially. If you are interested in looking deeper
 
2045
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
 
2046
      working this way, you may wish to either:
 
2047
 
 
2048
      * change your default log format to short (or line)
 
2049
      * add this alias: log = log -n1
2347
2050
 
2348
2051
      ``bzr log -v`` on a branch with lots of history is currently
2349
2052
      very slow. A fix for this issue is currently under development.
2357
2060
 
2358
2061
      When exploring non-mainline history on large projects with deep
2359
2062
      history, the performance of log can be greatly improved by installing
2360
 
      the historycache plugin. This plugin buffers historical information
 
2063
      the revnocache plugin. This plugin buffers historical information
2361
2064
      trading disk space for faster speed.
2362
2065
    """
2363
 
    takes_args = ['file*']
 
2066
    takes_args = ['location?']
2364
2067
    _see_also = ['log-formats', 'revisionspec']
2365
2068
    takes_options = [
2366
2069
            Option('forward',
2376
2079
                   help='Show just the specified revision.'
2377
2080
                   ' See also "help revisionspec".'),
2378
2081
            '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
2082
            Option('levels',
2385
2083
                   short_name='n',
2386
2084
                   help='Number of levels to display - 0 for all, 1 for flat.',
2387
2085
                   argname='N',
2388
2086
                   type=_parse_levels),
2389
2087
            Option('message',
 
2088
                   short_name='m',
2390
2089
                   help='Show revisions whose message matches this '
2391
2090
                        'regular expression.',
2392
 
                   type=str,
2393
 
                   hidden=True),
 
2091
                   type=str),
2394
2092
            Option('limit',
2395
2093
                   short_name='l',
2396
2094
                   help='Limit the output to the first N revisions.',
2399
2097
            Option('show-diff',
2400
2098
                   short_name='p',
2401
2099
                   help='Show changes made in each revision as a patch.'),
2402
 
            Option('include-merges',
2403
 
                   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
2100
            ]
2432
2101
    encoding_type = 'replace'
2433
2102
 
2434
2103
    @display_command
2435
 
    def run(self, file_list=None, timezone='original',
 
2104
    def run(self, location=None, timezone='original',
2436
2105
            verbose=False,
2437
2106
            show_ids=False,
2438
2107
            forward=False,
2442
2111
            levels=None,
2443
2112
            message=None,
2444
2113
            limit=None,
2445
 
            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
 
            ):
2456
 
        from bzrlib.log import (
2457
 
            Logger,
2458
 
            make_log_request_dict,
2459
 
            _get_info_for_log_files,
2460
 
            )
 
2114
            show_diff=False):
 
2115
        from bzrlib.log import show_log, _get_fileid_to_log
2461
2116
        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
 
        if include_merges:
2467
 
            if levels is None:
2468
 
                levels = 0
2469
 
            else:
2470
 
                raise errors.BzrCommandError(
2471
 
                    '--levels and --include-merges are mutually exclusive')
2472
2117
 
2473
2118
        if change is not None:
2474
2119
            if len(change) > 1:
2479
2124
            else:
2480
2125
                revision = change
2481
2126
 
2482
 
        file_ids = []
2483
 
        filter_by_dir = False
2484
 
        if file_list:
2485
 
            # 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)
2488
 
            for relpath, file_id, kind in file_info_list:
 
2127
        # log everything
 
2128
        file_id = None
 
2129
        if location:
 
2130
            # find the file id to log:
 
2131
 
 
2132
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2133
                location)
 
2134
            if fp != '':
 
2135
                file_id = _get_fileid_to_log(revision, tree, b, fp)
2489
2136
                if file_id is None:
2490
2137
                    raise errors.BzrCommandError(
2491
2138
                        "Path unknown at end or start of revision range: %s" %
2492
 
                        relpath)
2493
 
                # If the relpath is the top of the tree, we log everything
2494
 
                if relpath == '':
2495
 
                    file_ids = []
2496
 
                    break
2497
 
                else:
2498
 
                    file_ids.append(file_id)
2499
 
                filter_by_dir = filter_by_dir or (
2500
 
                    kind in ['directory', 'tree-reference'])
 
2139
                        location)
2501
2140
        else:
2502
 
            # log everything
 
2141
            # local dir only
2503
2142
            # FIXME ? log the current subdir only RBC 20060203
2504
2143
            if revision is not None \
2505
2144
                    and len(revision) > 0 and revision[0].get_branch():
2508
2147
                location = '.'
2509
2148
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2510
2149
            b = dir.open_branch()
2511
 
            self.add_cleanup(b.lock_read().unlock)
 
2150
 
 
2151
        b.lock_read()
 
2152
        try:
2512
2153
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2513
 
 
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
 
        # Decide on the type of delta & diff filtering to use
2522
 
        # TODO: add an --all-files option to make this configurable & consistent
2523
 
        if not verbose:
2524
 
            delta_type = None
2525
 
        else:
2526
 
            delta_type = 'full'
2527
 
        if not show_diff:
2528
 
            diff_type = None
2529
 
        elif file_ids:
2530
 
            diff_type = 'partial'
2531
 
        else:
2532
 
            diff_type = 'full'
2533
 
 
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)
 
2154
            if log_format is None:
 
2155
                log_format = log.log_formatter_registry.get_default(b)
 
2156
 
 
2157
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2158
                            show_timezone=timezone,
 
2159
                            delta_format=get_verbosity_level(),
 
2160
                            levels=levels)
 
2161
 
 
2162
            show_log(b,
 
2163
                     lf,
 
2164
                     file_id,
 
2165
                     verbose=verbose,
 
2166
                     direction=direction,
 
2167
                     start_revision=rev1,
 
2168
                     end_revision=rev2,
 
2169
                     search=message,
 
2170
                     limit=limit,
 
2171
                     show_diff=show_diff)
 
2172
        finally:
 
2173
            b.unlock()
2587
2174
 
2588
2175
 
2589
2176
def _get_revision_range(revisionspec_list, branch, command_name):
2590
2177
    """Take the input of a revision option and turn it into a revision range.
2591
2178
 
2592
2179
    It returns RevisionInfo objects which can be used to obtain the rev_id's
2593
 
    of the desired revisions. It does some user input validations.
 
2180
    of the desired revisons. It does some user input validations.
2594
2181
    """
2595
2182
    if revisionspec_list is None:
2596
2183
        rev1 = None
2607
2194
            raise errors.BzrCommandError(
2608
2195
                "bzr %s doesn't accept two revisions in different"
2609
2196
                " 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)
 
2197
        rev1 = start_spec.in_history(branch)
2615
2198
        # Avoid loading all of history when we know a missing
2616
2199
        # end of range means the last revision ...
2617
2200
        if end_spec.spec is None:
2646
2229
 
2647
2230
 
2648
2231
class cmd_touching_revisions(Command):
2649
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2232
    """Return revision-ids which affected a particular file.
2650
2233
 
2651
2234
    A more user-friendly interface is "bzr log FILE".
2652
2235
    """
2657
2240
    @display_command
2658
2241
    def run(self, filename):
2659
2242
        tree, relpath = WorkingTree.open_containing(filename)
 
2243
        b = tree.branch
2660
2244
        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:
 
2245
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2665
2246
            self.outf.write("%6d %s\n" % (revno, what))
2666
2247
 
2667
2248
 
2668
2249
class cmd_ls(Command):
2669
 
    __doc__ = """List files in a tree.
 
2250
    """List files in a tree.
2670
2251
    """
2671
2252
 
2672
2253
    _see_also = ['status', 'cat']
2673
2254
    takes_args = ['path?']
 
2255
    # TODO: Take a revision or remote path and list that tree instead.
2674
2256
    takes_options = [
2675
2257
            'verbose',
2676
2258
            'revision',
2677
 
            Option('recursive', short_name='R',
2678
 
                   help='Recurse into subdirectories.'),
 
2259
            Option('non-recursive',
 
2260
                   help='Don\'t recurse into subdirectories.'),
2679
2261
            Option('from-root',
2680
2262
                   help='Print paths relative to the root of the branch.'),
2681
 
            Option('unknown', short_name='u',
2682
 
                help='Print unknown files.'),
 
2263
            Option('unknown', help='Print unknown files.'),
2683
2264
            Option('versioned', help='Print versioned files.',
2684
2265
                   short_name='V'),
2685
 
            Option('ignored', short_name='i',
2686
 
                help='Print ignored files.'),
2687
 
            Option('kind', short_name='k',
 
2266
            Option('ignored', help='Print ignored files.'),
 
2267
            Option('null',
 
2268
                   help='Write an ascii NUL (\\0) separator '
 
2269
                   'between files rather than a newline.'),
 
2270
            Option('kind',
2688
2271
                   help='List entries of a particular kind: file, directory, symlink.',
2689
2272
                   type=unicode),
2690
 
            'null',
2691
2273
            'show-ids',
2692
 
            'directory',
2693
2274
            ]
2694
2275
    @display_command
2695
2276
    def run(self, revision=None, verbose=False,
2696
 
            recursive=False, from_root=False,
 
2277
            non_recursive=False, from_root=False,
2697
2278
            unknown=False, versioned=False, ignored=False,
2698
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2279
            null=False, kind=None, show_ids=False, path=None):
2699
2280
 
2700
2281
        if kind and kind not in ('file', 'directory', 'symlink'):
2701
2282
            raise errors.BzrCommandError('invalid kind specified')
2708
2289
 
2709
2290
        if path is None:
2710
2291
            fs_path = '.'
 
2292
            prefix = ''
2711
2293
        else:
2712
2294
            if from_root:
2713
2295
                raise errors.BzrCommandError('cannot specify both --from-root'
2714
2296
                                             ' and PATH')
2715
2297
            fs_path = path
2716
 
        tree, branch, relpath = \
2717
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2718
 
 
2719
 
        # Calculate the prefix to use
2720
 
        prefix = None
 
2298
            prefix = path
 
2299
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2300
            fs_path)
2721
2301
        if from_root:
2722
 
            if relpath:
2723
 
                prefix = relpath + '/'
2724
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2725
 
            prefix = fs_path + '/'
2726
 
 
 
2302
            relpath = u''
 
2303
        elif relpath:
 
2304
            relpath += '/'
2727
2305
        if revision is not None or tree is None:
2728
2306
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2729
2307
 
2733
2311
            if view_files:
2734
2312
                apply_view = True
2735
2313
                view_str = views.view_display_str(view_files)
2736
 
                note("Ignoring files outside view. View is %s" % view_str)
2737
 
 
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
2755
 
 
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:
2782
 
                    self.outf.write(outstring + '\n')
 
2314
                note("ignoring files outside view: %s" % view_str)
 
2315
 
 
2316
        tree.lock_read()
 
2317
        try:
 
2318
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2319
                if fp.startswith(relpath):
 
2320
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
2321
                    if non_recursive and '/' in fp:
 
2322
                        continue
 
2323
                    if not all and not selection[fc]:
 
2324
                        continue
 
2325
                    if kind is not None and fkind != kind:
 
2326
                        continue
 
2327
                    if apply_view:
 
2328
                        try:
 
2329
                            views.check_path_in_view(tree, fp)
 
2330
                        except errors.FileOutsideView:
 
2331
                            continue
 
2332
                    kindch = entry.kind_character()
 
2333
                    outstring = fp + kindch
 
2334
                    if verbose:
 
2335
                        outstring = '%-8s %s' % (fc, outstring)
 
2336
                        if show_ids and fid is not None:
 
2337
                            outstring = "%-50s %s" % (outstring, fid)
 
2338
                        self.outf.write(outstring + '\n')
 
2339
                    elif null:
 
2340
                        self.outf.write(fp + '\0')
 
2341
                        if show_ids:
 
2342
                            if fid is not None:
 
2343
                                self.outf.write(fid)
 
2344
                            self.outf.write('\0')
 
2345
                        self.outf.flush()
 
2346
                    else:
 
2347
                        if fid is not None:
 
2348
                            my_id = fid
 
2349
                        else:
 
2350
                            my_id = ''
 
2351
                        if show_ids:
 
2352
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2353
                        else:
 
2354
                            self.outf.write(outstring + '\n')
 
2355
        finally:
 
2356
            tree.unlock()
2783
2357
 
2784
2358
 
2785
2359
class cmd_unknowns(Command):
2786
 
    __doc__ = """List unknown files.
 
2360
    """List unknown files.
2787
2361
    """
2788
2362
 
2789
2363
    hidden = True
2790
2364
    _see_also = ['ls']
2791
 
    takes_options = ['directory']
2792
2365
 
2793
2366
    @display_command
2794
 
    def run(self, directory=u'.'):
2795
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2367
    def run(self):
 
2368
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2796
2369
            self.outf.write(osutils.quotefn(f) + '\n')
2797
2370
 
2798
2371
 
2799
2372
class cmd_ignore(Command):
2800
 
    __doc__ = """Ignore specified files or patterns.
 
2373
    """Ignore specified files or patterns.
2801
2374
 
2802
2375
    See ``bzr help patterns`` for details on the syntax of patterns.
2803
2376
 
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
2377
    To remove patterns from the ignore list, edit the .bzrignore file.
2811
2378
    After adding, editing or deleting that file either indirectly by
2812
2379
    using this command or directly by using an editor, be sure to commit
2813
2380
    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.
 
2381
 
 
2382
    Note: ignore patterns containing shell wildcards must be quoted from
 
2383
    the shell on Unix.
2835
2384
 
2836
2385
    :Examples:
2837
2386
        Ignore the top level Makefile::
2838
2387
 
2839
2388
            bzr ignore ./Makefile
2840
2389
 
2841
 
        Ignore .class files in all directories...::
 
2390
        Ignore class files in all directories::
2842
2391
 
2843
2392
            bzr ignore "*.class"
2844
2393
 
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
2394
        Ignore .o files under the lib directory::
2854
2395
 
2855
2396
            bzr ignore "lib/**/*.o"
2861
2402
        Ignore everything but the "debian" toplevel directory::
2862
2403
 
2863
2404
            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
2405
    """
2872
2406
 
2873
2407
    _see_also = ['status', 'ignored', 'patterns']
2874
2408
    takes_args = ['name_pattern*']
2875
 
    takes_options = ['directory',
2876
 
        Option('default-rules',
2877
 
               help='Display the default ignore rules that bzr uses.')
 
2409
    takes_options = [
 
2410
        Option('old-default-rules',
 
2411
               help='Write out the ignore rules bzr < 0.9 always used.')
2878
2412
        ]
2879
2413
 
2880
 
    def run(self, name_pattern_list=None, default_rules=None,
2881
 
            directory=u'.'):
 
2414
    def run(self, name_pattern_list=None, old_default_rules=None):
2882
2415
        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)
 
2416
        if old_default_rules is not None:
 
2417
            # dump the rules and exit
 
2418
            for pattern in ignores.OLD_DEFAULTS:
 
2419
                print pattern
2887
2420
            return
2888
2421
        if not name_pattern_list:
2889
2422
            raise errors.BzrCommandError("ignore requires at least one "
2890
 
                "NAME_PATTERN or --default-rules.")
 
2423
                                  "NAME_PATTERN or --old-default-rules")
2891
2424
        name_pattern_list = [globbing.normalize_pattern(p)
2892
2425
                             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
2426
        for name_pattern in name_pattern_list:
2902
2427
            if (name_pattern[0] == '/' or
2903
2428
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2904
2429
                raise errors.BzrCommandError(
2905
2430
                    "NAME_PATTERN should not be an absolute path")
2906
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2431
        tree, relpath = WorkingTree.open_containing(u'.')
2907
2432
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2908
2433
        ignored = globbing.Globster(name_pattern_list)
2909
2434
        matches = []
2910
 
        self.add_cleanup(tree.lock_read().unlock)
 
2435
        tree.lock_read()
2911
2436
        for entry in tree.list_files():
2912
2437
            id = entry[3]
2913
2438
            if id is not None:
2914
2439
                filename = entry[0]
2915
2440
                if ignored.match(filename):
2916
 
                    matches.append(filename)
 
2441
                    matches.append(filename.encode('utf-8'))
 
2442
        tree.unlock()
2917
2443
        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),))
 
2444
            print "Warning: the following files are version controlled and" \
 
2445
                  " match your ignore pattern:\n%s" \
 
2446
                  "\nThese files will continue to be version controlled" \
 
2447
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2922
2448
 
2923
2449
 
2924
2450
class cmd_ignored(Command):
2925
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2451
    """List ignored files and the patterns that matched them.
2926
2452
 
2927
2453
    List all the ignored files and the ignore pattern that caused the file to
2928
2454
    be ignored.
2934
2460
 
2935
2461
    encoding_type = 'replace'
2936
2462
    _see_also = ['ignore', 'ls']
2937
 
    takes_options = ['directory']
2938
2463
 
2939
2464
    @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))
 
2465
    def run(self):
 
2466
        tree = WorkingTree.open_containing(u'.')[0]
 
2467
        tree.lock_read()
 
2468
        try:
 
2469
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2470
                if file_class != 'I':
 
2471
                    continue
 
2472
                ## XXX: Slightly inefficient since this was already calculated
 
2473
                pat = tree.is_ignored(path)
 
2474
                self.outf.write('%-50s %s\n' % (path, pat))
 
2475
        finally:
 
2476
            tree.unlock()
2949
2477
 
2950
2478
 
2951
2479
class cmd_lookup_revision(Command):
2952
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2480
    """Lookup the revision-id from a revision-number
2953
2481
 
2954
2482
    :Examples:
2955
2483
        bzr lookup-revision 33
2956
2484
    """
2957
2485
    hidden = True
2958
2486
    takes_args = ['revno']
2959
 
    takes_options = ['directory']
2960
2487
 
2961
2488
    @display_command
2962
 
    def run(self, revno, directory=u'.'):
 
2489
    def run(self, revno):
2963
2490
        try:
2964
2491
            revno = int(revno)
2965
2492
        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)
 
2493
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2494
 
 
2495
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2970
2496
 
2971
2497
 
2972
2498
class cmd_export(Command):
2973
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2499
    """Export current or past revision to a destination directory or archive.
2974
2500
 
2975
2501
    If no revision is specified this exports the last committed revision.
2976
2502
 
2997
2523
         zip                          .zip
2998
2524
      =================       =========================
2999
2525
    """
3000
 
    encoding = 'exact'
3001
2526
    takes_args = ['dest', 'branch_or_subdir?']
3002
 
    takes_options = ['directory',
 
2527
    takes_options = [
3003
2528
        Option('format',
3004
2529
               help="Type of file to export to.",
3005
2530
               type=unicode),
3009
2534
        Option('root',
3010
2535
               type=str,
3011
2536
               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
2537
        ]
3016
2538
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3017
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2539
        root=None, filters=False):
3018
2540
        from bzrlib.export import export
3019
2541
 
3020
2542
        if branch_or_subdir is None:
3021
 
            tree = WorkingTree.open_containing(directory)[0]
 
2543
            tree = WorkingTree.open_containing(u'.')[0]
3022
2544
            b = tree.branch
3023
2545
            subdir = None
3024
2546
        else:
3027
2549
 
3028
2550
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3029
2551
        try:
3030
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
3031
 
                   per_file_timestamps=per_file_timestamps)
 
2552
            export(rev_tree, dest, format, root, subdir, filtered=filters)
3032
2553
        except errors.NoSuchExportFormat, e:
3033
2554
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3034
2555
 
3035
2556
 
3036
2557
class cmd_cat(Command):
3037
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2558
    """Write the contents of a file as of a given revision to standard output.
3038
2559
 
3039
2560
    If no revision is nominated, the last revision is used.
3040
2561
 
3043
2564
    """
3044
2565
 
3045
2566
    _see_also = ['ls']
3046
 
    takes_options = ['directory',
 
2567
    takes_options = [
3047
2568
        Option('name-from-revision', help='The path name in the old tree.'),
3048
2569
        Option('filters', help='Apply content filters to display the '
3049
2570
                'convenience form.'),
3054
2575
 
3055
2576
    @display_command
3056
2577
    def run(self, filename, revision=None, name_from_revision=False,
3057
 
            filters=False, directory=None):
 
2578
            filters=False):
3058
2579
        if revision is not None and len(revision) != 1:
3059
2580
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
3060
2581
                                         " one revision specifier")
3061
2582
        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)
 
2583
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2584
        branch.lock_read()
 
2585
        try:
 
2586
            return self._run(tree, branch, relpath, filename, revision,
 
2587
                             name_from_revision, filters)
 
2588
        finally:
 
2589
            branch.unlock()
3066
2590
 
3067
2591
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3068
2592
        filtered):
3069
2593
        if tree is None:
3070
2594
            tree = b.basis_tree()
3071
2595
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3072
 
        self.add_cleanup(rev_tree.lock_read().unlock)
3073
2596
 
3074
2597
        old_file_id = rev_tree.path2id(relpath)
3075
2598
 
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
2599
        if name_from_revision:
3081
2600
            # Try in revision if requested
3082
2601
            if old_file_id is None:
3084
2603
                    "%r is not present in revision %s" % (
3085
2604
                        filename, rev_tree.get_revision_id()))
3086
2605
            else:
3087
 
                actual_file_id = old_file_id
 
2606
                content = rev_tree.get_file_text(old_file_id)
3088
2607
        else:
3089
2608
            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:
 
2609
            found = False
 
2610
            if cur_file_id is not None:
 
2611
                # Then try with the actual file id
 
2612
                try:
 
2613
                    content = rev_tree.get_file_text(cur_file_id)
 
2614
                    found = True
 
2615
                except errors.NoSuchId:
 
2616
                    # The actual file id didn't exist at that time
 
2617
                    pass
 
2618
            if not found and old_file_id is not None:
 
2619
                # Finally try with the old file id
 
2620
                content = rev_tree.get_file_text(old_file_id)
 
2621
                found = True
 
2622
            if not found:
 
2623
                # Can't be found anywhere
3095
2624
                raise errors.BzrCommandError(
3096
2625
                    "%r is not present in revision %s" % (
3097
2626
                        filename, rev_tree.get_revision_id()))
3098
2627
        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)
 
2628
            from bzrlib.filters import (
 
2629
                ContentFilterContext,
 
2630
                filtered_output_bytes,
 
2631
                )
 
2632
            filters = rev_tree._content_filter_stack(relpath)
 
2633
            chunks = content.splitlines(True)
 
2634
            content = filtered_output_bytes(chunks, filters,
 
2635
                ContentFilterContext(relpath, rev_tree))
 
2636
            self.outf.writelines(content)
3103
2637
        else:
3104
 
            content = rev_tree.get_file_text(actual_file_id)
3105
 
        self.cleanup_now()
3106
 
        self.outf.write(content)
 
2638
            self.outf.write(content)
3107
2639
 
3108
2640
 
3109
2641
class cmd_local_time_offset(Command):
3110
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2642
    """Show the offset in seconds from GMT to local time."""
3111
2643
    hidden = True
3112
2644
    @display_command
3113
2645
    def run(self):
3114
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2646
        print osutils.local_time_offset()
3115
2647
 
3116
2648
 
3117
2649
 
3118
2650
class cmd_commit(Command):
3119
 
    __doc__ = """Commit changes into a new revision.
3120
 
 
3121
 
    An explanatory message needs to be given for each commit. This is
3122
 
    often done by using the --message option (getting the message from the
3123
 
    command line) or by using the --file option (getting the message from
3124
 
    a file). If neither of these options is given, an editor is opened for
3125
 
    the user to enter the message. To see the changed files in the
3126
 
    boilerplate text loaded into the editor, use the --show-diff option.
3127
 
 
3128
 
    By default, the entire tree is committed and the person doing the
3129
 
    commit is assumed to be the author. These defaults can be overridden
3130
 
    as explained below.
3131
 
 
3132
 
    :Selective commits:
3133
 
 
3134
 
      If selected files are specified, only changes to those files are
3135
 
      committed.  If a directory is specified then the directory and
3136
 
      everything within it is committed.
3137
 
  
3138
 
      When excludes are given, they take precedence over selected files.
3139
 
      For example, to commit only changes within foo, but not changes
3140
 
      within foo/bar::
3141
 
  
3142
 
        bzr commit foo -x foo/bar
3143
 
  
3144
 
      A selective commit after a merge is not yet supported.
3145
 
 
3146
 
    :Custom authors:
3147
 
 
3148
 
      If the author of the change is not the same person as the committer,
3149
 
      you can specify the author's name using the --author option. The
3150
 
      name should be in the same format as a committer-id, e.g.
3151
 
      "John Doe <jdoe@example.com>". If there is more than one author of
3152
 
      the change you can specify the option multiple times, once for each
3153
 
      author.
3154
 
  
3155
 
    :Checks:
3156
 
 
3157
 
      A common mistake is to forget to add a new file or directory before
3158
 
      running the commit command. The --strict option checks for unknown
3159
 
      files and aborts the commit if any are found. More advanced pre-commit
3160
 
      checks can be implemented by defining hooks. See ``bzr help hooks``
3161
 
      for details.
3162
 
 
3163
 
    :Things to note:
3164
 
 
3165
 
      If you accidentially commit the wrong changes or make a spelling
3166
 
      mistake in the commit message say, you can use the uncommit command
3167
 
      to undo it. See ``bzr help uncommit`` for details.
3168
 
 
3169
 
      Hooks can also be configured to run after a commit. This allows you
3170
 
      to trigger updates to external systems like bug trackers. The --fixes
3171
 
      option can be used to record the association between a revision and
3172
 
      one or more bugs. See ``bzr help bugs`` for details.
 
2651
    """Commit changes into a new revision.
 
2652
 
 
2653
    If no arguments are given, the entire tree is committed.
 
2654
 
 
2655
    If selected files are specified, only changes to those files are
 
2656
    committed.  If a directory is specified then the directory and everything
 
2657
    within it is committed.
 
2658
 
 
2659
    When excludes are given, they take precedence over selected files.
 
2660
    For example, too commit only changes within foo, but not changes within
 
2661
    foo/bar::
 
2662
 
 
2663
      bzr commit foo -x foo/bar
 
2664
 
 
2665
    If author of the change is not the same person as the committer, you can
 
2666
    specify the author's name using the --author option. The name should be
 
2667
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2668
    If there is more than one author of the change you can specify the option
 
2669
    multiple times, once for each author.
 
2670
 
 
2671
    A selected-file commit may fail in some cases where the committed
 
2672
    tree would be invalid. Consider::
 
2673
 
 
2674
      bzr init foo
 
2675
      mkdir foo/bar
 
2676
      bzr add foo/bar
 
2677
      bzr commit foo -m "committing foo"
 
2678
      bzr mv foo/bar foo/baz
 
2679
      mkdir foo/bar
 
2680
      bzr add foo/bar
 
2681
      bzr commit foo/bar -m "committing bar but not baz"
 
2682
 
 
2683
    In the example above, the last commit will fail by design. This gives
 
2684
    the user the opportunity to decide whether they want to commit the
 
2685
    rename at the same time, separately first, or not at all. (As a general
 
2686
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2687
 
 
2688
    Note: A selected-file commit after a merge is not yet supported.
3173
2689
    """
3174
 
 
3175
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2690
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2691
 
 
2692
    # TODO: Strict commit that fails if there are deleted files.
 
2693
    #       (what does "deleted files" mean ??)
 
2694
 
 
2695
    # TODO: Give better message for -s, --summary, used by tla people
 
2696
 
 
2697
    # XXX: verbose currently does nothing
 
2698
 
 
2699
    _see_also = ['bugs', 'uncommit']
3176
2700
    takes_args = ['selected*']
3177
2701
    takes_options = [
3178
2702
            ListOption('exclude', type=str, short_name='x',
3190
2714
             Option('strict',
3191
2715
                    help="Refuse to commit if there are unknown "
3192
2716
                    "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
2717
             ListOption('fixes', type=str,
3197
2718
                    help="Mark a bug as being fixed by this revision "
3198
2719
                         "(see \"bzr help bugs\")."),
3205
2726
                         "the master branch until a normal commit "
3206
2727
                         "is performed."
3207
2728
                    ),
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.'),
 
2729
              Option('show-diff',
 
2730
                     help='When no message is supplied, show the diff along'
 
2731
                     ' with the status summary in the message editor.'),
3215
2732
             ]
3216
2733
    aliases = ['ci', 'checkin']
3217
2734
 
3236
2753
 
3237
2754
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3238
2755
            unchanged=False, strict=False, local=False, fixes=None,
3239
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3240
 
            lossy=False):
 
2756
            author=None, show_diff=False, exclude=None):
3241
2757
        from bzrlib.errors import (
3242
2758
            PointlessCommit,
3243
2759
            ConflictsInTree,
3246
2762
        from bzrlib.msgeditor import (
3247
2763
            edit_commit_message_encoded,
3248
2764
            generate_commit_message_template,
3249
 
            make_commit_message_template_encoded,
3250
 
            set_commit_message,
 
2765
            make_commit_message_template_encoded
3251
2766
        )
3252
2767
 
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))
 
2768
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2769
        # slightly problematic to run this cross-platform.
 
2770
 
 
2771
        # TODO: do more checks that the commit will succeed before
 
2772
        # spending the user's valuable time typing a commit message.
3260
2773
 
3261
2774
        properties = {}
3262
2775
 
3263
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
2776
        tree, selected_list = tree_files(selected_list)
3264
2777
        if selected_list == ['']:
3265
2778
            # workaround - commit of root of tree should be exactly the same
3266
2779
            # as just default commit in that tree, and succeed even though
3277
2790
        if local and not tree.branch.get_bound_location():
3278
2791
            raise errors.LocalRequiresBoundBranch()
3279
2792
 
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
2793
        def get_message(commit_obj):
3302
2794
            """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,
 
2795
            my_message = message
 
2796
            if my_message is None and not file:
 
2797
                t = make_commit_message_template_encoded(tree,
3315
2798
                        selected_list, diff=show_diff,
3316
2799
                        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)
 
2800
                start_message = generate_commit_message_template(commit_obj)
 
2801
                my_message = edit_commit_message_encoded(t,
 
2802
                    start_message=start_message)
3327
2803
                if my_message is None:
3328
2804
                    raise errors.BzrCommandError("please specify a commit"
3329
2805
                        " message with either --message or --file")
 
2806
            elif my_message and file:
 
2807
                raise errors.BzrCommandError(
 
2808
                    "please specify either --message or --file")
 
2809
            if file:
 
2810
                my_message = codecs.open(file, 'rt',
 
2811
                                         osutils.get_user_encoding()).read()
3330
2812
            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 \"\".")
 
2813
                raise errors.BzrCommandError("empty commit message specified")
3335
2814
            return my_message
3336
2815
 
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
2816
        try:
3342
2817
            tree.commit(message_callback=get_message,
3343
2818
                        specific_files=selected_list,
3344
2819
                        allow_pointless=unchanged, strict=strict, local=local,
3345
2820
                        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)
 
2821
                        authors=author,
 
2822
                        exclude=safe_relpath_files(tree, exclude))
3350
2823
        except PointlessCommit:
3351
 
            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.")
 
2824
            # FIXME: This should really happen before the file is read in;
 
2825
            # perhaps prepare the commit; get the message; then actually commit
 
2826
            raise errors.BzrCommandError("no changes to commit."
 
2827
                              " use --unchanged to commit anyhow")
3354
2828
        except ConflictsInTree:
3355
2829
            raise errors.BzrCommandError('Conflicts detected in working '
3356
2830
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3359
2833
            raise errors.BzrCommandError("Commit refused because there are"
3360
2834
                              " unknown files in the working tree.")
3361
2835
        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
 
2836
            raise errors.BzrCommandError(str(e) + "\n"
 
2837
            'To commit to master branch, run update and then commit.\n'
 
2838
            'You can also pass --local to commit to continue working '
 
2839
            'disconnected.')
3367
2840
 
3368
2841
 
3369
2842
class cmd_check(Command):
3370
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2843
    """Validate working tree structure, branch consistency and repository history.
3371
2844
 
3372
2845
    This command checks various invariants about branch and repository storage
3373
2846
    to detect data corruption or bzr bugs.
3375
2848
    The working tree and branch checks will only give output if a problem is
3376
2849
    detected. The output fields of the repository check are:
3377
2850
 
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.
 
2851
        revisions: This is just the number of revisions checked.  It doesn't
 
2852
            indicate a problem.
 
2853
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2854
            doesn't indicate a problem.
 
2855
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2856
            are not properly referenced by the revision ancestry.  This is a
 
2857
            subtle problem that Bazaar can work around.
 
2858
        unique file texts: This is the total number of unique file contents
 
2859
            seen in the checked revisions.  It does not indicate a problem.
 
2860
        repeated file texts: This is the total number of repeated texts seen
 
2861
            in the checked revisions.  Texts can be repeated when their file
 
2862
            entries are modified, but the file contents are not.  It does not
 
2863
            indicate a problem.
3400
2864
 
3401
2865
    If no restrictions are specified, all Bazaar data that is found at the given
3402
2866
    location will be checked.
3437
2901
 
3438
2902
 
3439
2903
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/.
 
2904
    """Upgrade branch storage to current format.
 
2905
 
 
2906
    The check command or bzr developers may sometimes advise you to run
 
2907
    this command. When the default format has changed you may also be warned
 
2908
    during other operations to upgrade.
3470
2909
    """
3471
2910
 
3472
 
    _see_also = ['check', 'reconcile', 'formats']
 
2911
    _see_also = ['check']
3473
2912
    takes_args = ['url?']
3474
2913
    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
 
    ]
 
2914
                    RegistryOption('format',
 
2915
                        help='Upgrade to a specific format.  See "bzr help'
 
2916
                             ' formats" for details.',
 
2917
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
2918
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2919
                        value_switches=True, title='Branch format'),
 
2920
                    ]
3486
2921
 
3487
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
2922
    def run(self, url='.', format=None):
3488
2923
        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
 
2924
        if format is None:
 
2925
            format = bzrdir.format_registry.make_bzrdir('default')
 
2926
        upgrade(url, format)
3496
2927
 
3497
2928
 
3498
2929
class cmd_whoami(Command):
3499
 
    __doc__ = """Show or set bzr user id.
 
2930
    """Show or set bzr user id.
3500
2931
 
3501
2932
    :Examples:
3502
2933
        Show the email of the current user::
3507
2938
 
3508
2939
            bzr whoami "Frank Chu <fchu@example.com>"
3509
2940
    """
3510
 
    takes_options = [ 'directory',
3511
 
                      Option('email',
 
2941
    takes_options = [ Option('email',
3512
2942
                             help='Display email address only.'),
3513
2943
                      Option('branch',
3514
2944
                             help='Set identity for the current branch instead of '
3518
2948
    encoding_type = 'replace'
3519
2949
 
3520
2950
    @display_command
3521
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
2951
    def run(self, email=False, branch=False, name=None):
3522
2952
        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()
 
2953
            # use branch if we're inside one; otherwise global config
 
2954
            try:
 
2955
                c = Branch.open_containing('.')[0].get_config()
 
2956
            except errors.NotBranchError:
 
2957
                c = config.GlobalConfig()
3531
2958
            if email:
3532
2959
                self.outf.write(c.user_email() + '\n')
3533
2960
            else:
3534
2961
                self.outf.write(c.username() + '\n')
3535
2962
            return
3536
2963
 
3537
 
        if email:
3538
 
            raise errors.BzrCommandError("--email can only be used to display existing "
3539
 
                                         "identity")
3540
 
 
3541
2964
        # display a warning if an email address isn't included in the given name.
3542
2965
        try:
3543
 
            _mod_config.extract_email_address(name)
 
2966
            config.extract_email_address(name)
3544
2967
        except errors.NoEmailInUsername, e:
3545
2968
            warning('"%s" does not seem to contain an email address.  '
3546
2969
                    'This is allowed, but not recommended.', name)
3547
2970
 
3548
2971
        # use global config unless --branch given
3549
2972
        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()
 
2973
            c = Branch.open_containing('.')[0].get_config()
3554
2974
        else:
3555
 
            c = _mod_config.GlobalConfig()
 
2975
            c = config.GlobalConfig()
3556
2976
        c.set_user_option('email', name)
3557
2977
 
3558
2978
 
3559
2979
class cmd_nick(Command):
3560
 
    __doc__ = """Print or set the branch nickname.
 
2980
    """Print or set the branch nickname.
3561
2981
 
3562
2982
    If unset, the tree root directory name is used as the nickname.
3563
2983
    To print the current nickname, execute with no argument.
3568
2988
 
3569
2989
    _see_also = ['info']
3570
2990
    takes_args = ['nickname?']
3571
 
    takes_options = ['directory']
3572
 
    def run(self, nickname=None, directory=u'.'):
3573
 
        branch = Branch.open_containing(directory)[0]
 
2991
    def run(self, nickname=None):
 
2992
        branch = Branch.open_containing(u'.')[0]
3574
2993
        if nickname is None:
3575
2994
            self.printme(branch)
3576
2995
        else:
3578
2997
 
3579
2998
    @display_command
3580
2999
    def printme(self, branch):
3581
 
        self.outf.write('%s\n' % branch.nick)
 
3000
        print branch.nick
3582
3001
 
3583
3002
 
3584
3003
class cmd_alias(Command):
3585
 
    __doc__ = """Set/unset and display aliases.
 
3004
    """Set/unset and display aliases.
3586
3005
 
3587
3006
    :Examples:
3588
3007
        Show the current aliases::
3625
3044
                'bzr alias --remove expects an alias to remove.')
3626
3045
        # If alias is not found, print something like:
3627
3046
        # unalias: foo: not found
3628
 
        c = _mod_config.GlobalConfig()
 
3047
        c = config.GlobalConfig()
3629
3048
        c.unset_alias(alias_name)
3630
3049
 
3631
3050
    @display_command
3632
3051
    def print_aliases(self):
3633
3052
        """Print out the defined aliases in a similar format to bash."""
3634
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3053
        aliases = config.GlobalConfig().get_aliases()
3635
3054
        for key, value in sorted(aliases.iteritems()):
3636
3055
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3637
3056
 
3647
3066
 
3648
3067
    def set_alias(self, alias_name, alias_command):
3649
3068
        """Save the alias in the global config."""
3650
 
        c = _mod_config.GlobalConfig()
 
3069
        c = config.GlobalConfig()
3651
3070
        c.set_alias(alias_name, alias_command)
3652
3071
 
3653
3072
 
3654
3073
class cmd_selftest(Command):
3655
 
    __doc__ = """Run internal test suite.
 
3074
    """Run internal test suite.
3656
3075
 
3657
3076
    If arguments are given, they are regular expressions that say which tests
3658
3077
    should run.  Tests matching any expression are run, and other tests are
3685
3104
    Tests that need working space on disk use a common temporary directory,
3686
3105
    typically inside $TMPDIR or /tmp.
3687
3106
 
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
3107
    :Examples:
3695
3108
        Run only tests relating to 'ignore'::
3696
3109
 
3705
3118
    def get_transport_type(typestring):
3706
3119
        """Parse and return a transport specifier."""
3707
3120
        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
 
3121
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3122
            return SFTPAbsoluteServer
 
3123
        if typestring == "memory":
 
3124
            from bzrlib.transport.memory import MemoryServer
 
3125
            return MemoryServer
 
3126
        if typestring == "fakenfs":
 
3127
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3128
            return FakeNFSServer
3716
3129
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3717
3130
            (typestring)
3718
3131
        raise errors.BzrCommandError(msg)
3729
3142
                                 'throughout the test suite.',
3730
3143
                            type=get_transport_type),
3731
3144
                     Option('benchmark',
3732
 
                            help='Run the benchmarks rather than selftests.',
3733
 
                            hidden=True),
 
3145
                            help='Run the benchmarks rather than selftests.'),
3734
3146
                     Option('lsprof-timed',
3735
3147
                            help='Generate lsprof output for benchmarked'
3736
3148
                                 ' sections of code.'),
3737
 
                     Option('lsprof-tests',
3738
 
                            help='Generate lsprof output for each test.'),
 
3149
                     Option('cache-dir', type=str,
 
3150
                            help='Cache intermediate benchmark output in this '
 
3151
                                 'directory.'),
3739
3152
                     Option('first',
3740
3153
                            help='Run all tests, but run specified tests first.',
3741
3154
                            short_name='f',
3742
3155
                            ),
3743
3156
                     Option('list-only',
3744
3157
                            help='List the tests instead of running them.'),
3745
 
                     RegistryOption('parallel',
3746
 
                        help="Run the test suite in parallel.",
3747
 
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
3748
 
                        value_switches=False,
3749
 
                        ),
3750
3158
                     Option('randomize', type=str, argname="SEED",
3751
3159
                            help='Randomize the order of tests using the given'
3752
3160
                                 ' 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.'),
 
3161
                     Option('exclude', type=str, argname="PATTERN",
 
3162
                            short_name='x',
 
3163
                            help='Exclude tests that match this regular'
 
3164
                                 ' expression.'),
3757
3165
                     Option('subunit',
3758
3166
                        help='Output test progress via subunit.'),
3759
3167
                     Option('strict', help='Fail on missing dependencies or '
3775
3183
 
3776
3184
    def run(self, testspecs_list=None, verbose=False, one=False,
3777
3185
            transport=None, benchmark=None,
3778
 
            lsprof_timed=None,
 
3186
            lsprof_timed=None, cache_dir=None,
3779
3187
            first=False, list_only=False,
3780
3188
            randomize=None, exclude=None, strict=False,
3781
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3782
 
            parallel=None, lsprof_tests=False):
3783
 
        from bzrlib import tests
3784
 
 
 
3189
            load_list=None, debugflag=None, starting_with=None, subunit=False):
 
3190
        from bzrlib.tests import selftest
 
3191
        import bzrlib.benchmarks as benchmarks
 
3192
        from bzrlib.benchmarks import tree_creator
 
3193
 
 
3194
        # Make deprecation warnings visible, unless -Werror is set
 
3195
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3196
 
 
3197
        if cache_dir is not None:
 
3198
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3199
        if not list_only:
 
3200
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
3201
            print '   %s (%s python%s)' % (
 
3202
                    bzrlib.__path__[0],
 
3203
                    bzrlib.version_string,
 
3204
                    bzrlib._format_version_tuple(sys.version_info),
 
3205
                    )
 
3206
        print
3785
3207
        if testspecs_list is not None:
3786
3208
            pattern = '|'.join(testspecs_list)
3787
3209
        else:
3793
3215
                raise errors.BzrCommandError("subunit not available. subunit "
3794
3216
                    "needs to be installed to use --subunit.")
3795
3217
            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
 
        if parallel:
3806
 
            self.additional_selftest_args.setdefault(
3807
 
                'suite_decorators', []).append(parallel)
3808
3218
        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
 
3219
            test_suite_factory = benchmarks.test_suite
 
3220
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3221
            verbose = not is_quiet()
 
3222
            # TODO: should possibly lock the history file...
 
3223
            benchfile = open(".perf_history", "at", buffering=1)
3815
3224
        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)
 
3225
            test_suite_factory = None
 
3226
            benchfile = None
3838
3227
        try:
3839
 
            result = tests.selftest(**selftest_kwargs)
 
3228
            selftest_kwargs = {"verbose": verbose,
 
3229
                              "pattern": pattern,
 
3230
                              "stop_on_failure": one,
 
3231
                              "transport": transport,
 
3232
                              "test_suite_factory": test_suite_factory,
 
3233
                              "lsprof_timed": lsprof_timed,
 
3234
                              "bench_history": benchfile,
 
3235
                              "matching_tests_first": first,
 
3236
                              "list_only": list_only,
 
3237
                              "random_seed": randomize,
 
3238
                              "exclude_pattern": exclude,
 
3239
                              "strict": strict,
 
3240
                              "load_list": load_list,
 
3241
                              "debug_flags": debugflag,
 
3242
                              "starting_with": starting_with
 
3243
                              }
 
3244
            selftest_kwargs.update(self.additional_selftest_args)
 
3245
            result = selftest(**selftest_kwargs)
3840
3246
        finally:
3841
 
            cleanup()
 
3247
            if benchfile is not None:
 
3248
                benchfile.close()
 
3249
        if result:
 
3250
            note('tests passed')
 
3251
        else:
 
3252
            note('tests failed')
3842
3253
        return int(not result)
3843
3254
 
3844
3255
 
3845
3256
class cmd_version(Command):
3846
 
    __doc__ = """Show version of bzr."""
 
3257
    """Show version of bzr."""
3847
3258
 
3848
3259
    encoding_type = 'replace'
3849
3260
    takes_options = [
3860
3271
 
3861
3272
 
3862
3273
class cmd_rocks(Command):
3863
 
    __doc__ = """Statement of optimism."""
 
3274
    """Statement of optimism."""
3864
3275
 
3865
3276
    hidden = True
3866
3277
 
3867
3278
    @display_command
3868
3279
    def run(self):
3869
 
        self.outf.write("It sure does!\n")
 
3280
        print "It sure does!"
3870
3281
 
3871
3282
 
3872
3283
class cmd_find_merge_base(Command):
3873
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3284
    """Find and print a base revision for merging two branches."""
3874
3285
    # TODO: Options to specify revisions on either side, as if
3875
3286
    #       merging only part of the history.
3876
3287
    takes_args = ['branch', 'other']
3882
3293
 
3883
3294
        branch1 = Branch.open_containing(branch)[0]
3884
3295
        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)
 
3296
        branch1.lock_read()
 
3297
        try:
 
3298
            branch2.lock_read()
 
3299
            try:
 
3300
                last1 = ensure_null(branch1.last_revision())
 
3301
                last2 = ensure_null(branch2.last_revision())
 
3302
 
 
3303
                graph = branch1.repository.get_graph(branch2.repository)
 
3304
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3305
 
 
3306
                print 'merge base is revision %s' % base_rev_id
 
3307
            finally:
 
3308
                branch2.unlock()
 
3309
        finally:
 
3310
            branch1.unlock()
3894
3311
 
3895
3312
 
3896
3313
class cmd_merge(Command):
3897
 
    __doc__ = """Perform a three-way merge.
 
3314
    """Perform a three-way merge.
3898
3315
 
3899
3316
    The source of the merge can be specified either in the form of a branch,
3900
3317
    or in the form of a path to a file containing a merge directive generated
3901
3318
    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.
 
3319
    or the branch most recently merged using --remember.
 
3320
 
 
3321
    When merging a branch, by default the tip will be merged. To pick a different
 
3322
    revision, pass --revision. If you specify two values, the first will be used as
 
3323
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3324
    available revisions, like this is commonly referred to as "cherrypicking".
 
3325
 
 
3326
    Revision numbers are always relative to the branch being merged.
 
3327
 
 
3328
    By default, bzr will try to merge in all new work from the other
 
3329
    branch, automatically determining an appropriate base.  If this
 
3330
    fails, you may need to give an explicit base.
3923
3331
 
3924
3332
    Merge will do its best to combine the changes in two branches, but there
3925
3333
    are some kinds of problems only a human can fix.  When it encounters those,
3928
3336
 
3929
3337
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3930
3338
 
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.
 
3339
    If there is no default branch set, the first merge will set it. After
 
3340
    that, you can omit the branch to use the default.  To change the
 
3341
    default, use --remember. The value will only be saved if the remote
 
3342
    location can be accessed.
3935
3343
 
3936
3344
    The results of the merge are placed into the destination working
3937
3345
    directory, where they can be reviewed (with bzr diff), tested, and then
3938
3346
    committed to record the result of the merge.
3939
3347
 
3940
3348
    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".
 
3349
    --force is given.
3952
3350
 
3953
3351
    :Examples:
3954
 
        To merge all new revisions from bzr.dev::
 
3352
        To merge the latest revision from bzr.dev::
3955
3353
 
3956
3354
            bzr merge ../bzr.dev
3957
3355
 
3963
3361
 
3964
3362
            bzr merge -r 81..82 ../bzr.dev
3965
3363
 
3966
 
        To apply a merge directive contained in /tmp/merge::
 
3364
        To apply a merge directive contained in in /tmp/merge:
3967
3365
 
3968
3366
            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
3367
    """
3977
3368
 
3978
3369
    encoding_type = 'exact'
3994
3385
                ' completely merged into the source, pull from the'
3995
3386
                ' source rather than merging.  When this happens,'
3996
3387
                ' you do not need to commit the result.'),
3997
 
        custom_help('directory',
 
3388
        Option('directory',
3998
3389
               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')
 
3390
                    'rather than the one containing the working directory.',
 
3391
               short_name='d',
 
3392
               type=unicode,
 
3393
               ),
 
3394
        Option('preview', help='Instead of merging, show a diff of the merge.')
4004
3395
    ]
4005
3396
 
4006
3397
    def run(self, location=None, revision=None, force=False,
4007
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
3398
            merge_type=None, show_base=False, reprocess=None, remember=False,
4008
3399
            uncommitted=False, pull=False,
4009
3400
            directory=None,
4010
3401
            preview=False,
4011
 
            interactive=False,
4012
3402
            ):
4013
3403
        if merge_type is None:
4014
3404
            merge_type = _mod_merge.Merge3Merger
4018
3408
        merger = None
4019
3409
        allow_pending = True
4020
3410
        verified = 'inapplicable'
4021
 
 
4022
3411
        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
3412
 
 
3413
        # die as quickly as possible if there are uncommitted changes
4027
3414
        try:
4028
3415
            basis_tree = tree.revision_tree(tree.last_revision())
4029
3416
        except errors.NoSuchRevision:
4030
3417
            basis_tree = tree.basis_tree()
4031
 
 
4032
 
        # die as quickly as possible if there are uncommitted changes
4033
3418
        if not force:
4034
 
            if tree.has_changes():
 
3419
            changes = tree.changes_from(basis_tree)
 
3420
            if changes.has_changed():
4035
3421
                raise errors.UncommittedChanges(tree)
4036
3422
 
4037
3423
        view_info = _get_view_info_for_change_reporter(tree)
4038
3424
        change_reporter = delta._ChangeReporter(
4039
3425
            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
 
3426
        cleanups = []
 
3427
        try:
 
3428
            pb = ui.ui_factory.nested_progress_bar()
 
3429
            cleanups.append(pb.finished)
 
3430
            tree.lock_write()
 
3431
            cleanups.append(tree.unlock)
 
3432
            if location is not None:
 
3433
                try:
 
3434
                    mergeable = bundle.read_mergeable_from_url(location,
 
3435
                        possible_transports=possible_transports)
 
3436
                except errors.NotABundle:
 
3437
                    mergeable = None
 
3438
                else:
 
3439
                    if uncommitted:
 
3440
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3441
                            ' with bundles or merge directives.')
 
3442
 
 
3443
                    if revision is not None:
 
3444
                        raise errors.BzrCommandError(
 
3445
                            'Cannot use -r with merge directives or bundles')
 
3446
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3447
                       mergeable, pb)
 
3448
 
 
3449
            if merger is None and uncommitted:
 
3450
                if revision is not None and len(revision) > 0:
 
3451
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3452
                        ' --revision at the same time.')
 
3453
                location = self._select_branch_location(tree, location)[0]
 
3454
                other_tree, other_path = WorkingTree.open_containing(location)
 
3455
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3456
                    pb)
 
3457
                allow_pending = False
 
3458
                if other_path != '':
 
3459
                    merger.interesting_files = [other_path]
 
3460
 
 
3461
            if merger is None:
 
3462
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3463
                    location, revision, remember, possible_transports, pb)
 
3464
 
 
3465
            merger.merge_type = merge_type
 
3466
            merger.reprocess = reprocess
 
3467
            merger.show_base = show_base
 
3468
            self.sanity_check_merger(merger)
 
3469
            if (merger.base_rev_id == merger.other_rev_id and
 
3470
                merger.other_rev_id is not None):
 
3471
                note('Nothing to do.')
 
3472
                return 0
 
3473
            if pull:
 
3474
                if merger.interesting_files is not None:
 
3475
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3476
                if (merger.base_rev_id == tree.last_revision()):
 
3477
                    result = tree.pull(merger.other_branch, False,
 
3478
                                       merger.other_rev_id)
 
3479
                    result.report(self.outf)
 
3480
                    return 0
 
3481
            merger.check_basis(False)
 
3482
            if preview:
 
3483
                return self._do_preview(merger)
4049
3484
            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):
 
3485
                return self._do_merge(merger, change_reporter, allow_pending,
 
3486
                                      verified)
 
3487
        finally:
 
3488
            for cleanup in reversed(cleanups):
 
3489
                cleanup()
 
3490
 
 
3491
    def _do_preview(self, merger):
 
3492
        from bzrlib.diff import show_diff_trees
4107
3493
        tree_merger = merger.make_merger()
4108
3494
        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)
 
3495
        try:
 
3496
            result_tree = tt.get_preview_tree()
 
3497
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3498
                            old_label='', new_label='')
 
3499
        finally:
 
3500
            tt.finalize()
4120
3501
 
4121
3502
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4122
3503
        merger.change_reporter = change_reporter
4130
3511
        else:
4131
3512
            return 0
4132
3513
 
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
3514
    def sanity_check_merger(self, merger):
4152
3515
        if (merger.show_base and
4153
3516
            not merger.merge_type is _mod_merge.Merge3Merger):
4188
3551
            base_branch, base_path = Branch.open_containing(base_loc,
4189
3552
                possible_transports)
4190
3553
        # 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:
 
3554
        if revision is None or len(revision) < 1 or revision[-1] is None:
4199
3555
            other_revision_id = _mod_revision.ensure_null(
4200
3556
                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)))):
 
3557
        else:
 
3558
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3559
        if (revision is not None and len(revision) == 2
 
3560
            and revision[0] is not None):
 
3561
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3562
        else:
 
3563
            base_revision_id = None
 
3564
        # Remember where we merge from
 
3565
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3566
             user_location is not None):
4210
3567
            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)
 
3568
        _merge_tags_if_possible(other_branch, tree.branch)
4214
3569
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4215
3570
            other_revision_id, base_revision_id, other_branch, base_branch)
4216
3571
        if other_path != '':
4220
3575
            allow_pending = True
4221
3576
        return merger, allow_pending
4222
3577
 
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
3578
    def _select_branch_location(self, tree, user_location, revision=None,
4238
3579
                                index=None):
4239
3580
        """Select a branch location, according to possible inputs.
4283
3624
 
4284
3625
 
4285
3626
class cmd_remerge(Command):
4286
 
    __doc__ = """Redo a merge.
 
3627
    """Redo a merge.
4287
3628
 
4288
3629
    Use this if you want to try a different merge technique while resolving
4289
3630
    conflicts.  Some merge techniques are better than others, and remerge
4314
3655
 
4315
3656
    def run(self, file_list=None, merge_type=None, show_base=False,
4316
3657
            reprocess=False):
4317
 
        from bzrlib.conflicts import restore
4318
3658
        if merge_type is None:
4319
3659
            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
 
3660
        tree, file_list = tree_files(file_list)
 
3661
        tree.lock_write()
 
3662
        try:
 
3663
            parents = tree.get_parent_ids()
 
3664
            if len(parents) != 2:
 
3665
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3666
                                             " merges.  Not cherrypicking or"
 
3667
                                             " multi-merges.")
 
3668
            repository = tree.branch.repository
 
3669
            interesting_ids = None
 
3670
            new_conflicts = []
 
3671
            conflicts = tree.conflicts()
 
3672
            if file_list is not None:
 
3673
                interesting_ids = set()
 
3674
                for filename in file_list:
 
3675
                    file_id = tree.path2id(filename)
 
3676
                    if file_id is None:
 
3677
                        raise errors.NotVersionedError(filename)
 
3678
                    interesting_ids.add(file_id)
 
3679
                    if tree.kind(file_id) != "directory":
 
3680
                        continue
4340
3681
 
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:
 
3682
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3683
                        interesting_ids.add(ie.file_id)
 
3684
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3685
            else:
 
3686
                # Remerge only supports resolving contents conflicts
 
3687
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3688
                restore_files = [c.path for c in conflicts
 
3689
                                 if c.typestring in allowed_conflicts]
 
3690
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3691
            tree.set_conflicts(ConflictList(new_conflicts))
 
3692
            if file_list is not None:
 
3693
                restore_files = file_list
 
3694
            for filename in restore_files:
 
3695
                try:
 
3696
                    restore(tree.abspath(filename))
 
3697
                except errors.NotConflicted:
 
3698
                    pass
 
3699
            # Disable pending merges, because the file texts we are remerging
 
3700
            # have not had those merges performed.  If we use the wrong parents
 
3701
            # list, we imply that the working tree text has seen and rejected
 
3702
            # all the changes from the other tree, when in fact those changes
 
3703
            # have not yet been seen.
 
3704
            pb = ui.ui_factory.nested_progress_bar()
 
3705
            tree.set_parent_ids(parents[:1])
4354
3706
            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()
 
3707
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3708
                                                             tree, parents[1])
 
3709
                merger.interesting_ids = interesting_ids
 
3710
                merger.merge_type = merge_type
 
3711
                merger.show_base = show_base
 
3712
                merger.reprocess = reprocess
 
3713
                conflicts = merger.do_merge()
 
3714
            finally:
 
3715
                tree.set_parent_ids(parents)
 
3716
                pb.finished()
4371
3717
        finally:
4372
 
            tree.set_parent_ids(parents)
 
3718
            tree.unlock()
4373
3719
        if conflicts > 0:
4374
3720
            return 1
4375
3721
        else:
4377
3723
 
4378
3724
 
4379
3725
class cmd_revert(Command):
4380
 
    __doc__ = """Revert files to a previous revision.
 
3726
    """Revert files to a previous revision.
4381
3727
 
4382
3728
    Giving a list of files will revert only those files.  Otherwise, all files
4383
3729
    will be reverted.  If the revision is not specified with '--revision', the
4384
3730
    last committed revision is used.
4385
3731
 
4386
3732
    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.
 
3733
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3734
    changes introduced by -2, without affecting the changes introduced by -1.
 
3735
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4391
3736
 
4392
3737
    By default, any files that have been manually changed will be backed up
4393
3738
    first.  (Files changed only by merge are not backed up.)  Backup files have
4398
3743
    name.  If you name a directory, all the contents of that directory will be
4399
3744
    reverted.
4400
3745
 
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.
 
3746
    Any files that have been newly added since that revision will be deleted,
 
3747
    with a backup kept if appropriate.  Directories containing unknown files
 
3748
    will not be deleted.
4405
3749
 
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
 
3750
    The working tree contains a list of pending merged revisions, which will
 
3751
    be included as parents in the next commit.  Normally, revert clears that
 
3752
    list as well as reverting the files.  If any files are specified, revert
 
3753
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3754
    revert ." in the tree root to revert all files but keep the merge record,
 
3755
    and "bzr revert --forget-merges" to clear the pending merge list without
4413
3756
    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
3757
    """
4425
3758
 
4426
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
3759
    _see_also = ['cat', 'export']
4427
3760
    takes_options = [
4428
3761
        'revision',
4429
3762
        Option('no-backup', "Do not save backups of reverted files."),
4434
3767
 
4435
3768
    def run(self, revision=None, no_backup=False, file_list=None,
4436
3769
            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)
 
3770
        tree, file_list = tree_files(file_list)
 
3771
        tree.lock_write()
 
3772
        try:
 
3773
            if forget_merges:
 
3774
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3775
            else:
 
3776
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3777
        finally:
 
3778
            tree.unlock()
4443
3779
 
4444
3780
    @staticmethod
4445
3781
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4446
3782
        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)
 
3783
        pb = ui.ui_factory.nested_progress_bar()
 
3784
        try:
 
3785
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3786
                report_changes=True)
 
3787
        finally:
 
3788
            pb.finished()
4449
3789
 
4450
3790
 
4451
3791
class cmd_assert_fail(Command):
4452
 
    __doc__ = """Test reporting of assertion failures"""
 
3792
    """Test reporting of assertion failures"""
4453
3793
    # intended just for use in testing
4454
3794
 
4455
3795
    hidden = True
4459
3799
 
4460
3800
 
4461
3801
class cmd_help(Command):
4462
 
    __doc__ = """Show help on a command or other topic.
 
3802
    """Show help on a command or other topic.
4463
3803
    """
4464
3804
 
4465
3805
    _see_also = ['topics']
4478
3818
 
4479
3819
 
4480
3820
class cmd_shell_complete(Command):
4481
 
    __doc__ = """Show appropriate completions for context.
 
3821
    """Show appropriate completions for context.
4482
3822
 
4483
3823
    For a list of all available commands, say 'bzr shell-complete'.
4484
3824
    """
4493
3833
 
4494
3834
 
4495
3835
class cmd_missing(Command):
4496
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3836
    """Show unmerged/unpulled revisions between two branches.
4497
3837
 
4498
3838
    OTHER_BRANCH may be local or remote.
4499
3839
 
4500
3840
    To filter on a range of revisions, you can use the command -r begin..end
4501
3841
    -r revision requests a specific revision, -r ..end or -r begin.. are
4502
3842
    also valid.
4503
 
            
4504
 
    :Exit values:
4505
 
        1 - some missing revisions
4506
 
        0 - no missing revisions
4507
3843
 
4508
3844
    :Examples:
4509
3845
 
4530
3866
    _see_also = ['merge', 'pull']
4531
3867
    takes_args = ['other_branch?']
4532
3868
    takes_options = [
4533
 
        'directory',
4534
3869
        Option('reverse', 'Reverse the order of revisions.'),
4535
3870
        Option('mine-only',
4536
3871
               'Display changes in the local branch only.'),
4548
3883
            type=_parse_revision_str,
4549
3884
            help='Filter on local branch revisions (inclusive). '
4550
3885
                'See "help revisionspec" for details.'),
4551
 
        Option('include-merges',
4552
 
               'Show all revisions in addition to the mainline ones.'),
 
3886
        Option('include-merges', 'Show merged revisions.'),
4553
3887
        ]
4554
3888
    encoding_type = 'replace'
4555
3889
 
4558
3892
            theirs_only=False,
4559
3893
            log_format=None, long=False, short=False, line=False,
4560
3894
            show_ids=False, verbose=False, this=False, other=False,
4561
 
            include_merges=False, revision=None, my_revision=None,
4562
 
            directory=u'.'):
 
3895
            include_merges=False, revision=None, my_revision=None):
4563
3896
        from bzrlib.missing import find_unmerged, iter_log_revisions
4564
3897
        def message(s):
4565
3898
            if not is_quiet():
4578
3911
        elif theirs_only:
4579
3912
            restrict = 'remote'
4580
3913
 
4581
 
        local_branch = Branch.open_containing(directory)[0]
4582
 
        self.add_cleanup(local_branch.lock_read().unlock)
4583
 
 
 
3914
        local_branch = Branch.open_containing(u".")[0]
4584
3915
        parent = local_branch.get_parent()
4585
3916
        if other_branch is None:
4586
3917
            other_branch = parent
4595
3926
        remote_branch = Branch.open(other_branch)
4596
3927
        if remote_branch.base == local_branch.base:
4597
3928
            remote_branch = local_branch
4598
 
        else:
4599
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4600
3929
 
4601
3930
        local_revid_range = _revision_range_to_revid_range(
4602
3931
            _get_revision_range(my_revision, local_branch,
4606
3935
            _get_revision_range(revision,
4607
3936
                remote_branch, self.name()))
4608
3937
 
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()
 
3938
        local_branch.lock_read()
 
3939
        try:
 
3940
            remote_branch.lock_read()
 
3941
            try:
 
3942
                local_extra, remote_extra = find_unmerged(
 
3943
                    local_branch, remote_branch, restrict,
 
3944
                    backward=not reverse,
 
3945
                    include_merges=include_merges,
 
3946
                    local_revid_range=local_revid_range,
 
3947
                    remote_revid_range=remote_revid_range)
 
3948
 
 
3949
                if log_format is None:
 
3950
                    registry = log.log_formatter_registry
 
3951
                    log_format = registry.get_default(local_branch)
 
3952
                lf = log_format(to_file=self.outf,
 
3953
                                show_ids=show_ids,
 
3954
                                show_timezone='original')
 
3955
 
 
3956
                status_code = 0
 
3957
                if local_extra and not theirs_only:
 
3958
                    message("You have %d extra revision(s):\n" %
 
3959
                        len(local_extra))
 
3960
                    for revision in iter_log_revisions(local_extra,
 
3961
                                        local_branch.repository,
 
3962
                                        verbose):
 
3963
                        lf.log_revision(revision)
 
3964
                    printed_local = True
 
3965
                    status_code = 1
 
3966
                else:
 
3967
                    printed_local = False
 
3968
 
 
3969
                if remote_extra and not mine_only:
 
3970
                    if printed_local is True:
 
3971
                        message("\n\n\n")
 
3972
                    message("You are missing %d revision(s):\n" %
 
3973
                        len(remote_extra))
 
3974
                    for revision in iter_log_revisions(remote_extra,
 
3975
                                        remote_branch.repository,
 
3976
                                        verbose):
 
3977
                        lf.log_revision(revision)
 
3978
                    status_code = 1
 
3979
 
 
3980
                if mine_only and not local_extra:
 
3981
                    # We checked local, and found nothing extra
 
3982
                    message('This branch is up to date.\n')
 
3983
                elif theirs_only and not remote_extra:
 
3984
                    # We checked remote, and found nothing extra
 
3985
                    message('Other branch is up to date.\n')
 
3986
                elif not (mine_only or theirs_only or local_extra or
 
3987
                          remote_extra):
 
3988
                    # We checked both branches, and neither one had extra
 
3989
                    # revisions
 
3990
                    message("Branches are up to date.\n")
 
3991
            finally:
 
3992
                remote_branch.unlock()
 
3993
        finally:
 
3994
            local_branch.unlock()
4659
3995
        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)
 
3996
            local_branch.lock_write()
 
3997
            try:
 
3998
                # handle race conditions - a parent might be set while we run.
 
3999
                if local_branch.get_parent() is None:
 
4000
                    local_branch.set_parent(remote_branch.base)
 
4001
            finally:
 
4002
                local_branch.unlock()
4664
4003
        return status_code
4665
4004
 
4666
4005
 
4667
4006
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
 
    """
 
4007
    """Compress the data within a repository."""
4685
4008
 
4686
4009
    _see_also = ['repositories']
4687
4010
    takes_args = ['branch_or_repo?']
4688
 
    takes_options = [
4689
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4690
 
        ]
4691
4011
 
4692
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4012
    def run(self, branch_or_repo='.'):
4693
4013
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4694
4014
        try:
4695
4015
            branch = dir.open_branch()
4696
4016
            repository = branch.repository
4697
4017
        except errors.NotBranchError:
4698
4018
            repository = dir.open_repository()
4699
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4019
        repository.pack()
4700
4020
 
4701
4021
 
4702
4022
class cmd_plugins(Command):
4703
 
    __doc__ = """List the installed plugins.
 
4023
    """List the installed plugins.
4704
4024
 
4705
4025
    This command displays the list of installed plugins including
4706
4026
    version of plugin and a short description of each.
4713
4033
    adding new commands, providing additional network transports and
4714
4034
    customizing log output.
4715
4035
 
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.
 
4036
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4037
    information on plugins including where to find them and how to
 
4038
    install them. Instructions are also provided there on how to
 
4039
    write new plugins using the Python programming language.
4720
4040
    """
4721
4041
    takes_options = ['verbose']
4722
4042
 
4723
4043
    @display_command
4724
4044
    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)))
 
4045
        import bzrlib.plugin
 
4046
        from inspect import getdoc
 
4047
        result = []
 
4048
        for name, plugin in bzrlib.plugin.plugins().items():
 
4049
            version = plugin.__version__
 
4050
            if version == 'unknown':
 
4051
                version = ''
 
4052
            name_ver = '%s %s' % (name, version)
 
4053
            d = getdoc(plugin.module)
 
4054
            if d:
 
4055
                doc = d.split('\n')[0]
 
4056
            else:
 
4057
                doc = '(no description)'
 
4058
            result.append((name_ver, doc, plugin.path()))
 
4059
        for name_ver, doc, path in sorted(result):
 
4060
            print name_ver
 
4061
            print '   ', doc
 
4062
            if verbose:
 
4063
                print '   ', path
 
4064
            print
4729
4065
 
4730
4066
 
4731
4067
class cmd_testament(Command):
4732
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4068
    """Show testament (signing-form) of a revision."""
4733
4069
    takes_options = [
4734
4070
            'revision',
4735
4071
            Option('long', help='Produce long-format testament.'),
4747
4083
            b = Branch.open_containing(branch)[0]
4748
4084
        else:
4749
4085
            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())
 
4086
        b.lock_read()
 
4087
        try:
 
4088
            if revision is None:
 
4089
                rev_id = b.last_revision()
 
4090
            else:
 
4091
                rev_id = revision[0].as_revision_id(b)
 
4092
            t = testament_class.from_revision(b.repository, rev_id)
 
4093
            if long:
 
4094
                sys.stdout.writelines(t.as_text_lines())
 
4095
            else:
 
4096
                sys.stdout.write(t.as_short_text())
 
4097
        finally:
 
4098
            b.unlock()
4760
4099
 
4761
4100
 
4762
4101
class cmd_annotate(Command):
4763
 
    __doc__ = """Show the origin of each line in a file.
 
4102
    """Show the origin of each line in a file.
4764
4103
 
4765
4104
    This prints out the given file with an annotation on the left side
4766
4105
    indicating which revision, author and date introduced the change.
4777
4116
                     Option('long', help='Show commit date in annotations.'),
4778
4117
                     'revision',
4779
4118
                     'show-ids',
4780
 
                     'directory',
4781
4119
                     ]
4782
4120
    encoding_type = 'exact'
4783
4121
 
4784
4122
    @display_command
4785
4123
    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
 
            )
 
4124
            show_ids=False):
 
4125
        from bzrlib.annotate import annotate_file, annotate_file_tree
4790
4126
        wt, branch, relpath = \
4791
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4127
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4792
4128
        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)
 
4129
            wt.lock_read()
 
4130
        else:
 
4131
            branch.lock_read()
 
4132
        try:
 
4133
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4134
            if wt is not None:
 
4135
                file_id = wt.path2id(relpath)
 
4136
            else:
 
4137
                file_id = tree.path2id(relpath)
 
4138
            if file_id is None:
 
4139
                raise errors.NotVersionedError(filename)
 
4140
            file_version = tree.inventory[file_id].revision
 
4141
            if wt is not None and revision is None:
 
4142
                # If there is a tree and we're not annotating historical
 
4143
                # versions, annotate the working tree's content.
 
4144
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4145
                    show_ids=show_ids)
 
4146
            else:
 
4147
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4148
                              show_ids=show_ids)
 
4149
        finally:
 
4150
            if wt is not None:
 
4151
                wt.unlock()
 
4152
            else:
 
4153
                branch.unlock()
4812
4154
 
4813
4155
 
4814
4156
class cmd_re_sign(Command):
4815
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4157
    """Create a digital signature for an existing revision."""
4816
4158
    # TODO be able to replace existing ones.
4817
4159
 
4818
4160
    hidden = True # is this right ?
4819
4161
    takes_args = ['revision_id*']
4820
 
    takes_options = ['directory', 'revision']
 
4162
    takes_options = ['revision']
4821
4163
 
4822
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4164
    def run(self, revision_id_list=None, revision=None):
4823
4165
        if revision_id_list is not None and revision is not None:
4824
4166
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4825
4167
        if revision_id_list is None and revision is None:
4826
4168
            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)
 
4169
        b = WorkingTree.open_containing(u'.')[0].branch
 
4170
        b.lock_write()
 
4171
        try:
 
4172
            return self._run(b, revision_id_list, revision)
 
4173
        finally:
 
4174
            b.unlock()
4830
4175
 
4831
4176
    def _run(self, b, revision_id_list, revision):
4832
4177
        import bzrlib.gpg as gpg
4877
4222
 
4878
4223
 
4879
4224
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.
 
4225
    """Convert the current branch into a checkout of the supplied branch.
4882
4226
 
4883
4227
    Once converted into a checkout, commits must succeed on the master branch
4884
4228
    before they will be applied to the local branch.
4885
4229
 
4886
4230
    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
 
4231
    locally, in which case binding will update the the local nickname to be
4888
4232
    that of the master.
4889
4233
    """
4890
4234
 
4891
4235
    _see_also = ['checkouts', 'unbind']
4892
4236
    takes_args = ['location?']
4893
 
    takes_options = ['directory']
 
4237
    takes_options = []
4894
4238
 
4895
 
    def run(self, location=None, directory=u'.'):
4896
 
        b, relpath = Branch.open_containing(directory)
 
4239
    def run(self, location=None):
 
4240
        b, relpath = Branch.open_containing(u'.')
4897
4241
        if location is None:
4898
4242
            try:
4899
4243
                location = b.get_old_bound_location()
4902
4246
                    'This format does not remember old locations.')
4903
4247
            else:
4904
4248
                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')
 
4249
                    raise errors.BzrCommandError('No location supplied and no '
 
4250
                        'previous location known')
4910
4251
        b_other = Branch.open(location)
4911
4252
        try:
4912
4253
            b.bind(b_other)
4918
4259
 
4919
4260
 
4920
4261
class cmd_unbind(Command):
4921
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4262
    """Convert the current checkout into a regular branch.
4922
4263
 
4923
4264
    After unbinding, the local branch is considered independent and subsequent
4924
4265
    commits will be local only.
4926
4267
 
4927
4268
    _see_also = ['checkouts', 'bind']
4928
4269
    takes_args = []
4929
 
    takes_options = ['directory']
 
4270
    takes_options = []
4930
4271
 
4931
 
    def run(self, directory=u'.'):
4932
 
        b, relpath = Branch.open_containing(directory)
 
4272
    def run(self):
 
4273
        b, relpath = Branch.open_containing(u'.')
4933
4274
        if not b.unbind():
4934
4275
            raise errors.BzrCommandError('Local branch is not bound')
4935
4276
 
4936
4277
 
4937
4278
class cmd_uncommit(Command):
4938
 
    __doc__ = """Remove the last committed revision.
 
4279
    """Remove the last committed revision.
4939
4280
 
4940
4281
    --verbose will print out what is being removed.
4941
4282
    --dry-run will go through all the motions, but not actually
4981
4322
            b = control.open_branch()
4982
4323
 
4983
4324
        if tree is not None:
4984
 
            self.add_cleanup(tree.lock_write().unlock)
 
4325
            tree.lock_write()
4985
4326
        else:
4986
 
            self.add_cleanup(b.lock_write().unlock)
4987
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4327
            b.lock_write()
 
4328
        try:
 
4329
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4330
                             local=local)
 
4331
        finally:
 
4332
            if tree is not None:
 
4333
                tree.unlock()
 
4334
            else:
 
4335
                b.unlock()
4988
4336
 
4989
4337
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4990
4338
        from bzrlib.log import log_formatter, show_log
5022
4370
                 end_revision=last_revno)
5023
4371
 
5024
4372
        if dry_run:
5025
 
            self.outf.write('Dry-run, pretending to remove'
5026
 
                            ' the above revisions.\n')
 
4373
            print 'Dry-run, pretending to remove the above revisions.'
 
4374
            if not force:
 
4375
                val = raw_input('Press <enter> to continue')
5027
4376
        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
 
4377
            print 'The above revision(s) will be removed.'
 
4378
            if not force:
 
4379
                val = raw_input('Are you sure [y/N]? ')
 
4380
                if val.lower() not in ('y', 'yes'):
 
4381
                    print 'Canceled'
 
4382
                    return 0
5037
4383
 
5038
4384
        mutter('Uncommitting from {%s} to {%s}',
5039
4385
               last_rev_id, rev_id)
5040
4386
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5041
4387
                 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)
 
4388
        note('You can restore the old tip by running:\n'
 
4389
             '  bzr pull . -r revid:%s', last_rev_id)
5044
4390
 
5045
4391
 
5046
4392
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.
 
4393
    """Break a dead lock on a repository, branch or working directory.
5051
4394
 
5052
4395
    CAUTION: Locks should only be broken when you are sure that the process
5053
4396
    holding the lock has been stopped.
5054
4397
 
5055
 
    You can get information on what locks are open via the 'bzr info
5056
 
    [location]' command.
 
4398
    You can get information on what locks are open via the 'bzr info' command.
5057
4399
 
5058
4400
    :Examples:
5059
4401
        bzr break-lock
5060
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
5061
 
        bzr break-lock --conf ~/.bazaar
5062
4402
    """
5063
 
 
5064
4403
    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
4404
 
5072
 
    def run(self, location=None, config=False, force=False):
 
4405
    def run(self, location=None, show=False):
5073
4406
        if location is None:
5074
4407
            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
 
4408
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4409
        try:
 
4410
            control.break_lock()
 
4411
        except NotImplementedError:
 
4412
            pass
5088
4413
 
5089
4414
 
5090
4415
class cmd_wait_until_signalled(Command):
5091
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4416
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5092
4417
 
5093
4418
    This just prints a line to signal when it is ready, then blocks on stdin.
5094
4419
    """
5102
4427
 
5103
4428
 
5104
4429
class cmd_serve(Command):
5105
 
    __doc__ = """Run the bzr server."""
 
4430
    """Run the bzr server."""
5106
4431
 
5107
4432
    aliases = ['server']
5108
4433
 
5109
4434
    takes_options = [
5110
4435
        Option('inet',
5111
4436
               help='Serve on stdin/out for use from inetd or sshd.'),
5112
 
        RegistryOption('protocol',
5113
 
               help="Protocol to serve.",
5114
 
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
5115
 
               value_switches=True),
5116
4437
        Option('port',
5117
4438
               help='Listen for connections on nominated port of the form '
5118
4439
                    '[hostname:]portnumber.  Passing 0 as the port number will '
5119
 
                    'result in a dynamically allocated port.  The default port '
5120
 
                    'depends on the protocol.',
 
4440
                    'result in a dynamically allocated port.  The default port is '
 
4441
                    '4155.',
5121
4442
               type=str),
5122
 
        custom_help('directory',
5123
 
               help='Serve contents of this directory.'),
 
4443
        Option('directory',
 
4444
               help='Serve contents of this directory.',
 
4445
               type=unicode),
5124
4446
        Option('allow-writes',
5125
4447
               help='By default the server is a readonly server.  Supplying '
5126
4448
                    '--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.'
 
4449
                    'the served directory and below.'
5132
4450
                ),
5133
4451
        ]
5134
4452
 
 
4453
    def run_smart_server(self, smart_server):
 
4454
        """Run 'smart_server' forever, with no UI output at all."""
 
4455
        # For the duration of this server, no UI output is permitted. note
 
4456
        # that this may cause problems with blackbox tests. This should be
 
4457
        # changed with care though, as we dont want to use bandwidth sending
 
4458
        # progress over stderr to smart server clients!
 
4459
        from bzrlib import lockdir
 
4460
        old_factory = ui.ui_factory
 
4461
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4462
        try:
 
4463
            ui.ui_factory = ui.SilentUIFactory()
 
4464
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4465
            smart_server.serve()
 
4466
        finally:
 
4467
            ui.ui_factory = old_factory
 
4468
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4469
 
5135
4470
    def get_host_and_port(self, port):
5136
4471
        """Return the host and port to run the smart server on.
5137
4472
 
5138
 
        If 'port' is None, None will be returned for the host and port.
 
4473
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4474
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
5139
4475
 
5140
4476
        If 'port' has a colon in it, the string before the colon will be
5141
4477
        interpreted as the host.
5144
4480
        :return: A tuple of (host, port), where 'host' is a host name or IP,
5145
4481
            and port is an integer TCP/IP port.
5146
4482
        """
5147
 
        host = None
5148
 
        if port is not None:
 
4483
        from bzrlib.smart import medium
 
4484
        host = medium.BZR_DEFAULT_INTERFACE
 
4485
        if port is None:
 
4486
            port = medium.BZR_DEFAULT_PORT
 
4487
        else:
5149
4488
            if ':' in port:
5150
4489
                host, port = port.split(':')
5151
4490
            port = int(port)
5152
4491
        return host, port
5153
4492
 
5154
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5155
 
            protocol=None):
5156
 
        from bzrlib import transport
 
4493
    def get_smart_server(self, transport, inet, port):
 
4494
        """Construct a smart server.
 
4495
 
 
4496
        :param transport: The base transport from which branches will be
 
4497
            served.
 
4498
        :param inet: If True, serve over stdin and stdout. Used for running
 
4499
            from inet.
 
4500
        :param port: The port to listen on. By default, it's `
 
4501
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4502
            information.
 
4503
        :return: A smart server.
 
4504
        """
 
4505
        from bzrlib.smart import medium, server
 
4506
        if inet:
 
4507
            smart_server = medium.SmartServerPipeStreamMedium(
 
4508
                sys.stdin, sys.stdout, transport)
 
4509
        else:
 
4510
            host, port = self.get_host_and_port(port)
 
4511
            smart_server = server.SmartTCPServer(
 
4512
                transport, host=host, port=port)
 
4513
            note('listening on port: %s' % smart_server.port)
 
4514
        return smart_server
 
4515
 
 
4516
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4517
        from bzrlib.transport import get_transport
 
4518
        from bzrlib.transport.chroot import ChrootServer
5157
4519
        if directory is None:
5158
4520
            directory = os.getcwd()
5159
 
        if protocol is None:
5160
 
            protocol = transport.transport_server_registry.get()
5161
 
        host, port = self.get_host_and_port(port)
5162
4521
        url = urlutils.local_path_to_url(directory)
5163
4522
        if not allow_writes:
5164
4523
            url = 'readonly+' + url
5165
 
        t = transport.get_transport(url)
5166
 
        protocol(t, host, port, inet)
 
4524
        chroot_server = ChrootServer(get_transport(url))
 
4525
        chroot_server.setUp()
 
4526
        t = get_transport(chroot_server.get_url())
 
4527
        smart_server = self.get_smart_server(t, inet, port)
 
4528
        self.run_smart_server(smart_server)
5167
4529
 
5168
4530
 
5169
4531
class cmd_join(Command):
5170
 
    __doc__ = """Combine a tree into its containing tree.
 
4532
    """Combine a subtree into its containing tree.
5171
4533
 
5172
 
    This command requires the target tree to be in a rich-root format.
 
4534
    This command is for experimental use only.  It requires the target tree
 
4535
    to be in dirstate-with-subtree format, which cannot be converted into
 
4536
    earlier formats.
5173
4537
 
5174
4538
    The TREE argument should be an independent tree, inside another tree, but
5175
4539
    not part of it.  (Such trees can be produced by "bzr split", but also by
5176
4540
    running "bzr branch" with the target inside a tree.)
5177
4541
 
5178
 
    The result is a combined tree, with the subtree no longer an independent
 
4542
    The result is a combined tree, with the subtree no longer an independant
5179
4543
    part.  This is marked as a merge of the subtree into the containing tree,
5180
4544
    and all history is preserved.
 
4545
 
 
4546
    If --reference is specified, the subtree retains its independence.  It can
 
4547
    be branched by itself, and can be part of multiple projects at the same
 
4548
    time.  But operations performed in the containing tree, such as commit
 
4549
    and merge, will recurse into the subtree.
5181
4550
    """
5182
4551
 
5183
4552
    _see_also = ['split']
5184
4553
    takes_args = ['tree']
5185
4554
    takes_options = [
5186
 
            Option('reference', help='Join by reference.', hidden=True),
 
4555
            Option('reference', help='Join by reference.'),
5187
4556
            ]
 
4557
    hidden = True
5188
4558
 
5189
4559
    def run(self, tree, reference=False):
5190
4560
        sub_tree = WorkingTree.open(tree)
5213
4583
 
5214
4584
 
5215
4585
class cmd_split(Command):
5216
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4586
    """Split a subdirectory of a tree into a separate tree.
5217
4587
 
5218
4588
    This command will produce a target tree in a format that supports
5219
4589
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5224
4594
    branch.  Commits in the top-level tree will not apply to the new subtree.
5225
4595
    """
5226
4596
 
5227
 
    _see_also = ['join']
 
4597
    # join is not un-hidden yet
 
4598
    #_see_also = ['join']
5228
4599
    takes_args = ['tree']
5229
4600
 
5230
4601
    def run(self, tree):
5235
4606
        try:
5236
4607
            containing_tree.extract(sub_id)
5237
4608
        except errors.RootNotRich:
5238
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4609
            raise errors.UpgradeRequired(containing_tree.branch.base)
5239
4610
 
5240
4611
 
5241
4612
class cmd_merge_directive(Command):
5242
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4613
    """Generate a merge directive for auto-merge tools.
5243
4614
 
5244
4615
    A directive requests a merge to be performed, and also provides all the
5245
4616
    information necessary to do so.  This means it must either include a
5262
4633
    _see_also = ['send']
5263
4634
 
5264
4635
    takes_options = [
5265
 
        'directory',
5266
4636
        RegistryOption.from_kwargs('patch-type',
5267
4637
            'The type of patch to include in the directive.',
5268
4638
            title='Patch type',
5281
4651
    encoding_type = 'exact'
5282
4652
 
5283
4653
    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'.'):
 
4654
            sign=False, revision=None, mail_to=None, message=None):
5286
4655
        from bzrlib.revision import ensure_null, NULL_REVISION
5287
4656
        include_patch, include_bundle = {
5288
4657
            'plain': (False, False),
5289
4658
            'diff': (True, False),
5290
4659
            'bundle': (True, True),
5291
4660
            }[patch_type]
5292
 
        branch = Branch.open(directory)
 
4661
        branch = Branch.open('.')
5293
4662
        stored_submit_branch = branch.get_submit_branch()
5294
4663
        if submit_branch is None:
5295
4664
            submit_branch = stored_submit_branch
5340
4709
 
5341
4710
 
5342
4711
class cmd_send(Command):
5343
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4712
    """Mail or create a merge-directive for submitting changes.
5344
4713
 
5345
4714
    A merge directive provides many things needed for requesting merges:
5346
4715
 
5352
4721
      directly from the merge directive, without retrieving data from a
5353
4722
      branch.
5354
4723
 
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.
 
4724
    If --no-bundle is specified, then public_branch is needed (and must be
 
4725
    up-to-date), so that the receiver can perform the merge using the
 
4726
    public_branch.  The public_branch is always included if known, so that
 
4727
    people can check it later.
 
4728
 
 
4729
    The submit branch defaults to the parent, but can be overridden.  Both
 
4730
    submit branch and public branch will be remembered if supplied.
 
4731
 
 
4732
    If a public_branch is known for the submit_branch, that public submit
 
4733
    branch is used in the merge instructions.  This means that a local mirror
 
4734
    can be used as your actual submit branch, once you have set public_branch
 
4735
    for that mirror.
5387
4736
 
5388
4737
    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.
 
4738
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5390
4739
    If the preferred client can't be found (or used), your editor will be used.
5391
4740
 
5392
4741
    To use a specific mail program, set the mail_client configuration option.
5393
4742
    (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.
 
4743
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4744
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4745
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5398
4746
 
5399
4747
    If mail is being sent, a to address is required.  This can be supplied
5400
4748
    either on the commandline, by setting the submit_to configuration
5409
4757
 
5410
4758
    The merge directives created by bzr send may be applied using bzr merge or
5411
4759
    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
4760
    """
5417
4761
 
5418
4762
    encoding_type = 'exact'
5434
4778
               short_name='f',
5435
4779
               type=unicode),
5436
4780
        Option('output', short_name='o',
5437
 
               help='Write merge directive to this file or directory; '
 
4781
               help='Write merge directive to this file; '
5438
4782
                    'use - for stdout.',
5439
4783
               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
4784
        Option('mail-to', help='Mail the request to this address.',
5444
4785
               type=unicode),
5445
4786
        'revision',
5446
4787
        'message',
5447
4788
        Option('body', help='Body for the email.', type=unicode),
5448
 
        RegistryOption('format',
5449
 
                       help='Use the specified output format.',
5450
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4789
        RegistryOption.from_kwargs('format',
 
4790
        'Use the specified output format.',
 
4791
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4792
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5451
4793
        ]
5452
4794
 
5453
4795
    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):
5457
 
        from bzrlib.send import send
5458
 
        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)
 
4796
            no_patch=False, revision=None, remember=False, output=None,
 
4797
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4798
        return self._run(submit_branch, revision, public_branch, remember,
 
4799
                         format, no_bundle, no_patch, output,
 
4800
                         kwargs.get('from', '.'), mail_to, message, body)
 
4801
 
 
4802
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4803
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4804
        from bzrlib.revision import NULL_REVISION
 
4805
        branch = Branch.open_containing(from_)[0]
 
4806
        if output is None:
 
4807
            outfile = cStringIO.StringIO()
 
4808
        elif output == '-':
 
4809
            outfile = self.outf
 
4810
        else:
 
4811
            outfile = open(output, 'wb')
 
4812
        # we may need to write data into branch's repository to calculate
 
4813
        # the data to send.
 
4814
        branch.lock_write()
 
4815
        try:
 
4816
            if output is None:
 
4817
                config = branch.get_config()
 
4818
                if mail_to is None:
 
4819
                    mail_to = config.get_user_option('submit_to')
 
4820
                mail_client = config.get_mail_client()
 
4821
                if (not getattr(mail_client, 'supports_body', False)
 
4822
                    and body is not None):
 
4823
                    raise errors.BzrCommandError(
 
4824
                        'Mail client "%s" does not support specifying body' %
 
4825
                        mail_client.__class__.__name__)
 
4826
            if remember and submit_branch is None:
 
4827
                raise errors.BzrCommandError(
 
4828
                    '--remember requires a branch to be specified.')
 
4829
            stored_submit_branch = branch.get_submit_branch()
 
4830
            remembered_submit_branch = None
 
4831
            if submit_branch is None:
 
4832
                submit_branch = stored_submit_branch
 
4833
                remembered_submit_branch = "submit"
 
4834
            else:
 
4835
                if stored_submit_branch is None or remember:
 
4836
                    branch.set_submit_branch(submit_branch)
 
4837
            if submit_branch is None:
 
4838
                submit_branch = branch.get_parent()
 
4839
                remembered_submit_branch = "parent"
 
4840
            if submit_branch is None:
 
4841
                raise errors.BzrCommandError('No submit branch known or'
 
4842
                                             ' specified')
 
4843
            if remembered_submit_branch is not None:
 
4844
                note('Using saved %s location "%s" to determine what '
 
4845
                        'changes to submit.', remembered_submit_branch,
 
4846
                        submit_branch)
 
4847
 
 
4848
            if mail_to is None:
 
4849
                submit_config = Branch.open(submit_branch).get_config()
 
4850
                mail_to = submit_config.get_user_option("child_submit_to")
 
4851
 
 
4852
            stored_public_branch = branch.get_public_branch()
 
4853
            if public_branch is None:
 
4854
                public_branch = stored_public_branch
 
4855
            elif stored_public_branch is None or remember:
 
4856
                branch.set_public_branch(public_branch)
 
4857
            if no_bundle and public_branch is None:
 
4858
                raise errors.BzrCommandError('No public branch specified or'
 
4859
                                             ' known')
 
4860
            base_revision_id = None
 
4861
            revision_id = None
 
4862
            if revision is not None:
 
4863
                if len(revision) > 2:
 
4864
                    raise errors.BzrCommandError('bzr send takes '
 
4865
                        'at most two one revision identifiers')
 
4866
                revision_id = revision[-1].as_revision_id(branch)
 
4867
                if len(revision) == 2:
 
4868
                    base_revision_id = revision[0].as_revision_id(branch)
 
4869
            if revision_id is None:
 
4870
                revision_id = branch.last_revision()
 
4871
            if revision_id == NULL_REVISION:
 
4872
                raise errors.BzrCommandError('No revisions to submit.')
 
4873
            if format == '4':
 
4874
                directive = merge_directive.MergeDirective2.from_objects(
 
4875
                    branch.repository, revision_id, time.time(),
 
4876
                    osutils.local_time_offset(), submit_branch,
 
4877
                    public_branch=public_branch, include_patch=not no_patch,
 
4878
                    include_bundle=not no_bundle, message=message,
 
4879
                    base_revision_id=base_revision_id)
 
4880
            elif format == '0.9':
 
4881
                if not no_bundle:
 
4882
                    if not no_patch:
 
4883
                        patch_type = 'bundle'
 
4884
                    else:
 
4885
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4886
                            ' permit bundle with no patch')
 
4887
                else:
 
4888
                    if not no_patch:
 
4889
                        patch_type = 'diff'
 
4890
                    else:
 
4891
                        patch_type = None
 
4892
                directive = merge_directive.MergeDirective.from_objects(
 
4893
                    branch.repository, revision_id, time.time(),
 
4894
                    osutils.local_time_offset(), submit_branch,
 
4895
                    public_branch=public_branch, patch_type=patch_type,
 
4896
                    message=message)
 
4897
 
 
4898
            outfile.writelines(directive.to_lines())
 
4899
            if output is None:
 
4900
                subject = '[MERGE] '
 
4901
                if message is not None:
 
4902
                    subject += message
 
4903
                else:
 
4904
                    revision = branch.repository.get_revision(revision_id)
 
4905
                    subject += revision.get_summary()
 
4906
                basename = directive.get_disk_name(branch)
 
4907
                mail_client.compose_merge_request(mail_to, subject,
 
4908
                                                  outfile.getvalue(),
 
4909
                                                  basename, body)
 
4910
        finally:
 
4911
            if output != '-':
 
4912
                outfile.close()
 
4913
            branch.unlock()
5463
4914
 
5464
4915
 
5465
4916
class cmd_bundle_revisions(cmd_send):
5466
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4917
 
 
4918
    """Create a merge-directive for submitting changes.
5467
4919
 
5468
4920
    A merge directive provides many things needed for requesting merges:
5469
4921
 
5509
4961
               type=unicode),
5510
4962
        Option('output', short_name='o', help='Write directive to this file.',
5511
4963
               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
4964
        'revision',
5516
 
        RegistryOption('format',
5517
 
                       help='Use the specified output format.',
5518
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4965
        RegistryOption.from_kwargs('format',
 
4966
        'Use the specified output format.',
 
4967
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4968
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5519
4969
        ]
5520
4970
    aliases = ['bundle']
5521
4971
 
5525
4975
 
5526
4976
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5527
4977
            no_patch=False, revision=None, remember=False, output=None,
5528
 
            format=None, strict=None, **kwargs):
 
4978
            format='4', **kwargs):
5529
4979
        if output is None:
5530
4980
            output = '-'
5531
 
        from bzrlib.send import send
5532
 
        return send(submit_branch, revision, public_branch, remember,
 
4981
        return self._run(submit_branch, revision, public_branch, remember,
5533
4982
                         format, no_bundle, no_patch, output,
5534
 
                         kwargs.get('from', '.'), None, None, None,
5535
 
                         self.outf, strict=strict)
 
4983
                         kwargs.get('from', '.'), None, None, None)
5536
4984
 
5537
4985
 
5538
4986
class cmd_tag(Command):
5539
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4987
    """Create, remove or modify a tag naming a revision.
5540
4988
 
5541
4989
    Tags give human-meaningful names to revisions.  Commands that take a -r
5542
4990
    (--revision) option can be given -rtag:X, where X is any previously
5550
4998
 
5551
4999
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5552
5000
    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
5001
    """
5559
5002
 
5560
5003
    _see_also = ['commit', 'tags']
5561
 
    takes_args = ['tag_name?']
 
5004
    takes_args = ['tag_name']
5562
5005
    takes_options = [
5563
5006
        Option('delete',
5564
5007
            help='Delete this tag rather than placing it.',
5565
5008
            ),
5566
 
        custom_help('directory',
5567
 
            help='Branch in which to place the tag.'),
 
5009
        Option('directory',
 
5010
            help='Branch in which to place the tag.',
 
5011
            short_name='d',
 
5012
            type=unicode,
 
5013
            ),
5568
5014
        Option('force',
5569
5015
            help='Replace existing tags.',
5570
5016
            ),
5571
5017
        'revision',
5572
5018
        ]
5573
5019
 
5574
 
    def run(self, tag_name=None,
 
5020
    def run(self, tag_name,
5575
5021
            delete=None,
5576
5022
            directory='.',
5577
5023
            force=None,
5578
5024
            revision=None,
5579
5025
            ):
5580
5026
        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)
 
5027
        branch.lock_write()
 
5028
        try:
 
5029
            if delete:
 
5030
                branch.tags.delete_tag(tag_name)
 
5031
                self.outf.write('Deleted tag %s.\n' % tag_name)
5594
5032
            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)
 
5033
                if revision:
 
5034
                    if len(revision) != 1:
 
5035
                        raise errors.BzrCommandError(
 
5036
                            "Tags can only be placed on a single revision, "
 
5037
                            "not on a range")
 
5038
                    revision_id = revision[0].as_revision_id(branch)
 
5039
                else:
 
5040
                    revision_id = branch.last_revision()
 
5041
                if (not force) and branch.tags.has_tag(tag_name):
 
5042
                    raise errors.TagAlreadyExists(tag_name)
 
5043
                branch.tags.set_tag(tag_name, revision_id)
 
5044
                self.outf.write('Created tag %s.\n' % tag_name)
 
5045
        finally:
 
5046
            branch.unlock()
5605
5047
 
5606
5048
 
5607
5049
class cmd_tags(Command):
5608
 
    __doc__ = """List tags.
 
5050
    """List tags.
5609
5051
 
5610
5052
    This command shows a table of tag names and the revisions they reference.
5611
5053
    """
5612
5054
 
5613
5055
    _see_also = ['tag']
5614
5056
    takes_options = [
5615
 
        custom_help('directory',
5616
 
            help='Branch whose tags should be displayed.'),
5617
 
        RegistryOption('sort',
 
5057
        Option('directory',
 
5058
            help='Branch whose tags should be displayed.',
 
5059
            short_name='d',
 
5060
            type=unicode,
 
5061
            ),
 
5062
        RegistryOption.from_kwargs('sort',
5618
5063
            'Sort tags by different criteria.', title='Sorting',
5619
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
5064
            alpha='Sort tags lexicographically (default).',
 
5065
            time='Sort tags chronologically.',
5620
5066
            ),
5621
5067
        'show-ids',
5622
5068
        'revision',
5623
5069
    ]
5624
5070
 
5625
5071
    @display_command
5626
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5627
 
        from bzrlib.tag import tag_sort_methods
 
5072
    def run(self,
 
5073
            directory='.',
 
5074
            sort='alpha',
 
5075
            show_ids=False,
 
5076
            revision=None,
 
5077
            ):
5628
5078
        branch, relpath = Branch.open_containing(directory)
5629
5079
 
5630
5080
        tags = branch.tags.get_tag_dict().items()
5631
5081
        if not tags:
5632
5082
            return
5633
5083
 
5634
 
        self.add_cleanup(branch.lock_read().unlock)
5635
5084
        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)
 
5085
            branch.lock_read()
 
5086
            try:
 
5087
                graph = branch.repository.get_graph()
 
5088
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5089
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5090
                # only show revisions between revid1 and revid2 (inclusive)
 
5091
                tags = [(tag, revid) for tag, revid in tags if
 
5092
                    graph.is_between(revid, revid1, revid2)]
 
5093
            finally:
 
5094
                branch.unlock()
 
5095
        if sort == 'alpha':
 
5096
            tags.sort()
 
5097
        elif sort == 'time':
 
5098
            timestamps = {}
 
5099
            for tag, revid in tags:
 
5100
                try:
 
5101
                    revobj = branch.repository.get_revision(revid)
 
5102
                except errors.NoSuchRevision:
 
5103
                    timestamp = sys.maxint # place them at the end
 
5104
                else:
 
5105
                    timestamp = revobj.timestamp
 
5106
                timestamps[revid] = timestamp
 
5107
            tags.sort(key=lambda x: timestamps[x[1]])
5645
5108
        if not show_ids:
5646
5109
            # [ (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()
 
5110
            revno_map = branch.get_revision_id_to_revno_map()
 
5111
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5112
                        for tag, revid in tags ]
5658
5113
        for tag, revspec in tags:
5659
5114
            self.outf.write('%-20s %s\n' % (tag, revspec))
5660
5115
 
5661
5116
 
5662
5117
class cmd_reconfigure(Command):
5663
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5118
    """Reconfigure the type of a bzr directory.
5664
5119
 
5665
5120
    A target configuration must be specified.
5666
5121
 
5696
5151
            ),
5697
5152
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5698
5153
        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
 
            ),
 
5154
               help='Perform reconfiguration even if local changes'
 
5155
               ' will be lost.')
5709
5156
        ]
5710
5157
 
5711
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5712
 
            stacked_on=None,
5713
 
            unstacked=None):
 
5158
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5714
5159
        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
5160
        if target_type is None:
5725
 
            if stacked_on or unstacked:
5726
 
                return
5727
 
            else:
5728
 
                raise errors.BzrCommandError('No target configuration '
5729
 
                    'specified')
 
5161
            raise errors.BzrCommandError('No target configuration specified')
5730
5162
        elif target_type == 'branch':
5731
5163
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5732
5164
        elif target_type == 'tree':
5751
5183
 
5752
5184
 
5753
5185
class cmd_switch(Command):
5754
 
    __doc__ = """Set the branch of a checkout and update.
 
5186
    """Set the branch of a checkout and update.
5755
5187
 
5756
5188
    For lightweight checkouts, this changes the branch being referenced.
5757
5189
    For heavyweight checkouts, this checks that there are no local commits
5769
5201
    /path/to/newbranch.
5770
5202
 
5771
5203
    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
 
5204
    locally, in which case switching will update the the local nickname to be
5773
5205
    that of the master.
5774
5206
    """
5775
5207
 
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
 
                    ]
 
5208
    takes_args = ['to_location']
 
5209
    takes_options = [Option('force',
 
5210
                        help='Switch even if local commits will be lost.')
 
5211
                     ]
5785
5212
 
5786
 
    def run(self, to_location=None, force=False, create_branch=False,
5787
 
            revision=None, directory=u'.'):
 
5213
    def run(self, to_location, force=False):
5788
5214
        from bzrlib import switch
5789
 
        tree_location = directory
5790
 
        revision = _get_one_revision('switch', revision)
 
5215
        tree_location = '.'
5791
5216
        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
 
5217
        branch = control_dir.open_branch()
5797
5218
        try:
5798
 
            branch = control_dir.open_branch()
5799
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5219
            to_branch = Branch.open(to_location)
5800
5220
        except errors.NotBranchError:
5801
 
            branch = None
5802
 
            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)
5826
 
        if had_explicit_nick:
 
5221
            this_branch = control_dir.open_branch()
 
5222
            # This may be a heavy checkout, where we want the master branch
 
5223
            this_url = this_branch.get_bound_location()
 
5224
            # If not, use a local sibling
 
5225
            if this_url is None:
 
5226
                this_url = this_branch.base
 
5227
            to_branch = Branch.open(
 
5228
                urlutils.join(this_url, '..', to_location))
 
5229
        switch.switch(control_dir, to_branch, force)
 
5230
        if branch.get_config().has_explicit_nickname():
5827
5231
            branch = control_dir.open_branch() #get the new branch!
5828
5232
            branch.nick = to_branch.nick
5829
5233
        note('Switched to branch: %s',
5830
5234
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5831
5235
 
5832
 
    def _get_branch_location(self, control_dir):
5833
 
        """Return location of branch for this control dir."""
 
5236
 
 
5237
class cmd_guess_renames(Command):
 
5238
    """Guess which files have been have been renamed, based on their content.
 
5239
 
 
5240
    Only versioned files which have been deleted are candidates for rename
 
5241
    detection, and renames to ignored files will not be detected.
 
5242
    """
 
5243
 
 
5244
    def run(self):
 
5245
        work_tree, file_list = tree_files(None, default_branch='.')
 
5246
        work_tree.lock_write()
5834
5247
        try:
5835
 
            this_branch = control_dir.open_branch()
5836
 
            # This may be a heavy checkout, where we want the master branch
5837
 
            master_location = this_branch.get_bound_location()
5838
 
            if master_location is not None:
5839
 
                return master_location
5840
 
            # If not, use a local sibling
5841
 
            return this_branch.base
5842
 
        except errors.NotBranchError:
5843
 
            format = control_dir.find_branch_format()
5844
 
            if getattr(format, 'get_reference', None) is not None:
5845
 
                return format.get_reference(control_dir)
5846
 
            else:
5847
 
                return control_dir.root_transport.base
 
5248
            rename_map.RenameMap.guess_renames(work_tree)
 
5249
        finally:
 
5250
            work_tree.unlock()
5848
5251
 
5849
5252
 
5850
5253
class cmd_view(Command):
5851
 
    __doc__ = """Manage filtered views.
 
5254
    """Manage filtered views.
5852
5255
 
5853
5256
    Views provide a mask over the tree so that users can focus on
5854
5257
    a subset of a tree when doing their work. After creating a view,
5934
5337
            name=None,
5935
5338
            switch=None,
5936
5339
            ):
5937
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5938
 
            apply_view=False)
 
5340
        tree, file_list = tree_files(file_list, apply_view=False)
5939
5341
        current_view, view_dict = tree.views.get_view_info()
5940
5342
        if name is None:
5941
5343
            name = current_view
6003
5405
 
6004
5406
 
6005
5407
class cmd_hooks(Command):
6006
 
    __doc__ = """Show hooks."""
 
5408
    """Show hooks."""
6007
5409
 
6008
5410
    hidden = True
6009
5411
 
6022
5424
                    self.outf.write("    <no hooks installed>\n")
6023
5425
 
6024
5426
 
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
5427
class cmd_shelve(Command):
6051
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5428
    """Temporarily set aside some changes from the current tree.
6052
5429
 
6053
5430
    Shelve allows you to temporarily put changes you've made "on the shelf",
6054
5431
    ie. out of the way, until a later time when you can bring them back from
6070
5447
 
6071
5448
    You can put multiple items on the shelf, and by default, 'unshelve' will
6072
5449
    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
5450
    """
6086
5451
 
6087
5452
    takes_args = ['file*']
6088
5453
 
6089
5454
    takes_options = [
6090
 
        'directory',
6091
5455
        'revision',
6092
5456
        Option('all', help='Shelve all changes.'),
6093
5457
        'message',
6099
5463
        Option('destroy',
6100
5464
               help='Destroy removed changes instead of shelving them.'),
6101
5465
    ]
6102
 
    _see_also = ['unshelve', 'configuration']
 
5466
    _see_also = ['unshelve']
6103
5467
 
6104
5468
    def run(self, revision=None, all=False, file_list=None, message=None,
6105
 
            writer=None, list=False, destroy=False, directory=None):
 
5469
            writer=None, list=False, destroy=False):
6106
5470
        if list:
6107
 
            return self.run_for_list(directory=directory)
 
5471
            return self.run_for_list()
6108
5472
        from bzrlib.shelf_ui import Shelver
6109
5473
        if writer is None:
6110
5474
            writer = bzrlib.option.diff_writer_registry.get()
6111
5475
        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()
 
5476
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5477
                              message, destroy=destroy).run()
6118
5478
        except errors.UserAbort:
6119
5479
            return 0
6120
5480
 
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
 
5481
    def run_for_list(self):
 
5482
        tree = WorkingTree.open_containing('.')[0]
 
5483
        tree.lock_read()
 
5484
        try:
 
5485
            manager = tree.get_shelf_manager()
 
5486
            shelves = manager.active_shelves()
 
5487
            if len(shelves) == 0:
 
5488
                note('No shelved changes.')
 
5489
                return 0
 
5490
            for shelf_id in reversed(shelves):
 
5491
                message = manager.get_metadata(shelf_id).get('message')
 
5492
                if message is None:
 
5493
                    message = '<no message>'
 
5494
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5495
            return 1
 
5496
        finally:
 
5497
            tree.unlock()
6137
5498
 
6138
5499
 
6139
5500
class cmd_unshelve(Command):
6140
 
    __doc__ = """Restore shelved changes.
 
5501
    """Restore shelved changes.
6141
5502
 
6142
5503
    By default, the most recently shelved changes are restored. However if you
6143
5504
    specify a shelf by id those changes will be restored instead.  This works
6146
5507
 
6147
5508
    takes_args = ['shelf_id?']
6148
5509
    takes_options = [
6149
 
        'directory',
6150
5510
        RegistryOption.from_kwargs(
6151
5511
            'action', help="The action to perform.",
6152
5512
            enum_switch=False, value_switches=True,
6153
5513
            apply="Apply changes and remove from the shelf.",
6154
5514
            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.",
 
5515
            delete_only="Delete changes without applying them."
6159
5516
        )
6160
5517
    ]
6161
5518
    _see_also = ['shelve']
6162
5519
 
6163
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5520
    def run(self, shelf_id=None, action='apply'):
6164
5521
        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()
 
5522
        Unshelver.from_args(shelf_id, action).run()
6170
5523
 
6171
5524
 
6172
5525
class cmd_clean_tree(Command):
6173
 
    __doc__ = """Remove unwanted files from working tree.
 
5526
    """Remove unwanted files from working tree.
6174
5527
 
6175
5528
    By default, only unknown files, not ignored files, are deleted.  Versioned
6176
5529
    files are never deleted.
6184
5537
 
6185
5538
    To check what clean-tree will do, use --dry-run.
6186
5539
    """
6187
 
    takes_options = ['directory',
6188
 
                     Option('ignored', help='Delete all ignored files.'),
6189
 
                     Option('detritus', help='Delete conflict files, merge and revert'
 
5540
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5541
                     Option('detritus', help='Delete conflict files, merge'
6190
5542
                            ' backups, and failed selftest dirs.'),
6191
5543
                     Option('unknown',
6192
5544
                            help='Delete files unknown to bzr (default).'),
6194
5546
                            ' deleting them.'),
6195
5547
                     Option('force', help='Do not prompt before deleting.')]
6196
5548
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6197
 
            force=False, directory=u'.'):
 
5549
            force=False):
6198
5550
        from bzrlib.clean_tree import clean_tree
6199
5551
        if not (unknown or ignored or detritus):
6200
5552
            unknown = True
6201
5553
        if dry_run:
6202
5554
            force = True
6203
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6204
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
6205
 
 
6206
 
 
6207
 
class cmd_reference(Command):
6208
 
    __doc__ = """list, view and set branch locations for nested trees.
6209
 
 
6210
 
    If no arguments are provided, lists the branch locations for nested trees.
6211
 
    If one argument is provided, display the branch location for that tree.
6212
 
    If two arguments are provided, set the branch location for that tree.
6213
 
    """
6214
 
 
6215
 
    hidden = True
6216
 
 
6217
 
    takes_args = ['path?', 'location?']
6218
 
 
6219
 
    def run(self, path=None, location=None):
6220
 
        branchdir = '.'
6221
 
        if path is not None:
6222
 
            branchdir = path
6223
 
        tree, branch, relpath =(
6224
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6225
 
        if path is not None:
6226
 
            path = relpath
6227
 
        if tree is None:
6228
 
            tree = branch.basis_tree()
6229
 
        if path is None:
6230
 
            info = branch._get_all_reference_info().iteritems()
6231
 
            self._display_reference_info(tree, branch, info)
 
5555
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5556
                   dry_run=dry_run, no_prompt=force)
 
5557
 
 
5558
 
 
5559
def _create_prefix(cur_transport):
 
5560
    needed = [cur_transport]
 
5561
    # Recurse upwards until we can create a directory successfully
 
5562
    while True:
 
5563
        new_transport = cur_transport.clone('..')
 
5564
        if new_transport.base == cur_transport.base:
 
5565
            raise errors.BzrCommandError(
 
5566
                "Failed to create path prefix for %s."
 
5567
                % cur_transport.base)
 
5568
        try:
 
5569
            new_transport.mkdir('.')
 
5570
        except errors.NoSuchFile:
 
5571
            needed.append(new_transport)
 
5572
            cur_transport = new_transport
6232
5573
        else:
6233
 
            file_id = tree.path2id(path)
6234
 
            if file_id is None:
6235
 
                raise errors.NotVersionedError(path)
6236
 
            if location is None:
6237
 
                info = [(file_id, branch.get_reference_info(file_id))]
6238
 
                self._display_reference_info(tree, branch, info)
6239
 
            else:
6240
 
                branch.set_reference_info(file_id, path, location)
6241
 
 
6242
 
    def _display_reference_info(self, tree, branch, info):
6243
 
        ref_list = []
6244
 
        for file_id, (path, location) in info:
6245
 
            try:
6246
 
                path = tree.id2path(file_id)
6247
 
            except errors.NoSuchId:
6248
 
                pass
6249
 
            ref_list.append((path, location))
6250
 
        for path, location in sorted(ref_list):
6251
 
            self.outf.write('%s %s\n' % (path, location))
6252
 
 
6253
 
 
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)
 
5574
            break
 
5575
    # Now we only need to create child directories
 
5576
    while needed:
 
5577
        cur_transport = needed.pop()
 
5578
        cur_transport.ensure_base()
 
5579
 
 
5580
 
 
5581
# these get imported and then picked up by the scan for cmd_*
 
5582
# TODO: Some more consistent way to split command definitions across files;
 
5583
# we do need to load at least some information about them to know of
 
5584
# aliases.  ideally we would avoid loading the implementation until the
 
5585
# details were needed.
 
5586
from bzrlib.cmd_version_info import cmd_version_info
 
5587
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5588
from bzrlib.bundle.commands import (
 
5589
    cmd_bundle_info,
 
5590
    )
 
5591
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5592
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5593
        cmd_weave_plan_merge, cmd_weave_merge_text