~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Add a NEWS entry and prepare submission.

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,
44
44
    rename_map,
45
45
    revision as _mod_revision,
46
46
    static_tuple,
 
47
    symbol_versioning,
47
48
    timestamp,
48
49
    transport,
49
50
    ui,
50
51
    urlutils,
51
52
    views,
52
 
    gpg,
53
53
    )
54
54
from bzrlib.branch import Branch
55
55
from bzrlib.conflicts import ConflictList
56
 
from bzrlib.transport import memory
57
56
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
57
from bzrlib.smtp_connection import SMTPConnection
59
58
from bzrlib.workingtree import WorkingTree
60
 
from bzrlib.i18n import gettext, ngettext
61
59
""")
62
60
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
 
61
from bzrlib.commands import Command, display_command
68
62
from bzrlib.option import (
69
63
    ListOption,
70
64
    Option,
73
67
    _parse_revision_str,
74
68
    )
75
69
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
 
from bzrlib import (
77
 
    symbol_versioning,
78
 
    )
79
 
 
80
 
 
81
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
 
70
 
 
71
 
82
72
def tree_files(file_list, default_branch=u'.', canonicalize=True,
83
73
    apply_view=True):
84
 
    return internal_tree_files(file_list, default_branch, canonicalize,
85
 
        apply_view)
 
74
    try:
 
75
        return internal_tree_files(file_list, default_branch, canonicalize,
 
76
            apply_view)
 
77
    except errors.FileInWrongBranch, e:
 
78
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
79
                                     (e.path, file_list[0]))
86
80
 
87
81
 
88
82
def tree_files_for_add(file_list):
113
107
            if view_files:
114
108
                file_list = view_files
115
109
                view_str = views.view_display_str(view_files)
116
 
                note(gettext("Ignoring files outside view. View is %s") % view_str)
 
110
                note("Ignoring files outside view. View is %s" % view_str)
117
111
    return tree, file_list
118
112
 
119
113
 
121
115
    if revisions is None:
122
116
        return None
123
117
    if len(revisions) != 1:
124
 
        raise errors.BzrCommandError(gettext(
125
 
            'bzr %s --revision takes exactly one revision identifier') % (
 
118
        raise errors.BzrCommandError(
 
119
            'bzr %s --revision takes exactly one revision identifier' % (
126
120
                command_name,))
127
121
    return revisions[0]
128
122
 
152
146
 
153
147
# XXX: Bad function name; should possibly also be a class method of
154
148
# WorkingTree rather than a function.
155
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
156
149
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
157
150
    apply_view=True):
158
151
    """Convert command-line paths to a WorkingTree and relative paths.
159
152
 
160
 
    Deprecated: use WorkingTree.open_containing_paths instead.
161
 
 
162
153
    This is typically used for command-line processors that take one or
163
154
    more filenames, and infer the workingtree that contains them.
164
155
 
174
165
 
175
166
    :return: workingtree, [relative_paths]
176
167
    """
177
 
    return WorkingTree.open_containing_paths(
178
 
        file_list, default_directory='.',
179
 
        canonicalize=True,
180
 
        apply_view=True)
 
168
    if file_list is None or len(file_list) == 0:
 
169
        tree = WorkingTree.open_containing(default_branch)[0]
 
170
        if tree.supports_views() and apply_view:
 
171
            view_files = tree.views.lookup_view()
 
172
            if view_files:
 
173
                file_list = view_files
 
174
                view_str = views.view_display_str(view_files)
 
175
                note("Ignoring files outside view. View is %s" % view_str)
 
176
        return tree, file_list
 
177
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
178
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
179
        apply_view=apply_view)
 
180
 
 
181
 
 
182
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
183
    """Convert file_list into a list of relpaths in tree.
 
184
 
 
185
    :param tree: A tree to operate on.
 
186
    :param file_list: A list of user provided paths or None.
 
187
    :param apply_view: if True and a view is set, apply it or check that
 
188
        specified files are within it
 
189
    :return: A list of relative paths.
 
190
    :raises errors.PathNotChild: When a provided path is in a different tree
 
191
        than tree.
 
192
    """
 
193
    if file_list is None:
 
194
        return None
 
195
    if tree.supports_views() and apply_view:
 
196
        view_files = tree.views.lookup_view()
 
197
    else:
 
198
        view_files = []
 
199
    new_list = []
 
200
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
201
    # doesn't - fix that up here before we enter the loop.
 
202
    if canonicalize:
 
203
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
204
    else:
 
205
        fixer = tree.relpath
 
206
    for filename in file_list:
 
207
        try:
 
208
            relpath = fixer(osutils.dereference_path(filename))
 
209
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
210
                raise errors.FileOutsideView(filename, view_files)
 
211
            new_list.append(relpath)
 
212
        except errors.PathNotChild:
 
213
            raise errors.FileInWrongBranch(tree.branch, filename)
 
214
    return new_list
181
215
 
182
216
 
183
217
def _get_view_info_for_change_reporter(tree):
192
226
    return view_info
193
227
 
194
228
 
195
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
196
 
    """Open the tree or branch containing the specified file, unless
197
 
    the --directory option is used to specify a different branch."""
198
 
    if directory is not None:
199
 
        return (None, Branch.open(directory), filename)
200
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
201
 
 
202
 
 
203
229
# TODO: Make sure no commands unconditionally use the working directory as a
204
230
# branch.  If a filename argument is used, the first of them should be used to
205
231
# specify the branch.  (Perhaps this can be factored out into some kind of
207
233
# opens the branch?)
208
234
 
209
235
class cmd_status(Command):
210
 
    __doc__ = """Display status summary.
 
236
    """Display status summary.
211
237
 
212
238
    This reports on versioned and unknown files, reporting them
213
239
    grouped by state.  Possible states are:
233
259
    unknown
234
260
        Not versioned and not matching an ignore pattern.
235
261
 
236
 
    Additionally for directories, symlinks and files with a changed
237
 
    executable bit, Bazaar indicates their type using a trailing
238
 
    character: '/', '@' or '*' respectively. These decorations can be
239
 
    disabled using the '--no-classify' option.
 
262
    Additionally for directories, symlinks and files with an executable
 
263
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
264
    or '*' respectively.
240
265
 
241
266
    To see ignored files use 'bzr ignored'.  For details on the
242
267
    changes to file texts, use 'bzr diff'.
255
280
    To skip the display of pending merge information altogether, use
256
281
    the no-pending option or specify a file/directory.
257
282
 
258
 
    To compare the working directory to a specific revision, pass a
259
 
    single revision to the revision argument.
260
 
 
261
 
    To see which files have changed in a specific revision, or between
262
 
    two revisions, pass a revision range to the revision argument.
263
 
    This will produce the same results as calling 'bzr diff --summarize'.
 
283
    If a revision argument is given, the status is calculated against
 
284
    that revision, or between two revisions if two are provided.
264
285
    """
265
286
 
266
287
    # TODO: --no-recurse, --recurse options
273
294
                            short_name='V'),
274
295
                     Option('no-pending', help='Don\'t show pending merges.',
275
296
                           ),
276
 
                     Option('no-classify',
277
 
                            help='Do not mark object type using indicator.',
278
 
                           ),
279
297
                     ]
280
298
    aliases = ['st', 'stat']
281
299
 
284
302
 
285
303
    @display_command
286
304
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
287
 
            versioned=False, no_pending=False, verbose=False,
288
 
            no_classify=False):
 
305
            versioned=False, no_pending=False, verbose=False):
289
306
        from bzrlib.status import show_tree_status
290
307
 
291
308
        if revision and len(revision) > 2:
292
 
            raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
293
 
                                         ' one or two revision specifiers'))
 
309
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
310
                                         ' one or two revision specifiers')
294
311
 
295
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
312
        tree, relfile_list = tree_files(file_list)
296
313
        # Avoid asking for specific files when that is not needed.
297
314
        if relfile_list == ['']:
298
315
            relfile_list = None
305
322
        show_tree_status(tree, show_ids=show_ids,
306
323
                         specific_files=relfile_list, revision=revision,
307
324
                         to_file=self.outf, short=short, versioned=versioned,
308
 
                         show_pending=(not no_pending), verbose=verbose,
309
 
                         classify=not no_classify)
 
325
                         show_pending=(not no_pending), verbose=verbose)
310
326
 
311
327
 
312
328
class cmd_cat_revision(Command):
313
 
    __doc__ = """Write out metadata for a revision.
 
329
    """Write out metadata for a revision.
314
330
 
315
331
    The revision to print can either be specified by a specific
316
332
    revision identifier, or you can use --revision.
318
334
 
319
335
    hidden = True
320
336
    takes_args = ['revision_id?']
321
 
    takes_options = ['directory', 'revision']
 
337
    takes_options = ['revision']
322
338
    # cat-revision is more for frontends so should be exact
323
339
    encoding = 'strict'
324
340
 
325
 
    def print_revision(self, revisions, revid):
326
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
327
 
        record = stream.next()
328
 
        if record.storage_kind == 'absent':
329
 
            raise errors.NoSuchRevision(revisions, revid)
330
 
        revtext = record.get_bytes_as('fulltext')
331
 
        self.outf.write(revtext.decode('utf-8'))
332
 
 
333
341
    @display_command
334
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
342
    def run(self, revision_id=None, revision=None):
335
343
        if revision_id is not None and revision is not None:
336
 
            raise errors.BzrCommandError(gettext('You can only supply one of'
337
 
                                         ' revision_id or --revision'))
 
344
            raise errors.BzrCommandError('You can only supply one of'
 
345
                                         ' revision_id or --revision')
338
346
        if revision_id is None and revision is None:
339
 
            raise errors.BzrCommandError(gettext('You must supply either'
340
 
                                         ' --revision or a revision_id'))
341
 
 
342
 
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
343
 
 
344
 
        revisions = b.repository.revisions
345
 
        if revisions is None:
346
 
            raise errors.BzrCommandError(gettext('Repository %r does not support '
347
 
                'access to raw revision texts'))
348
 
 
349
 
        b.repository.lock_read()
350
 
        try:
351
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
352
 
            if revision_id is not None:
353
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
354
 
                try:
355
 
                    self.print_revision(revisions, revision_id)
356
 
                except errors.NoSuchRevision:
357
 
                    msg = gettext("The repository {0} contains no revision {1}.").format(
358
 
                        b.repository.base, revision_id)
359
 
                    raise errors.BzrCommandError(msg)
360
 
            elif revision is not None:
361
 
                for rev in revision:
362
 
                    if rev is None:
363
 
                        raise errors.BzrCommandError(
364
 
                            gettext('You cannot specify a NULL revision.'))
365
 
                    rev_id = rev.as_revision_id(b)
366
 
                    self.print_revision(revisions, rev_id)
367
 
        finally:
368
 
            b.repository.unlock()
369
 
        
 
347
            raise errors.BzrCommandError('You must supply either'
 
348
                                         ' --revision or a revision_id')
 
349
        b = WorkingTree.open_containing(u'.')[0].branch
 
350
 
 
351
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
352
        if revision_id is not None:
 
353
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
354
            try:
 
355
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
356
            except errors.NoSuchRevision:
 
357
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
358
                    revision_id)
 
359
                raise errors.BzrCommandError(msg)
 
360
        elif revision is not None:
 
361
            for rev in revision:
 
362
                if rev is None:
 
363
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
364
                                                 ' revision.')
 
365
                rev_id = rev.as_revision_id(b)
 
366
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
367
 
370
368
 
371
369
class cmd_dump_btree(Command):
372
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
370
    """Dump the contents of a btree index file to stdout.
373
371
 
374
372
    PATH is a btree index file, it can be any URL. This includes things like
375
373
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
423
421
                self.outf.write(page_bytes[:header_end])
424
422
                page_bytes = data
425
423
            self.outf.write('\nPage %d\n' % (page_idx,))
426
 
            if len(page_bytes) == 0:
427
 
                self.outf.write('(empty)\n');
428
 
            else:
429
 
                decomp_bytes = zlib.decompress(page_bytes)
430
 
                self.outf.write(decomp_bytes)
431
 
                self.outf.write('\n')
 
424
            decomp_bytes = zlib.decompress(page_bytes)
 
425
            self.outf.write(decomp_bytes)
 
426
            self.outf.write('\n')
432
427
 
433
428
    def _dump_entries(self, trans, basename):
434
429
        try:
442
437
        for node in bt.iter_all_entries():
443
438
            # Node is made up of:
444
439
            # (index, key, value, [references])
445
 
            try:
446
 
                refs = node[3]
447
 
            except IndexError:
448
 
                refs_as_tuples = None
449
 
            else:
450
 
                refs_as_tuples = static_tuple.as_tuples(refs)
 
440
            refs_as_tuples = static_tuple.as_tuples(node[3])
451
441
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
452
442
            self.outf.write('%s\n' % (as_tuple,))
453
443
 
454
444
 
455
445
class cmd_remove_tree(Command):
456
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
446
    """Remove the working tree from a given branch/checkout.
457
447
 
458
448
    Since a lightweight checkout is little more than a working tree
459
449
    this will refuse to run against one.
461
451
    To re-create the working tree, use "bzr checkout".
462
452
    """
463
453
    _see_also = ['checkout', 'working-trees']
464
 
    takes_args = ['location*']
 
454
    takes_args = ['location?']
465
455
    takes_options = [
466
456
        Option('force',
467
457
               help='Remove the working tree even if it has '
468
 
                    'uncommitted or shelved changes.'),
 
458
                    'uncommitted changes.'),
469
459
        ]
470
460
 
471
 
    def run(self, location_list, force=False):
472
 
        if not location_list:
473
 
            location_list=['.']
474
 
 
475
 
        for location in location_list:
476
 
            d = bzrdir.BzrDir.open(location)
477
 
            
478
 
            try:
479
 
                working = d.open_workingtree()
480
 
            except errors.NoWorkingTree:
481
 
                raise errors.BzrCommandError(gettext("No working tree to remove"))
482
 
            except errors.NotLocalUrl:
483
 
                raise errors.BzrCommandError(gettext("You cannot remove the working tree"
484
 
                                             " of a remote path"))
485
 
            if not force:
486
 
                if (working.has_changes()):
487
 
                    raise errors.UncommittedChanges(working)
488
 
                if working.get_shelf_manager().last_shelf() is not None:
489
 
                    raise errors.ShelvedChanges(working)
490
 
 
491
 
            if working.user_url != working.branch.user_url:
492
 
                raise errors.BzrCommandError(gettext("You cannot remove the working tree"
493
 
                                             " from a lightweight checkout"))
494
 
 
495
 
            d.destroy_workingtree()
496
 
 
497
 
 
498
 
class cmd_repair_workingtree(Command):
499
 
    __doc__ = """Reset the working tree state file.
500
 
 
501
 
    This is not meant to be used normally, but more as a way to recover from
502
 
    filesystem corruption, etc. This rebuilds the working inventory back to a
503
 
    'known good' state. Any new modifications (adding a file, renaming, etc)
504
 
    will be lost, though modified files will still be detected as such.
505
 
 
506
 
    Most users will want something more like "bzr revert" or "bzr update"
507
 
    unless the state file has become corrupted.
508
 
 
509
 
    By default this attempts to recover the current state by looking at the
510
 
    headers of the state file. If the state file is too corrupted to even do
511
 
    that, you can supply --revision to force the state of the tree.
512
 
    """
513
 
 
514
 
    takes_options = ['revision', 'directory',
515
 
        Option('force',
516
 
               help='Reset the tree even if it doesn\'t appear to be'
517
 
                    ' corrupted.'),
518
 
    ]
519
 
    hidden = True
520
 
 
521
 
    def run(self, revision=None, directory='.', force=False):
522
 
        tree, _ = WorkingTree.open_containing(directory)
523
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
461
    def run(self, location='.', force=False):
 
462
        d = bzrdir.BzrDir.open(location)
 
463
 
 
464
        try:
 
465
            working = d.open_workingtree()
 
466
        except errors.NoWorkingTree:
 
467
            raise errors.BzrCommandError("No working tree to remove")
 
468
        except errors.NotLocalUrl:
 
469
            raise errors.BzrCommandError("You cannot remove the working tree"
 
470
                                         " of a remote path")
524
471
        if not force:
525
 
            try:
526
 
                tree.check_state()
527
 
            except errors.BzrError:
528
 
                pass # There seems to be a real error here, so we'll reset
529
 
            else:
530
 
                # Refuse
531
 
                raise errors.BzrCommandError(gettext(
532
 
                    'The tree does not appear to be corrupt. You probably'
533
 
                    ' want "bzr revert" instead. Use "--force" if you are'
534
 
                    ' sure you want to reset the working tree.'))
535
 
        if revision is None:
536
 
            revision_ids = None
537
 
        else:
538
 
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
539
 
        try:
540
 
            tree.reset_state(revision_ids)
541
 
        except errors.BzrError, e:
542
 
            if revision_ids is None:
543
 
                extra = (gettext(', the header appears corrupt, try passing -r -1'
544
 
                         ' to set the state to the last commit'))
545
 
            else:
546
 
                extra = ''
547
 
            raise errors.BzrCommandError(gettext('failed to reset the tree state{0}').format(extra))
 
472
            if (working.has_changes()):
 
473
                raise errors.UncommittedChanges(working)
 
474
 
 
475
        working_path = working.bzrdir.root_transport.base
 
476
        branch_path = working.branch.bzrdir.root_transport.base
 
477
        if working_path != branch_path:
 
478
            raise errors.BzrCommandError("You cannot remove the working tree"
 
479
                                         " from a lightweight checkout")
 
480
 
 
481
        d.destroy_workingtree()
548
482
 
549
483
 
550
484
class cmd_revno(Command):
551
 
    __doc__ = """Show current revision number.
 
485
    """Show current revision number.
552
486
 
553
487
    This is equal to the number of revisions on this branch.
554
488
    """
564
498
        if tree:
565
499
            try:
566
500
                wt = WorkingTree.open_containing(location)[0]
567
 
                self.add_cleanup(wt.lock_read().unlock)
 
501
                wt.lock_read()
568
502
            except (errors.NoWorkingTree, errors.NotLocalUrl):
569
503
                raise errors.NoWorkingTree(location)
570
 
            revid = wt.last_revision()
571
504
            try:
572
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
573
 
            except errors.NoSuchRevision:
574
 
                revno_t = ('???',)
575
 
            revno = ".".join(str(n) for n in revno_t)
 
505
                revid = wt.last_revision()
 
506
                try:
 
507
                    revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
508
                except errors.NoSuchRevision:
 
509
                    revno_t = ('???',)
 
510
                revno = ".".join(str(n) for n in revno_t)
 
511
            finally:
 
512
                wt.unlock()
576
513
        else:
577
514
            b = Branch.open_containing(location)[0]
578
 
            self.add_cleanup(b.lock_read().unlock)
579
 
            revno = b.revno()
580
 
        self.cleanup_now()
 
515
            b.lock_read()
 
516
            try:
 
517
                revno = b.revno()
 
518
            finally:
 
519
                b.unlock()
 
520
 
581
521
        self.outf.write(str(revno) + '\n')
582
522
 
583
523
 
584
524
class cmd_revision_info(Command):
585
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
525
    """Show revision number and revision id for a given revision identifier.
586
526
    """
587
527
    hidden = True
588
528
    takes_args = ['revision_info*']
589
529
    takes_options = [
590
530
        'revision',
591
 
        custom_help('directory',
 
531
        Option('directory',
592
532
            help='Branch to examine, '
593
 
                 'rather than the one containing the working directory.'),
 
533
                 'rather than the one containing the working directory.',
 
534
            short_name='d',
 
535
            type=unicode,
 
536
            ),
594
537
        Option('tree', help='Show revno of working tree'),
595
538
        ]
596
539
 
601
544
        try:
602
545
            wt = WorkingTree.open_containing(directory)[0]
603
546
            b = wt.branch
604
 
            self.add_cleanup(wt.lock_read().unlock)
 
547
            wt.lock_read()
605
548
        except (errors.NoWorkingTree, errors.NotLocalUrl):
606
549
            wt = None
607
550
            b = Branch.open_containing(directory)[0]
608
 
            self.add_cleanup(b.lock_read().unlock)
609
 
        revision_ids = []
610
 
        if revision is not None:
611
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
612
 
        if revision_info_list is not None:
613
 
            for rev_str in revision_info_list:
614
 
                rev_spec = RevisionSpec.from_string(rev_str)
615
 
                revision_ids.append(rev_spec.as_revision_id(b))
616
 
        # No arguments supplied, default to the last revision
617
 
        if len(revision_ids) == 0:
618
 
            if tree:
619
 
                if wt is None:
620
 
                    raise errors.NoWorkingTree(directory)
621
 
                revision_ids.append(wt.last_revision())
 
551
            b.lock_read()
 
552
        try:
 
553
            revision_ids = []
 
554
            if revision is not None:
 
555
                revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
556
            if revision_info_list is not None:
 
557
                for rev_str in revision_info_list:
 
558
                    rev_spec = RevisionSpec.from_string(rev_str)
 
559
                    revision_ids.append(rev_spec.as_revision_id(b))
 
560
            # No arguments supplied, default to the last revision
 
561
            if len(revision_ids) == 0:
 
562
                if tree:
 
563
                    if wt is None:
 
564
                        raise errors.NoWorkingTree(directory)
 
565
                    revision_ids.append(wt.last_revision())
 
566
                else:
 
567
                    revision_ids.append(b.last_revision())
 
568
 
 
569
            revinfos = []
 
570
            maxlen = 0
 
571
            for revision_id in revision_ids:
 
572
                try:
 
573
                    dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
574
                    revno = '.'.join(str(i) for i in dotted_revno)
 
575
                except errors.NoSuchRevision:
 
576
                    revno = '???'
 
577
                maxlen = max(maxlen, len(revno))
 
578
                revinfos.append([revno, revision_id])
 
579
        finally:
 
580
            if wt is None:
 
581
                b.unlock()
622
582
            else:
623
 
                revision_ids.append(b.last_revision())
624
 
 
625
 
        revinfos = []
626
 
        maxlen = 0
627
 
        for revision_id in revision_ids:
628
 
            try:
629
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
630
 
                revno = '.'.join(str(i) for i in dotted_revno)
631
 
            except errors.NoSuchRevision:
632
 
                revno = '???'
633
 
            maxlen = max(maxlen, len(revno))
634
 
            revinfos.append([revno, revision_id])
635
 
 
636
 
        self.cleanup_now()
 
583
                wt.unlock()
 
584
 
637
585
        for ri in revinfos:
638
586
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
639
587
 
640
588
 
641
589
class cmd_add(Command):
642
 
    __doc__ = """Add specified files or directories.
 
590
    """Add specified files or directories.
643
591
 
644
592
    In non-recursive mode, all the named items are added, regardless
645
593
    of whether they were previously ignored.  A warning is given if
674
622
    
675
623
    Any files matching patterns in the ignore list will not be added
676
624
    unless they are explicitly mentioned.
677
 
    
678
 
    In recursive mode, files larger than the configuration option 
679
 
    add.maximum_file_size will be skipped. Named items are never skipped due
680
 
    to file size.
681
625
    """
682
626
    takes_args = ['file*']
683
627
    takes_options = [
710
654
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
711
655
                          to_file=self.outf, should_print=(not is_quiet()))
712
656
        else:
713
 
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
 
657
            action = bzrlib.add.AddAction(to_file=self.outf,
714
658
                should_print=(not is_quiet()))
715
659
 
716
660
        if base_tree:
717
 
            self.add_cleanup(base_tree.lock_read().unlock)
718
 
        tree, file_list = tree_files_for_add(file_list)
719
 
        added, ignored = tree.smart_add(file_list, not
720
 
            no_recurse, action=action, save=not dry_run)
721
 
        self.cleanup_now()
 
661
            base_tree.lock_read()
 
662
        try:
 
663
            tree, file_list = tree_files_for_add(file_list)
 
664
            added, ignored = tree.smart_add(file_list, not
 
665
                no_recurse, action=action, save=not dry_run)
 
666
        finally:
 
667
            if base_tree is not None:
 
668
                base_tree.unlock()
722
669
        if len(ignored) > 0:
723
670
            if verbose:
724
671
                for glob in sorted(ignored.keys()):
725
672
                    for path in ignored[glob]:
726
 
                        self.outf.write(
727
 
                         gettext("ignored {0} matching \"{1}\"\n").format(
728
 
                         path, glob))
 
673
                        self.outf.write("ignored %s matching \"%s\"\n"
 
674
                                        % (path, glob))
729
675
 
730
676
 
731
677
class cmd_mkdir(Command):
732
 
    __doc__ = """Create a new versioned directory.
 
678
    """Create a new versioned directory.
733
679
 
734
680
    This is equivalent to creating the directory and then adding it.
735
681
    """
739
685
 
740
686
    def run(self, dir_list):
741
687
        for d in dir_list:
 
688
            os.mkdir(d)
742
689
            wt, dd = WorkingTree.open_containing(d)
743
 
            base = os.path.dirname(dd)
744
 
            id = wt.path2id(base)
745
 
            if id != None:
746
 
                os.mkdir(d)
747
 
                wt.add([dd])
748
 
                self.outf.write(gettext('added %s\n') % d)
749
 
            else:
750
 
                raise errors.NotVersionedError(path=base)
 
690
            wt.add([dd])
 
691
            self.outf.write('added %s\n' % d)
751
692
 
752
693
 
753
694
class cmd_relpath(Command):
754
 
    __doc__ = """Show path of a file relative to root"""
 
695
    """Show path of a file relative to root"""
755
696
 
756
697
    takes_args = ['filename']
757
698
    hidden = True
766
707
 
767
708
 
768
709
class cmd_inventory(Command):
769
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
710
    """Show inventory of the current working copy or a revision.
770
711
 
771
712
    It is possible to limit the output to a particular entry
772
713
    type using the --kind option.  For example: --kind file.
789
730
    @display_command
790
731
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
791
732
        if kind and kind not in ['file', 'directory', 'symlink']:
792
 
            raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
 
733
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
793
734
 
794
735
        revision = _get_one_revision('inventory', revision)
795
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
796
 
        self.add_cleanup(work_tree.lock_read().unlock)
797
 
        if revision is not None:
798
 
            tree = revision.as_tree(work_tree.branch)
799
 
 
800
 
            extra_trees = [work_tree]
801
 
            self.add_cleanup(tree.lock_read().unlock)
802
 
        else:
803
 
            tree = work_tree
804
 
            extra_trees = []
805
 
 
806
 
        if file_list is not None:
807
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
808
 
                                      require_versioned=True)
809
 
            # find_ids_across_trees may include some paths that don't
810
 
            # exist in 'tree'.
811
 
            entries = sorted(
812
 
                (tree.id2path(file_id), tree.inventory[file_id])
813
 
                for file_id in file_ids if tree.has_id(file_id))
814
 
        else:
815
 
            entries = tree.inventory.entries()
816
 
 
817
 
        self.cleanup_now()
 
736
        work_tree, file_list = tree_files(file_list)
 
737
        work_tree.lock_read()
 
738
        try:
 
739
            if revision is not None:
 
740
                tree = revision.as_tree(work_tree.branch)
 
741
 
 
742
                extra_trees = [work_tree]
 
743
                tree.lock_read()
 
744
            else:
 
745
                tree = work_tree
 
746
                extra_trees = []
 
747
 
 
748
            if file_list is not None:
 
749
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
750
                                          require_versioned=True)
 
751
                # find_ids_across_trees may include some paths that don't
 
752
                # exist in 'tree'.
 
753
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
754
                                 for file_id in file_ids if file_id in tree)
 
755
            else:
 
756
                entries = tree.inventory.entries()
 
757
        finally:
 
758
            tree.unlock()
 
759
            if tree is not work_tree:
 
760
                work_tree.unlock()
 
761
 
818
762
        for path, entry in entries:
819
763
            if kind and kind != entry.kind:
820
764
                continue
826
770
 
827
771
 
828
772
class cmd_mv(Command):
829
 
    __doc__ = """Move or rename a file.
 
773
    """Move or rename a file.
830
774
 
831
775
    :Usage:
832
776
        bzr mv OLDNAME NEWNAME
859
803
        if auto:
860
804
            return self.run_auto(names_list, after, dry_run)
861
805
        elif dry_run:
862
 
            raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
 
806
            raise errors.BzrCommandError('--dry-run requires --auto.')
863
807
        if names_list is None:
864
808
            names_list = []
865
809
        if len(names_list) < 2:
866
 
            raise errors.BzrCommandError(gettext("missing file argument"))
867
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
868
 
        self.add_cleanup(tree.lock_tree_write().unlock)
869
 
        self._run(tree, names_list, rel_names, after)
 
810
            raise errors.BzrCommandError("missing file argument")
 
811
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
812
        tree.lock_tree_write()
 
813
        try:
 
814
            self._run(tree, names_list, rel_names, after)
 
815
        finally:
 
816
            tree.unlock()
870
817
 
871
818
    def run_auto(self, names_list, after, dry_run):
872
819
        if names_list is not None and len(names_list) > 1:
873
 
            raise errors.BzrCommandError(gettext('Only one path may be specified to'
874
 
                                         ' --auto.'))
 
820
            raise errors.BzrCommandError('Only one path may be specified to'
 
821
                                         ' --auto.')
875
822
        if after:
876
 
            raise errors.BzrCommandError(gettext('--after cannot be specified with'
877
 
                                         ' --auto.'))
878
 
        work_tree, file_list = WorkingTree.open_containing_paths(
879
 
            names_list, default_directory='.')
880
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
881
 
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
823
            raise errors.BzrCommandError('--after cannot be specified with'
 
824
                                         ' --auto.')
 
825
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
826
        work_tree.lock_tree_write()
 
827
        try:
 
828
            rename_map.RenameMap.guess_renames(work_tree, dry_run)
 
829
        finally:
 
830
            work_tree.unlock()
882
831
 
883
832
    def _run(self, tree, names_list, rel_names, after):
884
833
        into_existing = osutils.isdir(names_list[-1])
910
859
                    self.outf.write("%s => %s\n" % (src, dest))
911
860
        else:
912
861
            if len(names_list) != 2:
913
 
                raise errors.BzrCommandError(gettext('to mv multiple files the'
 
862
                raise errors.BzrCommandError('to mv multiple files the'
914
863
                                             ' destination must be a versioned'
915
 
                                             ' directory'))
 
864
                                             ' directory')
916
865
 
917
866
            # for cicp file-systems: the src references an existing inventory
918
867
            # item:
962
911
 
963
912
 
964
913
class cmd_pull(Command):
965
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
914
    """Turn this branch into a mirror of another branch.
966
915
 
967
916
    By default, this command only works on branches that have not diverged.
968
917
    Branches are considered diverged if the destination branch's most recent 
977
926
    match the remote one, use pull --overwrite. This will work even if the two
978
927
    branches have diverged.
979
928
 
