~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2009-05-04 14:48:21 UTC
  • mto: (4349.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4350.
  • Revision ID: v.ladeuil+lp@free.fr-20090504144821-39dvqkikmd3zqkdg
Handle servers proposing several authentication schemes.

* bzrlib/transport/http/_urllib2_wrappers.py:
(AbstractAuthHandler.auth_required): Several schemes can be
proposed by the server, try to match each one in turn.
(BasicAuthHandler.auth_match): Delete dead code.

* bzrlib/tests/test_http.py:
(load_tests): Separate proxy and http authentication tests as they
require different server setups.
(TestAuth.create_transport_readonly_server): Simplified by using
parameter provided by load_tests.
(TestAuth.test_changing_nonce): Adapt to new parametrization.
(TestProxyAuth.create_transport_readonly_server): Deleted.

* bzrlib/tests/http_utils.py:
(DigestAndBasicAuthRequestHandler, HTTPBasicAndDigestAuthServer,
ProxyBasicAndDigestAuthServer): Add a test server proposing both
basic and digest auth schemes but accepting only digest as valid.

Show diffs side-by-side

added added

removed removed

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