980
 
    If there is no default location set, the first pull will set it (use
981
 
    --no-remember to avoid setting it). After that, you can omit the
982
 
    location to use the default.  To change the default, use --remember. The
983
 
    value will only be saved if the remote location can be accessed.
 
929
    If there is no default location set, the first pull will set it.  After
 
930
    that, you can omit the location to use the default.  To change the
 
931
    default, use --remember. The value will only be saved if the remote
 
932
    location can be accessed.
984
933
 
985
934
    Note: The location can be specified either in the form of a branch,
986
935
    or in the form of a path to a file containing a merge directive generated
991
940
    takes_options = ['remember', 'overwrite', 'revision',
992
941
        custom_help('verbose',
993
942
            help='Show logs of pulled revisions.'),
994
 
        custom_help('directory',
 
943
        Option('directory',
995
944
            help='Branch to pull into, '
996
 
                 'rather than the one containing the working directory.'),
 
945
                 'rather than the one containing the working directory.',
 
946
            short_name='d',
 
947
            type=unicode,
 
948
            ),
997
949
        Option('local',
998
950
            help="Perform a local pull in a bound "
999
951
                 "branch.  Local pulls are not applied to "
1000
952
                 "the master branch."
1001
953
            ),
1002
 
        Option('show-base',
1003
 
            help="Show base revision text in conflicts.")
1004
954
        ]
1005
955
    takes_args = ['location?']
1006
956
    encoding_type = 'replace'
1007
957
 
1008
 
    def run(self, location=None, remember=None, overwrite=False,
 
958
    def run(self, location=None, remember=False, overwrite=False,
1009
959
            revision=None, verbose=False,
1010
 
            directory=None, local=False,
1011
 
            show_base=False):
 
960
            directory=None, local=False):
1012
961
        # FIXME: too much stuff is in the command class
1013
962
        revision_id = None
1014
963
        mergeable = None
1017
966
        try:
1018
967
            tree_to = WorkingTree.open_containing(directory)[0]
1019
968
            branch_to = tree_to.branch
1020
 
            self.add_cleanup(tree_to.lock_write().unlock)
1021
969
        except errors.NoWorkingTree:
1022
970
            tree_to = None
1023
971
            branch_to = Branch.open_containing(directory)[0]
1024
 
            self.add_cleanup(branch_to.lock_write().unlock)
1025
 
 
1026
 
        if tree_to is None and show_base:
1027
 
            raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
1028
 
 
 
972
        
1029
973
        if local and not branch_to.get_bound_location():
1030
974
            raise errors.LocalRequiresBoundBranch()
1031
975
 
1040
984
        stored_loc = branch_to.get_parent()
1041
985
        if location is None:
1042
986
            if stored_loc is None:
1043
 
                raise errors.BzrCommandError(gettext("No pull location known or"
1044
 
                                             " specified."))
 
987
                raise errors.BzrCommandError("No pull location known or"
 
988
                                             " specified.")
1045
989
            else:
1046
990
                display_url = urlutils.unescape_for_display(stored_loc,
1047
991
                        self.outf.encoding)
1048
992
                if not is_quiet():
1049
 
                    self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
 
993
                    self.outf.write("Using saved parent location: %s\n" % display_url)
1050
994
                location = stored_loc
1051
995
 
1052
996
        revision = _get_one_revision('pull', revision)
1053
997
        if mergeable is not None:
1054
998
            if revision is not None:
1055
 
                raise errors.BzrCommandError(gettext(
1056
 
                    'Cannot use -r with merge directives or bundles'))
 
999
                raise errors.BzrCommandError(
 
1000
                    'Cannot use -r with merge directives or bundles')
1057
1001
            mergeable.install_revisions(branch_to.repository)
1058
1002
            base_revision_id, revision_id, verified = \
1059
1003
                mergeable.get_merge_request(branch_to.repository)
1061
1005
        else:
1062
1006
            branch_from = Branch.open(location,
1063
1007
                possible_transports=possible_transports)
1064
 
            self.add_cleanup(branch_from.lock_read().unlock)
1065
 
            # Remembers if asked explicitly or no previous location is set
1066
 
            if (remember
1067
 
                or (remember is None and branch_to.get_parent() is None)):
 
1008
 
 
1009
            if branch_to.get_parent() is None or remember:
1068
1010
                branch_to.set_parent(branch_from.base)
1069
1011
 
1070
 
        if revision is not None:
1071
 
            revision_id = revision.as_revision_id(branch_from)
1072
 
 
1073
 
        if tree_to is not None:
1074
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1075
 
            change_reporter = delta._ChangeReporter(
1076
 
                unversioned_filter=tree_to.is_ignored,
1077
 
                view_info=view_info)
1078
 
            result = tree_to.pull(
1079
 
                branch_from, overwrite, revision_id, change_reporter,
1080
 
                local=local, show_base=show_base)
1081
 
        else:
1082
 
            result = branch_to.pull(
1083
 
                branch_from, overwrite, revision_id, local=local)
1084
 
 
1085
 
        result.report(self.outf)
1086
 
        if verbose and result.old_revid != result.new_revid:
1087
 
            log.show_branch_change(
1088
 
                branch_to, self.outf, result.old_revno,
1089
 
                result.old_revid)
1090
 
        if getattr(result, 'tag_conflicts', None):
1091
 
            return 1
1092
 
        else:
1093
 
            return 0
 
1012
        if branch_from is not branch_to:
 
1013
            branch_from.lock_read()
 
1014
        try:
 
1015
            if revision is not None:
 
1016
                revision_id = revision.as_revision_id(branch_from)
 
1017
 
 
1018
            branch_to.lock_write()
 
1019
            try:
 
1020
                if tree_to is not None:
 
1021
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
1022
                    change_reporter = delta._ChangeReporter(
 
1023
                        unversioned_filter=tree_to.is_ignored,
 
1024
                        view_info=view_info)
 
1025
                    result = tree_to.pull(
 
1026
                        branch_from, overwrite, revision_id, change_reporter,
 
1027
                        possible_transports=possible_transports, local=local)
 
1028
                else:
 
1029
                    result = branch_to.pull(
 
1030
                        branch_from, overwrite, revision_id, local=local)
 
1031
 
 
1032
                result.report(self.outf)
 
1033
                if verbose and result.old_revid != result.new_revid:
 
1034
                    log.show_branch_change(
 
1035
                        branch_to, self.outf, result.old_revno,
 
1036
                        result.old_revid)
 
1037
            finally:
 
1038
                branch_to.unlock()
 
1039
        finally:
 
1040
            if branch_from is not branch_to:
 
1041
                branch_from.unlock()
1094
1042
 
1095
1043
 
1096
1044
class cmd_push(Command):
1097
 
    __doc__ = """Update a mirror of this branch.
 
1045
    """Update a mirror of this branch.
1098
1046
 
1099
1047
    The target branch will not have its working tree populated because this
1100
1048
    is both expensive, and is not supported on remote file systems.
1113
1061
    do a merge (see bzr help merge) from the other branch, and commit that.
1114
1062
    After that you will be able to do a push without '--overwrite'.
1115
1063
 
1116
 
    If there is no default push location set, the first push will set it (use
1117
 
    --no-remember to avoid setting it).  After that, you can omit the
1118
 
    location to use the default.  To change the default, use --remember. The
1119
 
    value will only be saved if the remote location can be accessed.
 
1064
    If there is no default push location set, the first push will set it.
 
1065
    After that, you can omit the location to use the default.  To change the
 
1066
    default, use --remember. The value will only be saved if the remote
 
1067
    location can be accessed.
1120
1068
    """
1121
1069
 
1122
1070
    _see_also = ['pull', 'update', 'working-trees']
1124
1072
        Option('create-prefix',
1125
1073
               help='Create the path leading up to the branch '
1126
1074
                    'if it does not already exist.'),
1127
 
        custom_help('directory',
 
1075
        Option('directory',
1128
1076
            help='Branch to push from, '
1129
 
                 'rather than the one containing the working directory.'),
 
1077
                 'rather than the one containing the working directory.',
 
1078
            short_name='d',
 
1079
            type=unicode,
 
1080
            ),
1130
1081
        Option('use-existing-dir',
1131
1082
               help='By default push will fail if the target'
1132
1083
                    ' directory exists, but does not already'
1143
1094
        Option('strict',
1144
1095
               help='Refuse to push if there are uncommitted changes in'
1145
1096
               ' the working tree, --no-strict disables the check.'),
1146
 
        Option('no-tree',
1147
 
               help="Don't populate the working tree, even for protocols"
1148
 
               " that support it."),
1149
1097
        ]
1150
1098
    takes_args = ['location?']
1151
1099
    encoding_type = 'replace'
1152
1100
 
1153
 
    def run(self, location=None, remember=None, overwrite=False,
 
1101
    def run(self, location=None, remember=False, overwrite=False,
1154
1102
        create_prefix=False, verbose=False, revision=None,
1155
1103
        use_existing_dir=False, directory=None, stacked_on=None,
1156
 
        stacked=False, strict=None, no_tree=False):
 
1104
        stacked=False, strict=None):
1157
1105
        from bzrlib.push import _show_push_branch
1158
1106
 
1159
1107
        if directory is None:
1161
1109
        # Get the source branch
1162
1110
        (tree, br_from,
1163
1111
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1112
        if strict is None:
 
1113
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1114
        if strict is None: strict = True # default value
1164
1115
        # Get the tip's revision_id
1165
1116
        revision = _get_one_revision('push', revision)
1166
1117
        if revision is not None:
1167
1118
            revision_id = revision.in_history(br_from).rev_id
1168
1119
        else:
1169
1120
            revision_id = None
1170
 
        if tree is not None and revision_id is None:
1171
 
            tree.check_changed_or_out_of_date(
1172
 
                strict, 'push_strict',
1173
 
                more_error='Use --no-strict to force the push.',
1174
 
                more_warning='Uncommitted changes will not be pushed.')
 
1121
        if strict and tree is not None and revision_id is None:
 
1122
            if (tree.has_changes()):
 
1123
                raise errors.UncommittedChanges(
 
1124
                    tree, more='Use --no-strict to force the push.')
 
1125
            if tree.last_revision() != tree.branch.last_revision():
 
1126
                # The tree has lost sync with its branch, there is little
 
1127
                # chance that the user is aware of it but he can still force
 
1128
                # the push with --no-strict
 
1129
                raise errors.OutOfDateTree(
 
1130
                    tree, more='Use --no-strict to force the push.')
 
1131
 
1175
1132
        # Get the stacked_on branch, if any
1176
1133
        if stacked_on is not None:
1177
1134
            stacked_on = urlutils.normalize_url(stacked_on)
1187
1144
                    # error by the feedback given to them. RBC 20080227.
1188
1145
                    stacked_on = parent_url
1189
1146
            if not stacked_on:
1190
 
                raise errors.BzrCommandError(gettext(
1191
 
                    "Could not determine branch to refer to."))
 
1147
                raise errors.BzrCommandError(
 
1148
                    "Could not determine branch to refer to.")
1192
1149
 
1193
1150
        # Get the destination location
1194
1151
        if location is None:
1195
1152
            stored_loc = br_from.get_push_location()
1196
1153
            if stored_loc is None:
1197
 
                raise errors.BzrCommandError(gettext(
1198
 
                    "No push location known or specified."))
 
1154
                raise errors.BzrCommandError(
 
1155
                    "No push location known or specified.")
1199
1156
            else:
1200
1157
                display_url = urlutils.unescape_for_display(stored_loc,
1201
1158
                        self.outf.encoding)
1202
 
                note(gettext("Using saved push location: %s") % display_url)
 
1159
                self.outf.write("Using saved push location: %s\n" % display_url)
1203
1160
                location = stored_loc
1204
1161
 
1205
1162
        _show_push_branch(br_from, revision_id, location, self.outf,
1206
1163
            verbose=verbose, overwrite=overwrite, remember=remember,
1207
1164
            stacked_on=stacked_on, create_prefix=create_prefix,
1208
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1165
            use_existing_dir=use_existing_dir)
1209
1166
 
1210
1167
 
1211
1168
class cmd_branch(Command):
1212
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1169
    """Create a new branch that is a copy of an existing branch.
1213
1170
 
1214
1171
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1215
1172
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1220
1177
 
1221
1178
    To retrieve the branch as of a particular revision, supply the --revision
1222
1179
    parameter, as in "branch foo/bar -r 5".
1223
 
 
1224
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1225
1180
    """
1226
1181
 
1227
1182
    _see_also = ['checkout']
1228
1183
    takes_args = ['from_location', 'to_location?']
1229
 
    takes_options = ['revision',
1230
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1231
 
        Option('files-from', type=str,
1232
 
               help="Get file contents from this tree."),
 
1184
    takes_options = ['revision', Option('hardlink',
 
1185
        help='Hard-link working tree files where possible.'),
1233
1186
        Option('no-tree',
1234
1187
            help="Create a branch without a working-tree."),
1235
1188
        Option('switch',
1246
1199
                    ' directory exists, but does not already'
1247
1200
                    ' have a control directory.  This flag will'
1248
1201
                    ' allow branch to proceed.'),
1249
 
        Option('bind',
1250
 
            help="Bind new branch to from location."),
1251
1202
        ]
1252
1203
    aliases = ['get', 'clone']
1253
1204
 
1254
1205
    def run(self, from_location, to_location=None, revision=None,
1255
1206
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1256
 
            use_existing_dir=False, switch=False, bind=False,
1257
 
            files_from=None):
 
1207
            use_existing_dir=False, switch=False):
1258
1208
        from bzrlib import switch as _mod_switch
1259
1209
        from bzrlib.tag import _merge_tags_if_possible
1260
 
        if self.invoked_as in ['get', 'clone']:
1261
 
            ui.ui_factory.show_user_warning(
1262
 
                'deprecated_command',
1263
 
                deprecated_name=self.invoked_as,
1264
 
                recommended_name='branch',
1265
 
                deprecated_in_version='2.4')
1266
1210
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1267
1211
            from_location)
1268
 
        if not (hardlink or files_from):
1269
 
            # accelerator_tree is usually slower because you have to read N
1270
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1271
 
            # explicitly request it
1272
 
            accelerator_tree = None
1273
 
        if files_from is not None and files_from != from_location:
1274
 
            accelerator_tree = WorkingTree.open(files_from)
1275
1212
        revision = _get_one_revision('branch', revision)
1276
 
        self.add_cleanup(br_from.lock_read().unlock)
1277
 
        if revision is not None:
1278
 
            revision_id = revision.as_revision_id(br_from)
1279
 
        else:
1280
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1281
 
            # None or perhaps NULL_REVISION to mean copy nothing
1282
 
            # RBC 20060209
1283
 
            revision_id = br_from.last_revision()
1284
 
        if to_location is None:
1285
 
            to_location = urlutils.derive_to_location(from_location)
1286
 
        to_transport = transport.get_transport(to_location)
 
1213
        br_from.lock_read()
1287
1214
        try:
1288
 
            to_transport.mkdir('.')
1289
 
        except errors.FileExists:
1290
 
            if not use_existing_dir:
1291
 
                raise errors.BzrCommandError(gettext('Target directory "%s" '
1292
 
                    'already exists.') % to_location)
 
1215
            if revision is not None:
 
1216
                revision_id = revision.as_revision_id(br_from)
1293
1217
            else:
1294
 
                try:
1295
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1296
 
                except errors.NotBranchError:
1297
 
                    pass
 
1218
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1219
                # None or perhaps NULL_REVISION to mean copy nothing
 
1220
                # RBC 20060209
 
1221
                revision_id = br_from.last_revision()
 
1222
            if to_location is None:
 
1223
                to_location = urlutils.derive_to_location(from_location)
 
1224
            to_transport = transport.get_transport(to_location)
 
1225
            try:
 
1226
                to_transport.mkdir('.')
 
1227
            except errors.FileExists:
 
1228
                if not use_existing_dir:
 
1229
                    raise errors.BzrCommandError('Target directory "%s" '
 
1230
                        'already exists.' % to_location)
1298
1231
                else:
1299
 
                    raise errors.AlreadyBranchError(to_location)
1300
 
        except errors.NoSuchFile:
1301
 
            raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1302
 
                                         % to_location)
1303
 
        try:
1304
 
            # preserve whatever source format we have.
1305
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1306
 
                                        possible_transports=[to_transport],
1307
 
                                        accelerator_tree=accelerator_tree,
1308
 
                                        hardlink=hardlink, stacked=stacked,
1309
 
                                        force_new_repo=standalone,
1310
 
                                        create_tree_if_local=not no_tree,
1311
 
                                        source_branch=br_from)
1312
 
            branch = dir.open_branch()
1313
 
        except errors.NoSuchRevision:
1314
 
            to_transport.delete_tree('.')
1315
 
            msg = gettext("The branch {0} has no revision {1}.").format(
1316
 
                from_location, revision)
1317
 
            raise errors.BzrCommandError(msg)
1318
 
        _merge_tags_if_possible(br_from, branch)
1319
 
        # If the source branch is stacked, the new branch may
1320
 
        # be stacked whether we asked for that explicitly or not.
1321
 
        # We therefore need a try/except here and not just 'if stacked:'
1322
 
        try:
1323
 
            note(gettext('Created new stacked branch referring to %s.') %
1324
 
                branch.get_stacked_on_url())
1325
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1326
 
            errors.UnstackableRepositoryFormat), e:
1327
 
            note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1328
 
        if bind:
1329
 
            # Bind to the parent
1330
 
            parent_branch = Branch.open(from_location)
1331
 
            branch.bind(parent_branch)
1332
 
            note(gettext('New branch bound to %s') % from_location)
1333
 
        if switch:
1334
 
            # Switch to the new branch
1335
 
            wt, _ = WorkingTree.open_containing('.')
1336
 
            _mod_switch.switch(wt.bzrdir, branch)
1337
 
            note(gettext('Switched to branch: %s'),
1338
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1339
 
 
1340
 
 
1341
 
class cmd_branches(Command):
1342
 
    __doc__ = """List the branches available at the current location.
1343
 
 
1344
 
    This command will print the names of all the branches at the current location.
1345
 
    """
1346
 
 
1347
 
    takes_args = ['location?']
1348
 
 
1349
 
    def run(self, location="."):
1350
 
        dir = bzrdir.BzrDir.open_containing(location)[0]
1351
 
        for branch in dir.list_branches():
1352
 
            if branch.name is None:
1353
 
                self.outf.write(gettext(" (default)\n"))
1354
 
            else:
1355
 
                self.outf.write(" %s\n" % branch.name.encode(self.outf.encoding))
 
1232
                    try:
 
1233
                        bzrdir.BzrDir.open_from_transport(to_transport)
 
1234
                    except errors.NotBranchError:
 
1235
                        pass
 
1236
                    else:
 
1237
                        raise errors.AlreadyBranchError(to_location)
 
1238
            except errors.NoSuchFile:
 
1239
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1240
                                             % to_location)
 
1241
            try:
 
1242
                # preserve whatever source format we have.
 
1243
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1244
                                            possible_transports=[to_transport],
 
1245
                                            accelerator_tree=accelerator_tree,
 
1246
                                            hardlink=hardlink, stacked=stacked,
 
1247
                                            force_new_repo=standalone,
 
1248
                                            create_tree_if_local=not no_tree,
 
1249
                                            source_branch=br_from)
 
1250
                branch = dir.open_branch()
 
1251
            except errors.NoSuchRevision:
 
1252
                to_transport.delete_tree('.')
 
1253
                msg = "The branch %s has no revision %s." % (from_location,
 
1254
                    revision)
 
1255
                raise errors.BzrCommandError(msg)
 
1256
            _merge_tags_if_possible(br_from, branch)
 
1257
            # If the source branch is stacked, the new branch may
 
1258
            # be stacked whether we asked for that explicitly or not.
 
1259
            # We therefore need a try/except here and not just 'if stacked:'
 
1260
            try:
 
1261
                note('Created new stacked branch referring to %s.' %
 
1262
                    branch.get_stacked_on_url())
 
1263
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1264
                errors.UnstackableRepositoryFormat), e:
 
1265
                note('Branched %d revision(s).' % branch.revno())
 
1266
            if switch:
 
1267
                # Switch to the new branch
 
1268
                wt, _ = WorkingTree.open_containing('.')
 
1269
                _mod_switch.switch(wt.bzrdir, branch)
 
1270
                note('Switched to branch: %s',
 
1271
                    urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1272
        finally:
 
1273
            br_from.unlock()
1356
1274
 
1357
1275
 
1358
1276
class cmd_checkout(Command):
1359
 
    __doc__ = """Create a new checkout of an existing branch.
 
1277
    """Create a new checkout of an existing branch.
1360
1278
 
1361
1279
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1362
1280
    the branch found in '.'. This is useful if you have removed the working tree
1401
1319
            to_location = branch_location
1402
1320
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1403
1321
            branch_location)
1404
 
        if not (hardlink or files_from):
1405
 
            # accelerator_tree is usually slower because you have to read N
1406
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1407
 
            # explicitly request it
1408
 
            accelerator_tree = None
1409
1322
        revision = _get_one_revision('checkout', revision)
1410
 
        if files_from is not None and files_from != branch_location:
 
1323
        if files_from is not None:
1411
1324
            accelerator_tree = WorkingTree.open(files_from)
1412
1325
        if revision is not None:
1413
1326
            revision_id = revision.as_revision_id(source)
1430
1343
 
1431
1344
 
1432
1345
class cmd_renames(Command):
1433
 
    __doc__ = """Show list of renamed files.
 
1346
    """Show list of renamed files.
1434
1347
    """
1435
1348
    # TODO: Option to show renames between two historical versions.
1436
1349
 
1441
1354
    @display_command
1442
1355
    def run(self, dir=u'.'):
1443
1356
        tree = WorkingTree.open_containing(dir)[0]
1444
 
        self.add_cleanup(tree.lock_read().unlock)
1445
 
        new_inv = tree.inventory
1446
 
        old_tree = tree.basis_tree()
1447
 
        self.add_cleanup(old_tree.lock_read().unlock)
1448
 
        old_inv = old_tree.inventory
1449
 
        renames = []
1450
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1451
 
        for f, paths, c, v, p, n, k, e in iterator:
1452
 
            if paths[0] == paths[1]:
1453
 
                continue
1454
 
            if None in (paths):
1455
 
                continue
1456
 
            renames.append(paths)
1457
 
        renames.sort()
1458
 
        for old_name, new_name in renames:
1459
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1357
        tree.lock_read()
 
1358
        try:
 
1359
            new_inv = tree.inventory
 
1360
            old_tree = tree.basis_tree()
 
1361
            old_tree.lock_read()
 
1362
            try:
 
1363
                old_inv = old_tree.inventory
 
1364
                renames = []
 
1365
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1366
                for f, paths, c, v, p, n, k, e in iterator:
 
1367
                    if paths[0] == paths[1]:
 
1368
                        continue
 
1369
                    if None in (paths):
 
1370
                        continue
 
1371
                    renames.append(paths)
 
1372
                renames.sort()
 
1373
                for old_name, new_name in renames:
 
1374
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1375
            finally:
 
1376
                old_tree.unlock()
 
1377
        finally:
 
1378
            tree.unlock()
1460
1379
 
1461
1380
 
1462
1381
class cmd_update(Command):
1463
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1382
    """Update a tree to have the latest code committed to its branch.
1464
1383
 
1465
1384
    This will perform a merge into the working tree, and may generate
1466
1385
    conflicts. If you have any local changes, you will still
1468
1387
 
1469
1388
    If you want to discard your local changes, you can just do a
1470
1389
    'bzr revert' instead of 'bzr commit' after the update.
1471
 
 
1472
 
    If you want to restore a file that has been removed locally, use
1473
 
    'bzr revert' instead of 'bzr update'.
1474
 
 
1475
 
    If the tree's branch is bound to a master branch, it will also update
1476
 
    the branch from the master.
1477
1390
    """
1478
1391
 
1479
1392
    _see_also = ['pull', 'working-trees', 'status-flags']
1480
1393
    takes_args = ['dir?']
1481
 
    takes_options = ['revision',
1482
 
                     Option('show-base',
1483
 
                            help="Show base revision text in conflicts."),
1484
 
                     ]
1485
1394
    aliases = ['up']
1486
1395
 
1487
 
    def run(self, dir='.', revision=None, show_base=None):
1488
 
        if revision is not None and len(revision) != 1:
1489
 
            raise errors.BzrCommandError(gettext(
1490
 
                        "bzr update --revision takes exactly one revision"))
 
1396
    def run(self, dir='.'):
1491
1397
        tree = WorkingTree.open_containing(dir)[0]
1492
 
        branch = tree.branch
1493
1398
        possible_transports = []
1494
 
        master = branch.get_master_branch(
 
1399
        master = tree.branch.get_master_branch(
1495
1400
            possible_transports=possible_transports)
1496
1401
        if master is not None:
 
1402
            tree.lock_write()
1497
1403
            branch_location = master.base
1498
 
            tree.lock_write()
1499
1404
        else:
 
1405
            tree.lock_tree_write()
1500
1406
            branch_location = tree.branch.base
1501
 
            tree.lock_tree_write()
1502
 
        self.add_cleanup(tree.unlock)
1503
1407
        # get rid of the final '/' and be ready for display
1504
 
        branch_location = urlutils.unescape_for_display(
1505
 
            branch_location.rstrip('/'),
1506
 
            self.outf.encoding)
1507
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1508
 
        if master is None:
1509
 
            old_tip = None
1510
 
        else:
1511
 
            # may need to fetch data into a heavyweight checkout
1512
 
            # XXX: this may take some time, maybe we should display a
1513
 
            # message
1514
 
            old_tip = branch.update(possible_transports)
1515
 
        if revision is not None:
1516
 
            revision_id = revision[0].as_revision_id(branch)
1517
 
        else:
1518
 
            revision_id = branch.last_revision()
1519
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1520
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1521
 
            note(gettext("Tree is up to date at revision {0} of branch {1}"
1522
 
                        ).format('.'.join(map(str, revno)), branch_location))
1523
 
            return 0
1524
 
        view_info = _get_view_info_for_change_reporter(tree)
1525
 
        change_reporter = delta._ChangeReporter(
1526
 
            unversioned_filter=tree.is_ignored,
1527
 
            view_info=view_info)
 
1408
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1409
                                                        self.outf.encoding)
1528
1410
        try:
 
1411
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1412
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1413
            if last_rev == _mod_revision.ensure_null(
 
1414
                tree.branch.last_revision()):
 
1415
                # may be up to date, check master too.
 
1416
                if master is None or last_rev == _mod_revision.ensure_null(
 
1417
                    master.last_revision()):
 
1418
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1419
                    note('Tree is up to date at revision %d of branch %s'
 
1420
                         % (revno, branch_location))
 
1421
                    return 0
 
1422
            view_info = _get_view_info_for_change_reporter(tree)
1529
1423
            conflicts = tree.update(
1530
 
                change_reporter,
1531
 
                possible_transports=possible_transports,
1532
 
                revision=revision_id,
1533
 
                old_tip=old_tip,
1534
 
                show_base=show_base)
1535
 
        except errors.NoSuchRevision, e:
1536
 
            raise errors.BzrCommandError(gettext(
1537
 
                                  "branch has no revision %s\n"
1538
 
                                  "bzr update --revision only works"
1539
 
                                  " for a revision in the branch history")
1540
 
                                  % (e.revision))
1541
 
        revno = tree.branch.revision_id_to_dotted_revno(
1542
 
            _mod_revision.ensure_null(tree.last_revision()))
1543
 
        note(gettext('Updated to revision {0} of branch {1}').format(
1544
 
             '.'.join(map(str, revno)), branch_location))
1545
 
        parent_ids = tree.get_parent_ids()
1546
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1547
 
            note(gettext('Your local commits will now show as pending merges with '
1548
 
                 "'bzr status', and can be committed with 'bzr commit'."))
1549
 
        if conflicts != 0:
1550
 
            return 1
1551
 
        else:
1552
 
            return 0
 
1424
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1425
                view_info=view_info), possible_transports=possible_transports)
 
1426
            revno = tree.branch.revision_id_to_revno(
 
1427
                _mod_revision.ensure_null(tree.last_revision()))
 
1428
            note('Updated to revision %d of branch %s' %
 
1429
                 (revno, branch_location))
 
1430
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1431
                note('Your local commits will now show as pending merges with '
 
1432
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1433
            if conflicts != 0:
 
1434
                return 1
 
1435
            else:
 
1436
                return 0
 
1437
        finally:
 
1438
            tree.unlock()
1553
1439
 
1554
1440
 
1555
1441
class cmd_info(Command):
1556
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1442
    """Show information about a working tree, branch or repository.
1557
1443
 
1558
1444
    This command will show all known locations and formats associated to the
1559
1445
    tree, branch or repository.
1597
1483
 
1598
1484
 
1599
1485
class cmd_remove(Command):
1600
 
    __doc__ = """Remove files or directories.
 
1486
    """Remove files or directories.
1601
1487
 
1602
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1603
 
    delete them if they can easily be recovered using revert otherwise they
1604
 
    will be backed up (adding an extention of the form .~#~). If no options or
1605
 
    parameters are given Bazaar will scan for files that are being tracked by
1606
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1488
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1489
    them if they can easily be recovered using revert. If no options or
 
1490
    parameters are given bzr will scan for files that are being tracked by bzr
 
1491
    but missing in your tree and stop tracking them for you.
1607
1492
    """
1608
1493
    takes_args = ['file*']
1609
1494
    takes_options = ['verbose',
1611
1496
        RegistryOption.from_kwargs('file-deletion-strategy',
1612
1497
            'The file deletion mode to be used.',
1613
1498
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1614
 
            safe='Backup changed files (default).',
 
1499
            safe='Only delete files if they can be'
 
1500
                 ' safely recovered (default).',
1615
1501
            keep='Delete from bzr but leave the working copy.',
1616
 
            no_backup='Don\'t backup changed files.',
1617
1502
            force='Delete all the specified files, even if they can not be '
1618
 
                'recovered and even if they are non-empty directories. '
1619
 
                '(deprecated, use no-backup)')]
 
1503
                'recovered and even if they are non-empty directories.')]
1620
1504
    aliases = ['rm', 'del']
1621
1505
    encoding_type = 'replace'
1622
1506
 
1623
1507
    def run(self, file_list, verbose=False, new=False,
1624
1508
        file_deletion_strategy='safe'):
1625
 
        if file_deletion_strategy == 'force':
1626
 
            note(gettext("(The --force option is deprecated, rather use --no-backup "
1627
 
                "in future.)"))
1628
 
            file_deletion_strategy = 'no-backup'
1629
 
 
1630
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1509
        tree, file_list = tree_files(file_list)
1631
1510
 
1632
1511
        if file_list is not None:
1633
1512
            file_list = [f for f in file_list]
1634
1513
 
1635
 
        self.add_cleanup(tree.lock_write().unlock)
1636
 
        # Heuristics should probably all move into tree.remove_smart or
1637
 
        # some such?
1638
 
        if new:
1639
 
            added = tree.changes_from(tree.basis_tree(),
1640
 
                specific_files=file_list).added
1641
 
            file_list = sorted([f[0] for f in added], reverse=True)
1642
 
            if len(file_list) == 0:
1643
 
                raise errors.BzrCommandError(gettext('No matching files.'))
1644
 
        elif file_list is None:
1645
 
            # missing files show up in iter_changes(basis) as
1646
 
            # versioned-with-no-kind.
1647
 
            missing = []
1648
 
            for change in tree.iter_changes(tree.basis_tree()):
1649
 
                # Find paths in the working tree that have no kind:
1650
 
                if change[1][1] is not None and change[6][1] is None:
1651
 
                    missing.append(change[1][1])
1652
 
            file_list = sorted(missing, reverse=True)
1653
 
            file_deletion_strategy = 'keep'
1654
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1655
 
            keep_files=file_deletion_strategy=='keep',
1656
 
            force=(file_deletion_strategy=='no-backup'))
 
1514
        tree.lock_write()
 
1515
        try:
 
1516
            # Heuristics should probably all move into tree.remove_smart or
 
1517
            # some such?
 
1518
            if new:
 
1519
                added = tree.changes_from(tree.basis_tree(),
 
1520
                    specific_files=file_list).added
 
1521
                file_list = sorted([f[0] for f in added], reverse=True)
 
1522
                if len(file_list) == 0:
 
1523
                    raise errors.BzrCommandError('No matching files.')
 
1524
            elif file_list is None:
 
1525
                # missing files show up in iter_changes(basis) as
 
1526
                # versioned-with-no-kind.
 
1527
                missing = []
 
1528
                for change in tree.iter_changes(tree.basis_tree()):
 
1529
                    # Find paths in the working tree that have no kind:
 
1530
                    if change[1][1] is not None and change[6][1] is None:
 
1531
                        missing.append(change[1][1])
 
1532
                file_list = sorted(missing, reverse=True)
 
1533
                file_deletion_strategy = 'keep'
 
1534
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1535
                keep_files=file_deletion_strategy=='keep',
 
1536
                force=file_deletion_strategy=='force')
 
1537
        finally:
 
1538
            tree.unlock()
1657
1539
 
1658
1540
 
1659
1541
class cmd_file_id(Command):
1660
 
    __doc__ = """Print file_id of a particular file or directory.
 
1542
    """Print file_id of a particular file or directory.
1661
1543
 
1662
1544
    The file_id is assigned when the file is first added and remains the
1663
1545
    same through all revisions where the file exists, even when it is
1679
1561
 
1680
1562
 
1681
1563
class cmd_file_path(Command):
1682
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1564
    """Print path of file_ids to a file or directory.
1683
1565
 
1684
1566
    This prints one line for each directory down to the target,
1685
1567
    starting at the branch root.
1701
1583
 
1702
1584
 
1703
1585
class cmd_reconcile(Command):
1704
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1586
    """Reconcile bzr metadata in a branch.
1705
1587
 
1706
1588
    This can correct data mismatches that may have been caused by
1707
1589
    previous ghost operations or bzr upgrades. You should only
1721
1603
 
1722
1604
    _see_also = ['check']
1723
1605
    takes_args = ['branch?']
1724
 
    takes_options = [
1725
 
        Option('canonicalize-chks',
1726
 
               help='Make sure CHKs are in canonical form (repairs '
1727
 
                    'bug 522637).',
1728
 
               hidden=True),
1729
 
        ]
1730
1606
 
1731
 
    def run(self, branch=".", canonicalize_chks=False):
 
1607
    def run(self, branch="."):
1732
1608
        from bzrlib.reconcile import reconcile
1733
1609
        dir = bzrdir.BzrDir.open(branch)
1734
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1610
        reconcile(dir)
1735
1611
 
1736
1612
 
1737
1613
class cmd_revision_history(Command):
1738
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1614
    """Display the list of revision ids on a branch."""
1739
1615
 
1740
1616
    _see_also = ['log']
1741
1617
    takes_args = ['location?']
1751
1627
 
1752
1628
 
1753
1629
class cmd_ancestry(Command):
1754
 
    __doc__ = """List all revisions merged into this branch."""
 
1630
    """List all revisions merged into this branch."""
1755
1631
 
1756
1632
    _see_also = ['log', 'revision-history']
1757
1633
    takes_args = ['location?']
1769
1645
            b = wt.branch
1770
1646
            last_revision = wt.last_revision()
1771
1647
 
1772
 
        self.add_cleanup(b.repository.lock_read().unlock)
1773
 
        graph = b.repository.get_graph()
1774
 
        revisions = [revid for revid, parents in
1775
 
            graph.iter_ancestry([last_revision])]
1776
 
        for revision_id in reversed(revisions):
1777
 
            if _mod_revision.is_null(revision_id):
1778
 
                continue
 
1648
        revision_ids = b.repository.get_ancestry(last_revision)
 
1649
        revision_ids.pop(0)
 
1650
        for revision_id in revision_ids:
1779
1651
            self.outf.write(revision_id + '\n')
1780
1652
 
1781
1653
 
1782
1654
class cmd_init(Command):
1783
 
    __doc__ = """Make a directory into a versioned branch.
 
1655
    """Make a directory into a versioned branch.
1784
1656
 
1785
1657
    Use this to create an empty branch, or before importing an
1786
1658
    existing project.
1818
1690
                ),
1819
1691
         Option('append-revisions-only',
1820
1692
                help='Never change revnos or the existing log.'
1821
 
                '  Append revisions to it only.'),
1822
 
         Option('no-tree',
1823
 
                'Create a branch without a working tree.')
 
1693
                '  Append revisions to it only.')
1824
1694
         ]
1825
1695
    def run(self, location=None, format=None, append_revisions_only=False,
1826
 
            create_prefix=False, no_tree=False):
 
1696
            create_prefix=False):
1827
1697
        if format is None:
1828
1698
            format = bzrdir.format_registry.make_bzrdir('default')
1829
1699
        if location is None:
1840
1710
            to_transport.ensure_base()
1841
1711
        except errors.NoSuchFile:
1842
1712
            if not create_prefix:
1843
 
                raise errors.BzrCommandError(gettext("Parent directory of %s"
 
1713
                raise errors.BzrCommandError("Parent directory of %s"
1844
1714
                    " does not exist."
1845
1715
                    "\nYou may supply --create-prefix to create all"
1846
 
                    " leading parent directories.")
 
1716
                    " leading parent directories."
1847
1717
                    % location)
1848
1718
            to_transport.create_prefix()
1849
1719
 
1852
1722
        except errors.NotBranchError:
1853
1723
            # really a NotBzrDir error...
1854
1724
            create_branch = bzrdir.BzrDir.create_branch_convenience
1855
 
            if no_tree:
1856
 
                force_new_tree = False
1857
 
            else:
1858
 
                force_new_tree = None
1859
1725
            branch = create_branch(to_transport.base, format=format,
1860
 
                                   possible_transports=[to_transport],
1861
 
                                   force_new_tree=force_new_tree)
 
1726
                                   possible_transports=[to_transport])
1862
1727
            a_bzrdir = branch.bzrdir
1863
1728
        else:
1864
1729
            from bzrlib.transport.local import LocalTransport
1868
1733
                        raise errors.BranchExistsWithoutWorkingTree(location)
1869
1734
                raise errors.AlreadyBranchError(location)
1870
1735
            branch = a_bzrdir.create_branch()
1871
 
            if not no_tree:
1872
 
                a_bzrdir.create_workingtree()
 
1736
            a_bzrdir.create_workingtree()
1873
1737
        if append_revisions_only:
1874
1738
            try:
1875
1739
                branch.set_append_revisions_only(True)
1876
1740
            except errors.UpgradeRequired:
1877
 
                raise errors.BzrCommandError(gettext('This branch format cannot be set'
1878
 
                    ' to append-revisions-only.  Try --default.'))
 
1741
                raise errors.BzrCommandError('This branch format cannot be set'
 
1742
                    ' to append-revisions-only.  Try --default.')
1879
1743
        if not is_quiet():
1880
1744
            from bzrlib.info import describe_layout, describe_format
1881
1745
            try:
1885
1749
            repository = branch.repository
1886
1750
            layout = describe_layout(repository, branch, tree).lower()
1887
1751
            format = describe_format(a_bzrdir, repository, branch, tree)
1888
 
            self.outf.write(gettext("Created a {0} (format: {1})\n").format(
1889
 
                  layout, format))
 
1752
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
1890
1753
            if repository.is_shared():
1891
1754
                #XXX: maybe this can be refactored into transport.path_or_url()
1892
1755
                url = repository.bzrdir.root_transport.external_url()
1894
1757
                    url = urlutils.local_path_from_url(url)
1895
1758
                except errors.InvalidURL:
1896
1759
                    pass
1897
 
                self.outf.write(gettext("Using shared repository: %s\n") % url)
 
1760
                self.outf.write("Using shared repository: %s\n" % url)
1898
1761
 
1899
1762
 
1900
1763
class cmd_init_repository(Command):
1901
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1764
    """Create a shared repository for branches to share storage space.
1902
1765
 
1903
1766
    New branches created under the repository directory will store their
1904
1767
    revisions in the repository, not in the branch directory.  For branches
1958
1821
 
1959
1822
 
1960
1823
class cmd_diff(Command):
1961
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1824
    """Show differences in the working tree, between revisions or branches.
1962
1825
 
1963
1826
    If no arguments are given, all changes for the current tree are listed.
1964
1827
    If files are given, only the changes in those files are listed.
1970
1833
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1971
1834
    produces patches suitable for "patch -p1".
1972
1835
 
1973
 
    Note that when using the -r argument with a range of revisions, the
1974
 
    differences are computed between the two specified revisions.  That
1975
 
    is, the command does not show the changes introduced by the first 
1976
 
    revision in the range.  This differs from the interpretation of 
1977
 
    revision ranges used by "bzr log" which includes the first revision
1978
 
    in the range.
1979
 
 
1980
1836
    :Exit values:
1981
1837
        1 - changed
1982
1838
        2 - unrepresentable changes
2000
1856
 
2001
1857
            bzr diff -r1..3 xxx
2002
1858
 
2003
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
2004
 
 
2005
 
            bzr diff -c2
2006
 
 
2007
 
        To see the changes introduced by revision X::
 
1859
        To see the changes introduced in revision X::
2008
1860
        
2009
1861
            bzr diff -cX
2010
1862
 
2014
1866
 
2015
1867
            bzr diff -r<chosen_parent>..X
2016
1868
 
2017
 
        The changes between the current revision and the previous revision
2018
 
        (equivalent to -c-1 and -r-2..-1)
 
1869
        The changes introduced by revision 2 (equivalent to -r1..2)::
2019
1870
 
2020
 
            bzr diff -r-2..
 
1871
            bzr diff -c2
2021
1872
 
2022
1873
        Show just the differences for file NEWS::
2023
1874
 
2038
1889
        Same as 'bzr diff' but prefix paths with old/ and new/::
2039
1890
 
2040
1891
            bzr diff --prefix old/:new/
2041
 
            
2042
 
        Show the differences using a custom diff program with options::
2043
 
        
2044
 
            bzr diff --using /usr/bin/diff --diff-options -wu
2045
1892
    """
2046
1893
    _see_also = ['status']
2047
1894
    takes_args = ['file*']
2066
1913
            help='Use this command to compare files.',
2067
1914
            type=unicode,
2068
1915
            ),
2069
 
        RegistryOption('format',
2070
 
            short_name='F',
2071
 
            help='Diff format to use.',
2072
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
2073
 
            title='Diff format'),
2074
1916
        ]
2075
1917
    aliases = ['di', 'dif']
2076
1918
    encoding_type = 'exact'
2077
1919
 
2078
1920
    @display_command
2079
1921
    def run(self, revision=None, file_list=None, diff_options=None,
2080
 
            prefix=None, old=None, new=None, using=None, format=None):
2081
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2082
 
            show_diff_trees)
 
1922
            prefix=None, old=None, new=None, using=None):
 
1923
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
2083
1924
 
2084
1925
        if (prefix is None) or (prefix == '0'):
2085
1926
            # diff -p0 format
2091
1932
        elif ':' in prefix:
2092
1933
            old_label, new_label = prefix.split(":")
2093
1934
        else:
2094
 
            raise errors.BzrCommandError(gettext(
 
1935
            raise errors.BzrCommandError(
2095
1936
                '--prefix expects two values separated by a colon'
2096
 
                ' (eg "old/:new/")'))
 
1937
                ' (eg "old/:new/")')
2097
1938
 
2098
1939
        if revision and len(revision) > 2:
2099
 
            raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
2100
 
                                         ' one or two revision specifiers'))
2101
 
 
2102
 
        if using is not None and format is not None:
2103
 
            raise errors.BzrCommandError(gettext(
2104
 
                '{0} and {1} are mutually exclusive').format(
2105
 
                '--using', '--format'))
 
1940
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1941
                                         ' one or two revision specifiers')
2106
1942
 
2107
1943
        (old_tree, new_tree,
2108
1944
         old_branch, new_branch,
2109
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2110
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
2111
 
        # GNU diff on Windows uses ANSI encoding for filenames
2112
 
        path_encoding = osutils.get_diff_header_encoding()
 
1945
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1946
            file_list, revision, old, new, apply_view=True)
2113
1947
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2114
1948
                               specific_files=specific_files,
2115
1949
                               external_diff_options=diff_options,
2116
1950
                               old_label=old_label, new_label=new_label,
2117
 
                               extra_trees=extra_trees,
2118
 
                               path_encoding=path_encoding,
2119
 
                               using=using,
2120
 
                               format_cls=format)
 
1951
                               extra_trees=extra_trees, using=using)
2121
1952
 
2122
1953
 
2123
1954
class cmd_deleted(Command):
2124
 
    __doc__ = """List files deleted in the working tree.
 
1955
    """List files deleted in the working tree.
2125
1956
    """
2126
1957
    # TODO: Show files deleted since a previous revision, or
2127
1958
    # between two revisions.
2130
1961
    # level of effort but possibly much less IO.  (Or possibly not,
2131
1962
    # if the directories are very large...)
2132
1963
    _see_also = ['status', 'ls']
2133
 
    takes_options = ['directory', 'show-ids']
 
1964
    takes_options = ['show-ids']
2134
1965
 
2135
1966
    @display_command
2136
 
    def run(self, show_ids=False, directory=u'.'):
2137
 
        tree = WorkingTree.open_containing(directory)[0]
2138
 
        self.add_cleanup(tree.lock_read().unlock)
2139
 
        old = tree.basis_tree()
2140
 
        self.add_cleanup(old.lock_read().unlock)
2141
 
        for path, ie in old.inventory.iter_entries():
2142
 
            if not tree.has_id(ie.file_id):
2143
 
                self.outf.write(path)
2144
 
                if show_ids:
2145
 
                    self.outf.write(' ')
2146
 
                    self.outf.write(ie.file_id)
2147
 
                self.outf.write('\n')
 
1967
    def run(self, show_ids=False):
 
1968
        tree = WorkingTree.open_containing(u'.')[0]
 
1969
        tree.lock_read()
 
1970
        try:
 
1971
            old = tree.basis_tree()
 
1972
            old.lock_read()
 
1973
            try:
 
1974
                for path, ie in old.inventory.iter_entries():
 
1975
                    if not tree.has_id(ie.file_id):
 
1976
                        self.outf.write(path)
 
1977
                        if show_ids:
 
1978
                            self.outf.write(' ')
 
1979
                            self.outf.write(ie.file_id)
 
1980
                        self.outf.write('\n')
 
1981
            finally:
 
1982
                old.unlock()
 
1983
        finally:
 
1984
            tree.unlock()
2148
1985
 
2149
1986
 
2150
1987
class cmd_modified(Command):
2151
 
    __doc__ = """List files modified in working tree.
 
1988
    """List files modified in working tree.
2152
1989
    """
2153
1990
 
2154
1991
    hidden = True
2155
1992
    _see_also = ['status', 'ls']
2156
 
    takes_options = ['directory', 'null']
 
1993
    takes_options = [
 
1994
            Option('null',
 
1995
                   help='Write an ascii NUL (\\0) separator '
 
1996
                   'between files rather than a newline.')
 
1997
            ]
2157
1998
 
2158
1999
    @display_command
2159
 
    def run(self, null=False, directory=u'.'):
2160
 
        tree = WorkingTree.open_containing(directory)[0]
2161
 
        self.add_cleanup(tree.lock_read().unlock)
 
2000
    def run(self, null=False):
 
2001
        tree = WorkingTree.open_containing(u'.')[0]
2162
2002
        td = tree.changes_from(tree.basis_tree())
2163
 
        self.cleanup_now()
2164
2003
        for path, id, kind, text_modified, meta_modified in td.modified:
2165
2004
            if null:
2166
2005
                self.outf.write(path + '\0')
2169
2008
 
2170
2009
 
2171
2010
class cmd_added(Command):
2172
 
    __doc__ = """List files added in working tree.
 
2011
    """List files added in working tree.
2173
2012
    """
2174
2013
 
2175
2014
    hidden = True
2176
2015
    _see_also = ['status', 'ls']
2177
 
    takes_options = ['directory', 'null']
 
2016
    takes_options = [
 
2017
            Option('null',
 
2018
                   help='Write an ascii NUL (\\0) separator '
 
2019
                   'between files rather than a newline.')
 
2020
            ]
2178
2021
 
2179
2022
    @display_command
2180
 
    def run(self, null=False, directory=u'.'):
2181
 
        wt = WorkingTree.open_containing(directory)[0]
2182
 
        self.add_cleanup(wt.lock_read().unlock)
2183
 
        basis = wt.basis_tree()
2184
 
        self.add_cleanup(basis.lock_read().unlock)
2185
 
        basis_inv = basis.inventory
2186
 
        inv = wt.inventory
2187
 
        for file_id in inv:
2188
 
            if basis_inv.has_id(file_id):
2189
 
                continue
2190
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2191
 
                continue
2192
 
            path = inv.id2path(file_id)
2193
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2194
 
                continue
2195
 
            if null:
2196
 
                self.outf.write(path + '\0')
2197
 
            else:
2198
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
2023
    def run(self, null=False):
 
2024
        wt = WorkingTree.open_containing(u'.')[0]
 
2025
        wt.lock_read()
 
2026
        try:
 
2027
            basis = wt.basis_tree()
 
2028
            basis.lock_read()
 
2029
            try:
 
2030
                basis_inv = basis.inventory
 
2031
                inv = wt.inventory
 
2032
                for file_id in inv:
 
2033
                    if file_id in basis_inv:
 
2034
                        continue
 
2035
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
2036
                        continue
 
2037
                    path = inv.id2path(file_id)
 
2038
                    if not os.access(osutils.abspath(path), os.F_OK):
 
2039
                        continue
 
2040
                    if null:
 
2041
                        self.outf.write(path + '\0')
 
2042
                    else:
 
2043
                        self.outf.write(osutils.quotefn(path) + '\n')
 
2044
            finally:
 
2045
                basis.unlock()
 
2046
        finally:
 
2047
            wt.unlock()
2199
2048
 
2200
2049
 
2201
2050
class cmd_root(Command):
2202
 
    __doc__ = """Show the tree root directory.
 
2051
    """Show the tree root directory.
2203
2052
 
2204
2053
    The root is the nearest enclosing directory with a .bzr control
2205
2054
    directory."""
2216
2065
    try:
2217
2066
        return int(limitstring)
2218
2067
    except ValueError:
2219
 
        msg = gettext("The limit argument must be an integer.")
 
2068
        msg = "The limit argument must be an integer."
2220
2069
        raise errors.BzrCommandError(msg)
2221
2070
 
2222
2071
 
2224
2073
    try:
2225
2074
        return int(s)
2226
2075
    except ValueError:
2227
 
        msg = gettext("The levels argument must be an integer.")
 
2076
        msg = "The levels argument must be an integer."
2228
2077
        raise errors.BzrCommandError(msg)
2229
2078
 
2230
2079
 
2231
2080
class cmd_log(Command):
2232
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2081
    """Show historical log for a branch or subset of a branch.
2233
2082
 
2234
2083
    log is bzr's default tool for exploring the history of a branch.
2235
2084
    The branch to use is taken from the first parameter. If no parameters
2340
2189
 
2341
2190
    :Other filtering:
2342
2191
 
2343
 
      The --match option can be used for finding revisions that match a
2344
 
      regular expression in a commit message, committer, author or bug.
2345
 
      Specifying the option several times will match any of the supplied
2346
 
      expressions. --match-author, --match-bugs, --match-committer and
2347
 
      --match-message can be used to only match a specific field.
 
2192
      The --message option can be used for finding revisions that match a
 
2193
      regular expression in a commit message.
2348
2194
 
2349
2195
    :Tips & tricks:
2350
2196
 
2351
2197
      GUI tools and IDEs are often better at exploring history than command
2352
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2353
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2354
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2355
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2198
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2199
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2200
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2201
 
 
2202
      Web interfaces are often better at exploring history than command line
 
2203
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2204
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2356
2205
 
2357
2206
      You may find it useful to add the aliases below to ``bazaar.conf``::
2358
2207
 
2399
2248
                   help='Show just the specified revision.'
2400
2249
                   ' See also "help revisionspec".'),
2401
2250
            'log-format',
2402
 
            RegistryOption('authors',
2403
 
                'What names to list as authors - first, all or committer.',
2404
 
                title='Authors',
2405
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2406
 
            ),
2407
2251
            Option('levels',
2408
2252
                   short_name='n',
2409
2253
                   help='Number of levels to display - 0 for all, 1 for flat.',
2410
2254
                   argname='N',
2411
2255
                   type=_parse_levels),
2412
2256
            Option('message',
 
2257
                   short_name='m',
2413
2258
                   help='Show revisions whose message matches this '
2414
2259
                        'regular expression.',
2415
 
                   type=str,
2416
 
                   hidden=True),
 
2260
                   type=str),
2417
2261
            Option('limit',
2418
2262
                   short_name='l',
2419
2263
                   help='Limit the output to the first N revisions.',
2422
2266
            Option('show-diff',
2423
2267
                   short_name='p',
2424
2268
                   help='Show changes made in each revision as a patch.'),
2425
 
            Option('include-merged',
 
2269
            Option('include-merges',
2426
2270
                   help='Show merged revisions like --levels 0 does.'),
2427
 
            Option('include-merges', hidden=True,
2428
 
                   help='Historical alias for --include-merged.'),
2429
 
            Option('omit-merges',
2430
 
                   help='Do not report commits with more than one parent.'),
2431
 
            Option('exclude-common-ancestry',
2432
 
                   help='Display only the revisions that are not part'
2433
 
                   ' of both ancestries (require -rX..Y)'
2434
 
                   ),
2435
 
            Option('signatures',
2436
 
                   help='Show digital signature validity'),
2437
 
            ListOption('match',
2438
 
                short_name='m',
2439
 
                help='Show revisions whose properties match this '
2440
 
                'expression.',
2441
 
                type=str),
2442
 
            ListOption('match-message',
2443
 
                   help='Show revisions whose message matches this '
2444
 
                   'expression.',
2445
 
                type=str),
2446
 
            ListOption('match-committer',
2447
 
                   help='Show revisions whose committer matches this '
2448
 
                   'expression.',
2449
 
                type=str),
2450
 
            ListOption('match-author',
2451
 
                   help='Show revisions whose authors match this '
2452
 
                   'expression.',
2453
 
                type=str),
2454
 
            ListOption('match-bugs',
2455
 
                   help='Show revisions whose bugs match this '
2456
 
                   'expression.',
2457
 
                type=str)
2458
2271
            ]
2459
2272
    encoding_type = 'replace'
2460
2273
 
2470
2283
            message=None,
2471
2284
            limit=None,
2472
2285
            show_diff=False,
2473
 
            include_merged=None,
2474
 
            authors=None,
2475
 
            exclude_common_ancestry=False,
2476
 
            signatures=False,
2477
 
            match=None,
2478
 
            match_message=None,
2479
 
            match_committer=None,
2480
 
            match_author=None,
2481
 
            match_bugs=None,
2482
 
            omit_merges=False,
2483
 
            include_merges=symbol_versioning.DEPRECATED_PARAMETER,
2484
 
            ):
 
2286
            include_merges=False):
2485
2287
        from bzrlib.log import (
2486
2288
            Logger,
2487
2289
            make_log_request_dict,
2488
2290
            _get_info_for_log_files,
2489
2291
            )
2490
2292
        direction = (forward and 'forward') or 'reverse'
2491
 
        if symbol_versioning.deprecated_passed(include_merges):
2492
 
            ui.ui_factory.show_user_warning(
2493
 
                'deprecated_command_option',
2494
 
                deprecated_name='--include-merges',
2495
 
                recommended_name='--include-merged',
2496
 
                deprecated_in_version='2.5',
2497
 
                command=self.invoked_as)
2498
 
            if include_merged is None:
2499
 
                include_merged = include_merges
2500
 
            else:
2501
 
                raise errors.BzrCommandError(gettext(
2502
 
                    '{0} and {1} are mutually exclusive').format(
2503
 
                    '--include-merges', '--include-merged'))
2504
 
        if include_merged is None:
2505
 
            include_merged = False
2506
 
        if (exclude_common_ancestry
2507
 
            and (revision is None or len(revision) != 2)):
2508
 
            raise errors.BzrCommandError(gettext(
2509
 
                '--exclude-common-ancestry requires -r with two revisions'))
2510
 
        if include_merged:
 
2293
        if include_merges:
2511
2294
            if levels is None:
2512
2295
                levels = 0
2513
2296
            else:
2514
 
                raise errors.BzrCommandError(gettext(
2515
 
                    '{0} and {1} are mutually exclusive').format(
2516
 
                    '--levels', '--include-merged'))
 
2297
                raise errors.BzrCommandError(
 
2298
                    '--levels and --include-merges are mutually exclusive')
2517
2299
 
2518
2300
        if change is not None:
2519
2301
            if len(change) > 1:
2520
2302
                raise errors.RangeInChangeOption()
2521
2303
            if revision is not None:
2522
 
                raise errors.BzrCommandError(gettext(
2523
 
                    '{0} and {1} are mutually exclusive').format(
2524
 
                    '--revision', '--change'))
 
2304
                raise errors.BzrCommandError(
 
2305
                    '--revision and --change are mutually exclusive')
2525
2306
            else:
2526
2307
                revision = change
2527
2308
 
2528
2309
        file_ids = []
2529
2310
        filter_by_dir = False
2530
 
        if file_list:
2531
 
            # find the file ids to log and check for directory filtering
2532
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2533
 
                revision, file_list, self.add_cleanup)
2534
 
            for relpath, file_id, kind in file_info_list:
2535
 
                if file_id is None:
2536
 
                    raise errors.BzrCommandError(gettext(
2537
 
                        "Path unknown at end or start of revision range: %s") %
2538
 
                        relpath)
2539
 
                # If the relpath is the top of the tree, we log everything
2540
 
                if relpath == '':
2541
 
                    file_ids = []
2542
 
                    break
 
2311
        b = None
 
2312
        try:
 
2313
            if file_list:
 
2314
                # find the file ids to log and check for directory filtering
 
2315
                b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2316
                    revision, file_list)
 
2317
                for relpath, file_id, kind in file_info_list:
 
2318
                    if file_id is None:
 
2319
                        raise errors.BzrCommandError(
 
2320
                            "Path unknown at end or start of revision range: %s" %
 
2321
                            relpath)
 
2322
                    # If the relpath is the top of the tree, we log everything
 
2323
                    if relpath == '':
 
2324
                        file_ids = []
 
2325
                        break
 
2326
                    else:
 
2327
                        file_ids.append(file_id)
 
2328
                    filter_by_dir = filter_by_dir or (
 
2329
                        kind in ['directory', 'tree-reference'])
 
2330
            else:
 
2331
                # log everything
 
2332
                # FIXME ? log the current subdir only RBC 20060203
 
2333
                if revision is not None \
 
2334
                        and len(revision) > 0 and revision[0].get_branch():
 
2335
                    location = revision[0].get_branch()
2543
2336
                else:
2544
 
                    file_ids.append(file_id)
2545
 
                filter_by_dir = filter_by_dir or (
2546
 
                    kind in ['directory', 'tree-reference'])
2547
 
        else:
2548
 
            # log everything
2549
 
            # FIXME ? log the current subdir only RBC 20060203
2550
 
            if revision is not None \
2551
 
                    and len(revision) > 0 and revision[0].get_branch():
2552
 
                location = revision[0].get_branch()
2553
 
            else:
2554
 
                location = '.'
2555
 
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2556
 
            b = dir.open_branch()
2557
 
            self.add_cleanup(b.lock_read().unlock)
2558
 
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2559
 
 
2560
 
        if b.get_config().validate_signatures_in_log():
2561
 
            signatures = True
2562
 
 
2563
 
        if signatures:
2564
 
            if not gpg.GPGStrategy.verify_signatures_available():
2565
 
                raise errors.GpgmeNotInstalled(None)
2566
 
 
2567
 
        # Decide on the type of delta & diff filtering to use
2568
 
        # TODO: add an --all-files option to make this configurable & consistent
2569
 
        if not verbose:
2570
 
            delta_type = None
2571
 
        else:
2572
 
            delta_type = 'full'
2573
 
        if not show_diff:
2574
 
            diff_type = None
2575
 
        elif file_ids:
2576
 
            diff_type = 'partial'
2577
 
        else:
2578
 
            diff_type = 'full'
2579
 
 
2580
 
        # Build the log formatter
2581
 
        if log_format is None:
2582
 
            log_format = log.log_formatter_registry.get_default(b)
2583
 
        # Make a non-encoding output to include the diffs - bug 328007
2584
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2585
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2586
 
                        to_exact_file=unencoded_output,
2587
 
                        show_timezone=timezone,
2588
 
                        delta_format=get_verbosity_level(),
2589
 
                        levels=levels,
2590
 
                        show_advice=levels is None,
2591
 
                        author_list_handler=authors)
2592
 
 
2593
 
        # Choose the algorithm for doing the logging. It's annoying
2594
 
        # having multiple code paths like this but necessary until
2595
 
        # the underlying repository format is faster at generating
2596
 
        # deltas or can provide everything we need from the indices.
2597
 
        # The default algorithm - match-using-deltas - works for
2598
 
        # multiple files and directories and is faster for small
2599
 
        # amounts of history (200 revisions say). However, it's too
2600
 
        # slow for logging a single file in a repository with deep
2601
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2602
 
        # evil when adding features", we continue to use the
2603
 
        # original algorithm - per-file-graph - for the "single
2604
 
        # file that isn't a directory without showing a delta" case.
2605
 
        partial_history = revision and b.repository._format.supports_chks
2606
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2607
 
            or delta_type or partial_history)
2608
 
 
2609
 
        match_dict = {}
2610
 
        if match:
2611
 
            match_dict[''] = match
2612
 
        if match_message:
2613
 
            match_dict['message'] = match_message
2614
 
        if match_committer:
2615
 
            match_dict['committer'] = match_committer
2616
 
        if match_author:
2617
 
            match_dict['author'] = match_author
2618
 
        if match_bugs:
2619
 
            match_dict['bugs'] = match_bugs
2620
 
            
2621
 
        # Build the LogRequest and execute it
2622
 
        if len(file_ids) == 0:
2623
 
            file_ids = None
2624
 
        rqst = make_log_request_dict(
2625
 
            direction=direction, specific_fileids=file_ids,
2626
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2627
 
            message_search=message, delta_type=delta_type,
2628
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2629
 
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2630
 
            signature=signatures, omit_merges=omit_merges,
2631
 
            )
2632
 
        Logger(b, rqst).show(lf)
 
2337
                    location = '.'
 
2338
                dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2339
                b = dir.open_branch()
 
2340
                b.lock_read()
 
2341
                rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2342
 
 
2343
            # Decide on the type of delta & diff filtering to use
 
2344
            # TODO: add an --all-files option to make this configurable & consistent
 
2345
            if not verbose:
 
2346
                delta_type = None
 
2347
            else:
 
2348
                delta_type = 'full'
 
2349
            if not show_diff:
 
2350
                diff_type = None
 
2351
            elif file_ids:
 
2352
                diff_type = 'partial'
 
2353
            else:
 
2354
                diff_type = 'full'
 
2355
 
 
2356
            # Build the log formatter
 
2357
            if log_format is None:
 
2358
                log_format = log.log_formatter_registry.get_default(b)
 
2359
            # Make a non-encoding output to include the diffs - bug 328007
 
2360
            unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2361
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2362
                            to_exact_file=unencoded_output,
 
2363
                            show_timezone=timezone,
 
2364
                            delta_format=get_verbosity_level(),
 
2365
                            levels=levels,
 
2366
                            show_advice=levels is None)
 
2367
 
 
2368
            # Choose the algorithm for doing the logging. It's annoying
 
2369
            # having multiple code paths like this but necessary until
 
2370
            # the underlying repository format is faster at generating
 
2371
            # deltas or can provide everything we need from the indices.
 
2372
            # The default algorithm - match-using-deltas - works for
 
2373
            # multiple files and directories and is faster for small
 
2374
            # amounts of history (200 revisions say). However, it's too
 
2375
            # slow for logging a single file in a repository with deep
 
2376
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2377
            # evil when adding features", we continue to use the
 
2378
            # original algorithm - per-file-graph - for the "single
 
2379
            # file that isn't a directory without showing a delta" case.
 
2380
            partial_history = revision and b.repository._format.supports_chks
 
2381
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2382
                or delta_type or partial_history)
 
2383
 
 
2384
            # Build the LogRequest and execute it
 
2385
            if len(file_ids) == 0:
 
2386
                file_ids = None
 
2387
            rqst = make_log_request_dict(
 
2388
                direction=direction, specific_fileids=file_ids,
 
2389
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2390
                message_search=message, delta_type=delta_type,
 
2391
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2392
            Logger(b, rqst).show(lf)
 
2393
        finally:
 
2394
            if b is not None:
 
2395
                b.unlock()
2633
2396
 
2634
2397
 
2635
2398
def _get_revision_range(revisionspec_list, branch, command_name):
2650
2413
            # b is taken from revision[0].get_branch(), and
2651
2414
            # show_log will use its revision_history. Having
2652
2415
            # different branches will lead to weird behaviors.
2653
 
            raise errors.BzrCommandError(gettext(
 
2416
            raise errors.BzrCommandError(
2654
2417
                "bzr %s doesn't accept two revisions in different"
2655
 
                " branches.") % command_name)
2656
 
        if start_spec.spec is None:
2657
 
            # Avoid loading all the history.
2658
 
            rev1 = RevisionInfo(branch, None, None)
2659
 
        else:
2660
 
            rev1 = start_spec.in_history(branch)
 
2418
                " branches." % command_name)
 
2419
        rev1 = start_spec.in_history(branch)
2661
2420
        # Avoid loading all of history when we know a missing
2662
2421
        # end of range means the last revision ...
2663
2422
        if end_spec.spec is None:
2666
2425
        else:
2667
2426
            rev2 = end_spec.in_history(branch)
2668
2427
    else:
2669
 
        raise errors.BzrCommandError(gettext(
2670
 
            'bzr %s --revision takes one or two values.') % command_name)
 
2428
        raise errors.BzrCommandError(
 
2429
            'bzr %s --revision takes one or two values.' % command_name)
2671
2430
    return rev1, rev2
2672
2431
 
2673
2432
 
2692
2451
 
2693
2452
 
2694
2453
class cmd_touching_revisions(Command):
2695
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2454
    """Return revision-ids which affected a particular file.
2696
2455
 
2697
2456
    A more user-friendly interface is "bzr log FILE".
2698
2457
    """
2705
2464
        tree, relpath = WorkingTree.open_containing(filename)
2706
2465
        file_id = tree.path2id(relpath)
2707
2466
        b = tree.branch
2708
 
        self.add_cleanup(b.lock_read().unlock)
2709
 
        touching_revs = log.find_touching_revisions(b, file_id)
2710
 
        for revno, revision_id, what in touching_revs:
2711
 
            self.outf.write("%6d %s\n" % (revno, what))
 
2467
        b.lock_read()
 
2468
        try:
 
2469
            touching_revs = log.find_touching_revisions(b, file_id)
 
2470
            for revno, revision_id, what in touching_revs:
 
2471
                self.outf.write("%6d %s\n" % (revno, what))
 
2472
        finally:
 
2473
            b.unlock()
2712
2474
 
2713
2475
 
2714
2476
class cmd_ls(Command):
2715
 
    __doc__ = """List files in a tree.
 
2477
    """List files in a tree.
2716
2478
    """
2717
2479
 
2718
2480
    _see_also = ['status', 'cat']
2724
2486
                   help='Recurse into subdirectories.'),
2725
2487
            Option('from-root',
2726
2488
                   help='Print paths relative to the root of the branch.'),
2727
 
            Option('unknown', short_name='u',
2728
 
                help='Print unknown files.'),
 
2489
            Option('unknown', help='Print unknown files.'),
2729
2490
            Option('versioned', help='Print versioned files.',
2730
2491
                   short_name='V'),
2731
 
            Option('ignored', short_name='i',
2732
 
                help='Print ignored files.'),
2733
 
            Option('kind', short_name='k',
 
2492
            Option('ignored', help='Print ignored files.'),
 
2493
            Option('null',
 
2494
                   help='Write an ascii NUL (\\0) separator '
 
2495
                   'between files rather than a newline.'),
 
2496
            Option('kind',
2734
2497
                   help='List entries of a particular kind: file, directory, symlink.',
2735
2498
                   type=unicode),
2736
 
            'null',
2737
2499
            'show-ids',
2738
 
            'directory',
2739
2500
            ]
2740
2501
    @display_command
2741
2502
    def run(self, revision=None, verbose=False,
2742
2503
            recursive=False, from_root=False,
2743
2504
            unknown=False, versioned=False, ignored=False,
2744
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2505
            null=False, kind=None, show_ids=False, path=None):
2745
2506
 
2746
2507
        if kind and kind not in ('file', 'directory', 'symlink'):
2747
 
            raise errors.BzrCommandError(gettext('invalid kind specified'))
 
2508
            raise errors.BzrCommandError('invalid kind specified')
2748
2509
 
2749
2510
        if verbose and null:
2750
 
            raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
 
2511
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
2751
2512
        all = not (unknown or versioned or ignored)
2752
2513
 
2753
2514
        selection = {'I':ignored, '?':unknown, 'V':versioned}
2756
2517
            fs_path = '.'
2757
2518
        else:
2758
2519
            if from_root:
2759
 
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2760
 
                                             ' and PATH'))
 
2520
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2521
                                             ' and PATH')
2761
2522
            fs_path = path
2762
 
        tree, branch, relpath = \
2763
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2523
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2524
            fs_path)
2764
2525
 
2765
2526
        # Calculate the prefix to use
2766
2527
        prefix = None
2779
2540
            if view_files:
2780
2541
                apply_view = True
2781
2542
                view_str = views.view_display_str(view_files)
2782
 
                note(gettext("Ignoring files outside view. View is %s") % view_str)
2783
 
 
2784
 
        self.add_cleanup(tree.lock_read().unlock)
2785
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2786
 
            from_dir=relpath, recursive=recursive):
2787
 
            # Apply additional masking
2788
 
            if not all and not selection[fc]:
2789
 
                continue
2790
 
            if kind is not None and fkind != kind:
2791
 
                continue
2792
 
            if apply_view:
2793
 
                try:
2794
 
                    if relpath:
2795
 
                        fullpath = osutils.pathjoin(relpath, fp)
2796
 
                    else:
2797
 
                        fullpath = fp
2798
 
                    views.check_path_in_view(tree, fullpath)
2799
 
                except errors.FileOutsideView:
2800
 
                    continue
2801
 
 
2802
 
            # Output the entry
2803
 
            if prefix:
2804
 
                fp = osutils.pathjoin(prefix, fp)
2805
 
            kindch = entry.kind_character()
2806
 
            outstring = fp + kindch
2807
 
            ui.ui_factory.clear_term()
2808
 
            if verbose:
2809
 
                outstring = '%-8s %s' % (fc, outstring)
2810
 
                if show_ids and fid is not None:
2811
 
                    outstring = "%-50s %s" % (outstring, fid)
2812
 
                self.outf.write(outstring + '\n')
2813
 
            elif null:
2814
 
                self.outf.write(fp + '\0')
2815
 
                if show_ids:
2816
 
                    if fid is not None:
2817
 
                        self.outf.write(fid)
2818
 
                    self.outf.write('\0')
2819
 
                self.outf.flush()
2820
 
            else:
2821
 
                if show_ids:
2822
 
                    if fid is not None:
2823
 
                        my_id = fid
2824
 
                    else:
2825
 
                        my_id = ''
2826
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2827
 
                else:
 
2543
                note("Ignoring files outside view. View is %s" % view_str)
 
2544
 
 
2545
        tree.lock_read()
 
2546
        try:
 
2547
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2548
                from_dir=relpath, recursive=recursive):
 
2549
                # Apply additional masking
 
2550
                if not all and not selection[fc]:
 
2551
                    continue
 
2552
                if kind is not None and fkind != kind:
 
2553
                    continue
 
2554
                if apply_view:
 
2555
                    try:
 
2556
                        if relpath:
 
2557
                            fullpath = osutils.pathjoin(relpath, fp)
 
2558
                        else:
 
2559
                            fullpath = fp
 
2560
                        views.check_path_in_view(tree, fullpath)
 
2561
                    except errors.FileOutsideView:
 
2562
                        continue
 
2563
 
 
2564
                # Output the entry
 
2565
                if prefix:
 
2566
                    fp = osutils.pathjoin(prefix, fp)
 
2567
                kindch = entry.kind_character()
 
2568
                outstring = fp + kindch
 
2569
                ui.ui_factory.clear_term()
 
2570
                if verbose:
 
2571
                    outstring = '%-8s %s' % (fc, outstring)
 
2572
                    if show_ids and fid is not None:
 
2573
                        outstring = "%-50s %s" % (outstring, fid)
2828
2574
                    self.outf.write(outstring + '\n')
 
2575
                elif null:
 
2576
                    self.outf.write(fp + '\0')
 
2577
                    if show_ids:
 
2578
                        if fid is not None:
 
2579
                            self.outf.write(fid)
 
2580
                        self.outf.write('\0')
 
2581
                    self.outf.flush()
 
2582
                else:
 
2583
                    if show_ids:
 
2584
                        if fid is not None:
 
2585
                            my_id = fid
 
2586
                        else:
 
2587
                            my_id = ''
 
2588
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2589
                    else:
 
2590
                        self.outf.write(outstring + '\n')
 
2591
        finally:
 
2592
            tree.unlock()
2829
2593
 
2830
2594
 
2831
2595
class cmd_unknowns(Command):
2832
 
    __doc__ = """List unknown files.
 
2596
    """List unknown files.
2833
2597
    """
2834
2598
 
2835
2599
    hidden = True
2836
2600
    _see_also = ['ls']
2837
 
    takes_options = ['directory']
2838
2601
 
2839
2602
    @display_command
2840
 
    def run(self, directory=u'.'):
2841
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2603
    def run(self):
 
2604
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2842
2605
            self.outf.write(osutils.quotefn(f) + '\n')
2843
2606
 
2844
2607
 
2845
2608
class cmd_ignore(Command):
2846
 
    __doc__ = """Ignore specified files or patterns.
 
2609
    """Ignore specified files or patterns.
2847
2610
 
2848
2611
    See ``bzr help patterns`` for details on the syntax of patterns.
2849
2612
 
2857
2620
    After adding, editing or deleting that file either indirectly by
2858
2621
    using this command or directly by using an editor, be sure to commit
2859
2622
    it.
2860
 
    
2861
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2862
 
    the global ignore file can be found in the application data directory as
2863
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2864
 
    Global ignores are not touched by this command. The global ignore file
2865
 
    can be edited directly using an editor.
2866
 
 
2867
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2868
 
    precedence over regular ignores.  Such exceptions are used to specify
2869
 
    files that should be versioned which would otherwise be ignored.
2870
 
    
2871
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2872
 
    precedence over the '!' exception patterns.
2873
 
 
2874
 
    :Notes: 
2875
 
        
2876
 
    * Ignore patterns containing shell wildcards must be quoted from
2877
 
      the shell on Unix.
2878
 
 
2879
 
    * Ignore patterns starting with "#" act as comments in the ignore file.
2880
 
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
2623
 
 
2624
    Note: ignore patterns containing shell wildcards must be quoted from
 
2625
    the shell on Unix.
2881
2626
 
2882
2627
    :Examples:
2883
2628
        Ignore the top level Makefile::
2884
2629
 
2885
2630
            bzr ignore ./Makefile
2886
2631
 
2887
 
        Ignore .class files in all directories...::
 
2632
        Ignore class files in all directories::
2888
2633
 
2889
2634
            bzr ignore "*.class"
2890
2635
 
2891
 
        ...but do not ignore "special.class"::
2892
 
 
2893
 
            bzr ignore "!special.class"
2894
 
 
2895
 
        Ignore files whose name begins with the "#" character::
2896
 
 
2897
 
            bzr ignore "RE:^#"
2898
 
 
2899
2636
        Ignore .o files under the lib directory::
2900
2637
 
2901
2638
            bzr ignore "lib/**/*.o"
2907
2644
        Ignore everything but the "debian" toplevel directory::
2908
2645
 
2909
2646
            bzr ignore "RE:(?!debian/).*"
2910
 
        
2911
 
        Ignore everything except the "local" toplevel directory,
2912
 
        but always ignore autosave files ending in ~, even under local/::
2913
 
        
2914
 
            bzr ignore "*"
2915
 
            bzr ignore "!./local"
2916
 
            bzr ignore "!!*~"
2917
2647
    """
2918
2648
 
2919
2649
    _see_also = ['status', 'ignored', 'patterns']
2920
2650
    takes_args = ['name_pattern*']
2921
 
    takes_options = ['directory',
2922
 
        Option('default-rules',
2923
 
               help='Display the default ignore rules that bzr uses.')
 
2651
    takes_options = [
 
2652
        Option('old-default-rules',
 
2653
               help='Write out the ignore rules bzr < 0.9 always used.')
2924
2654
        ]
2925
2655
 
2926
 
    def run(self, name_pattern_list=None, default_rules=None,
2927
 
            directory=u'.'):
 
2656
    def run(self, name_pattern_list=None, old_default_rules=None):
2928
2657
        from bzrlib import ignores
2929
 
        if default_rules is not None:
2930
 
            # dump the default rules and exit
2931
 
            for pattern in ignores.USER_DEFAULTS:
2932
 
                self.outf.write("%s\n" % pattern)
 
2658
        if old_default_rules is not None:
 
2659
            # dump the rules and exit
 
2660
            for pattern in ignores.OLD_DEFAULTS:
 
2661
                print pattern
2933
2662
            return
2934
2663
        if not name_pattern_list:
2935
 
            raise errors.BzrCommandError(gettext("ignore requires at least one "
2936
 
                "NAME_PATTERN or --default-rules."))
 
2664
            raise errors.BzrCommandError("ignore requires at least one "
 
2665
                                  "NAME_PATTERN or --old-default-rules")
2937
2666
        name_pattern_list = [globbing.normalize_pattern(p)
2938
2667
                             for p in name_pattern_list]
2939
 
        bad_patterns = ''
2940
 
        bad_patterns_count = 0
2941
 
        for p in name_pattern_list:
2942
 
            if not globbing.Globster.is_pattern_valid(p):
2943
 
                bad_patterns_count += 1
2944
 
                bad_patterns += ('\n  %s' % p)
2945
 
        if bad_patterns:
2946
 
            msg = (ngettext('Invalid ignore pattern found. %s', 
2947
 
                            'Invalid ignore patterns found. %s',
2948
 
                            bad_patterns_count) % bad_patterns)
2949
 
            ui.ui_factory.show_error(msg)
2950
 
            raise errors.InvalidPattern('')
2951
2668
        for name_pattern in name_pattern_list:
2952
2669
            if (name_pattern[0] == '/' or
2953
2670
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2954
 
                raise errors.BzrCommandError(gettext(
2955
 
                    "NAME_PATTERN should not be an absolute path"))
2956
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2671
                raise errors.BzrCommandError(
 
2672
                    "NAME_PATTERN should not be an absolute path")
 
2673
        tree, relpath = WorkingTree.open_containing(u'.')
2957
2674
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2958
2675
        ignored = globbing.Globster(name_pattern_list)
2959
2676
        matches = []
2960
 
        self.add_cleanup(tree.lock_read().unlock)
 
2677
        tree.lock_read()
2961
2678
        for entry in tree.list_files():
2962
2679
            id = entry[3]
2963
2680
            if id is not None:
2964
2681
                filename = entry[0]
2965
2682
                if ignored.match(filename):
2966
 
                    matches.append(filename)
 
2683
                    matches.append(filename.encode('utf-8'))
 
2684
        tree.unlock()
2967
2685
        if len(matches) > 0:
2968
 
            self.outf.write(gettext("Warning: the following files are version "
2969
 
                  "controlled and match your ignore pattern:\n%s"
2970
 
                  "\nThese files will continue to be version controlled"
2971
 
                  " unless you 'bzr remove' them.\n") % ("\n".join(matches),))
 
2686
            print "Warning: the following files are version controlled and" \
 
2687
                  " match your ignore pattern:\n%s" \
 
2688
                  "\nThese files will continue to be version controlled" \
 
2689
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2972
2690
 
2973
2691
 
2974
2692
class cmd_ignored(Command):
2975
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2693
    """List ignored files and the patterns that matched them.
2976
2694
 
2977
2695
    List all the ignored files and the ignore pattern that caused the file to
2978
2696
    be ignored.
2984
2702
 
2985
2703
    encoding_type = 'replace'
2986
2704
    _see_also = ['ignore', 'ls']
2987
 
    takes_options = ['directory']
2988
2705
 
2989
2706
    @display_command
2990
 
    def run(self, directory=u'.'):
2991
 
        tree = WorkingTree.open_containing(directory)[0]
2992
 
        self.add_cleanup(tree.lock_read().unlock)
2993
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2994
 
            if file_class != 'I':
2995
 
                continue
2996
 
            ## XXX: Slightly inefficient since this was already calculated
2997
 
            pat = tree.is_ignored(path)
2998
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2707
    def run(self):
 
2708
        tree = WorkingTree.open_containing(u'.')[0]
 
2709
        tree.lock_read()
 
2710
        try:
 
2711
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2712
                if file_class != 'I':
 
2713
                    continue
 
2714
                ## XXX: Slightly inefficient since this was already calculated
 
2715
                pat = tree.is_ignored(path)
 
2716
                self.outf.write('%-50s %s\n' % (path, pat))
 
2717
        finally:
 
2718
            tree.unlock()
2999
2719
 
3000
2720
 
3001
2721
class cmd_lookup_revision(Command):
3002
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2722
    """Lookup the revision-id from a revision-number
3003
2723
 
3004
2724
    :Examples:
3005
2725
        bzr lookup-revision 33
3006
2726
    """
3007
2727
    hidden = True
3008
2728
    takes_args = ['revno']
3009
 
    takes_options = ['directory']
3010
2729
 
3011
2730
    @display_command
3012
 
    def run(self, revno, directory=u'.'):
 
2731
    def run(self, revno):
3013
2732
        try:
3014
2733
            revno = int(revno)
3015
2734
        except ValueError:
3016
 
            raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
3017
 
                                         % revno)
3018
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
3019
 
        self.outf.write("%s\n" % revid)
 
2735
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2736
 
 
2737
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
3020
2738
 
3021
2739
 
3022
2740
class cmd_export(Command):
3023
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2741
    """Export current or past revision to a destination directory or archive.
3024
2742
 
3025
2743
    If no revision is specified this exports the last committed revision.
3026
2744
 
3047
2765
         zip                          .zip
3048
2766
      =================       =========================
3049
2767
    """
3050
 
    encoding = 'exact'
3051
2768
    takes_args = ['dest', 'branch_or_subdir?']
3052
 
    takes_options = ['directory',
 
2769
    takes_options = [
3053
2770
        Option('format',
3054
2771
               help="Type of file to export to.",
3055
2772
               type=unicode),
3059
2776
        Option('root',
3060
2777
               type=str,
3061
2778
               help="Name of the root directory inside the exported file."),
3062
 
        Option('per-file-timestamps',
3063
 
               help='Set modification time of files to that of the last '
3064
 
                    'revision in which it was changed.'),
3065
2779
        ]
3066
2780
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3067
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2781
        root=None, filters=False):
3068
2782
        from bzrlib.export import export
3069
2783
 
3070
2784
        if branch_or_subdir is None:
3071
 
            tree = WorkingTree.open_containing(directory)[0]
 
2785
            tree = WorkingTree.open_containing(u'.')[0]
3072
2786
            b = tree.branch
3073
2787
            subdir = None
3074
2788
        else:
3077
2791
 
3078
2792
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3079
2793
        try:
3080
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
3081
 
                   per_file_timestamps=per_file_timestamps)
 
2794
            export(rev_tree, dest, format, root, subdir, filtered=filters)
3082
2795
        except errors.NoSuchExportFormat, e:
3083
 
            raise errors.BzrCommandError(gettext('Unsupported export format: %s') % e.format)
 
2796
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3084
2797
 
3085
2798
 
3086
2799
class cmd_cat(Command):
3087
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2800
    """Write the contents of a file as of a given revision to standard output.
3088
2801
 
3089
2802
    If no revision is nominated, the last revision is used.
3090
2803
 
3093
2806
    """
3094
2807
 
3095
2808
    _see_also = ['ls']
3096
 
    takes_options = ['directory',
 
2809
    takes_options = [
3097
2810
        Option('name-from-revision', help='The path name in the old tree.'),
3098
2811
        Option('filters', help='Apply content filters to display the '
3099
2812
                'convenience form.'),
3104
2817
 
3105
2818
    @display_command
3106
2819
    def run(self, filename, revision=None, name_from_revision=False,
3107
 
            filters=False, directory=None):
 
2820
            filters=False):
3108
2821
        if revision is not None and len(revision) != 1:
3109
 
            raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3110
 
                                         " one revision specifier"))
 
2822
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2823
                                         " one revision specifier")
3111
2824
        tree, branch, relpath = \
3112
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
3113
 
        self.add_cleanup(branch.lock_read().unlock)
3114
 
        return self._run(tree, branch, relpath, filename, revision,
3115
 
                         name_from_revision, filters)
 
2825
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2826
        branch.lock_read()
 
2827
        try:
 
2828
            return self._run(tree, branch, relpath, filename, revision,
 
2829
                             name_from_revision, filters)
 
2830
        finally:
 
2831
            branch.unlock()
3116
2832
 
3117
2833
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3118
2834
        filtered):
3119
2835
        if tree is None:
3120
2836
            tree = b.basis_tree()
3121
2837
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3122
 
        self.add_cleanup(rev_tree.lock_read().unlock)
3123
2838
 
3124
2839
        old_file_id = rev_tree.path2id(relpath)
3125
2840
 
3126
 
        # TODO: Split out this code to something that generically finds the
3127
 
        # best id for a path across one or more trees; it's like
3128
 
        # find_ids_across_trees but restricted to find just one. -- mbp
3129
 
        # 20110705.
3130
2841
        if name_from_revision:
3131
2842
            # Try in revision if requested
3132
2843
            if old_file_id is None:
3133
 
                raise errors.BzrCommandError(gettext(
3134
 
                    "{0!r} is not present in revision {1}").format(
 
2844
                raise errors.BzrCommandError(
 
2845
                    "%r is not present in revision %s" % (
3135
2846
                        filename, rev_tree.get_revision_id()))
3136
2847
            else:
3137
 
                actual_file_id = old_file_id
 
2848
                content = rev_tree.get_file_text(old_file_id)
3138
2849
        else:
3139
2850
            cur_file_id = tree.path2id(relpath)
3140
 
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3141
 
                actual_file_id = cur_file_id
3142
 
            elif old_file_id is not None:
3143
 
                actual_file_id = old_file_id
3144
 
            else:
3145
 
                raise errors.BzrCommandError(gettext(
3146
 
                    "{0!r} is not present in revision {1}").format(
 
2851
            found = False
 
2852
            if cur_file_id is not None:
 
2853
                # Then try with the actual file id
 
2854
                try:
 
2855
                    content = rev_tree.get_file_text(cur_file_id)
 
2856
                    found = True
 
2857
                except errors.NoSuchId:
 
2858
                    # The actual file id didn't exist at that time
 
2859
                    pass
 
2860
            if not found and old_file_id is not None:
 
2861
                # Finally try with the old file id
 
2862
                content = rev_tree.get_file_text(old_file_id)
 
2863
                found = True
 
2864
            if not found:
 
2865
                # Can't be found anywhere
 
2866
                raise errors.BzrCommandError(
 
2867
                    "%r is not present in revision %s" % (
3147
2868
                        filename, rev_tree.get_revision_id()))
3148
2869
        if filtered:
3149
 
            from bzrlib.filter_tree import ContentFilterTree
3150
 
            filter_tree = ContentFilterTree(rev_tree,
3151
 
                rev_tree._content_filter_stack)
3152
 
            content = filter_tree.get_file_text(actual_file_id)
 
2870
            from bzrlib.filters import (
 
2871
                ContentFilterContext,
 
2872
                filtered_output_bytes,
 
2873
                )
 
2874
            filters = rev_tree._content_filter_stack(relpath)
 
2875
            chunks = content.splitlines(True)
 
2876
            content = filtered_output_bytes(chunks, filters,
 
2877
                ContentFilterContext(relpath, rev_tree))
 
2878
            self.outf.writelines(content)
3153
2879
        else:
3154
 
            content = rev_tree.get_file_text(actual_file_id)
3155
 
        self.cleanup_now()
3156
 
        self.outf.write(content)
 
2880
            self.outf.write(content)
3157
2881
 
3158
2882
 
3159
2883
class cmd_local_time_offset(Command):
3160
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2884
    """Show the offset in seconds from GMT to local time."""
3161
2885
    hidden = True
3162
2886
    @display_command
3163
2887
    def run(self):
3164
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2888
        print osutils.local_time_offset()
3165
2889
 
3166
2890
 
3167
2891
 
3168
2892
class cmd_commit(Command):
3169
 
    __doc__ = """Commit changes into a new revision.
 
2893
    """Commit changes into a new revision.
3170
2894
 
3171
2895
    An explanatory message needs to be given for each commit. This is
3172
2896
    often done by using the --message option (getting the message from the
3220
2944
      to trigger updates to external systems like bug trackers. The --fixes
3221
2945
      option can be used to record the association between a revision and
3222
2946
      one or more bugs. See ``bzr help bugs`` for details.
 
2947
 
 
2948
      A selective commit may fail in some cases where the committed
 
2949
      tree would be invalid. Consider::
 
2950
  
 
2951
        bzr init foo
 
2952
        mkdir foo/bar
 
2953
        bzr add foo/bar
 
2954
        bzr commit foo -m "committing foo"
 
2955
        bzr mv foo/bar foo/baz
 
2956
        mkdir foo/bar
 
2957
        bzr add foo/bar
 
2958
        bzr commit foo/bar -m "committing bar but not baz"
 
2959
  
 
2960
      In the example above, the last commit will fail by design. This gives
 
2961
      the user the opportunity to decide whether they want to commit the
 
2962
      rename at the same time, separately first, or not at all. (As a general
 
2963
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3223
2964
    """
 
2965
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2966
 
 
2967
    # TODO: Strict commit that fails if there are deleted files.
 
2968
    #       (what does "deleted files" mean ??)
 
2969
 
 
2970
    # TODO: Give better message for -s, --summary, used by tla people
 
2971
 
 
2972
    # XXX: verbose currently does nothing
3224
2973
 
3225
2974
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3226
2975
    takes_args = ['selected*']
3255
3004
                         "the master branch until a normal commit "
3256
3005
                         "is performed."
3257
3006
                    ),
3258
 
             Option('show-diff', short_name='p',
 
3007
             Option('show-diff',
3259
3008
                    help='When no message is supplied, show the diff along'
3260
3009
                    ' with the status summary in the message editor.'),
3261
 
             Option('lossy', 
3262
 
                    help='When committing to a foreign version control '
3263
 
                    'system do not push data that can not be natively '
3264
 
                    'represented.'),
3265
3010
             ]
3266
3011
    aliases = ['ci', 'checkin']
3267
3012
 
3268
3013
    def _iter_bug_fix_urls(self, fixes, branch):
3269
 
        default_bugtracker  = None
3270
3014
        # Configure the properties for bug fixing attributes.
3271
3015
        for fixed_bug in fixes:
3272
3016
            tokens = fixed_bug.split(':')
3273
 
            if len(tokens) == 1:
3274
 
                if default_bugtracker is None:
3275
 
                    branch_config = branch.get_config()
3276
 
                    default_bugtracker = branch_config.get_user_option(
3277
 
                        "bugtracker")
3278
 
                if default_bugtracker is None:
3279
 
                    raise errors.BzrCommandError(gettext(
3280
 
                        "No tracker specified for bug %s. Use the form "
3281
 
                        "'tracker:id' or specify a default bug tracker "
3282
 
                        "using the `bugtracker` option.\nSee "
3283
 
                        "\"bzr help bugs\" for more information on this "
3284
 
                        "feature. Commit refused.") % fixed_bug)
3285
 
                tag = default_bugtracker
3286
 
                bug_id = tokens[0]
3287
 
            elif len(tokens) != 2:
3288
 
                raise errors.BzrCommandError(gettext(
 
3017
            if len(tokens) != 2:
 
3018
                raise errors.BzrCommandError(
3289
3019
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
3290
3020
                    "See \"bzr help bugs\" for more information on this "
3291
 
                    "feature.\nCommit refused.") % fixed_bug)
3292
 
            else:
3293
 
                tag, bug_id = tokens
 
3021
                    "feature.\nCommit refused." % fixed_bug)
 
3022
            tag, bug_id = tokens
3294
3023
            try:
3295
3024
                yield bugtracker.get_bug_url(tag, branch, bug_id)
3296
3025
            except errors.UnknownBugTrackerAbbreviation:
3297
 
                raise errors.BzrCommandError(gettext(
3298
 
                    'Unrecognized bug %s. Commit refused.') % fixed_bug)
 
3026
                raise errors.BzrCommandError(
 
3027
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3299
3028
            except errors.MalformedBugIdentifier, e:
3300
 
                raise errors.BzrCommandError(gettext(
3301
 
                    "%s\nCommit refused.") % (str(e),))
 
3029
                raise errors.BzrCommandError(
 
3030
                    "%s\nCommit refused." % (str(e),))
3302
3031
 
3303
3032
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3304
3033
            unchanged=False, strict=False, local=False, fixes=None,
3305
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3306
 
            lossy=False):
 
3034
            author=None, show_diff=False, exclude=None, commit_time=None):
3307
3035
        from bzrlib.errors import (
3308
3036
            PointlessCommit,
3309
3037
            ConflictsInTree,
3312
3040
        from bzrlib.msgeditor import (
3313
3041
            edit_commit_message_encoded,
3314
3042
            generate_commit_message_template,
3315
 
            make_commit_message_template_encoded,
3316
 
            set_commit_message,
 
3043
            make_commit_message_template_encoded
3317
3044
        )
3318
3045
 
3319
3046
        commit_stamp = offset = None
3321
3048
            try:
3322
3049
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3323
3050
            except ValueError, e:
3324
 
                raise errors.BzrCommandError(gettext(
3325
 
                    "Could not parse --commit-time: " + str(e)))
 
3051
                raise errors.BzrCommandError(
 
3052
                    "Could not parse --commit-time: " + str(e))
 
3053
 
 
3054
        # TODO: Need a blackbox test for invoking the external editor; may be
 
3055
        # slightly problematic to run this cross-platform.
 
3056
 
 
3057
        # TODO: do more checks that the commit will succeed before
 
3058
        # spending the user's valuable time typing a commit message.
3326
3059
 
3327
3060
        properties = {}
3328
3061
 
3329
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3062
        tree, selected_list = tree_files(selected_list)
3330
3063
        if selected_list == ['']:
3331
3064
            # workaround - commit of root of tree should be exactly the same
3332
3065
            # as just default commit in that tree, and succeed even though
3357
3090
                    '(use --file "%(f)s" to take commit message from that file)'
3358
3091
                    % { 'f': message })
3359
3092
                ui.ui_factory.show_warning(warning_msg)
3360
 
            if '\r' in message:
3361
 
                message = message.replace('\r\n', '\n')
3362
 
                message = message.replace('\r', '\n')
3363
 
            if file:
3364
 
                raise errors.BzrCommandError(gettext(
3365
 
                    "please specify either --message or --file"))
3366
3093
 
3367
3094
        def get_message(commit_obj):
3368
3095
            """Callback to get commit message"""
3369
 
            if file:
3370
 
                f = open(file)
3371
 
                try:
3372
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3373
 
                finally:
3374
 
                    f.close()
3375
 
            elif message is not None:
3376
 
                my_message = message
3377
 
            else:
3378
 
                # No message supplied: make one up.
3379
 
                # text is the status of the tree
3380
 
                text = make_commit_message_template_encoded(tree,
 
3096
            my_message = message
 
3097
            if my_message is not None and '\r' in my_message:
 
3098
                my_message = my_message.replace('\r\n', '\n')
 
3099
                my_message = my_message.replace('\r', '\n')
 
3100
            if my_message is None and not file:
 
3101
                t = make_commit_message_template_encoded(tree,
3381
3102
                        selected_list, diff=show_diff,
3382
3103
                        output_encoding=osutils.get_user_encoding())
3383
 
                # start_message is the template generated from hooks
3384
 
                # XXX: Warning - looks like hooks return unicode,
3385
 
                # make_commit_message_template_encoded returns user encoding.
3386
 
                # We probably want to be using edit_commit_message instead to
3387
 
                # avoid this.
3388
 
                my_message = set_commit_message(commit_obj)
3389
 
                if my_message is None:
3390
 
                    start_message = generate_commit_message_template(commit_obj)
3391
 
                    my_message = edit_commit_message_encoded(text,
3392
 
                        start_message=start_message)
3393
 
                if my_message is None:
3394
 
                    raise errors.BzrCommandError(gettext("please specify a commit"
3395
 
                        " message with either --message or --file"))
3396
 
                if my_message == "":
3397
 
                    raise errors.BzrCommandError(gettext("Empty commit message specified."
3398
 
                            " Please specify a commit message with either"
3399
 
                            " --message or --file or leave a blank message"
3400
 
                            " with --message \"\"."))
 
3104
                start_message = generate_commit_message_template(commit_obj)
 
3105
                my_message = edit_commit_message_encoded(t,
 
3106
                    start_message=start_message)
 
3107
                if my_message is None:
 
3108
                    raise errors.BzrCommandError("please specify a commit"
 
3109
                        " message with either --message or --file")
 
3110
            elif my_message and file:
 
3111
                raise errors.BzrCommandError(
 
3112
                    "please specify either --message or --file")
 
3113
            if file:
 
3114
                my_message = codecs.open(file, 'rt',
 
3115
                                         osutils.get_user_encoding()).read()
 
3116
            if my_message == "":
 
3117
                raise errors.BzrCommandError("empty commit message specified")
3401
3118
            return my_message
3402
3119
 
3403
3120
        # The API permits a commit with a filter of [] to mean 'select nothing'
3411
3128
                        reporter=None, verbose=verbose, revprops=properties,
3412
3129
                        authors=author, timestamp=commit_stamp,
3413
3130
                        timezone=offset,
3414
 
                        exclude=tree.safe_relpath_files(exclude),
3415
 
                        lossy=lossy)
 
3131
                        exclude=safe_relpath_files(tree, exclude))
3416
3132
        except PointlessCommit:
3417
 
            raise errors.BzrCommandError(gettext("No changes to commit."
3418
 
                " Please 'bzr add' the files you want to commit, or use"
3419
 
                " --unchanged to force an empty commit."))
 
3133
            # FIXME: This should really happen before the file is read in;
 
3134
            # perhaps prepare the commit; get the message; then actually commit
 
3135
            raise errors.BzrCommandError("No changes to commit."
 
3136
                              " Use --unchanged to commit anyhow.")
3420
3137
        except ConflictsInTree:
3421
 
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
 
3138
            raise errors.BzrCommandError('Conflicts detected in working '
3422
3139
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3423
 
                ' resolve.'))
 
3140
                ' resolve.')
3424
3141
        except StrictCommitFailed:
3425
 
            raise errors.BzrCommandError(gettext("Commit refused because there are"
3426
 
                              " unknown files in the working tree."))
 
3142
            raise errors.BzrCommandError("Commit refused because there are"
 
3143
                              " unknown files in the working tree.")
3427
3144
        except errors.BoundBranchOutOfDate, e:
3428
 
            e.extra_help = (gettext("\n"
3429
 
                'To commit to master branch, run update and then commit.\n'
3430
 
                'You can also pass --local to commit to continue working '
3431
 
                'disconnected.'))
3432
 
            raise
 
3145
            raise errors.BzrCommandError(str(e) + "\n"
 
3146
            'To commit to master branch, run update and then commit.\n'
 
3147
            'You can also pass --local to commit to continue working '
 
3148
            'disconnected.')
3433
3149
 
3434
3150
 
3435
3151
class cmd_check(Command):
3436
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3152
    """Validate working tree structure, branch consistency and repository history.
3437
3153
 
3438
3154
    This command checks various invariants about branch and repository storage
3439
3155
    to detect data corruption or bzr bugs.
3503
3219
 
3504
3220
 
3505
3221
class cmd_upgrade(Command):
3506
 
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3507
 
 
3508
 
    When the default format has changed after a major new release of
3509
 
    Bazaar, you may be informed during certain operations that you
3510
 
    should upgrade. Upgrading to a newer format may improve performance
3511
 
    or make new features available. It may however limit interoperability
3512
 
    with older repositories or with older versions of Bazaar.
3513
 
 
3514
 
    If you wish to upgrade to a particular format rather than the
3515
 
    current default, that can be specified using the --format option.
3516
 
    As a consequence, you can use the upgrade command this way to
3517
 
    "downgrade" to an earlier format, though some conversions are
3518
 
    a one way process (e.g. changing from the 1.x default to the
3519
 
    2.x default) so downgrading is not always possible.
3520
 
 
3521
 
    A backup.bzr.~#~ directory is created at the start of the conversion
3522
 
    process (where # is a number). By default, this is left there on
3523
 
    completion. If the conversion fails, delete the new .bzr directory
3524
 
    and rename this one back in its place. Use the --clean option to ask
3525
 
    for the backup.bzr directory to be removed on successful conversion.
3526
 
    Alternatively, you can delete it by hand if everything looks good
3527
 
    afterwards.
3528
 
 
3529
 
    If the location given is a shared repository, dependent branches
3530
 
    are also converted provided the repository converts successfully.
3531
 
    If the conversion of a branch fails, remaining branches are still
3532
 
    tried.
3533
 
 
3534
 
    For more information on upgrades, see the Bazaar Upgrade Guide,
3535
 
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
 
3222
    """Upgrade branch storage to current format.
 
3223
 
 
3224
    The check command or bzr developers may sometimes advise you to run
 
3225
    this command. When the default format has changed you may also be warned
 
3226
    during other operations to upgrade.
3536
3227
    """
3537
3228
 
3538
 
    _see_also = ['check', 'reconcile', 'formats']
 
3229
    _see_also = ['check']
3539
3230
    takes_args = ['url?']
3540
3231
    takes_options = [
3541
 
        RegistryOption('format',
3542
 
            help='Upgrade to a specific format.  See "bzr help'
3543
 
                 ' formats" for details.',
3544
 
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3545
 
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3546
 
            value_switches=True, title='Branch format'),
3547
 
        Option('clean',
3548
 
            help='Remove the backup.bzr directory if successful.'),
3549
 
        Option('dry-run',
3550
 
            help="Show what would be done, but don't actually do anything."),
3551
 
    ]
 
3232
                    RegistryOption('format',
 
3233
                        help='Upgrade to a specific format.  See "bzr help'
 
3234
                             ' formats" for details.',
 
3235
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3236
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3237
                        value_switches=True, title='Branch format'),
 
3238
                    ]
3552
3239
 
3553
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3240
    def run(self, url='.', format=None):
3554
3241
        from bzrlib.upgrade import upgrade
3555
 
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3556
 
        if exceptions:
3557
 
            if len(exceptions) == 1:
3558
 
                # Compatibility with historical behavior
3559
 
                raise exceptions[0]
3560
 
            else:
3561
 
                return 3
 
3242
        upgrade(url, format)
3562
3243
 
3563
3244
 
3564
3245
class cmd_whoami(Command):
3565
 
    __doc__ = """Show or set bzr user id.
 
3246
    """Show or set bzr user id.
3566
3247
 
3567
3248
    :Examples:
3568
3249
        Show the email of the current user::
3573
3254
 
3574
3255
            bzr whoami "Frank Chu <fchu@example.com>"
3575
3256
    """
3576
 
    takes_options = [ 'directory',
3577
 
                      Option('email',
 
3257
    takes_options = [ Option('email',
3578
3258
                             help='Display email address only.'),
3579
3259
                      Option('branch',
3580
3260
                             help='Set identity for the current branch instead of '
3584
3264
    encoding_type = 'replace'
3585
3265
 
3586
3266
    @display_command
3587
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3267
    def run(self, email=False, branch=False, name=None):
3588
3268
        if name is None:
3589
 
            if directory is None:
3590
 
                # use branch if we're inside one; otherwise global config
3591
 
                try:
3592
 
                    c = Branch.open_containing(u'.')[0].get_config()
3593
 
                except errors.NotBranchError:
3594
 
                    c = _mod_config.GlobalConfig()
3595
 
            else:
3596
 
                c = Branch.open(directory).get_config()
 
3269
            # use branch if we're inside one; otherwise global config
 
3270
            try:
 
3271
                c = Branch.open_containing('.')[0].get_config()
 
3272
            except errors.NotBranchError:
 
3273
                c = config.GlobalConfig()
3597
3274
            if email:
3598
3275
                self.outf.write(c.user_email() + '\n')
3599
3276
            else:
3600
3277
                self.outf.write(c.username() + '\n')
3601
3278
            return
3602
3279
 
3603
 
        if email:
3604
 
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3605
 
                                         "identity"))
3606
 
 
3607
3280
        # display a warning if an email address isn't included in the given name.
3608
3281
        try:
3609
 
            _mod_config.extract_email_address(name)
 
3282
            config.extract_email_address(name)
3610
3283
        except errors.NoEmailInUsername, e:
3611
3284
            warning('"%s" does not seem to contain an email address.  '
3612
3285
                    'This is allowed, but not recommended.', name)
3613
3286
 
3614
3287
        # use global config unless --branch given
3615
3288
        if branch:
3616
 
            if directory is None:
3617
 
                c = Branch.open_containing(u'.')[0].get_config()
3618
 
            else:
3619
 
                c = Branch.open(directory).get_config()
 
3289
            c = Branch.open_containing('.')[0].get_config()
3620
3290
        else:
3621
 
            c = _mod_config.GlobalConfig()
 
3291
            c = config.GlobalConfig()
3622
3292
        c.set_user_option('email', name)
3623
3293
 
3624
3294
 
3625
3295
class cmd_nick(Command):
3626
 
    __doc__ = """Print or set the branch nickname.
 
3296
    """Print or set the branch nickname.
3627
3297
 
3628
3298
    If unset, the tree root directory name is used as the nickname.
3629
3299
    To print the current nickname, execute with no argument.
3634
3304
 
3635
3305
    _see_also = ['info']
3636
3306
    takes_args = ['nickname?']
3637
 
    takes_options = ['directory']
3638
 
    def run(self, nickname=None, directory=u'.'):
3639
 
        branch = Branch.open_containing(directory)[0]
 
3307
    def run(self, nickname=None):
 
3308
        branch = Branch.open_containing(u'.')[0]
3640
3309
        if nickname is None:
3641
3310
            self.printme(branch)
3642
3311
        else:
3644
3313
 
3645
3314
    @display_command
3646
3315
    def printme(self, branch):
3647
 
        self.outf.write('%s\n' % branch.nick)
 
3316
        print branch.nick
3648
3317
 
3649
3318
 
3650
3319
class cmd_alias(Command):
3651
 
    __doc__ = """Set/unset and display aliases.
 
3320
    """Set/unset and display aliases.
3652
3321
 
3653
3322
    :Examples:
3654
3323
        Show the current aliases::
3687
3356
 
3688
3357
    def remove_alias(self, alias_name):
3689
3358
        if alias_name is None:
3690
 
            raise errors.BzrCommandError(gettext(
3691
 
                'bzr alias --remove expects an alias to remove.'))
 
3359
            raise errors.BzrCommandError(
 
3360
                'bzr alias --remove expects an alias to remove.')
3692
3361
        # If alias is not found, print something like:
3693
3362
        # unalias: foo: not found
3694
 
        c = _mod_config.GlobalConfig()
 
3363
        c = config.GlobalConfig()
3695
3364
        c.unset_alias(alias_name)
3696
3365
 
3697
3366
    @display_command
3698
3367
    def print_aliases(self):
3699
3368
        """Print out the defined aliases in a similar format to bash."""
3700
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3369
        aliases = config.GlobalConfig().get_aliases()
3701
3370
        for key, value in sorted(aliases.iteritems()):
3702
3371
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3703
3372
 
3713
3382
 
3714
3383
    def set_alias(self, alias_name, alias_command):
3715
3384
        """Save the alias in the global config."""
3716
 
        c = _mod_config.GlobalConfig()
 
3385
        c = config.GlobalConfig()
3717
3386
        c.set_alias(alias_name, alias_command)
3718
3387
 
3719
3388
 
3720
3389
class cmd_selftest(Command):
3721
 
    __doc__ = """Run internal test suite.
 
3390
    """Run internal test suite.
3722
3391
 
3723
3392
    If arguments are given, they are regular expressions that say which tests
3724
3393
    should run.  Tests matching any expression are run, and other tests are
3754
3423
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3755
3424
    into a pdb postmortem session.
3756
3425
 
3757
 
    The --coverage=DIRNAME global option produces a report with covered code
3758
 
    indicated.
3759
 
 
3760
3426
    :Examples:
3761
3427
        Run only tests relating to 'ignore'::
3762
3428
 
3771
3437
    def get_transport_type(typestring):
3772
3438
        """Parse and return a transport specifier."""
3773
3439
        if typestring == "sftp":
3774
 
            from bzrlib.tests import stub_sftp
3775
 
            return stub_sftp.SFTPAbsoluteServer
3776
 
        elif typestring == "memory":
3777
 
            from bzrlib.tests import test_server
3778
 
            return memory.MemoryServer
3779
 
        elif typestring == "fakenfs":
3780
 
            from bzrlib.tests import test_server
3781
 
            return test_server.FakeNFSServer
 
3440
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3441
            return SFTPAbsoluteServer
 
3442
        if typestring == "memory":
 
3443
            from bzrlib.transport.memory import MemoryServer
 
3444
            return MemoryServer
 
3445
        if typestring == "fakenfs":
 
3446
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3447
            return FakeNFSServer
3782
3448
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3783
3449
            (typestring)
3784
3450
        raise errors.BzrCommandError(msg)
3795
3461
                                 'throughout the test suite.',
3796
3462
                            type=get_transport_type),
3797
3463
                     Option('benchmark',
3798
 
                            help='Run the benchmarks rather than selftests.',
3799
 
                            hidden=True),
 
3464
                            help='Run the benchmarks rather than selftests.'),
3800
3465
                     Option('lsprof-timed',
3801
3466
                            help='Generate lsprof output for benchmarked'
3802
3467
                                 ' sections of code.'),
3803
3468
                     Option('lsprof-tests',
3804
3469
                            help='Generate lsprof output for each test.'),
 
3470
                     Option('cache-dir', type=str,
 
3471
                            help='Cache intermediate benchmark output in this '
 
3472
                                 'directory.'),
3805
3473
                     Option('first',
3806
3474
                            help='Run all tests, but run specified tests first.',
3807
3475
                            short_name='f',
3816
3484
                     Option('randomize', type=str, argname="SEED",
3817
3485
                            help='Randomize the order of tests using the given'
3818
3486
                                 ' seed or "now" for the current time.'),
3819
 
                     ListOption('exclude', type=str, argname="PATTERN",
3820
 
                                short_name='x',
3821
 
                                help='Exclude tests that match this regular'
3822
 
                                ' expression.'),
 
3487
                     Option('exclude', type=str, argname="PATTERN",
 
3488
                            short_name='x',
 
3489
                            help='Exclude tests that match this regular'
 
3490
                                 ' expression.'),
3823
3491
                     Option('subunit',
3824
3492
                        help='Output test progress via subunit.'),
3825
3493
                     Option('strict', help='Fail on missing dependencies or '
3832
3500
                                param_name='starting_with', short_name='s',
3833
3501
                                help=
3834
3502
                                'Load only the tests starting with TESTID.'),
3835
 
                     Option('sync',
3836
 
                            help="By default we disable fsync and fdatasync"
3837
 
                                 " while running the test suite.")
3838
3503
                     ]
3839
3504
    encoding_type = 'replace'
3840
3505
 
3844
3509
 
3845
3510
    def run(self, testspecs_list=None, verbose=False, one=False,
3846
3511
            transport=None, benchmark=None,
3847
 
            lsprof_timed=None,
 
3512
            lsprof_timed=None, cache_dir=None,
3848
3513
            first=False, list_only=False,
3849
3514
            randomize=None, exclude=None, strict=False,
3850
3515
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3851
 
            parallel=None, lsprof_tests=False,
3852
 
            sync=False):
3853
 
        from bzrlib import tests
3854
 
 
 
3516
            parallel=None, lsprof_tests=False):
 
3517
        from bzrlib.tests import selftest
 
3518
        import bzrlib.benchmarks as benchmarks
 
3519
        from bzrlib.benchmarks import tree_creator
 
3520
 
 
3521
        # Make deprecation warnings visible, unless -Werror is set
 
3522
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3523
 
 
3524
        if cache_dir is not None:
 
3525
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3855
3526
        if testspecs_list is not None:
3856
3527
            pattern = '|'.join(testspecs_list)
3857
3528
        else:
3860
3531
            try:
3861
3532
                from bzrlib.tests import SubUnitBzrRunner
3862
3533
            except ImportError:
3863
 
                raise errors.BzrCommandError(gettext("subunit not available. subunit "
3864
 
                    "needs to be installed to use --subunit."))
 
3534
                raise errors.BzrCommandError("subunit not available. subunit "
 
3535
                    "needs to be installed to use --subunit.")
3865
3536
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3866
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3867
 
            # stdout, which would corrupt the subunit stream. 
3868
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3869
 
            # following code can be deleted when it's sufficiently deployed
3870
 
            # -- vila/mgz 20100514
3871
 
            if (sys.platform == "win32"
3872
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3873
 
                import msvcrt
3874
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3875
3537
        if parallel:
3876
3538
            self.additional_selftest_args.setdefault(
3877
3539
                'suite_decorators', []).append(parallel)
3878
3540
        if benchmark:
3879
 
            raise errors.BzrCommandError(gettext(
3880
 
                "--benchmark is no longer supported from bzr 2.2; "
3881
 
                "use bzr-usertest instead"))
3882
 
        test_suite_factory = None
3883
 
        if not exclude:
3884
 
            exclude_pattern = None
 
3541
            test_suite_factory = benchmarks.test_suite
 
3542
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3543
            verbose = not is_quiet()
 
3544
            # TODO: should possibly lock the history file...
 
3545
            benchfile = open(".perf_history", "at", buffering=1)
3885
3546
        else:
3886
 
            exclude_pattern = '(' + '|'.join(exclude) + ')'
3887
 
        if not sync:
3888
 
            self._disable_fsync()
3889
 
        selftest_kwargs = {"verbose": verbose,
3890
 
                          "pattern": pattern,
3891
 
                          "stop_on_failure": one,
3892
 
                          "transport": transport,
3893
 
                          "test_suite_factory": test_suite_factory,
3894
 
                          "lsprof_timed": lsprof_timed,
3895
 
                          "lsprof_tests": lsprof_tests,
3896
 
                          "matching_tests_first": first,
3897
 
                          "list_only": list_only,
3898
 
                          "random_seed": randomize,
3899
 
                          "exclude_pattern": exclude_pattern,
3900
 
                          "strict": strict,
3901
 
                          "load_list": load_list,
3902
 
                          "debug_flags": debugflag,
3903
 
                          "starting_with": starting_with
3904
 
                          }
3905
 
        selftest_kwargs.update(self.additional_selftest_args)
3906
 
 
3907
 
        # Make deprecation warnings visible, unless -Werror is set
3908
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3909
 
            override=False)
 
3547
            test_suite_factory = None
 
3548
            benchfile = None
3910
3549
        try:
3911
 
            result = tests.selftest(**selftest_kwargs)
 
3550
            selftest_kwargs = {"verbose": verbose,
 
3551
                              "pattern": pattern,
 
3552
                              "stop_on_failure": one,
 
3553
                              "transport": transport,
 
3554
                              "test_suite_factory": test_suite_factory,
 
3555
                              "lsprof_timed": lsprof_timed,
 
3556
                              "lsprof_tests": lsprof_tests,
 
3557
                              "bench_history": benchfile,
 
3558
                              "matching_tests_first": first,
 
3559
                              "list_only": list_only,
 
3560
                              "random_seed": randomize,
 
3561
                              "exclude_pattern": exclude,
 
3562
                              "strict": strict,
 
3563
                              "load_list": load_list,
 
3564
                              "debug_flags": debugflag,
 
3565
                              "starting_with": starting_with
 
3566
                              }
 
3567
            selftest_kwargs.update(self.additional_selftest_args)
 
3568
            result = selftest(**selftest_kwargs)
3912
3569
        finally:
3913
 
            cleanup()
 
3570
            if benchfile is not None:
 
3571
                benchfile.close()
3914
3572
        return int(not result)
3915
3573
 
3916
 
    def _disable_fsync(self):
3917
 
        """Change the 'os' functionality to not synchronize."""
3918
 
        self._orig_fsync = getattr(os, 'fsync', None)
3919
 
        if self._orig_fsync is not None:
3920
 
            os.fsync = lambda filedes: None
3921
 
        self._orig_fdatasync = getattr(os, 'fdatasync', None)
3922
 
        if self._orig_fdatasync is not None:
3923
 
            os.fdatasync = lambda filedes: None
3924
 
 
3925
3574
 
3926
3575
class cmd_version(Command):
3927
 
    __doc__ = """Show version of bzr."""
 
3576
    """Show version of bzr."""
3928
3577
 
3929
3578
    encoding_type = 'replace'
3930
3579
    takes_options = [
3941
3590
 
3942
3591
 
3943
3592
class cmd_rocks(Command):
3944
 
    __doc__ = """Statement of optimism."""
 
3593
    """Statement of optimism."""
3945
3594
 
3946
3595
    hidden = True
3947
3596
 
3948
3597
    @display_command
3949
3598
    def run(self):
3950
 
        self.outf.write(gettext("It sure does!\n"))
 
3599
        print "It sure does!"
3951
3600
 
3952
3601
 
3953
3602
class cmd_find_merge_base(Command):
3954
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3603
    """Find and print a base revision for merging two branches."""
3955
3604
    # TODO: Options to specify revisions on either side, as if
3956
3605
    #       merging only part of the history.
3957
3606
    takes_args = ['branch', 'other']
3963
3612
 
3964
3613
        branch1 = Branch.open_containing(branch)[0]
3965
3614
        branch2 = Branch.open_containing(other)[0]
3966
 
        self.add_cleanup(branch1.lock_read().unlock)
3967
 
        self.add_cleanup(branch2.lock_read().unlock)
3968
 
        last1 = ensure_null(branch1.last_revision())
3969
 
        last2 = ensure_null(branch2.last_revision())
3970
 
 
3971
 
        graph = branch1.repository.get_graph(branch2.repository)
3972
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3973
 
 
3974
 
        self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
 
3615
        branch1.lock_read()
 
3616
        try:
 
3617
            branch2.lock_read()
 
3618
            try:
 
3619
                last1 = ensure_null(branch1.last_revision())
 
3620
                last2 = ensure_null(branch2.last_revision())
 
3621
 
 
3622
                graph = branch1.repository.get_graph(branch2.repository)
 
3623
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3624
 
 
3625
                print 'merge base is revision %s' % base_rev_id
 
3626
            finally:
 
3627
                branch2.unlock()
 
3628
        finally:
 
3629
            branch1.unlock()
3975
3630
 
3976
3631
 
3977
3632
class cmd_merge(Command):
3978
 
    __doc__ = """Perform a three-way merge.
 
3633
    """Perform a three-way merge.
3979
3634
 
3980
3635
    The source of the merge can be specified either in the form of a branch,
3981
3636
    or in the form of a path to a file containing a merge directive generated
3982
3637
    with bzr send. If neither is specified, the default is the upstream branch
3983
 
    or the branch most recently merged using --remember.  The source of the
3984
 
    merge may also be specified in the form of a path to a file in another
3985
 
    branch:  in this case, only the modifications to that file are merged into
3986
 
    the current working tree.
3987
 
 
3988
 
    When merging from a branch, by default bzr will try to merge in all new
3989
 
    work from the other branch, automatically determining an appropriate base
3990
 
    revision.  If this fails, you may need to give an explicit base.
3991
 
 
3992
 
    To pick a different ending revision, pass "--revision OTHER".  bzr will
3993
 
    try to merge in all new work up to and including revision OTHER.
3994
 
 
3995
 
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
3996
 
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
3997
 
    causes some revisions to be skipped, i.e. if the destination branch does
3998
 
    not already contain revision BASE, such a merge is commonly referred to as
3999
 
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
4000
 
    cherrypicks. The changes look like a normal commit, and the history of the
4001
 
    changes from the other branch is not stored in the commit.
4002
 
 
4003
 
    Revision numbers are always relative to the source branch.
 
3638
    or the branch most recently merged using --remember.
 
3639
 
 
3640
    When merging a branch, by default the tip will be merged. To pick a different
 
3641
    revision, pass --revision. If you specify two values, the first will be used as
 
3642
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3643
    available revisions, like this is commonly referred to as "cherrypicking".
 
3644
 
 
3645
    Revision numbers are always relative to the branch being merged.
 
3646
 
 
3647
    By default, bzr will try to merge in all new work from the other
 
3648
    branch, automatically determining an appropriate base.  If this
 
3649
    fails, you may need to give an explicit base.
4004
3650
 
4005
3651
    Merge will do its best to combine the changes in two branches, but there
4006
3652
    are some kinds of problems only a human can fix.  When it encounters those,
4009
3655
 
4010
3656
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
4011
3657
 
4012
 
    If there is no default branch set, the first merge will set it (use
4013
 
    --no-remember to avoid setting it). After that, you can omit the branch
4014
 
    to use the default.  To change the default, use --remember. The value will
4015
 
    only be saved if the remote location can be accessed.
 
3658
    If there is no default branch set, the first merge will set it. After
 
3659
    that, you can omit the branch to use the default.  To change the
 
3660
    default, use --remember. The value will only be saved if the remote
 
3661
    location can be accessed.
4016
3662
 
4017
3663
    The results of the merge are placed into the destination working
4018
3664
    directory, where they can be reviewed (with bzr diff), tested, and then
4019
3665
    committed to record the result of the merge.
4020
3666
 
4021
3667
    merge refuses to run if there are any uncommitted changes, unless
4022
 
    --force is given.  If --force is given, then the changes from the source 
4023
 
    will be merged with the current working tree, including any uncommitted
4024
 
    changes in the tree.  The --force option can also be used to create a
4025
 
    merge revision which has more than two parents.
4026
 
 
4027
 
    If one would like to merge changes from the working tree of the other
4028
 
    branch without merging any committed revisions, the --uncommitted option
4029
 
    can be given.
 
3668
    --force is given.
4030
3669
 
4031
3670
    To select only some changes to merge, use "merge -i", which will prompt
4032
3671
    you to apply each diff hunk and file change, similar to "shelve".
4033
3672
 
4034
3673
    :Examples:
4035
 
        To merge all new revisions from bzr.dev::
 
3674
        To merge the latest revision from bzr.dev::
4036
3675
 
4037
3676
            bzr merge ../bzr.dev
4038
3677
 
4047
3686
        To apply a merge directive contained in /tmp/merge::
4048
3687
 
4049
3688
            bzr merge /tmp/merge
4050
 
 
4051
 
        To create a merge revision with three parents from two branches
4052
 
        feature1a and feature1b:
4053
 
 
4054
 
            bzr merge ../feature1a
4055
 
            bzr merge ../feature1b --force
4056
 
            bzr commit -m 'revision with three parents'
4057
3689
    """
4058
3690
 
4059
3691
    encoding_type = 'exact'
4075
3707
                ' completely merged into the source, pull from the'
4076
3708
                ' source rather than merging.  When this happens,'
4077
3709
                ' you do not need to commit the result.'),
4078
 
        custom_help('directory',
 
3710
        Option('directory',
4079
3711
               help='Branch to merge into, '
4080
 
                    'rather than the one containing the working directory.'),
 
3712
                    'rather than the one containing the working directory.',
 
3713
               short_name='d',
 
3714
               type=unicode,
 
3715
               ),
4081
3716
        Option('preview', help='Instead of merging, show a diff of the'
4082
3717
               ' merge.'),
4083
3718
        Option('interactive', help='Select changes interactively.',
4085
3720
    ]
4086
3721
 
4087
3722
    def run(self, location=None, revision=None, force=False,
4088
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
3723
            merge_type=None, show_base=False, reprocess=None, remember=False,
4089
3724
            uncommitted=False, pull=False,
4090
3725
            directory=None,
4091
3726
            preview=False,
4099
3734
        merger = None
4100
3735
        allow_pending = True
4101
3736
        verified = 'inapplicable'
4102
 
 
4103
3737
        tree = WorkingTree.open_containing(directory)[0]
4104
 
        if tree.branch.revno() == 0:
4105
 
            raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
4106
 
                                         'https://bugs.launchpad.net/bzr/+bug/308562'))
4107
3738
 
4108
3739
        try:
4109
3740
            basis_tree = tree.revision_tree(tree.last_revision())
4118
3749
        view_info = _get_view_info_for_change_reporter(tree)
4119
3750
        change_reporter = delta._ChangeReporter(
4120
3751
            unversioned_filter=tree.is_ignored, view_info=view_info)
4121
 
        pb = ui.ui_factory.nested_progress_bar()
4122
 
        self.add_cleanup(pb.finished)
4123
 
        self.add_cleanup(tree.lock_write().unlock)
4124
 
        if location is not None:
4125
 
            try:
4126
 
                mergeable = bundle.read_mergeable_from_url(location,
4127
 
                    possible_transports=possible_transports)
4128
 
            except errors.NotABundle:
4129
 
                mergeable = None
 
3752
        cleanups = []
 
3753
        try:
 
3754
            pb = ui.ui_factory.nested_progress_bar()
 
3755
            cleanups.append(pb.finished)
 
3756
            tree.lock_write()
 
3757
            cleanups.append(tree.unlock)
 
3758
            if location is not None:
 
3759
                try:
 
3760
                    mergeable = bundle.read_mergeable_from_url(location,
 
3761
                        possible_transports=possible_transports)
 
3762
                except errors.NotABundle:
 
3763
                    mergeable = None
 
3764
                else:
 
3765
                    if uncommitted:
 
3766
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3767
                            ' with bundles or merge directives.')
 
3768
 
 
3769
                    if revision is not None:
 
3770
                        raise errors.BzrCommandError(
 
3771
                            'Cannot use -r with merge directives or bundles')
 
3772
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3773
                       mergeable, pb)
 
3774
 
 
3775
            if merger is None and uncommitted:
 
3776
                if revision is not None and len(revision) > 0:
 
3777
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3778
                        ' --revision at the same time.')
 
3779
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3780
                                                          cleanups)
 
3781
                allow_pending = False
 
3782
 
 
3783
            if merger is None:
 
3784
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3785
                    location, revision, remember, possible_transports, pb)
 
3786
 
 
3787
            merger.merge_type = merge_type
 
3788
            merger.reprocess = reprocess
 
3789
            merger.show_base = show_base
 
3790
            self.sanity_check_merger(merger)
 
3791
            if (merger.base_rev_id == merger.other_rev_id and
 
3792
                merger.other_rev_id is not None):
 
3793
                note('Nothing to do.')
 
3794
                return 0
 
3795
            if pull:
 
3796
                if merger.interesting_files is not None:
 
3797
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3798
                if (merger.base_rev_id == tree.last_revision()):
 
3799
                    result = tree.pull(merger.other_branch, False,
 
3800
                                       merger.other_rev_id)
 
3801
                    result.report(self.outf)
 
3802
                    return 0
 
3803
            if merger.this_basis is None:
 
3804
                raise errors.BzrCommandError(
 
3805
                    "This branch has no commits."
 
3806
                    " (perhaps you would prefer 'bzr pull')")
 
3807
            if preview:
 
3808
                return self._do_preview(merger, cleanups)
 
3809
            elif interactive:
 
3810
                return self._do_interactive(merger, cleanups)
4130
3811
            else:
4131
 
                if uncommitted:
4132
 
                    raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
4133
 
                        ' with bundles or merge directives.'))
4134
 
 
4135
 
                if revision is not None:
4136
 
                    raise errors.BzrCommandError(gettext(
4137
 
                        'Cannot use -r with merge directives or bundles'))
4138
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
4139
 
                   mergeable, None)
4140
 
 
4141
 
        if merger is None and uncommitted:
4142
 
            if revision is not None and len(revision) > 0:
4143
 
                raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
4144
 
                    ' --revision at the same time.'))
4145
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
4146
 
            allow_pending = False
4147
 
 
4148
 
        if merger is None:
4149
 
            merger, allow_pending = self._get_merger_from_branch(tree,
4150
 
                location, revision, remember, possible_transports, None)
4151
 
 
4152
 
        merger.merge_type = merge_type
4153
 
        merger.reprocess = reprocess
4154
 
        merger.show_base = show_base
4155
 
        self.sanity_check_merger(merger)
4156
 
        if (merger.base_rev_id == merger.other_rev_id and
4157
 
            merger.other_rev_id is not None):
4158
 
            # check if location is a nonexistent file (and not a branch) to
4159
 
            # disambiguate the 'Nothing to do'
4160
 
            if merger.interesting_files:
4161
 
                if not merger.other_tree.has_filename(
4162
 
                    merger.interesting_files[0]):
4163
 
                    note(gettext("merger: ") + str(merger))
4164
 
                    raise errors.PathsDoNotExist([location])
4165
 
            note(gettext('Nothing to do.'))
4166
 
            return 0
4167
 
        if pull and not preview:
4168
 
            if merger.interesting_files is not None:
4169
 
                raise errors.BzrCommandError(gettext('Cannot pull individual files'))
4170
 
            if (merger.base_rev_id == tree.last_revision()):
4171
 
                result = tree.pull(merger.other_branch, False,
4172
 
                                   merger.other_rev_id)
4173
 
                result.report(self.outf)
4174
 
                return 0
4175
 
        if merger.this_basis is None:
4176
 
            raise errors.BzrCommandError(gettext(
4177
 
                "This branch has no commits."
4178
 
                " (perhaps you would prefer 'bzr pull')"))
4179
 
        if preview:
4180
 
            return self._do_preview(merger)
4181
 
        elif interactive:
4182
 
            return self._do_interactive(merger)
4183
 
        else:
4184
 
            return self._do_merge(merger, change_reporter, allow_pending,
4185
 
                                  verified)
4186
 
 
4187
 
    def _get_preview(self, merger):
 
3812
                return self._do_merge(merger, change_reporter, allow_pending,
 
3813
                                      verified)
 
3814
        finally:
 
3815
            for cleanup in reversed(cleanups):
 
3816
                cleanup()
 
3817
 
 
3818
    def _get_preview(self, merger, cleanups):
4188
3819
        tree_merger = merger.make_merger()
4189
3820
        tt = tree_merger.make_preview_transform()
4190
 
        self.add_cleanup(tt.finalize)
 
3821
        cleanups.append(tt.finalize)
4191
3822
        result_tree = tt.get_preview_tree()
4192
3823
        return result_tree
4193
3824
 
4194
 
    def _do_preview(self, merger):
 
3825
    def _do_preview(self, merger, cleanups):
4195
3826
        from bzrlib.diff import show_diff_trees
4196
 
        result_tree = self._get_preview(merger)
4197
 
        path_encoding = osutils.get_diff_header_encoding()
 
3827
        result_tree = self._get_preview(merger, cleanups)
4198
3828
        show_diff_trees(merger.this_tree, result_tree, self.outf,
4199
 
                        old_label='', new_label='',
4200
 
                        path_encoding=path_encoding)
 
3829
                        old_label='', new_label='')
4201
3830
 
4202
3831
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4203
3832
        merger.change_reporter = change_reporter
4211
3840
        else:
4212
3841
            return 0
4213
3842
 
4214
 
    def _do_interactive(self, merger):
 
3843
    def _do_interactive(self, merger, cleanups):
4215
3844
        """Perform an interactive merge.
4216
3845
 
4217
3846
        This works by generating a preview tree of the merge, then using
4219
3848
        and the preview tree.
4220
3849
        """
4221
3850
        from bzrlib import shelf_ui
4222
 
        result_tree = self._get_preview(merger)
 
3851
        result_tree = self._get_preview(merger, cleanups)
4223
3852
        writer = bzrlib.option.diff_writer_registry.get()
4224
3853
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4225
3854
                                   reporter=shelf_ui.ApplyReporter(),
4232
3861
    def sanity_check_merger(self, merger):
4233
3862
        if (merger.show_base and
4234
3863
            not merger.merge_type is _mod_merge.Merge3Merger):
4235
 
            raise errors.BzrCommandError(gettext("Show-base is not supported for this"
4236
 
                                         " merge type. %s") % merger.merge_type)
 
3864
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3865
                                         " merge type. %s" % merger.merge_type)
4237
3866
        if merger.reprocess is None:
4238
3867
            if merger.show_base:
4239
3868
                merger.reprocess = False
4241
3870
                # Use reprocess if the merger supports it
4242
3871
                merger.reprocess = merger.merge_type.supports_reprocess
4243
3872
        if merger.reprocess and not merger.merge_type.supports_reprocess:
4244
 
            raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
4245
 
                                         " for merge type %s.") %
 
3873
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3874
                                         " for merge type %s." %
4246
3875
                                         merger.merge_type)
4247
3876
        if merger.reprocess and merger.show_base:
4248
 
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4249
 
                                         " show base."))
 
3877
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3878
                                         " show base.")
4250
3879
 
4251
3880
    def _get_merger_from_branch(self, tree, location, revision, remember,
4252
3881
                                possible_transports, pb):
4279
3908
        if other_revision_id is None:
4280
3909
            other_revision_id = _mod_revision.ensure_null(
4281
3910
                other_branch.last_revision())
4282
 
        # Remember where we merge from. We need to remember if:
4283
 
        # - user specify a location (and we don't merge from the parent
4284
 
        #   branch)
4285
 
        # - user ask to remember or there is no previous location set to merge
4286
 
        #   from and user didn't ask to *not* remember
4287
 
        if (user_location is not None
4288
 
            and ((remember
4289
 
                  or (remember is None
4290
 
                      and tree.branch.get_submit_branch() is None)))):
 
3911
        # Remember where we merge from
 
3912
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3913
             user_location is not None):
4291
3914
            tree.branch.set_submit_branch(other_branch.base)
4292
 
        # Merge tags (but don't set them in the master branch yet, the user
4293
 
        # might revert this merge).  Commit will propagate them.
4294
 
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
3915
        _merge_tags_if_possible(other_branch, tree.branch)
4295
3916
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4296
3917
            other_revision_id, base_revision_id, other_branch, base_branch)
4297
3918
        if other_path != '':
4301
3922
            allow_pending = True
4302
3923
        return merger, allow_pending
4303
3924
 
4304
 
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3925
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
4305
3926
        """Get a merger for uncommitted changes.
4306
3927
 
4307
3928
        :param tree: The tree the merger should apply to.
4308
3929
        :param location: The location containing uncommitted changes.
4309
3930
        :param pb: The progress bar to use for showing progress.
 
3931
        :param cleanups: A list of operations to perform to clean up the
 
3932
            temporary directories, unfinalized objects, etc.
4310
3933
        """
4311
3934
        location = self._select_branch_location(tree, location)[0]
4312
3935
        other_tree, other_path = WorkingTree.open_containing(location)
4356
3979
            stored_location_type = "parent"
4357
3980
        mutter("%s", stored_location)
4358
3981
        if stored_location is None:
4359
 
            raise errors.BzrCommandError(gettext("No location specified or remembered"))
 
3982
            raise errors.BzrCommandError("No location specified or remembered")
4360
3983
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4361
 
        note(gettext("{0} remembered {1} location {2}").format(verb_string,
4362
 
                stored_location_type, display_url))
 
3984
        note(u"%s remembered %s location %s", verb_string,
 
3985
                stored_location_type, display_url)
4363
3986
        return stored_location
4364
3987
 
4365
3988
 
4366
3989
class cmd_remerge(Command):
4367
 
    __doc__ = """Redo a merge.
 
3990
    """Redo a merge.
4368
3991
 
4369
3992
    Use this if you want to try a different merge technique while resolving
4370
3993
    conflicts.  Some merge techniques are better than others, and remerge
4395
4018
 
4396
4019
    def run(self, file_list=None, merge_type=None, show_base=False,
4397
4020
            reprocess=False):
4398
 
        from bzrlib.conflicts import restore
4399
4021
        if merge_type is None:
4400
4022
            merge_type = _mod_merge.Merge3Merger
4401
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4402
 
        self.add_cleanup(tree.lock_write().unlock)
4403
 
        parents = tree.get_parent_ids()
4404
 
        if len(parents) != 2:
4405
 
            raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4406
 
                                         " merges.  Not cherrypicking or"
4407
 
                                         " multi-merges."))
4408
 
        repository = tree.branch.repository
4409
 
        interesting_ids = None
4410
 
        new_conflicts = []
4411
 
        conflicts = tree.conflicts()
4412
 
        if file_list is not None:
4413
 
            interesting_ids = set()
4414
 
            for filename in file_list:
4415
 
                file_id = tree.path2id(filename)
4416
 
                if file_id is None:
4417
 
                    raise errors.NotVersionedError(filename)
4418
 
                interesting_ids.add(file_id)
4419
 
                if tree.kind(file_id) != "directory":
4420
 
                    continue
 
4023
        tree, file_list = tree_files(file_list)
 
4024
        tree.lock_write()
 
4025
        try:
 
4026
            parents = tree.get_parent_ids()
 
4027
            if len(parents) != 2:
 
4028
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4029
                                             " merges.  Not cherrypicking or"
 
4030
                                             " multi-merges.")
 
4031
            repository = tree.branch.repository
 
4032
            interesting_ids = None
 
4033
            new_conflicts = []
 
4034
            conflicts = tree.conflicts()
 
4035
            if file_list is not None:
 
4036
                interesting_ids = set()
 
4037
                for filename in file_list:
 
4038
                    file_id = tree.path2id(filename)
 
4039
                    if file_id is None:
 
4040
                        raise errors.NotVersionedError(filename)
 
4041
                    interesting_ids.add(file_id)
 
4042
                    if tree.kind(file_id) != "directory":
 
4043
                        continue
4421
4044
 
4422
 
                for name, ie in tree.inventory.iter_entries(file_id):
4423
 
                    interesting_ids.add(ie.file_id)
4424
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4425
 
        else:
4426
 
            # Remerge only supports resolving contents conflicts
4427
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4428
 
            restore_files = [c.path for c in conflicts
4429
 
                             if c.typestring in allowed_conflicts]
4430
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4431
 
        tree.set_conflicts(ConflictList(new_conflicts))
4432
 
        if file_list is not None:
4433
 
            restore_files = file_list
4434
 
        for filename in restore_files:
 
4045
                    for name, ie in tree.inventory.iter_entries(file_id):
 
4046
                        interesting_ids.add(ie.file_id)
 
4047
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4048
            else:
 
4049
                # Remerge only supports resolving contents conflicts
 
4050
                allowed_conflicts = ('text conflict', 'contents conflict')
 
4051
                restore_files = [c.path for c in conflicts
 
4052
                                 if c.typestring in allowed_conflicts]
 
4053
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4054
            tree.set_conflicts(ConflictList(new_conflicts))
 
4055
            if file_list is not None:
 
4056
                restore_files = file_list
 
4057
            for filename in restore_files:
 
4058
                try:
 
4059
                    restore(tree.abspath(filename))
 
4060
                except errors.NotConflicted:
 
4061
                    pass
 
4062
            # Disable pending merges, because the file texts we are remerging
 
4063
            # have not had those merges performed.  If we use the wrong parents
 
4064
            # list, we imply that the working tree text has seen and rejected
 
4065
            # all the changes from the other tree, when in fact those changes
 
4066
            # have not yet been seen.
 
4067
            pb = ui.ui_factory.nested_progress_bar()
 
4068
            tree.set_parent_ids(parents[:1])
4435
4069
            try:
4436
 
                restore(tree.abspath(filename))
4437
 
            except errors.NotConflicted:
4438
 
                pass
4439
 
        # Disable pending merges, because the file texts we are remerging
4440
 
        # have not had those merges performed.  If we use the wrong parents
4441
 
        # list, we imply that the working tree text has seen and rejected
4442
 
        # all the changes from the other tree, when in fact those changes
4443
 
        # have not yet been seen.
4444
 
        tree.set_parent_ids(parents[:1])
4445
 
        try:
4446
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4447
 
            merger.interesting_ids = interesting_ids
4448
 
            merger.merge_type = merge_type
4449
 
            merger.show_base = show_base
4450
 
            merger.reprocess = reprocess
4451
 
            conflicts = merger.do_merge()
 
4070
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
4071
                                                             tree, parents[1])
 
4072
                merger.interesting_ids = interesting_ids
 
4073
                merger.merge_type = merge_type
 
4074
                merger.show_base = show_base
 
4075
                merger.reprocess = reprocess
 
4076
                conflicts = merger.do_merge()
 
4077
            finally:
 
4078
                tree.set_parent_ids(parents)
 
4079
                pb.finished()
4452
4080
        finally:
4453
 
            tree.set_parent_ids(parents)
 
4081
            tree.unlock()
4454
4082
        if conflicts > 0:
4455
4083
            return 1
4456
4084
        else:
4458
4086
 
4459
4087
 
4460
4088
class cmd_revert(Command):
4461
 
    __doc__ = """Revert files to a previous revision.
 
4089
    """Revert files to a previous revision.
4462
4090
 
4463
4091
    Giving a list of files will revert only those files.  Otherwise, all files
4464
4092
    will be reverted.  If the revision is not specified with '--revision', the
4465
4093
    last committed revision is used.
4466
4094
 
4467
4095
    To remove only some changes, without reverting to a prior version, use
4468
 
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
4469
 
    will remove the changes introduced by the second last commit (-2), without
4470
 
    affecting the changes introduced by the last commit (-1).  To remove
4471
 
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
4096
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
4097
    changes introduced by -2, without affecting the changes introduced by -1.
 
4098
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4472
4099
 
4473
4100
    By default, any files that have been manually changed will be backed up
4474
4101
    first.  (Files changed only by merge are not backed up.)  Backup files have
4484
4111
    created as above.  Directories containing unknown files will not be
4485
4112
    deleted.
4486
4113
 
4487
 
    The working tree contains a list of revisions that have been merged but
4488
 
    not yet committed. These revisions will be included as additional parents
4489
 
    of the next commit.  Normally, using revert clears that list as well as
4490
 
    reverting the files.  If any files are specified, revert leaves the list
4491
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4492
 
    .`` in the tree root to revert all files but keep the recorded merges,
4493
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4114
    The working tree contains a list of pending merged revisions, which will
 
4115
    be included as parents in the next commit.  Normally, revert clears that
 
4116
    list as well as reverting the files.  If any files are specified, revert
 
4117
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4118
    revert ." in the tree root to revert all files but keep the merge record,
 
4119
    and "bzr revert --forget-merges" to clear the pending merge list without
4494
4120
    reverting any files.
4495
4121
 
4496
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4497
 
    changes from a branch in a single revision.  To do this, perform the merge
4498
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4499
 
    the content of the tree as it was, but it will clear the list of pending
4500
 
    merges.  The next commit will then contain all of the changes that are
4501
 
    present in the other branch, but without any other parent revisions.
4502
 
    Because this technique forgets where these changes originated, it may
4503
 
    cause additional conflicts on later merges involving the same source and
 
4122
    Using "bzr revert --forget-merges", it is possible to apply the changes
 
4123
    from an arbitrary merge as a single revision.  To do this, perform the
 
4124
    merge as desired.  Then doing revert with the "--forget-merges" option will
 
4125
    keep the content of the tree as it was, but it will clear the list of
 
4126
    pending merges.  The next commit will then contain all of the changes that
 
4127
    would have been in the merge, but without any mention of the other parent
 
4128
    revisions.  Because this technique forgets where these changes originated,
 
4129
    it may cause additional conflicts on later merges involving the source and
4504
4130
    target branches.
4505
4131
    """
4506
4132
 
4507
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4133
    _see_also = ['cat', 'export']
4508
4134
    takes_options = [
4509
4135
        'revision',
4510
4136
        Option('no-backup', "Do not save backups of reverted files."),
4515
4141
 
4516
4142
    def run(self, revision=None, no_backup=False, file_list=None,
4517
4143
            forget_merges=None):
4518
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4519
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4520
 
        if forget_merges:
4521
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4522
 
        else:
4523
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4144
        tree, file_list = tree_files(file_list)
 
4145
        tree.lock_write()
 
4146
        try:
 
4147
            if forget_merges:
 
4148
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4149
            else:
 
4150
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4151
        finally:
 
4152
            tree.unlock()
4524
4153
 
4525
4154
    @staticmethod
4526
4155
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4527
4156
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4528
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4529
 
            report_changes=True)
 
4157
        pb = ui.ui_factory.nested_progress_bar()
 
4158
        try:
 
4159
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4160
                report_changes=True)
 
4161
        finally:
 
4162
            pb.finished()
4530
4163
 
4531
4164
 
4532
4165
class cmd_assert_fail(Command):
4533
 
    __doc__ = """Test reporting of assertion failures"""
 
4166
    """Test reporting of assertion failures"""
4534
4167
    # intended just for use in testing
4535
4168
 
4536
4169
    hidden = True
4540
4173
 
4541
4174
 
4542
4175
class cmd_help(Command):
4543
 
    __doc__ = """Show help on a command or other topic.
 
4176
    """Show help on a command or other topic.
4544
4177
    """
4545
4178
 
4546
4179
    _see_also = ['topics']
4559
4192
 
4560
4193
 
4561
4194
class cmd_shell_complete(Command):
4562
 
    __doc__ = """Show appropriate completions for context.
 
4195
    """Show appropriate completions for context.
4563
4196
 
4564
4197
    For a list of all available commands, say 'bzr shell-complete'.
4565
4198
    """
4574
4207
 
4575
4208
 
4576
4209
class cmd_missing(Command):
4577
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4210
    """Show unmerged/unpulled revisions between two branches.
4578
4211
 
4579
4212
    OTHER_BRANCH may be local or remote.
4580
4213
 
4611
4244
    _see_also = ['merge', 'pull']
4612
4245
    takes_args = ['other_branch?']
4613
4246
    takes_options = [
4614
 
        'directory',
4615
4247
        Option('reverse', 'Reverse the order of revisions.'),
4616
4248
        Option('mine-only',
4617
4249
               'Display changes in the local branch only.'),
4629
4261
            type=_parse_revision_str,
4630
4262
            help='Filter on local branch revisions (inclusive). '
4631
4263
                'See "help revisionspec" for details.'),
4632
 
        Option('include-merged',
 
4264
        Option('include-merges',
4633
4265
               'Show all revisions in addition to the mainline ones.'),
4634
 
        Option('include-merges', hidden=True,
4635
 
               help='Historical alias for --include-merged.'),
4636
4266
        ]
4637
4267
    encoding_type = 'replace'
4638
4268
 
4641
4271
            theirs_only=False,
4642
4272
            log_format=None, long=False, short=False, line=False,
4643
4273
            show_ids=False, verbose=False, this=False, other=False,
4644
 
            include_merged=None, revision=None, my_revision=None,
4645
 
            directory=u'.',
4646
 
            include_merges=symbol_versioning.DEPRECATED_PARAMETER):
 
4274
            include_merges=False, revision=None, my_revision=None):
4647
4275
        from bzrlib.missing import find_unmerged, iter_log_revisions
4648
4276
        def message(s):
4649
4277
            if not is_quiet():
4650
4278
                self.outf.write(s)
4651
4279
 
4652
 
        if symbol_versioning.deprecated_passed(include_merges):
4653
 
            ui.ui_factory.show_user_warning(
4654
 
                'deprecated_command_option',
4655
 
                deprecated_name='--include-merges',
4656
 
                recommended_name='--include-merged',
4657
 
                deprecated_in_version='2.5',
4658
 
                command=self.invoked_as)
4659
 
            if include_merged is None:
4660
 
                include_merged = include_merges
4661
 
            else:
4662
 
                raise errors.BzrCommandError(gettext(
4663
 
                    '{0} and {1} are mutually exclusive').format(
4664
 
                    '--include-merges', '--include-merged'))
4665
 
        if include_merged is None:
4666
 
            include_merged = False
4667
4280
        if this:
4668
4281
            mine_only = this
4669
4282
        if other:
4677
4290
        elif theirs_only:
4678
4291
            restrict = 'remote'
4679
4292
 
4680
 
        local_branch = Branch.open_containing(directory)[0]
4681
 
        self.add_cleanup(local_branch.lock_read().unlock)
4682
 
 
 
4293
        local_branch = Branch.open_containing(u".")[0]
4683
4294
        parent = local_branch.get_parent()
4684
4295
        if other_branch is None:
4685
4296
            other_branch = parent
4686
4297
            if other_branch is None:
4687
 
                raise errors.BzrCommandError(gettext("No peer location known"
4688
 
                                             " or specified."))
 
4298
                raise errors.BzrCommandError("No peer location known"
 
4299
                                             " or specified.")
4689
4300
            display_url = urlutils.unescape_for_display(parent,
4690
4301
                                                        self.outf.encoding)
4691
 
            message(gettext("Using saved parent location: {0}\n").format(
4692
 
                    display_url))
 
4302
            message("Using saved parent location: "
 
4303
                    + display_url + "\n")
4693
4304
 
4694
4305
        remote_branch = Branch.open(other_branch)
4695
4306
        if remote_branch.base == local_branch.base:
4696
4307
            remote_branch = local_branch
4697
 
        else:
4698
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4699
4308
 
4700
4309
        local_revid_range = _revision_range_to_revid_range(
4701
4310
            _get_revision_range(my_revision, local_branch,
4705
4314
            _get_revision_range(revision,
4706
4315
                remote_branch, self.name()))
4707
4316
 
4708
 
        local_extra, remote_extra = find_unmerged(
4709
 
            local_branch, remote_branch, restrict,
4710
 
            backward=not reverse,
4711
 
            include_merged=include_merged,
4712
 
            local_revid_range=local_revid_range,
4713
 
            remote_revid_range=remote_revid_range)
4714
 
 
4715
 
        if log_format is None:
4716
 
            registry = log.log_formatter_registry
4717
 
            log_format = registry.get_default(local_branch)
4718
 
        lf = log_format(to_file=self.outf,
4719
 
                        show_ids=show_ids,
4720
 
                        show_timezone='original')
4721
 
 
4722
 
        status_code = 0
4723
 
        if local_extra and not theirs_only:
4724
 
            message(ngettext("You have %d extra revision:\n",
4725
 
                             "You have %d extra revisions:\n", 
4726
 
                             len(local_extra)) %
4727
 
                len(local_extra))
4728
 
            for revision in iter_log_revisions(local_extra,
4729
 
                                local_branch.repository,
4730
 
                                verbose):
4731
 
                lf.log_revision(revision)
4732
 
            printed_local = True
4733
 
            status_code = 1
4734
 
        else:
4735
 
            printed_local = False
4736
 
 
4737
 
        if remote_extra and not mine_only:
4738
 
            if printed_local is True:
4739
 
                message("\n\n\n")
4740
 
            message(ngettext("You are missing %d revision:\n",
4741
 
                             "You are missing %d revisions:\n",
4742
 
                             len(remote_extra)) %
4743
 
                len(remote_extra))
4744
 
            for revision in iter_log_revisions(remote_extra,
4745
 
                                remote_branch.repository,
4746
 
                                verbose):
4747
 
                lf.log_revision(revision)
4748
 
            status_code = 1
4749
 
 
4750
 
        if mine_only and not local_extra:
4751
 
            # We checked local, and found nothing extra
4752
 
            message(gettext('This branch has no new revisions.\n'))
4753
 
        elif theirs_only and not remote_extra:
4754
 
            # We checked remote, and found nothing extra
4755
 
            message(gettext('Other branch has no new revisions.\n'))
4756
 
        elif not (mine_only or theirs_only or local_extra or
4757
 
                  remote_extra):
4758
 
            # We checked both branches, and neither one had extra
4759
 
            # revisions
4760
 
            message(gettext("Branches are up to date.\n"))
4761
 
        self.cleanup_now()
 
4317
        local_branch.lock_read()
 
4318
        try:
 
4319
            remote_branch.lock_read()
 
4320
            try:
 
4321
                local_extra, remote_extra = find_unmerged(
 
4322
                    local_branch, remote_branch, restrict,
 
4323
                    backward=not reverse,
 
4324
                    include_merges=include_merges,
 
4325
                    local_revid_range=local_revid_range,
 
4326
                    remote_revid_range=remote_revid_range)
 
4327
 
 
4328
                if log_format is None:
 
4329
                    registry = log.log_formatter_registry
 
4330
                    log_format = registry.get_default(local_branch)
 
4331
                lf = log_format(to_file=self.outf,
 
4332
                                show_ids=show_ids,
 
4333
                                show_timezone='original')
 
4334
 
 
4335
                status_code = 0
 
4336
                if local_extra and not theirs_only:
 
4337
                    message("You have %d extra revision(s):\n" %
 
4338
                        len(local_extra))
 
4339
                    for revision in iter_log_revisions(local_extra,
 
4340
                                        local_branch.repository,
 
4341
                                        verbose):
 
4342
                        lf.log_revision(revision)
 
4343
                    printed_local = True
 
4344
                    status_code = 1
 
4345
                else:
 
4346
                    printed_local = False
 
4347
 
 
4348
                if remote_extra and not mine_only:
 
4349
                    if printed_local is True:
 
4350
                        message("\n\n\n")
 
4351
                    message("You are missing %d revision(s):\n" %
 
4352
                        len(remote_extra))
 
4353
                    for revision in iter_log_revisions(remote_extra,
 
4354
                                        remote_branch.repository,
 
4355
                                        verbose):
 
4356
                        lf.log_revision(revision)
 
4357
                    status_code = 1
 
4358
 
 
4359
                if mine_only and not local_extra:
 
4360
                    # We checked local, and found nothing extra
 
4361
                    message('This branch is up to date.\n')
 
4362
                elif theirs_only and not remote_extra:
 
4363
                    # We checked remote, and found nothing extra
 
4364
                    message('Other branch is up to date.\n')
 
4365
                elif not (mine_only or theirs_only or local_extra or
 
4366
                          remote_extra):
 
4367
                    # We checked both branches, and neither one had extra
 
4368
                    # revisions
 
4369
                    message("Branches are up to date.\n")
 
4370
            finally:
 
4371
                remote_branch.unlock()
 
4372
        finally:
 
4373
            local_branch.unlock()
4762
4374
        if not status_code and parent is None and other_branch is not None:
4763
 
            self.add_cleanup(local_branch.lock_write().unlock)
4764
 
            # handle race conditions - a parent might be set while we run.
4765
 
            if local_branch.get_parent() is None:
4766
 
                local_branch.set_parent(remote_branch.base)
 
4375
            local_branch.lock_write()
 
4376
            try:
 
4377
                # handle race conditions - a parent might be set while we run.
 
4378
                if local_branch.get_parent() is None:
 
4379
                    local_branch.set_parent(remote_branch.base)
 
4380
            finally:
 
4381
                local_branch.unlock()
4767
4382
        return status_code
4768
4383
 
4769
4384
 
4770
4385
class cmd_pack(Command):
4771
 
    __doc__ = """Compress the data within a repository.
4772
 
 
4773
 
    This operation compresses the data within a bazaar repository. As
4774
 
    bazaar supports automatic packing of repository, this operation is
4775
 
    normally not required to be done manually.
4776
 
 
4777
 
    During the pack operation, bazaar takes a backup of existing repository
4778
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4779
 
    automatically when it is safe to do so. To save disk space by removing
4780
 
    the backed up pack files, the --clean-obsolete-packs option may be
4781
 
    used.
4782
 
 
4783
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4784
 
    during or immediately after repacking, you may be left with a state
4785
 
    where the deletion has been written to disk but the new packs have not
4786
 
    been. In this case the repository may be unusable.
4787
 
    """
 
4386
    """Compress the data within a repository."""
4788
4387
 
4789
4388
    _see_also = ['repositories']
4790
4389
    takes_args = ['branch_or_repo?']
4791
 
    takes_options = [
4792
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4793
 
        ]
4794
4390
 
4795
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4391
    def run(self, branch_or_repo='.'):
4796
4392
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4797
4393
        try:
4798
4394
            branch = dir.open_branch()
4799
4395
            repository = branch.repository
4800
4396
        except errors.NotBranchError:
4801
4397
            repository = dir.open_repository()
4802
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4398
        repository.pack()
4803
4399
 
4804
4400
 
4805
4401
class cmd_plugins(Command):
4806
 
    __doc__ = """List the installed plugins.
 
4402
    """List the installed plugins.
4807
4403
 
4808
4404
    This command displays the list of installed plugins including
4809
4405
    version of plugin and a short description of each.
4816
4412
    adding new commands, providing additional network transports and
4817
4413
    customizing log output.
4818
4414
 
4819
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4820
 
    for further information on plugins including where to find them and how to
4821
 
    install them. Instructions are also provided there on how to write new
4822
 
    plugins using the Python programming language.
 
4415
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4416
    information on plugins including where to find them and how to
 
4417
    install them. Instructions are also provided there on how to
 
4418
    write new plugins using the Python programming language.
4823
4419
    """
4824
4420
    takes_options = ['verbose']
4825
4421
 
4826
4422
    @display_command
4827
4423
    def run(self, verbose=False):
4828
 
        from bzrlib import plugin
4829
 
        # Don't give writelines a generator as some codecs don't like that
4830
 
        self.outf.writelines(
4831
 
            list(plugin.describe_plugins(show_paths=verbose)))
 
4424
        import bzrlib.plugin
 
4425
        from inspect import getdoc
 
4426
        result = []
 
4427
        for name, plugin in bzrlib.plugin.plugins().items():
 
4428
            version = plugin.__version__
 
4429
            if version == 'unknown':
 
4430
                version = ''
 
4431
            name_ver = '%s %s' % (name, version)
 
4432
            d = getdoc(plugin.module)
 
4433
            if d:
 
4434
                doc = d.split('\n')[0]
 
4435
            else:
 
4436
                doc = '(no description)'
 
4437
            result.append((name_ver, doc, plugin.path()))
 
4438
        for name_ver, doc, path in sorted(result):
 
4439
            print name_ver
 
4440
            print '   ', doc
 
4441
            if verbose:
 
4442
                print '   ', path
 
4443
            print
4832
4444
 
4833
4445
 
4834
4446
class cmd_testament(Command):
4835
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4447
    """Show testament (signing-form) of a revision."""
4836
4448
    takes_options = [
4837
4449
            'revision',
4838
4450
            Option('long', help='Produce long-format testament.'),
4850
4462
            b = Branch.open_containing(branch)[0]
4851
4463
        else:
4852
4464
            b = Branch.open(branch)
4853
 
        self.add_cleanup(b.lock_read().unlock)
4854
 
        if revision is None:
4855
 
            rev_id = b.last_revision()
4856
 
        else:
4857
 
            rev_id = revision[0].as_revision_id(b)
4858
 
        t = testament_class.from_revision(b.repository, rev_id)
4859
 
        if long:
4860
 
            sys.stdout.writelines(t.as_text_lines())
4861
 
        else:
4862
 
            sys.stdout.write(t.as_short_text())
 
4465
        b.lock_read()
 
4466
        try:
 
4467
            if revision is None:
 
4468
                rev_id = b.last_revision()
 
4469
            else:
 
4470
                rev_id = revision[0].as_revision_id(b)
 
4471
            t = testament_class.from_revision(b.repository, rev_id)
 
4472
            if long:
 
4473
                sys.stdout.writelines(t.as_text_lines())
 
4474
            else:
 
4475
                sys.stdout.write(t.as_short_text())
 
4476
        finally:
 
4477
            b.unlock()
4863
4478
 
4864
4479
 
4865
4480
class cmd_annotate(Command):
4866
 
    __doc__ = """Show the origin of each line in a file.
 
4481
    """Show the origin of each line in a file.
4867
4482
 
4868
4483
    This prints out the given file with an annotation on the left side
4869
4484
    indicating which revision, author and date introduced the change.
4880
4495
                     Option('long', help='Show commit date in annotations.'),
4881
4496
                     'revision',
4882
4497
                     'show-ids',
4883
 
                     'directory',
4884
4498
                     ]
4885
4499
    encoding_type = 'exact'
4886
4500
 
4887
4501
    @display_command
4888
4502
    def run(self, filename, all=False, long=False, revision=None,
4889
 
            show_ids=False, directory=None):
4890
 
        from bzrlib.annotate import (
4891
 
            annotate_file_tree,
4892
 
            )
 
4503
            show_ids=False):
 
4504
        from bzrlib.annotate import annotate_file, annotate_file_tree
4893
4505
        wt, branch, relpath = \
4894
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4506
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4895
4507
        if wt is not None:
4896
 
            self.add_cleanup(wt.lock_read().unlock)
4897
 
        else:
4898
 
            self.add_cleanup(branch.lock_read().unlock)
4899
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4900
 
        self.add_cleanup(tree.lock_read().unlock)
4901
 
        if wt is not None and revision is None:
4902
 
            file_id = wt.path2id(relpath)
4903
 
        else:
4904
 
            file_id = tree.path2id(relpath)
4905
 
        if file_id is None:
4906
 
            raise errors.NotVersionedError(filename)
4907
 
        if wt is not None and revision is None:
4908
 
            # If there is a tree and we're not annotating historical
4909
 
            # versions, annotate the working tree's content.
4910
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4911
 
                show_ids=show_ids)
4912
 
        else:
4913
 
            annotate_file_tree(tree, file_id, self.outf, long, all,
4914
 
                show_ids=show_ids, branch=branch)
 
4508
            wt.lock_read()
 
4509
        else:
 
4510
            branch.lock_read()
 
4511
        try:
 
4512
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4513
            if wt is not None:
 
4514
                file_id = wt.path2id(relpath)
 
4515
            else:
 
4516
                file_id = tree.path2id(relpath)
 
4517
            if file_id is None:
 
4518
                raise errors.NotVersionedError(filename)
 
4519
            file_version = tree.inventory[file_id].revision
 
4520
            if wt is not None and revision is None:
 
4521
                # If there is a tree and we're not annotating historical
 
4522
                # versions, annotate the working tree's content.
 
4523
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4524
                    show_ids=show_ids)
 
4525
            else:
 
4526
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4527
                              show_ids=show_ids)
 
4528
        finally:
 
4529
            if wt is not None:
 
4530
                wt.unlock()
 
4531
            else:
 
4532
                branch.unlock()
4915
4533
 
4916
4534
 
4917
4535
class cmd_re_sign(Command):
4918
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4536
    """Create a digital signature for an existing revision."""
4919
4537
    # TODO be able to replace existing ones.
4920
4538
 
4921
4539
    hidden = True # is this right ?
4922
4540
    takes_args = ['revision_id*']
4923
 
    takes_options = ['directory', 'revision']
 
4541
    takes_options = ['revision']
4924
4542
 
4925
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4543
    def run(self, revision_id_list=None, revision=None):
4926
4544
        if revision_id_list is not None and revision is not None:
4927
 
            raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
 
4545
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4928
4546
        if revision_id_list is None and revision is None:
4929
 
            raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
4930
 
        b = WorkingTree.open_containing(directory)[0].branch
4931
 
        self.add_cleanup(b.lock_write().unlock)
4932
 
        return self._run(b, revision_id_list, revision)
 
4547
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
4548
        b = WorkingTree.open_containing(u'.')[0].branch
 
4549
        b.lock_write()
 
4550
        try:
 
4551
            return self._run(b, revision_id_list, revision)
 
4552
        finally:
 
4553
            b.unlock()
4933
4554
 
4934
4555
    def _run(self, b, revision_id_list, revision):
4935
4556
        import bzrlib.gpg as gpg
4964
4585
                if to_revid is None:
4965
4586
                    to_revno = b.revno()
4966
4587
                if from_revno is None or to_revno is None:
4967
 
                    raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
 
4588
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4968
4589
                b.repository.start_write_group()
4969
4590
                try:
4970
4591
                    for revno in range(from_revno, to_revno + 1):
4976
4597
                else:
4977
4598
                    b.repository.commit_write_group()
4978
4599
            else:
4979
 
                raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
 
4600
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
4980
4601
 
4981
4602
 
4982
4603
class cmd_bind(Command):
4983
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4984
 
    If no branch is supplied, rebind to the last bound location.
 
4604
    """Convert the current branch into a checkout of the supplied branch.
4985
4605
 
4986
4606
    Once converted into a checkout, commits must succeed on the master branch
4987
4607
    before they will be applied to the local branch.
4993
4613
 
4994
4614
    _see_also = ['checkouts', 'unbind']
4995
4615
    takes_args = ['location?']
4996
 
    takes_options = ['directory']
 
4616
    takes_options = []
4997
4617
 
4998
 
    def run(self, location=None, directory=u'.'):
4999
 
        b, relpath = Branch.open_containing(directory)
 
4618
    def run(self, location=None):
 
4619
        b, relpath = Branch.open_containing(u'.')
5000
4620
        if location is None:
5001
4621
            try:
5002
4622
                location = b.get_old_bound_location()
5003
4623
            except errors.UpgradeRequired:
5004
 
                raise errors.BzrCommandError(gettext('No location supplied.  '
5005
 
                    'This format does not remember old locations.'))
 
4624
                raise errors.BzrCommandError('No location supplied.  '
 
4625
                    'This format does not remember old locations.')
5006
4626
            else:
5007
4627
                if location is None:
5008
 
                    if b.get_bound_location() is not None:
5009
 
                        raise errors.BzrCommandError(gettext('Branch is already bound'))
5010
 
                    else:
5011
 
                        raise errors.BzrCommandError(gettext('No location supplied '
5012
 
                            'and no previous location known'))
 
4628
                    raise errors.BzrCommandError('No location supplied and no '
 
4629
                        'previous location known')
5013
4630
        b_other = Branch.open(location)
5014
4631
        try:
5015
4632
            b.bind(b_other)
5016
4633
        except errors.DivergedBranches:
5017
 
            raise errors.BzrCommandError(gettext('These branches have diverged.'
5018
 
                                         ' Try merging, and then bind again.'))
 
4634
            raise errors.BzrCommandError('These branches have diverged.'
 
4635
                                         ' Try merging, and then bind again.')
5019
4636
        if b.get_config().has_explicit_nickname():
5020
4637
            b.nick = b_other.nick
5021
4638
 
5022
4639
 
5023
4640
class cmd_unbind(Command):
5024
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4641
    """Convert the current checkout into a regular branch.
5025
4642
 
5026
4643
    After unbinding, the local branch is considered independent and subsequent
5027
4644
    commits will be local only.
5029
4646
 
5030
4647
    _see_also = ['checkouts', 'bind']
5031
4648
    takes_args = []
5032
 
    takes_options = ['directory']
 
4649
    takes_options = []
5033
4650
 
5034
 
    def run(self, directory=u'.'):
5035
 
        b, relpath = Branch.open_containing(directory)
 
4651
    def run(self):
 
4652
        b, relpath = Branch.open_containing(u'.')
5036
4653
        if not b.unbind():
5037
 
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
 
4654
            raise errors.BzrCommandError('Local branch is not bound')
5038
4655
 
5039
4656
 
5040
4657
class cmd_uncommit(Command):
5041
 
    __doc__ = """Remove the last committed revision.
 
4658
    """Remove the last committed revision.
5042
4659
 
5043
4660
    --verbose will print out what is being removed.
5044
4661
    --dry-run will go through all the motions, but not actually
5061
4678
    takes_options = ['verbose', 'revision',
5062
4679
                    Option('dry-run', help='Don\'t actually make changes.'),
5063
4680
                    Option('force', help='Say yes to all questions.'),
5064
 
                    Option('keep-tags',
5065
 
                           help='Keep tags that point to removed revisions.'),
5066
4681
                    Option('local',
5067
4682
                           help="Only remove the commits from the local branch"
5068
4683
                                " when in a checkout."
5072
4687
    aliases = []
5073
4688
    encoding_type = 'replace'
5074
4689
 
5075
 
    def run(self, location=None, dry_run=False, verbose=False,
5076
 
            revision=None, force=False, local=False, keep_tags=False):
 
4690
    def run(self, location=None,
 
4691
            dry_run=False, verbose=False,
 
4692
            revision=None, force=False, local=False):
5077
4693
        if location is None:
5078
4694
            location = u'.'
5079
4695
        control, relpath = bzrdir.BzrDir.open_containing(location)
5085
4701
            b = control.open_branch()
5086
4702
 
5087
4703
        if tree is not None:
5088
 
            self.add_cleanup(tree.lock_write().unlock)
 
4704
            tree.lock_write()
5089
4705
        else:
5090
 
            self.add_cleanup(b.lock_write().unlock)
5091
 
        return self._run(b, tree, dry_run, verbose, revision, force,
5092
 
                         local, keep_tags)
 
4706
            b.lock_write()
 
4707
        try:
 
4708
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4709
                             local=local)
 
4710
        finally:
 
4711
            if tree is not None:
 
4712
                tree.unlock()
 
4713
            else:
 
4714
                b.unlock()
5093
4715
 
5094
 
    def _run(self, b, tree, dry_run, verbose, revision, force, local,
5095
 
             keep_tags):
 
4716
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
5096
4717
        from bzrlib.log import log_formatter, show_log
5097
4718
        from bzrlib.uncommit import uncommit
5098
4719
 
5113
4734
                rev_id = b.get_rev_id(revno)
5114
4735
 
5115
4736
        if rev_id is None or _mod_revision.is_null(rev_id):
5116
 
            self.outf.write(gettext('No revisions to uncommit.\n'))
 
4737
            self.outf.write('No revisions to uncommit.\n')
5117
4738
            return 1
5118
4739
 
5119
4740
        lf = log_formatter('short',
5128
4749
                 end_revision=last_revno)
5129
4750
 
5130
4751
        if dry_run:
5131
 
            self.outf.write(gettext('Dry-run, pretending to remove'
5132
 
                            ' the above revisions.\n'))
 
4752
            print 'Dry-run, pretending to remove the above revisions.'
 
4753
            if not force:
 
4754
                val = raw_input('Press <enter> to continue')
5133
4755
        else:
5134
 
            self.outf.write(gettext('The above revision(s) will be removed.\n'))
5135
 
 
5136
 
        if not force:
5137
 
            if not ui.ui_factory.confirm_action(
5138
 
                    gettext(u'Uncommit these revisions'),
5139
 
                    'bzrlib.builtins.uncommit',
5140
 
                    {}):
5141
 
                self.outf.write(gettext('Canceled\n'))
5142
 
                return 0
 
4756
            print 'The above revision(s) will be removed.'
 
4757
            if not force:
 
4758
                val = raw_input('Are you sure [y/N]? ')
 
4759
                if val.lower() not in ('y', 'yes'):
 
4760
                    print 'Canceled'
 
4761
                    return 0
5143
4762
 
5144
4763
        mutter('Uncommitting from {%s} to {%s}',
5145
4764
               last_rev_id, rev_id)
5146
4765
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5147
 
                 revno=revno, local=local, keep_tags=keep_tags)
5148
 
        self.outf.write(gettext('You can restore the old tip by running:\n'
5149
 
             '  bzr pull . -r revid:%s\n') % last_rev_id)
 
4766
                 revno=revno, local=local)
 
4767
        note('You can restore the old tip by running:\n'
 
4768
             '  bzr pull . -r revid:%s', last_rev_id)
5150
4769
 
5151
4770
 
5152
4771
class cmd_break_lock(Command):
5153
 
    __doc__ = """Break a dead lock.
5154
 
 
5155
 
    This command breaks a lock on a repository, branch, working directory or
5156
 
    config file.
 
4772
    """Break a dead lock on a repository, branch or working directory.
5157
4773
 
5158
4774
    CAUTION: Locks should only be broken when you are sure that the process
5159
4775
    holding the lock has been stopped.
5160
4776
 
5161
 
    You can get information on what locks are open via the 'bzr info
5162
 
    [location]' command.
 
4777
    You can get information on what locks are open via the 'bzr info' command.
5163
4778
 
5164
4779
    :Examples:
5165
4780
        bzr break-lock
5166
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
5167
 
        bzr break-lock --conf ~/.bazaar
5168
4781
    """
5169
 
 
5170
4782
    takes_args = ['location?']
5171
 
    takes_options = [
5172
 
        Option('config',
5173
 
               help='LOCATION is the directory where the config lock is.'),
5174
 
        Option('force',
5175
 
            help='Do not ask for confirmation before breaking the lock.'),
5176
 
        ]
5177
4783
 
5178
 
    def run(self, location=None, config=False, force=False):
 
4784
    def run(self, location=None, show=False):
5179
4785
        if location is None:
5180
4786
            location = u'.'
5181
 
        if force:
5182
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5183
 
                None,
5184
 
                {'bzrlib.lockdir.break': True})
5185
 
        if config:
5186
 
            conf = _mod_config.LockableConfig(file_name=location)
5187
 
            conf.break_lock()
5188
 
        else:
5189
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
5190
 
            try:
5191
 
                control.break_lock()
5192
 
            except NotImplementedError:
5193
 
                pass
 
4787
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4788
        try:
 
4789
            control.break_lock()
 
4790
        except NotImplementedError:
 
4791
            pass
5194
4792
 
5195
4793
 
5196
4794
class cmd_wait_until_signalled(Command):
5197
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4795
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5198
4796
 
5199
4797
    This just prints a line to signal when it is ready, then blocks on stdin.
5200
4798
    """
5208
4806
 
5209
4807
 
5210
4808
class cmd_serve(Command):
5211
 
    __doc__ = """Run the bzr server."""
 
4809
    """Run the bzr server."""
5212
4810
 
5213
4811
    aliases = ['server']
5214
4812
 
5225
4823
                    'result in a dynamically allocated port.  The default port '
5226
4824
                    'depends on the protocol.',
5227
4825
               type=str),
5228
 
        custom_help('directory',
5229
 
               help='Serve contents of this directory.'),
 
4826
        Option('directory',
 
4827
               help='Serve contents of this directory.',
 
4828
               type=unicode),
5230
4829
        Option('allow-writes',
5231
4830
               help='By default the server is a readonly server.  Supplying '
5232
4831
                    '--allow-writes enables write access to the contents of '
5259
4858
 
5260
4859
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5261
4860
            protocol=None):
5262
 
        from bzrlib import transport
 
4861
        from bzrlib.transport import get_transport, transport_server_registry
5263
4862
        if directory is None:
5264
4863
            directory = os.getcwd()
5265
4864
        if protocol is None:
5266
 
            protocol = transport.transport_server_registry.get()
 
4865
            protocol = transport_server_registry.get()
5267
4866
        host, port = self.get_host_and_port(port)
5268
4867
        url = urlutils.local_path_to_url(directory)
5269
4868
        if not allow_writes:
5270
4869
            url = 'readonly+' + url
5271
 
        t = transport.get_transport(url)
5272
 
        protocol(t, host, port, inet)
 
4870
        transport = get_transport(url)
 
4871
        protocol(transport, host, port, inet)
5273
4872
 
5274
4873
 
5275
4874
class cmd_join(Command):
5276
 
    __doc__ = """Combine a tree into its containing tree.
 
4875
    """Combine a tree into its containing tree.
5277
4876
 
5278
4877
    This command requires the target tree to be in a rich-root format.
5279
4878
 
5281
4880
    not part of it.  (Such trees can be produced by "bzr split", but also by
5282
4881
    running "bzr branch" with the target inside a tree.)
5283
4882
 
5284
 
    The result is a combined tree, with the subtree no longer an independent
 
4883
    The result is a combined tree, with the subtree no longer an independant
5285
4884
    part.  This is marked as a merge of the subtree into the containing tree,
5286
4885
    and all history is preserved.
5287
4886
    """
5298
4897
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
5299
4898
        repo = containing_tree.branch.repository
5300
4899
        if not repo.supports_rich_root():
5301
 
            raise errors.BzrCommandError(gettext(
 
4900
            raise errors.BzrCommandError(
5302
4901
                "Can't join trees because %s doesn't support rich root data.\n"
5303
 
                "You can use bzr upgrade on the repository.")
 
4902
                "You can use bzr upgrade on the repository."
5304
4903
                % (repo,))
5305
4904
        if reference:
5306
4905
            try:
5308
4907
            except errors.BadReferenceTarget, e:
5309
4908
                # XXX: Would be better to just raise a nicely printable
5310
4909
                # exception from the real origin.  Also below.  mbp 20070306
5311
 
                raise errors.BzrCommandError(
5312
 
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
 
4910
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4911
                                             (tree, e.reason))
5313
4912
        else:
5314
4913
            try:
5315
4914
                containing_tree.subsume(sub_tree)
5316
4915
            except errors.BadSubsumeSource, e:
5317
 
                raise errors.BzrCommandError(
5318
 
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
 
4916
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4917
                                             (tree, e.reason))
5319
4918
 
5320
4919
 
5321
4920
class cmd_split(Command):
5322
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4921
    """Split a subdirectory of a tree into a separate tree.
5323
4922
 
5324
4923
    This command will produce a target tree in a format that supports
5325
4924
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5345
4944
 
5346
4945
 
5347
4946
class cmd_merge_directive(Command):
5348
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4947
    """Generate a merge directive for auto-merge tools.
5349
4948
 
5350
4949
    A directive requests a merge to be performed, and also provides all the
5351
4950
    information necessary to do so.  This means it must either include a
5368
4967
    _see_also = ['send']
5369
4968
 
5370
4969
    takes_options = [
5371
 
        'directory',
5372
4970
        RegistryOption.from_kwargs('patch-type',
5373
4971
            'The type of patch to include in the directive.',
5374
4972
            title='Patch type',
5387
4985
    encoding_type = 'exact'
5388
4986
 
5389
4987
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5390
 
            sign=False, revision=None, mail_to=None, message=None,
5391
 
            directory=u'.'):
 
4988
            sign=False, revision=None, mail_to=None, message=None):
5392
4989
        from bzrlib.revision import ensure_null, NULL_REVISION
5393
4990
        include_patch, include_bundle = {
5394
4991
            'plain': (False, False),
5395
4992
            'diff': (True, False),
5396
4993
            'bundle': (True, True),
5397
4994
            }[patch_type]
5398
 
        branch = Branch.open(directory)
 
4995
        branch = Branch.open('.')
5399
4996
        stored_submit_branch = branch.get_submit_branch()
5400
4997
        if submit_branch is None:
5401
4998
            submit_branch = stored_submit_branch
5405
5002
        if submit_branch is None:
5406
5003
            submit_branch = branch.get_parent()
5407
5004
        if submit_branch is None:
5408
 
            raise errors.BzrCommandError(gettext('No submit branch specified or known'))
 
5005
            raise errors.BzrCommandError('No submit branch specified or known')
5409
5006
 
5410
5007
        stored_public_branch = branch.get_public_branch()
5411
5008
        if public_branch is None:
5413
5010
        elif stored_public_branch is None:
5414
5011
            branch.set_public_branch(public_branch)
5415
5012
        if not include_bundle and public_branch is None:
5416
 
            raise errors.BzrCommandError(gettext('No public branch specified or'
5417
 
                                         ' known'))
 
5013
            raise errors.BzrCommandError('No public branch specified or'
 
5014
                                         ' known')
5418
5015
        base_revision_id = None
5419
5016
        if revision is not None:
5420
5017
            if len(revision) > 2:
5421
 
                raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5422
 
                    'at most two one revision identifiers'))
 
5018
                raise errors.BzrCommandError('bzr merge-directive takes '
 
5019
                    'at most two one revision identifiers')
5423
5020
            revision_id = revision[-1].as_revision_id(branch)
5424
5021
            if len(revision) == 2:
5425
5022
                base_revision_id = revision[0].as_revision_id(branch)
5427
5024
            revision_id = branch.last_revision()
5428
5025
        revision_id = ensure_null(revision_id)
5429
5026
        if revision_id == NULL_REVISION:
5430
 
            raise errors.BzrCommandError(gettext('No revisions to bundle.'))
 
5027
            raise errors.BzrCommandError('No revisions to bundle.')
5431
5028
        directive = merge_directive.MergeDirective2.from_objects(
5432
5029
            branch.repository, revision_id, time.time(),
5433
5030
            osutils.local_time_offset(), submit_branch,
5446
5043
 
5447
5044
 
5448
5045
class cmd_send(Command):
5449
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
5046
    """Mail or create a merge-directive for submitting changes.
5450
5047
 
5451
5048
    A merge directive provides many things needed for requesting merges:
5452
5049
 
5458
5055
      directly from the merge directive, without retrieving data from a
5459
5056
      branch.
5460
5057
 
5461
 
    `bzr send` creates a compact data set that, when applied using bzr
5462
 
    merge, has the same effect as merging from the source branch.  
5463
 
    
5464
 
    By default the merge directive is self-contained and can be applied to any
5465
 
    branch containing submit_branch in its ancestory without needing access to
5466
 
    the source branch.
5467
 
    
5468
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5469
 
    revisions, but only a structured request to merge from the
5470
 
    public_location.  In that case the public_branch is needed and it must be
5471
 
    up-to-date and accessible to the recipient.  The public_branch is always
5472
 
    included if known, so that people can check it later.
5473
 
 
5474
 
    The submit branch defaults to the parent of the source branch, but can be
5475
 
    overridden.  Both submit branch and public branch will be remembered in
5476
 
    branch.conf the first time they are used for a particular branch.  The
5477
 
    source branch defaults to that containing the working directory, but can
5478
 
    be changed using --from.
5479
 
 
5480
 
    Both the submit branch and the public branch follow the usual behavior with
5481
 
    respect to --remember: If there is no default location set, the first send
5482
 
    will set it (use --no-remember to avoid setting it). After that, you can
5483
 
    omit the location to use the default.  To change the default, use
5484
 
    --remember. The value will only be saved if the location can be accessed.
5485
 
 
5486
 
    In order to calculate those changes, bzr must analyse the submit branch.
5487
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5488
 
    If a public location is known for the submit_branch, that location is used
5489
 
    in the merge directive.
5490
 
 
5491
 
    The default behaviour is to send the merge directive by mail, unless -o is
5492
 
    given, in which case it is sent to a file.
 
5058
    If --no-bundle is specified, then public_branch is needed (and must be
 
5059
    up-to-date), so that the receiver can perform the merge using the
 
5060
    public_branch.  The public_branch is always included if known, so that
 
5061
    people can check it later.
 
5062
 
 
5063
    The submit branch defaults to the parent, but can be overridden.  Both
 
5064
    submit branch and public branch will be remembered if supplied.
 
5065
 
 
5066
    If a public_branch is known for the submit_branch, that public submit
 
5067
    branch is used in the merge instructions.  This means that a local mirror
 
5068
    can be used as your actual submit branch, once you have set public_branch
 
5069
    for that mirror.
5493
5070
 
5494
5071
    Mail is sent using your preferred mail program.  This should be transparent
5495
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5072
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5496
5073
    If the preferred client can't be found (or used), your editor will be used.
5497
5074
 
5498
5075
    To use a specific mail program, set the mail_client configuration option.
5515
5092
 
5516
5093
    The merge directives created by bzr send may be applied using bzr merge or
5517
5094
    bzr pull by specifying a file containing a merge directive as the location.
5518
 
 
5519
 
    bzr send makes extensive use of public locations to map local locations into
5520
 
    URLs that can be used by other people.  See `bzr help configuration` to
5521
 
    set them, and use `bzr info` to display them.
5522
5095
    """
5523
5096
 
5524
5097
    encoding_type = 'exact'
5540
5113
               short_name='f',
5541
5114
               type=unicode),
5542
5115
        Option('output', short_name='o',
5543
 
               help='Write merge directive to this file or directory; '
 
5116
               help='Write merge directive to this file; '
5544
5117
                    'use - for stdout.',
5545
5118
               type=unicode),
5546
5119
        Option('strict',
5557
5130
        ]
5558
5131
 
5559
5132
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5560
 
            no_patch=False, revision=None, remember=None, output=None,
 
5133
            no_patch=False, revision=None, remember=False, output=None,
5561
5134
            format=None, mail_to=None, message=None, body=None,
5562
5135
            strict=None, **kwargs):
5563
5136
        from bzrlib.send import send
5569
5142
 
5570
5143
 
5571
5144
class cmd_bundle_revisions(cmd_send):
5572
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5145
    """Create a merge-directive for submitting changes.
5573
5146
 
5574
5147
    A merge directive provides many things needed for requesting merges:
5575
5148
 
5642
5215
 
5643
5216
 
5644
5217
class cmd_tag(Command):
5645
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5218
    """Create, remove or modify a tag naming a revision.
5646
5219
 
5647
5220
    Tags give human-meaningful names to revisions.  Commands that take a -r
5648
5221
    (--revision) option can be given -rtag:X, where X is any previously
5656
5229
 
5657
5230
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5658
5231
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5659
 
 
5660
 
    If no tag name is specified it will be determined through the 
5661
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5662
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5663
 
    details.
5664
5232
    """
5665
5233
 
5666
5234
    _see_also = ['commit', 'tags']
5667
 
    takes_args = ['tag_name?']
 
5235
    takes_args = ['tag_name']
5668
5236
    takes_options = [
5669
5237
        Option('delete',
5670
5238
            help='Delete this tag rather than placing it.',
5671
5239
            ),
5672
 
        custom_help('directory',
5673
 
            help='Branch in which to place the tag.'),
 
5240
        Option('directory',
 
5241
            help='Branch in which to place the tag.',
 
5242
            short_name='d',
 
5243
            type=unicode,
 
5244
            ),
5674
5245
        Option('force',
5675
5246
            help='Replace existing tags.',
5676
5247
            ),
5677
5248
        'revision',
5678
5249
        ]
5679
5250
 
5680
 
    def run(self, tag_name=None,
 
5251
    def run(self, tag_name,
5681
5252
            delete=None,
5682
5253
            directory='.',
5683
5254
            force=None,
5684
5255
            revision=None,
5685
5256
            ):
5686
5257
        branch, relpath = Branch.open_containing(directory)
5687
 
        self.add_cleanup(branch.lock_write().unlock)
5688
 
        if delete:
5689
 
            if tag_name is None:
5690
 
                raise errors.BzrCommandError(gettext("No tag specified to delete."))
5691
 
            branch.tags.delete_tag(tag_name)
5692
 
            note(gettext('Deleted tag %s.') % tag_name)
5693
 
        else:
5694
 
            if revision:
5695
 
                if len(revision) != 1:
5696
 
                    raise errors.BzrCommandError(gettext(
5697
 
                        "Tags can only be placed on a single revision, "
5698
 
                        "not on a range"))
5699
 
                revision_id = revision[0].as_revision_id(branch)
5700
 
            else:
5701
 
                revision_id = branch.last_revision()
5702
 
            if tag_name is None:
5703
 
                tag_name = branch.automatic_tag_name(revision_id)
5704
 
                if tag_name is None:
5705
 
                    raise errors.BzrCommandError(gettext(
5706
 
                        "Please specify a tag name."))
5707
 
            try:
5708
 
                existing_target = branch.tags.lookup_tag(tag_name)
5709
 
            except errors.NoSuchTag:
5710
 
                existing_target = None
5711
 
            if not force and existing_target not in (None, revision_id):
5712
 
                raise errors.TagAlreadyExists(tag_name)
5713
 
            if existing_target == revision_id:
5714
 
                note(gettext('Tag %s already exists for that revision.') % tag_name)
5715
 
            else:
 
5258
        branch.lock_write()
 
5259
        try:
 
5260
            if delete:
 
5261
                branch.tags.delete_tag(tag_name)
 
5262
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5263
            else:
 
5264
                if revision:
 
5265
                    if len(revision) != 1:
 
5266
                        raise errors.BzrCommandError(
 
5267
                            "Tags can only be placed on a single revision, "
 
5268
                            "not on a range")
 
5269
                    revision_id = revision[0].as_revision_id(branch)
 
5270
                else:
 
5271
                    revision_id = branch.last_revision()
 
5272
                if (not force) and branch.tags.has_tag(tag_name):
 
5273
                    raise errors.TagAlreadyExists(tag_name)
5716
5274
                branch.tags.set_tag(tag_name, revision_id)
5717
 
                if existing_target is None:
5718
 
                    note(gettext('Created tag %s.') % tag_name)
5719
 
                else:
5720
 
                    note(gettext('Updated tag %s.') % tag_name)
 
5275
                self.outf.write('Created tag %s.\n' % tag_name)
 
5276
        finally:
 
5277
            branch.unlock()
5721
5278
 
5722
5279
 
5723
5280
class cmd_tags(Command):
5724
 
    __doc__ = """List tags.
 
5281
    """List tags.
5725
5282
 
5726
5283
    This command shows a table of tag names and the revisions they reference.
5727
5284
    """
5728
5285
 
5729
5286
    _see_also = ['tag']
5730
5287
    takes_options = [
5731
 
        custom_help('directory',
5732
 
            help='Branch whose tags should be displayed.'),
5733
 
        RegistryOption('sort',
 
5288
        Option('directory',
 
5289
            help='Branch whose tags should be displayed.',
 
5290
            short_name='d',
 
5291
            type=unicode,
 
5292
            ),
 
5293
        RegistryOption.from_kwargs('sort',
5734
5294
            'Sort tags by different criteria.', title='Sorting',
5735
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
5295
            alpha='Sort tags lexicographically (default).',
 
5296
            time='Sort tags chronologically.',
5736
5297
            ),
5737
5298
        'show-ids',
5738
5299
        'revision',
5739
5300
    ]
5740
5301
 
5741
5302
    @display_command
5742
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5743
 
        from bzrlib.tag import tag_sort_methods
 
5303
    def run(self,
 
5304
            directory='.',
 
5305
            sort='alpha',
 
5306
            show_ids=False,
 
5307
            revision=None,
 
5308
            ):
5744
5309
        branch, relpath = Branch.open_containing(directory)
5745
5310
 
5746
5311
        tags = branch.tags.get_tag_dict().items()
5747
5312
        if not tags:
5748
5313
            return
5749
5314
 
5750
 
        self.add_cleanup(branch.lock_read().unlock)
5751
 
        if revision:
5752
 
            graph = branch.repository.get_graph()
5753
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5754
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5755
 
            # only show revisions between revid1 and revid2 (inclusive)
5756
 
            tags = [(tag, revid) for tag, revid in tags if
5757
 
                graph.is_between(revid, revid1, revid2)]
5758
 
        if sort is None:
5759
 
            sort = tag_sort_methods.get()
5760
 
        sort(branch, tags)
5761
 
        if not show_ids:
5762
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5763
 
            for index, (tag, revid) in enumerate(tags):
5764
 
                try:
5765
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5766
 
                    if isinstance(revno, tuple):
5767
 
                        revno = '.'.join(map(str, revno))
5768
 
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
5769
 
                    # Bad tag data/merges can lead to tagged revisions
5770
 
                    # which are not in this branch. Fail gracefully ...
5771
 
                    revno = '?'
5772
 
                tags[index] = (tag, revno)
5773
 
        self.cleanup_now()
 
5315
        branch.lock_read()
 
5316
        try:
 
5317
            if revision:
 
5318
                graph = branch.repository.get_graph()
 
5319
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5320
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5321
                # only show revisions between revid1 and revid2 (inclusive)
 
5322
                tags = [(tag, revid) for tag, revid in tags if
 
5323
                    graph.is_between(revid, revid1, revid2)]
 
5324
            if sort == 'alpha':
 
5325
                tags.sort()
 
5326
            elif sort == 'time':
 
5327
                timestamps = {}
 
5328
                for tag, revid in tags:
 
5329
                    try:
 
5330
                        revobj = branch.repository.get_revision(revid)
 
5331
                    except errors.NoSuchRevision:
 
5332
                        timestamp = sys.maxint # place them at the end
 
5333
                    else:
 
5334
                        timestamp = revobj.timestamp
 
5335
                    timestamps[revid] = timestamp
 
5336
                tags.sort(key=lambda x: timestamps[x[1]])
 
5337
            if not show_ids:
 
5338
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5339
                for index, (tag, revid) in enumerate(tags):
 
5340
                    try:
 
5341
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5342
                        if isinstance(revno, tuple):
 
5343
                            revno = '.'.join(map(str, revno))
 
5344
                    except errors.NoSuchRevision:
 
5345
                        # Bad tag data/merges can lead to tagged revisions
 
5346
                        # which are not in this branch. Fail gracefully ...
 
5347
                        revno = '?'
 
5348
                    tags[index] = (tag, revno)
 
5349
        finally:
 
5350
            branch.unlock()
5774
5351
        for tag, revspec in tags:
5775
5352
            self.outf.write('%-20s %s\n' % (tag, revspec))
5776
5353
 
5777
5354
 
5778
5355
class cmd_reconfigure(Command):
5779
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5356
    """Reconfigure the type of a bzr directory.
5780
5357
 
5781
5358
    A target configuration must be specified.
5782
5359
 
5793
5370
    takes_args = ['location?']
5794
5371
    takes_options = [
5795
5372
        RegistryOption.from_kwargs(
5796
 
            'tree_type',
5797
 
            title='Tree type',
5798
 
            help='The relation between branch and tree.',
 
5373
            'target_type',
 
5374
            title='Target type',
 
5375
            help='The type to reconfigure the directory to.',
5799
5376
            value_switches=True, enum_switch=False,
5800
5377
            branch='Reconfigure to be an unbound branch with no working tree.',
5801
5378
            tree='Reconfigure to be an unbound branch with a working tree.',
5802
5379
            checkout='Reconfigure to be a bound branch with a working tree.',
5803
5380
            lightweight_checkout='Reconfigure to be a lightweight'
5804
5381
                ' checkout (with no local history).',
5805
 
            ),
5806
 
        RegistryOption.from_kwargs(
5807
 
            'repository_type',
5808
 
            title='Repository type',
5809
 
            help='Location fo the repository.',
5810
 
            value_switches=True, enum_switch=False,
5811
5382
            standalone='Reconfigure to be a standalone branch '
5812
5383
                '(i.e. stop using shared repository).',
5813
5384
            use_shared='Reconfigure to use a shared repository.',
5814
 
            ),
5815
 
        RegistryOption.from_kwargs(
5816
 
            'repository_trees',
5817
 
            title='Trees in Repository',
5818
 
            help='Whether new branches in the repository have trees.',
5819
 
            value_switches=True, enum_switch=False,
5820
5385
            with_trees='Reconfigure repository to create '
5821
5386
                'working trees on branches by default.',
5822
5387
            with_no_trees='Reconfigure repository to not create '
5836
5401
            ),
5837
5402
        ]
5838
5403
 
5839
 
    def run(self, location=None, bind_to=None, force=False,
5840
 
            tree_type=None, repository_type=None, repository_trees=None,
5841
 
            stacked_on=None, unstacked=None):
 
5404
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5405
            stacked_on=None,
 
5406
            unstacked=None):
5842
5407
        directory = bzrdir.BzrDir.open(location)
5843
5408
        if stacked_on and unstacked:
5844
 
            raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
 
5409
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5845
5410
        elif stacked_on is not None:
5846
5411
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5847
5412
        elif unstacked:
5849
5414
        # At the moment you can use --stacked-on and a different
5850
5415
        # reconfiguration shape at the same time; there seems no good reason
5851
5416
        # to ban it.
5852
 
        if (tree_type is None and
5853
 
            repository_type is None and
5854
 
            repository_trees is None):
 
5417
        if target_type is None:
5855
5418
            if stacked_on or unstacked:
5856
5419
                return
5857
5420
            else:
5858
 
                raise errors.BzrCommandError(gettext('No target configuration '
5859
 
                    'specified'))
5860
 
        reconfiguration = None
5861
 
        if tree_type == 'branch':
 
5421
                raise errors.BzrCommandError('No target configuration '
 
5422
                    'specified')
 
5423
        elif target_type == 'branch':
5862
5424
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5863
 
        elif tree_type == 'tree':
 
5425
        elif target_type == 'tree':
5864
5426
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5865
 
        elif tree_type == 'checkout':
 
5427
        elif target_type == 'checkout':
5866
5428
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5867
5429
                directory, bind_to)
5868
 
        elif tree_type == 'lightweight-checkout':
 
5430
        elif target_type == 'lightweight-checkout':
5869
5431
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5870
5432
                directory, bind_to)
5871
 
        if reconfiguration:
5872
 
            reconfiguration.apply(force)
5873
 
            reconfiguration = None
5874
 
        if repository_type == 'use-shared':
 
5433
        elif target_type == 'use-shared':
5875
5434
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5876
 
        elif repository_type == 'standalone':
 
5435
        elif target_type == 'standalone':
5877
5436
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5878
 
        if reconfiguration:
5879
 
            reconfiguration.apply(force)
5880
 
            reconfiguration = None
5881
 
        if repository_trees == 'with-trees':
 
5437
        elif target_type == 'with-trees':
5882
5438
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5883
5439
                directory, True)
5884
 
        elif repository_trees == 'with-no-trees':
 
5440
        elif target_type == 'with-no-trees':
5885
5441
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5886
5442
                directory, False)
5887
 
        if reconfiguration:
5888
 
            reconfiguration.apply(force)
5889
 
            reconfiguration = None
 
5443
        reconfiguration.apply(force)
5890
5444
 
5891
5445
 
5892
5446
class cmd_switch(Command):
5893
 
    __doc__ = """Set the branch of a checkout and update.
 
5447
    """Set the branch of a checkout and update.
5894
5448
 
5895
5449
    For lightweight checkouts, this changes the branch being referenced.
5896
5450
    For heavyweight checkouts, this checks that there are no local commits
5912
5466
    that of the master.
5913
5467
    """
5914
5468
 
5915
 
    takes_args = ['to_location?']
5916
 
    takes_options = ['directory',
5917
 
                     Option('force',
 
5469
    takes_args = ['to_location']
 
5470
    takes_options = [Option('force',
5918
5471
                        help='Switch even if local commits will be lost.'),
5919
 
                     'revision',
5920
5472
                     Option('create-branch', short_name='b',
5921
5473
                        help='Create the target branch from this one before'
5922
5474
                             ' switching to it.'),
5923
 
                    ]
 
5475
                     ]
5924
5476
 
5925
 
    def run(self, to_location=None, force=False, create_branch=False,
5926
 
            revision=None, directory=u'.'):
 
5477
    def run(self, to_location, force=False, create_branch=False):
5927
5478
        from bzrlib import switch
5928
 
        tree_location = directory
5929
 
        revision = _get_one_revision('switch', revision)
 
5479
        tree_location = '.'
5930
5480
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5931
 
        if to_location is None:
5932
 
            if revision is None:
5933
 
                raise errors.BzrCommandError(gettext('You must supply either a'
5934
 
                                             ' revision or a location'))
5935
 
            to_location = tree_location
5936
5481
        try:
5937
5482
            branch = control_dir.open_branch()
5938
5483
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5941
5486
            had_explicit_nick = False
5942
5487
        if create_branch:
5943
5488
            if branch is None:
5944
 
                raise errors.BzrCommandError(gettext('cannot create branch without'
5945
 
                                             ' source branch'))
5946
 
            to_location = directory_service.directories.dereference(
5947
 
                              to_location)
 
5489
                raise errors.BzrCommandError('cannot create branch without'
 
5490
                                             ' source branch')
5948
5491
            if '/' not in to_location and '\\' not in to_location:
5949
5492
                # This path is meant to be relative to the existing branch
5950
5493
                this_url = self._get_branch_location(control_dir)
5952
5495
            to_branch = branch.bzrdir.sprout(to_location,
5953
5496
                                 possible_transports=[branch.bzrdir.root_transport],
5954
5497
                                 source_branch=branch).open_branch()
 
5498
            # try:
 
5499
            #     from_branch = control_dir.open_branch()
 
5500
            # except errors.NotBranchError:
 
5501
            #     raise BzrCommandError('Cannot create a branch from this'
 
5502
            #         ' location when we cannot open this branch')
 
5503
            # from_branch.bzrdir.sprout(
 
5504
            pass
5955
5505
        else:
5956
5506
            try:
5957
5507
                to_branch = Branch.open(to_location)
5959
5509
                this_url = self._get_branch_location(control_dir)
5960
5510
                to_branch = Branch.open(
5961
5511
                    urlutils.join(this_url, '..', to_location))
5962
 
        if revision is not None:
5963
 
            revision = revision.as_revision_id(to_branch)
5964
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5512
        switch.switch(control_dir, to_branch, force)
5965
5513
        if had_explicit_nick:
5966
5514
            branch = control_dir.open_branch() #get the new branch!
5967
5515
            branch.nick = to_branch.nick
5968
 
        note(gettext('Switched to branch: %s'),
 
5516
        note('Switched to branch: %s',
5969
5517
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5970
5518
 
5971
5519
    def _get_branch_location(self, control_dir):
5987
5535
 
5988
5536
 
5989
5537
class cmd_view(Command):
5990
 
    __doc__ = """Manage filtered views.
 
5538
    """Manage filtered views.
5991
5539
 
5992
5540
    Views provide a mask over the tree so that users can focus on
5993
5541
    a subset of a tree when doing their work. After creating a view,
6073
5621
            name=None,
6074
5622
            switch=None,
6075
5623
            ):
6076
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
6077
 
            apply_view=False)
 
5624
        tree, file_list = tree_files(file_list, apply_view=False)
6078
5625
        current_view, view_dict = tree.views.get_view_info()
6079
5626
        if name is None:
6080
5627
            name = current_view
6081
5628
        if delete:
6082
5629
            if file_list:
6083
 
                raise errors.BzrCommandError(gettext(
6084
 
                    "Both --delete and a file list specified"))
 
5630
                raise errors.BzrCommandError(
 
5631
                    "Both --delete and a file list specified")
6085
5632
            elif switch:
6086
 
                raise errors.BzrCommandError(gettext(
6087
 
                    "Both --delete and --switch specified"))
 
5633
                raise errors.BzrCommandError(
 
5634
                    "Both --delete and --switch specified")
6088
5635
            elif all:
6089
5636
                tree.views.set_view_info(None, {})
6090
 
                self.outf.write(gettext("Deleted all views.\n"))
 
5637
                self.outf.write("Deleted all views.\n")
6091
5638
            elif name is None:
6092
 
                raise errors.BzrCommandError(gettext("No current view to delete"))
 
5639
                raise errors.BzrCommandError("No current view to delete")
6093
5640
            else:
6094
5641
                tree.views.delete_view(name)
6095
 
                self.outf.write(gettext("Deleted '%s' view.\n") % name)
 
5642
                self.outf.write("Deleted '%s' view.\n" % name)
6096
5643
        elif switch:
6097
5644
            if file_list:
6098
 
                raise errors.BzrCommandError(gettext(
6099
 
                    "Both --switch and a file list specified"))
 
5645
                raise errors.BzrCommandError(
 
5646
                    "Both --switch and a file list specified")
6100
5647
            elif all:
6101
 
                raise errors.BzrCommandError(gettext(
6102
 
                    "Both --switch and --all specified"))
 
5648
                raise errors.BzrCommandError(
 
5649
                    "Both --switch and --all specified")
6103
5650
            elif switch == 'off':
6104
5651
                if current_view is None:
6105
 
                    raise errors.BzrCommandError(gettext("No current view to disable"))
 
5652
                    raise errors.BzrCommandError("No current view to disable")
6106
5653
                tree.views.set_view_info(None, view_dict)
6107
 
                self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
 
5654
                self.outf.write("Disabled '%s' view.\n" % (current_view))
6108
5655
            else:
6109
5656
                tree.views.set_view_info(switch, view_dict)
6110
5657
                view_str = views.view_display_str(tree.views.lookup_view())
6111
 
                self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
 
5658
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
6112
5659
        elif all:
6113
5660
            if view_dict:
6114
 
                self.outf.write(gettext('Views defined:\n'))
 
5661
                self.outf.write('Views defined:\n')
6115
5662
                for view in sorted(view_dict):
6116
5663
                    if view == current_view:
6117
5664
                        active = "=>"
6120
5667
                    view_str = views.view_display_str(view_dict[view])
6121
5668
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6122
5669
            else:
6123
 
                self.outf.write(gettext('No views defined.\n'))
 
5670
                self.outf.write('No views defined.\n')
6124
5671
        elif file_list:
6125
5672
            if name is None:
6126
5673
                # No name given and no current view set
6127
5674
                name = 'my'
6128
5675
            elif name == 'off':
6129
 
                raise errors.BzrCommandError(gettext(
6130
 
                    "Cannot change the 'off' pseudo view"))
 
5676
                raise errors.BzrCommandError(
 
5677
                    "Cannot change the 'off' pseudo view")
6131
5678
            tree.views.set_view(name, sorted(file_list))
6132
5679
            view_str = views.view_display_str(tree.views.lookup_view())
6133
 
            self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
 
5680
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
6134
5681
        else:
6135
5682
            # list the files
6136
5683
            if name is None:
6137
5684
                # No name given and no current view set
6138
 
                self.outf.write(gettext('No current view.\n'))
 
5685
                self.outf.write('No current view.\n')
6139
5686
            else:
6140
5687
                view_str = views.view_display_str(tree.views.lookup_view(name))
6141
 
                self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
 
5688
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
6142
5689
 
6143
5690
 
6144
5691
class cmd_hooks(Command):
6145
 
    __doc__ = """Show hooks."""
 
5692
    """Show hooks."""
6146
5693
 
6147
5694
    hidden = True
6148
5695
 
6158
5705
                        self.outf.write("    %s\n" %
6159
5706
                                        (some_hooks.get_hook_name(hook),))
6160
5707
                else:
6161
 
                    self.outf.write(gettext("    <no hooks installed>\n"))
6162
 
 
6163
 
 
6164
 
class cmd_remove_branch(Command):
6165
 
    __doc__ = """Remove a branch.
6166
 
 
6167
 
    This will remove the branch from the specified location but 
6168
 
    will keep any working tree or repository in place.
6169
 
 
6170
 
    :Examples:
6171
 
 
6172
 
      Remove the branch at repo/trunk::
6173
 
 
6174
 
        bzr remove-branch repo/trunk
6175
 
 
6176
 
    """
6177
 
 
6178
 
    takes_args = ["location?"]
6179
 
 
6180
 
    aliases = ["rmbranch"]
6181
 
 
6182
 
    def run(self, location=None):
6183
 
        if location is None:
6184
 
            location = "."
6185
 
        branch = Branch.open_containing(location)[0]
6186
 
        branch.bzrdir.destroy_branch()
 
5708
                    self.outf.write("    <no hooks installed>\n")
6187
5709
 
6188
5710
 
6189
5711
class cmd_shelve(Command):
6190
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5712
    """Temporarily set aside some changes from the current tree.
6191
5713
 
6192
5714
    Shelve allows you to temporarily put changes you've made "on the shelf",
6193
5715
    ie. out of the way, until a later time when you can bring them back from
6209
5731
 
6210
5732
    You can put multiple items on the shelf, and by default, 'unshelve' will
6211
5733
    restore the most recently shelved changes.
6212
 
 
6213
 
    For complicated changes, it is possible to edit the changes in a separate
6214
 
    editor program to decide what the file remaining in the working copy
6215
 
    should look like.  To do this, add the configuration option
6216
 
 
6217
 
        change_editor = PROGRAM @new_path @old_path
6218
 
 
6219
 
    where @new_path is replaced with the path of the new version of the 
6220
 
    file and @old_path is replaced with the path of the old version of 
6221
 
    the file.  The PROGRAM should save the new file with the desired 
6222
 
    contents of the file in the working tree.
6223
 
        
6224
5734
    """
6225
5735
 
6226
5736
    takes_args = ['file*']
6227
5737
 
6228
5738
    takes_options = [
6229
 
        'directory',
6230
5739
        'revision',
6231
5740
        Option('all', help='Shelve all changes.'),
6232
5741
        'message',
6238
5747
        Option('destroy',
6239
5748
               help='Destroy removed changes instead of shelving them.'),
6240
5749
    ]
6241
 
    _see_also = ['unshelve', 'configuration']
 
5750
    _see_also = ['unshelve']
6242
5751
 
6243
5752
    def run(self, revision=None, all=False, file_list=None, message=None,
6244
 
            writer=None, list=False, destroy=False, directory=None):
 
5753
            writer=None, list=False, destroy=False):
6245
5754
        if list:
6246
 
            return self.run_for_list(directory=directory)
 
5755
            return self.run_for_list()
6247
5756
        from bzrlib.shelf_ui import Shelver
6248
5757
        if writer is None:
6249
5758
            writer = bzrlib.option.diff_writer_registry.get()
6250
5759
        try:
6251
5760
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6252
 
                file_list, message, destroy=destroy, directory=directory)
 
5761
                file_list, message, destroy=destroy)
6253
5762
            try:
6254
5763
                shelver.run()
6255
5764
            finally:
6257
5766
        except errors.UserAbort:
6258
5767
            return 0
6259
5768
 
6260
 
    def run_for_list(self, directory=None):
6261
 
        if directory is None:
6262
 
            directory = u'.'
6263
 
        tree = WorkingTree.open_containing(directory)[0]
6264
 
        self.add_cleanup(tree.lock_read().unlock)
6265
 
        manager = tree.get_shelf_manager()
6266
 
        shelves = manager.active_shelves()
6267
 
        if len(shelves) == 0:
6268
 
            note(gettext('No shelved changes.'))
6269
 
            return 0
6270
 
        for shelf_id in reversed(shelves):
6271
 
            message = manager.get_metadata(shelf_id).get('message')
6272
 
            if message is None:
6273
 
                message = '<no message>'
6274
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
6275
 
        return 1
 
5769
    def run_for_list(self):
 
5770
        tree = WorkingTree.open_containing('.')[0]
 
5771
        tree.lock_read()
 
5772
        try:
 
5773
            manager = tree.get_shelf_manager()
 
5774
            shelves = manager.active_shelves()
 
5775
            if len(shelves) == 0:
 
5776
                note('No shelved changes.')
 
5777
                return 0
 
5778
            for shelf_id in reversed(shelves):
 
5779
                message = manager.get_metadata(shelf_id).get('message')
 
5780
                if message is None:
 
5781
                    message = '<no message>'
 
5782
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5783
            return 1
 
5784
        finally:
 
5785
            tree.unlock()
6276
5786
 
6277
5787
 
6278
5788
class cmd_unshelve(Command):
6279
 
    __doc__ = """Restore shelved changes.
 
5789
    """Restore shelved changes.
6280
5790
 
6281
5791
    By default, the most recently shelved changes are restored. However if you
6282
5792
    specify a shelf by id those changes will be restored instead.  This works
6285
5795
 
6286
5796
    takes_args = ['shelf_id?']
6287
5797
    takes_options = [
6288
 
        'directory',
6289
5798
        RegistryOption.from_kwargs(
6290
5799
            'action', help="The action to perform.",
6291
5800
            enum_switch=False, value_switches=True,
6292
5801
            apply="Apply changes and remove from the shelf.",
6293
5802
            dry_run="Show changes, but do not apply or remove them.",
6294
 
            preview="Instead of unshelving the changes, show the diff that "
6295
 
                    "would result from unshelving.",
6296
5803
            delete_only="Delete changes without applying them.",
6297
5804
            keep="Apply changes but don't delete them.",
6298
5805
        )
6299
5806
    ]
6300
5807
    _see_also = ['shelve']
6301
5808
 
6302
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5809
    def run(self, shelf_id=None, action='apply'):
6303
5810
        from bzrlib.shelf_ui import Unshelver
6304
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5811
        unshelver = Unshelver.from_args(shelf_id, action)
6305
5812
        try:
6306
5813
            unshelver.run()
6307
5814
        finally:
6309
5816
 
6310
5817
 
6311
5818
class cmd_clean_tree(Command):
6312
 
    __doc__ = """Remove unwanted files from working tree.
 
5819
    """Remove unwanted files from working tree.
6313
5820
 
6314
5821
    By default, only unknown files, not ignored files, are deleted.  Versioned
6315
5822
    files are never deleted.
6323
5830
 
6324
5831
    To check what clean-tree will do, use --dry-run.
6325
5832
    """
6326
 
    takes_options = ['directory',
6327
 
                     Option('ignored', help='Delete all ignored files.'),
6328
 
                     Option('detritus', help='Delete conflict files, merge and revert'
 
5833
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5834
                     Option('detritus', help='Delete conflict files, merge'
6329
5835
                            ' backups, and failed selftest dirs.'),
6330
5836
                     Option('unknown',
6331
5837
                            help='Delete files unknown to bzr (default).'),
6333
5839
                            ' deleting them.'),
6334
5840
                     Option('force', help='Do not prompt before deleting.')]
6335
5841
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6336
 
            force=False, directory=u'.'):
 
5842
            force=False):
6337
5843
        from bzrlib.clean_tree import clean_tree
6338
5844
        if not (unknown or ignored or detritus):
6339
5845
            unknown = True
6340
5846
        if dry_run:
6341
5847
            force = True
6342
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6343
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5848
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5849
                   dry_run=dry_run, no_prompt=force)
6344
5850
 
6345
5851
 
6346
5852
class cmd_reference(Command):
6347
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5853
    """list, view and set branch locations for nested trees.
6348
5854
 
6349
5855
    If no arguments are provided, lists the branch locations for nested trees.
6350
5856
    If one argument is provided, display the branch location for that tree.
6390
5896
            self.outf.write('%s %s\n' % (path, location))
6391
5897
 
6392
5898
 
6393
 
class cmd_export_pot(Command):
6394
 
    __doc__ = """Export command helps and error messages in po format."""
6395
 
 
6396
 
    hidden = True
6397
 
 
6398
 
    def run(self):
6399
 
        from bzrlib.export_pot import export_pot
6400
 
        export_pot(self.outf)
6401
 
 
6402
 
 
6403
 
def _register_lazy_builtins():
6404
 
    # register lazy builtins from other modules; called at startup and should
6405
 
    # be only called once.
6406
 
    for (name, aliases, module_name) in [
6407
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6408
 
        ('cmd_config', [], 'bzrlib.config'),
6409
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6410
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6411
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6412
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6413
 
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6414
 
        ('cmd_verify_signatures', [],
6415
 
                                        'bzrlib.commit_signature_commands'),
6416
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6417
 
        ]:
6418
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5899
# these get imported and then picked up by the scan for cmd_*
 
5900
# TODO: Some more consistent way to split command definitions across files;
 
5901
# we do need to load at least some information about them to know of
 
5902
# aliases.  ideally we would avoid loading the implementation until the
 
5903
# details were needed.
 
5904
from bzrlib.cmd_version_info import cmd_version_info
 
5905
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5906
from bzrlib.bundle.commands import (
 
5907
    cmd_bundle_info,
 
5908
    )
 
5909
from bzrlib.foreign import cmd_dpush
 
5910
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5911
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5912
        cmd_weave_plan_merge, cmd_weave_merge_text