~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Whitley
  • Date: 2010-01-02 07:36:36 UTC
  • mto: This revision was merged to the branch mainline in revision 4981.
  • Revision ID: whitley@bangpath.org-20100102073636-tes22lrpmxw9skv5
NEWS and various documentation updates for ignore exclusions.

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
32
33
    bzrdir,
33
34
    directory_service,
34
35
    delta,
35
 
    config as _mod_config,
 
36
    config,
36
37
    errors,
37
38
    globbing,
38
39
    hooks,
44
45
    rename_map,
45
46
    revision as _mod_revision,
46
47
    static_tuple,
 
48
    symbol_versioning,
47
49
    timestamp,
48
50
    transport,
49
51
    ui,
50
52
    urlutils,
51
53
    views,
52
 
    gpg,
53
54
    )
54
55
from bzrlib.branch import Branch
55
56
from bzrlib.conflicts import ConflictList
56
 
from bzrlib.transport import memory
57
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
58
from bzrlib.smtp_connection import SMTPConnection
59
59
from bzrlib.workingtree import WorkingTree
60
60
""")
61
61
 
62
 
from bzrlib.commands import (
63
 
    Command,
64
 
    builtin_command_registry,
65
 
    display_command,
66
 
    )
 
62
from bzrlib.commands import Command, display_command
67
63
from bzrlib.option import (
68
64
    ListOption,
69
65
    Option,
72
68
    _parse_revision_str,
73
69
    )
74
70
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
75
 
from bzrlib import (
76
 
    symbol_versioning,
77
 
    )
78
 
 
79
 
 
80
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
 
71
 
 
72
 
81
73
def tree_files(file_list, default_branch=u'.', canonicalize=True,
82
74
    apply_view=True):
83
 
    return internal_tree_files(file_list, default_branch, canonicalize,
84
 
        apply_view)
 
75
    try:
 
76
        return internal_tree_files(file_list, default_branch, canonicalize,
 
77
            apply_view)
 
78
    except errors.FileInWrongBranch, e:
 
79
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
80
                                     (e.path, file_list[0]))
85
81
 
86
82
 
87
83
def tree_files_for_add(file_list):
151
147
 
152
148
# XXX: Bad function name; should possibly also be a class method of
153
149
# WorkingTree rather than a function.
154
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
155
150
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
151
    apply_view=True):
157
152
    """Convert command-line paths to a WorkingTree and relative paths.
158
153
 
159
 
    Deprecated: use WorkingTree.open_containing_paths instead.
160
 
 
161
154
    This is typically used for command-line processors that take one or
162
155
    more filenames, and infer the workingtree that contains them.
163
156
 
173
166
 
174
167
    :return: workingtree, [relative_paths]
175
168
    """
176
 
    return WorkingTree.open_containing_paths(
177
 
        file_list, default_directory='.',
178
 
        canonicalize=True,
179
 
        apply_view=True)
 
169
    if file_list is None or len(file_list) == 0:
 
170
        tree = WorkingTree.open_containing(default_branch)[0]
 
171
        if tree.supports_views() and apply_view:
 
172
            view_files = tree.views.lookup_view()
 
173
            if view_files:
 
174
                file_list = view_files
 
175
                view_str = views.view_display_str(view_files)
 
176
                note("Ignoring files outside view. View is %s" % view_str)
 
177
        return tree, file_list
 
178
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
179
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
180
        apply_view=apply_view)
 
181
 
 
182
 
 
183
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
184
    """Convert file_list into a list of relpaths in tree.
 
185
 
 
186
    :param tree: A tree to operate on.
 
187
    :param file_list: A list of user provided paths or None.
 
188
    :param apply_view: if True and a view is set, apply it or check that
 
189
        specified files are within it
 
190
    :return: A list of relative paths.
 
191
    :raises errors.PathNotChild: When a provided path is in a different tree
 
192
        than tree.
 
193
    """
 
194
    if file_list is None:
 
195
        return None
 
196
    if tree.supports_views() and apply_view:
 
197
        view_files = tree.views.lookup_view()
 
198
    else:
 
199
        view_files = []
 
200
    new_list = []
 
201
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
202
    # doesn't - fix that up here before we enter the loop.
 
203
    if canonicalize:
 
204
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
205
    else:
 
206
        fixer = tree.relpath
 
207
    for filename in file_list:
 
208
        try:
 
209
            relpath = fixer(osutils.dereference_path(filename))
 
210
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
211
                raise errors.FileOutsideView(filename, view_files)
 
212
            new_list.append(relpath)
 
213
        except errors.PathNotChild:
 
214
            raise errors.FileInWrongBranch(tree.branch, filename)
 
215
    return new_list
180
216
 
181
217
 
182
218
def _get_view_info_for_change_reporter(tree):
191
227
    return view_info
192
228
 
193
229
 
194
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
195
 
    """Open the tree or branch containing the specified file, unless
196
 
    the --directory option is used to specify a different branch."""
197
 
    if directory is not None:
198
 
        return (None, Branch.open(directory), filename)
199
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
200
 
 
201
 
 
202
230
# TODO: Make sure no commands unconditionally use the working directory as a
203
231
# branch.  If a filename argument is used, the first of them should be used to
204
232
# specify the branch.  (Perhaps this can be factored out into some kind of
206
234
# opens the branch?)
207
235
 
208
236
class cmd_status(Command):
209
 
    __doc__ = """Display status summary.
 
237
    """Display status summary.
210
238
 
211
239
    This reports on versioned and unknown files, reporting them
212
240
    grouped by state.  Possible states are:
232
260
    unknown
233
261
        Not versioned and not matching an ignore pattern.
234
262
 
235
 
    Additionally for directories, symlinks and files with a changed
236
 
    executable bit, Bazaar indicates their type using a trailing
237
 
    character: '/', '@' or '*' respectively. These decorations can be
238
 
    disabled using the '--no-classify' option.
 
263
    Additionally for directories, symlinks and files with an executable
 
264
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
265
    or '*' respectively.
239
266
 
240
267
    To see ignored files use 'bzr ignored'.  For details on the
241
268
    changes to file texts, use 'bzr diff'.
254
281
    To skip the display of pending merge information altogether, use
255
282
    the no-pending option or specify a file/directory.
256
283
 
257
 
    To compare the working directory to a specific revision, pass a
258
 
    single revision to the revision argument.
259
 
 
260
 
    To see which files have changed in a specific revision, or between
261
 
    two revisions, pass a revision range to the revision argument.
262
 
    This will produce the same results as calling 'bzr diff --summarize'.
 
284
    If a revision argument is given, the status is calculated against
 
285
    that revision, or between two revisions if two are provided.
263
286
    """
264
287
 
265
288
    # TODO: --no-recurse, --recurse options
272
295
                            short_name='V'),
273
296
                     Option('no-pending', help='Don\'t show pending merges.',
274
297
                           ),
275
 
                     Option('no-classify',
276
 
                            help='Do not mark object type using indicator.',
277
 
                           ),
278
298
                     ]
279
299
    aliases = ['st', 'stat']
280
300
 
283
303
 
284
304
    @display_command
285
305
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
286
 
            versioned=False, no_pending=False, verbose=False,
287
 
            no_classify=False):
 
306
            versioned=False, no_pending=False, verbose=False):
288
307
        from bzrlib.status import show_tree_status
289
308
 
290
309
        if revision and len(revision) > 2:
291
310
            raise errors.BzrCommandError('bzr status --revision takes exactly'
292
311
                                         ' one or two revision specifiers')
293
312
 
294
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
313
        tree, relfile_list = tree_files(file_list)
295
314
        # Avoid asking for specific files when that is not needed.
296
315
        if relfile_list == ['']:
297
316
            relfile_list = None
304
323
        show_tree_status(tree, show_ids=show_ids,
305
324
                         specific_files=relfile_list, revision=revision,
306
325
                         to_file=self.outf, short=short, versioned=versioned,
307
 
                         show_pending=(not no_pending), verbose=verbose,
308
 
                         classify=not no_classify)
 
326
                         show_pending=(not no_pending), verbose=verbose)
309
327
 
310
328
 
311
329
class cmd_cat_revision(Command):
312
 
    __doc__ = """Write out metadata for a revision.
 
330
    """Write out metadata for a revision.
313
331
 
314
332
    The revision to print can either be specified by a specific
315
333
    revision identifier, or you can use --revision.
317
335
 
318
336
    hidden = True
319
337
    takes_args = ['revision_id?']
320
 
    takes_options = ['directory', 'revision']
 
338
    takes_options = ['revision']
321
339
    # cat-revision is more for frontends so should be exact
322
340
    encoding = 'strict'
323
341
 
324
 
    def print_revision(self, revisions, revid):
325
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
326
 
        record = stream.next()
327
 
        if record.storage_kind == 'absent':
328
 
            raise errors.NoSuchRevision(revisions, revid)
329
 
        revtext = record.get_bytes_as('fulltext')
330
 
        self.outf.write(revtext.decode('utf-8'))
331
 
 
332
342
    @display_command
333
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
343
    def run(self, revision_id=None, revision=None):
334
344
        if revision_id is not None and revision is not None:
335
345
            raise errors.BzrCommandError('You can only supply one of'
336
346
                                         ' revision_id or --revision')
337
347
        if revision_id is None and revision is None:
338
348
            raise errors.BzrCommandError('You must supply either'
339
349
                                         ' --revision or a revision_id')
340
 
 
341
 
        b = bzrdir.BzrDir.open_containing_tree_or_branch(directory)[1]
342
 
 
343
 
        revisions = b.repository.revisions
344
 
        if revisions is None:
345
 
            raise errors.BzrCommandError('Repository %r does not support '
346
 
                'access to raw revision texts')
347
 
 
348
 
        b.repository.lock_read()
349
 
        try:
350
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
351
 
            if revision_id is not None:
352
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
353
 
                try:
354
 
                    self.print_revision(revisions, revision_id)
355
 
                except errors.NoSuchRevision:
356
 
                    msg = "The repository %s contains no revision %s." % (
357
 
                        b.repository.base, revision_id)
358
 
                    raise errors.BzrCommandError(msg)
359
 
            elif revision is not None:
360
 
                for rev in revision:
361
 
                    if rev is None:
362
 
                        raise errors.BzrCommandError(
363
 
                            'You cannot specify a NULL revision.')
364
 
                    rev_id = rev.as_revision_id(b)
365
 
                    self.print_revision(revisions, rev_id)
366
 
        finally:
367
 
            b.repository.unlock()
368
 
        
 
350
        b = WorkingTree.open_containing(u'.')[0].branch
 
351
 
 
352
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
353
        if revision_id is not None:
 
354
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
355
            try:
 
356
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
357
            except errors.NoSuchRevision:
 
358
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
359
                    revision_id)
 
360
                raise errors.BzrCommandError(msg)
 
361
        elif revision is not None:
 
362
            for rev in revision:
 
363
                if rev is None:
 
364
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
365
                                                 ' revision.')
 
366
                rev_id = rev.as_revision_id(b)
 
367
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
368
 
369
369
 
370
370
class cmd_dump_btree(Command):
371
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
371
    """Dump the contents of a btree index file to stdout.
372
372
 
373
373
    PATH is a btree index file, it can be any URL. This includes things like
374
374
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
422
                self.outf.write(page_bytes[:header_end])
423
423
                page_bytes = data
424
424
            self.outf.write('\nPage %d\n' % (page_idx,))
425
 
            if len(page_bytes) == 0:
426
 
                self.outf.write('(empty)\n');
427
 
            else:
428
 
                decomp_bytes = zlib.decompress(page_bytes)
429
 
                self.outf.write(decomp_bytes)
430
 
                self.outf.write('\n')
 
425
            decomp_bytes = zlib.decompress(page_bytes)
 
426
            self.outf.write(decomp_bytes)
 
427
            self.outf.write('\n')
431
428
 
432
429
    def _dump_entries(self, trans, basename):
433
430
        try:
441
438
        for node in bt.iter_all_entries():
442
439
            # Node is made up of:
443
440
            # (index, key, value, [references])
444
 
            try:
445
 
                refs = node[3]
446
 
            except IndexError:
447
 
                refs_as_tuples = None
448
 
            else:
449
 
                refs_as_tuples = static_tuple.as_tuples(refs)
 
441
            refs_as_tuples = static_tuple.as_tuples(node[3])
450
442
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
451
443
            self.outf.write('%s\n' % (as_tuple,))
452
444
 
453
445
 
454
446
class cmd_remove_tree(Command):
455
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
447
    """Remove the working tree from a given branch/checkout.
456
448
 
457
449
    Since a lightweight checkout is little more than a working tree
458
450
    this will refuse to run against one.
460
452
    To re-create the working tree, use "bzr checkout".
461
453
    """
462
454
    _see_also = ['checkout', 'working-trees']
463
 
    takes_args = ['location*']
 
455
    takes_args = ['location?']
464
456
    takes_options = [
465
457
        Option('force',
466
458
               help='Remove the working tree even if it has '
467
 
                    'uncommitted or shelved changes.'),
 
459
                    'uncommitted changes.'),
468
460
        ]
469
461
 
470
 
    def run(self, location_list, force=False):
471
 
        if not location_list:
472
 
            location_list=['.']
473
 
 
474
 
        for location in location_list:
475
 
            d = bzrdir.BzrDir.open(location)
476
 
            
477
 
            try:
478
 
                working = d.open_workingtree()
479
 
            except errors.NoWorkingTree:
480
 
                raise errors.BzrCommandError("No working tree to remove")
481
 
            except errors.NotLocalUrl:
482
 
                raise errors.BzrCommandError("You cannot remove the working tree"
483
 
                                             " of a remote path")
484
 
            if not force:
485
 
                if (working.has_changes()):
486
 
                    raise errors.UncommittedChanges(working)
487
 
                if working.get_shelf_manager().last_shelf() is not None:
488
 
                    raise errors.ShelvedChanges(working)
489
 
 
490
 
            if working.user_url != working.branch.user_url:
491
 
                raise errors.BzrCommandError("You cannot remove the working tree"
492
 
                                             " from a lightweight checkout")
493
 
 
494
 
            d.destroy_workingtree()
495
 
 
496
 
 
497
 
class cmd_repair_workingtree(Command):
498
 
    __doc__ = """Reset the working tree state file.
499
 
 
500
 
    This is not meant to be used normally, but more as a way to recover from
501
 
    filesystem corruption, etc. This rebuilds the working inventory back to a
502
 
    'known good' state. Any new modifications (adding a file, renaming, etc)
503
 
    will be lost, though modified files will still be detected as such.
504
 
 
505
 
    Most users will want something more like "bzr revert" or "bzr update"
506
 
    unless the state file has become corrupted.
507
 
 
508
 
    By default this attempts to recover the current state by looking at the
509
 
    headers of the state file. If the state file is too corrupted to even do
510
 
    that, you can supply --revision to force the state of the tree.
511
 
    """
512
 
 
513
 
    takes_options = ['revision', 'directory',
514
 
        Option('force',
515
 
               help='Reset the tree even if it doesn\'t appear to be'
516
 
                    ' corrupted.'),
517
 
    ]
518
 
    hidden = True
519
 
 
520
 
    def run(self, revision=None, directory='.', force=False):
521
 
        tree, _ = WorkingTree.open_containing(directory)
522
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
462
    def run(self, location='.', force=False):
 
463
        d = bzrdir.BzrDir.open(location)
 
464
 
 
465
        try:
 
466
            working = d.open_workingtree()
 
467
        except errors.NoWorkingTree:
 
468
            raise errors.BzrCommandError("No working tree to remove")
 
469
        except errors.NotLocalUrl:
 
470
            raise errors.BzrCommandError("You cannot remove the working tree"
 
471
                                         " of a remote path")
523
472
        if not force:
524
 
            try:
525
 
                tree.check_state()
526
 
            except errors.BzrError:
527
 
                pass # There seems to be a real error here, so we'll reset
528
 
            else:
529
 
                # Refuse
530
 
                raise errors.BzrCommandError(
531
 
                    'The tree does not appear to be corrupt. You probably'
532
 
                    ' want "bzr revert" instead. Use "--force" if you are'
533
 
                    ' sure you want to reset the working tree.')
534
 
        if revision is None:
535
 
            revision_ids = None
536
 
        else:
537
 
            revision_ids = [r.as_revision_id(tree.branch) for r in revision]
538
 
        try:
539
 
            tree.reset_state(revision_ids)
540
 
        except errors.BzrError, e:
541
 
            if revision_ids is None:
542
 
                extra = (', the header appears corrupt, try passing -r -1'
543
 
                         ' to set the state to the last commit')
544
 
            else:
545
 
                extra = ''
546
 
            raise errors.BzrCommandError('failed to reset the tree state'
547
 
                                         + extra)
 
473
            if (working.has_changes()):
 
474
                raise errors.UncommittedChanges(working)
 
475
 
 
476
        working_path = working.bzrdir.root_transport.base
 
477
        branch_path = working.branch.bzrdir.root_transport.base
 
478
        if working_path != branch_path:
 
479
            raise errors.BzrCommandError("You cannot remove the working tree"
 
480
                                         " from a lightweight checkout")
 
481
 
 
482
        d.destroy_workingtree()
548
483
 
549
484
 
550
485
class cmd_revno(Command):
551
 
    __doc__ = """Show current revision number.
 
486
    """Show current revision number.
552
487
 
553
488
    This is equal to the number of revisions on this branch.
554
489
    """
564
499
        if tree:
565
500
            try:
566
501
                wt = WorkingTree.open_containing(location)[0]
567
 
                self.add_cleanup(wt.lock_read().unlock)
 
502
                wt.lock_read()
568
503
            except (errors.NoWorkingTree, errors.NotLocalUrl):
569
504
                raise errors.NoWorkingTree(location)
 
505
            self.add_cleanup(wt.unlock)
570
506
            revid = wt.last_revision()
571
507
            try:
572
508
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
575
511
            revno = ".".join(str(n) for n in revno_t)
576
512
        else:
577
513
            b = Branch.open_containing(location)[0]
578
 
            self.add_cleanup(b.lock_read().unlock)
 
514
            b.lock_read()
 
515
            self.add_cleanup(b.unlock)
579
516
            revno = b.revno()
580
517
        self.cleanup_now()
581
518
        self.outf.write(str(revno) + '\n')
582
519
 
583
520
 
584
521
class cmd_revision_info(Command):
585
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
522
    """Show revision number and revision id for a given revision identifier.
586
523
    """
587
524
    hidden = True
588
525
    takes_args = ['revision_info*']
589
526
    takes_options = [
590
527
        'revision',
591
 
        custom_help('directory',
 
528
        Option('directory',
592
529
            help='Branch to examine, '
593
 
                 'rather than the one containing the working directory.'),
 
530
                 'rather than the one containing the working directory.',
 
531
            short_name='d',
 
532
            type=unicode,
 
533
            ),
594
534
        Option('tree', help='Show revno of working tree'),
595
535
        ]
596
536
 
601
541
        try:
602
542
            wt = WorkingTree.open_containing(directory)[0]
603
543
            b = wt.branch
604
 
            self.add_cleanup(wt.lock_read().unlock)
 
544
            wt.lock_read()
 
545
            self.add_cleanup(wt.unlock)
605
546
        except (errors.NoWorkingTree, errors.NotLocalUrl):
606
547
            wt = None
607
548
            b = Branch.open_containing(directory)[0]
608
 
            self.add_cleanup(b.lock_read().unlock)
 
549
            b.lock_read()
 
550
            self.add_cleanup(b.unlock)
609
551
        revision_ids = []
610
552
        if revision is not None:
611
553
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
639
581
 
640
582
 
641
583
class cmd_add(Command):
642
 
    __doc__ = """Add specified files or directories.
 
584
    """Add specified files or directories.
643
585
 
644
586
    In non-recursive mode, all the named items are added, regardless
645
587
    of whether they were previously ignored.  A warning is given if
710
652
                should_print=(not is_quiet()))
711
653
 
712
654
        if base_tree:
713
 
            self.add_cleanup(base_tree.lock_read().unlock)
 
655
            base_tree.lock_read()
 
656
            self.add_cleanup(base_tree.unlock)
714
657
        tree, file_list = tree_files_for_add(file_list)
715
658
        added, ignored = tree.smart_add(file_list, not
716
659
            no_recurse, action=action, save=not dry_run)
724
667
 
725
668
 
726
669
class cmd_mkdir(Command):
727
 
    __doc__ = """Create a new versioned directory.
 
670
    """Create a new versioned directory.
728
671
 
729
672
    This is equivalent to creating the directory and then adding it.
730
673
    """
734
677
 
735
678
    def run(self, dir_list):
736
679
        for d in dir_list:
 
680
            os.mkdir(d)
737
681
            wt, dd = WorkingTree.open_containing(d)
738
 
            base = os.path.dirname(dd)
739
 
            id = wt.path2id(base)
740
 
            if id != None:
741
 
                os.mkdir(d)
742
 
                wt.add([dd])
743
 
                self.outf.write('added %s\n' % d)
744
 
            else:
745
 
                raise errors.NotVersionedError(path=base)
 
682
            wt.add([dd])
 
683
            self.outf.write('added %s\n' % d)
746
684
 
747
685
 
748
686
class cmd_relpath(Command):
749
 
    __doc__ = """Show path of a file relative to root"""
 
687
    """Show path of a file relative to root"""
750
688
 
751
689
    takes_args = ['filename']
752
690
    hidden = True
761
699
 
762
700
 
763
701
class cmd_inventory(Command):
764
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
702
    """Show inventory of the current working copy or a revision.
765
703
 
766
704
    It is possible to limit the output to a particular entry
767
705
    type using the --kind option.  For example: --kind file.
787
725
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
788
726
 
789
727
        revision = _get_one_revision('inventory', revision)
790
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
791
 
        self.add_cleanup(work_tree.lock_read().unlock)
 
728
        work_tree, file_list = tree_files(file_list)
 
729
        work_tree.lock_read()
 
730
        self.add_cleanup(work_tree.unlock)
792
731
        if revision is not None:
793
732
            tree = revision.as_tree(work_tree.branch)
794
733
 
795
734
            extra_trees = [work_tree]
796
 
            self.add_cleanup(tree.lock_read().unlock)
 
735
            tree.lock_read()
 
736
            self.add_cleanup(tree.unlock)
797
737
        else:
798
738
            tree = work_tree
799
739
            extra_trees = []
803
743
                                      require_versioned=True)
804
744
            # find_ids_across_trees may include some paths that don't
805
745
            # exist in 'tree'.
806
 
            entries = sorted(
807
 
                (tree.id2path(file_id), tree.inventory[file_id])
808
 
                for file_id in file_ids if tree.has_id(file_id))
 
746
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
747
                             for file_id in file_ids if file_id in tree)
809
748
        else:
810
749
            entries = tree.inventory.entries()
811
750
 
821
760
 
822
761
 
823
762
class cmd_mv(Command):
824
 
    __doc__ = """Move or rename a file.
 
763
    """Move or rename a file.
825
764
 
826
765
    :Usage:
827
766
        bzr mv OLDNAME NEWNAME
859
798
            names_list = []
860
799
        if len(names_list) < 2:
861
800
            raise errors.BzrCommandError("missing file argument")
862
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
863
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
801
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
802
        tree.lock_tree_write()
 
803
        self.add_cleanup(tree.unlock)
864
804
        self._run(tree, names_list, rel_names, after)
865
805
 
866
806
    def run_auto(self, names_list, after, dry_run):
870
810
        if after:
871
811
            raise errors.BzrCommandError('--after cannot be specified with'
872
812
                                         ' --auto.')
873
 
        work_tree, file_list = WorkingTree.open_containing_paths(
874
 
            names_list, default_directory='.')
875
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
813
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
814
        work_tree.lock_tree_write()
 
815
        self.add_cleanup(work_tree.unlock)
876
816
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
877
817
 
878
818
    def _run(self, tree, names_list, rel_names, after):
957
897
 
958
898
 
959
899
class cmd_pull(Command):
960
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
900
    """Turn this branch into a mirror of another branch.
961
901
 
962
902
    By default, this command only works on branches that have not diverged.
963
903
    Branches are considered diverged if the destination branch's most recent 
972
912
    match the remote one, use pull --overwrite. This will work even if the two
973
913
    branches have diverged.
974
914
 
975
 
    If there is no default location set, the first pull will set it (use
976
 
    --no-remember to avoid settting it). After that, you can omit the
977
 
    location to use the default.  To change the default, use --remember. The
978
 
    value will only be saved if the remote location can be accessed.
 
915
    If there is no default location set, the first pull will set it.  After
 
916
    that, you can omit the location to use the default.  To change the
 
917
    default, use --remember. The value will only be saved if the remote
 
918
    location can be accessed.
979
919
 
980
920
    Note: The location can be specified either in the form of a branch,
981
921
    or in the form of a path to a file containing a merge directive generated
986
926
    takes_options = ['remember', 'overwrite', 'revision',
987
927
        custom_help('verbose',
988
928
            help='Show logs of pulled revisions.'),
989
 
        custom_help('directory',
 
929
        Option('directory',
990
930
            help='Branch to pull into, '
991
 
                 'rather than the one containing the working directory.'),
 
931
                 'rather than the one containing the working directory.',
 
932
            short_name='d',
 
933
            type=unicode,
 
934
            ),
992
935
        Option('local',
993
936
            help="Perform a local pull in a bound "
994
937
                 "branch.  Local pulls are not applied to "
995
938
                 "the master branch."
996
939
            ),
997
 
        Option('show-base',
998
 
            help="Show base revision text in conflicts.")
999
940
        ]
1000
941
    takes_args = ['location?']
1001
942
    encoding_type = 'replace'
1002
943
 
1003
 
    def run(self, location=None, remember=None, overwrite=False,
 
944
    def run(self, location=None, remember=False, overwrite=False,
1004
945
            revision=None, verbose=False,
1005
 
            directory=None, local=False,
1006
 
            show_base=False):
 
946
            directory=None, local=False):
1007
947
        # FIXME: too much stuff is in the command class
1008
948
        revision_id = None
1009
949
        mergeable = None
1012
952
        try:
1013
953
            tree_to = WorkingTree.open_containing(directory)[0]
1014
954
            branch_to = tree_to.branch
1015
 
            self.add_cleanup(tree_to.lock_write().unlock)
1016
955
        except errors.NoWorkingTree:
1017
956
            tree_to = None
1018
957
            branch_to = Branch.open_containing(directory)[0]
1019
 
            self.add_cleanup(branch_to.lock_write().unlock)
1020
 
 
1021
 
        if tree_to is None and show_base:
1022
 
            raise errors.BzrCommandError("Need working tree for --show-base.")
1023
 
 
 
958
        
1024
959
        if local and not branch_to.get_bound_location():
1025
960
            raise errors.LocalRequiresBoundBranch()
1026
961
 
1056
991
        else:
1057
992
            branch_from = Branch.open(location,
1058
993
                possible_transports=possible_transports)
1059
 
            self.add_cleanup(branch_from.lock_read().unlock)
1060
 
            # Remembers if asked explicitly or no previous location is set
1061
 
            if (remember
1062
 
                or (remember is None and branch_to.get_parent() is None)):
 
994
 
 
995
            if branch_to.get_parent() is None or remember:
1063
996
                branch_to.set_parent(branch_from.base)
1064
997
 
 
998
        if branch_from is not branch_to:
 
999
            branch_from.lock_read()
 
1000
            self.add_cleanup(branch_from.unlock)
1065
1001
        if revision is not None:
1066
1002
            revision_id = revision.as_revision_id(branch_from)
1067
1003
 
 
1004
        branch_to.lock_write()
 
1005
        self.add_cleanup(branch_to.unlock)
1068
1006
        if tree_to is not None:
1069
1007
            view_info = _get_view_info_for_change_reporter(tree_to)
1070
1008
            change_reporter = delta._ChangeReporter(
1072
1010
                view_info=view_info)
1073
1011
            result = tree_to.pull(
1074
1012
                branch_from, overwrite, revision_id, change_reporter,
1075
 
                possible_transports=possible_transports, local=local,
1076
 
                show_base=show_base)
 
1013
                possible_transports=possible_transports, local=local)
1077
1014
        else:
1078
1015
            result = branch_to.pull(
1079
1016
                branch_from, overwrite, revision_id, local=local)
1083
1020
            log.show_branch_change(
1084
1021
                branch_to, self.outf, result.old_revno,
1085
1022
                result.old_revid)
1086
 
        if getattr(result, 'tag_conflicts', None):
1087
 
            return 1
1088
 
        else:
1089
 
            return 0
1090
1023
 
1091
1024
 
1092
1025
class cmd_push(Command):
1093
 
    __doc__ = """Update a mirror of this branch.
 
1026
    """Update a mirror of this branch.
1094
1027
 
1095
1028
    The target branch will not have its working tree populated because this
1096
1029
    is both expensive, and is not supported on remote file systems.
1109
1042
    do a merge (see bzr help merge) from the other branch, and commit that.
1110
1043
    After that you will be able to do a push without '--overwrite'.
1111
1044
 
1112
 
    If there is no default push location set, the first push will set it (use
1113
 
    --no-remember to avoid settting it).  After that, you can omit the
1114
 
    location to use the default.  To change the default, use --remember. The
1115
 
    value will only be saved if the remote location can be accessed.
 
1045
    If there is no default push location set, the first push will set it.
 
1046
    After that, you can omit the location to use the default.  To change the
 
1047
    default, use --remember. The value will only be saved if the remote
 
1048
    location can be accessed.
1116
1049
    """
1117
1050
 
1118
1051
    _see_also = ['pull', 'update', 'working-trees']
1120
1053
        Option('create-prefix',
1121
1054
               help='Create the path leading up to the branch '
1122
1055
                    'if it does not already exist.'),
1123
 
        custom_help('directory',
 
1056
        Option('directory',
1124
1057
            help='Branch to push from, '
1125
 
                 'rather than the one containing the working directory.'),
 
1058
                 'rather than the one containing the working directory.',
 
1059
            short_name='d',
 
1060
            type=unicode,
 
1061
            ),
1126
1062
        Option('use-existing-dir',
1127
1063
               help='By default push will fail if the target'
1128
1064
                    ' directory exists, but does not already'
1139
1075
        Option('strict',
1140
1076
               help='Refuse to push if there are uncommitted changes in'
1141
1077
               ' the working tree, --no-strict disables the check.'),
1142
 
        Option('no-tree',
1143
 
               help="Don't populate the working tree, even for protocols"
1144
 
               " that support it."),
1145
1078
        ]
1146
1079
    takes_args = ['location?']
1147
1080
    encoding_type = 'replace'
1148
1081
 
1149
 
    def run(self, location=None, remember=None, overwrite=False,
 
1082
    def run(self, location=None, remember=False, overwrite=False,
1150
1083
        create_prefix=False, verbose=False, revision=None,
1151
1084
        use_existing_dir=False, directory=None, stacked_on=None,
1152
 
        stacked=False, strict=None, no_tree=False):
 
1085
        stacked=False, strict=None):
1153
1086
        from bzrlib.push import _show_push_branch
1154
1087
 
1155
1088
        if directory is None:
1157
1090
        # Get the source branch
1158
1091
        (tree, br_from,
1159
1092
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1093
        if strict is None:
 
1094
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
 
1095
        if strict is None: strict = True # default value
1160
1096
        # Get the tip's revision_id
1161
1097
        revision = _get_one_revision('push', revision)
1162
1098
        if revision is not None:
1163
1099
            revision_id = revision.in_history(br_from).rev_id
1164
1100
        else:
1165
1101
            revision_id = None
1166
 
        if tree is not None and revision_id is None:
1167
 
            tree.check_changed_or_out_of_date(
1168
 
                strict, 'push_strict',
1169
 
                more_error='Use --no-strict to force the push.',
1170
 
                more_warning='Uncommitted changes will not be pushed.')
 
1102
        if strict and tree is not None and revision_id is None:
 
1103
            if (tree.has_changes()):
 
1104
                raise errors.UncommittedChanges(
 
1105
                    tree, more='Use --no-strict to force the push.')
 
1106
            if tree.last_revision() != tree.branch.last_revision():
 
1107
                # The tree has lost sync with its branch, there is little
 
1108
                # chance that the user is aware of it but he can still force
 
1109
                # the push with --no-strict
 
1110
                raise errors.OutOfDateTree(
 
1111
                    tree, more='Use --no-strict to force the push.')
 
1112
 
1171
1113
        # Get the stacked_on branch, if any
1172
1114
        if stacked_on is not None:
1173
1115
            stacked_on = urlutils.normalize_url(stacked_on)
1195
1137
            else:
1196
1138
                display_url = urlutils.unescape_for_display(stored_loc,
1197
1139
                        self.outf.encoding)
1198
 
                note("Using saved push location: %s" % display_url)
 
1140
                self.outf.write("Using saved push location: %s\n" % display_url)
1199
1141
                location = stored_loc
1200
1142
 
1201
1143
        _show_push_branch(br_from, revision_id, location, self.outf,
1202
1144
            verbose=verbose, overwrite=overwrite, remember=remember,
1203
1145
            stacked_on=stacked_on, create_prefix=create_prefix,
1204
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1146
            use_existing_dir=use_existing_dir)
1205
1147
 
1206
1148
 
1207
1149
class cmd_branch(Command):
1208
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1150
    """Create a new branch that is a copy of an existing branch.
1209
1151
 
1210
1152
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1211
1153
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1216
1158
 
1217
1159
    To retrieve the branch as of a particular revision, supply the --revision
1218
1160
    parameter, as in "branch foo/bar -r 5".
1219
 
 
1220
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1221
1161
    """
1222
1162
 
1223
1163
    _see_also = ['checkout']
1224
1164
    takes_args = ['from_location', 'to_location?']
1225
 
    takes_options = ['revision',
1226
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1227
 
        Option('files-from', type=str,
1228
 
               help="Get file contents from this tree."),
 
1165
    takes_options = ['revision', Option('hardlink',
 
1166
        help='Hard-link working tree files where possible.'),
1229
1167
        Option('no-tree',
1230
1168
            help="Create a branch without a working-tree."),
1231
1169
        Option('switch',
1242
1180
                    ' directory exists, but does not already'
1243
1181
                    ' have a control directory.  This flag will'
1244
1182
                    ' allow branch to proceed.'),
1245
 
        Option('bind',
1246
 
            help="Bind new branch to from location."),
1247
1183
        ]
1248
1184
    aliases = ['get', 'clone']
1249
1185
 
1250
1186
    def run(self, from_location, to_location=None, revision=None,
1251
1187
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1252
 
            use_existing_dir=False, switch=False, bind=False,
1253
 
            files_from=None):
 
1188
            use_existing_dir=False, switch=False):
1254
1189
        from bzrlib import switch as _mod_switch
1255
1190
        from bzrlib.tag import _merge_tags_if_possible
1256
 
        if self.invoked_as in ['get', 'clone']:
1257
 
            ui.ui_factory.show_user_warning(
1258
 
                'deprecated_command',
1259
 
                deprecated_name=self.invoked_as,
1260
 
                recommended_name='branch',
1261
 
                deprecated_in_version='2.4')
1262
1191
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1263
1192
            from_location)
1264
 
        if not (hardlink or files_from):
1265
 
            # accelerator_tree is usually slower because you have to read N
1266
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1267
 
            # explicitly request it
1268
 
            accelerator_tree = None
1269
 
        if files_from is not None and files_from != from_location:
1270
 
            accelerator_tree = WorkingTree.open(files_from)
1271
1193
        revision = _get_one_revision('branch', revision)
1272
 
        self.add_cleanup(br_from.lock_read().unlock)
 
1194
        br_from.lock_read()
 
1195
        self.add_cleanup(br_from.unlock)
1273
1196
        if revision is not None:
1274
1197
            revision_id = revision.as_revision_id(br_from)
1275
1198
        else:
1321
1244
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1322
1245
            errors.UnstackableRepositoryFormat), e:
1323
1246
            note('Branched %d revision(s).' % branch.revno())
1324
 
        if bind:
1325
 
            # Bind to the parent
1326
 
            parent_branch = Branch.open(from_location)
1327
 
            branch.bind(parent_branch)
1328
 
            note('New branch bound to %s' % from_location)
1329
1247
        if switch:
1330
1248
            # Switch to the new branch
1331
1249
            wt, _ = WorkingTree.open_containing('.')
1335
1253
 
1336
1254
 
1337
1255
class cmd_checkout(Command):
1338
 
    __doc__ = """Create a new checkout of an existing branch.
 
1256
    """Create a new checkout of an existing branch.
1339
1257
 
1340
1258
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1341
1259
    the branch found in '.'. This is useful if you have removed the working tree
1380
1298
            to_location = branch_location
1381
1299
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1382
1300
            branch_location)
1383
 
        if not (hardlink or files_from):
1384
 
            # accelerator_tree is usually slower because you have to read N
1385
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1386
 
            # explicitly request it
1387
 
            accelerator_tree = None
1388
1301
        revision = _get_one_revision('checkout', revision)
1389
 
        if files_from is not None and files_from != branch_location:
 
1302
        if files_from is not None:
1390
1303
            accelerator_tree = WorkingTree.open(files_from)
1391
1304
        if revision is not None:
1392
1305
            revision_id = revision.as_revision_id(source)
1409
1322
 
1410
1323
 
1411
1324
class cmd_renames(Command):
1412
 
    __doc__ = """Show list of renamed files.
 
1325
    """Show list of renamed files.
1413
1326
    """
1414
1327
    # TODO: Option to show renames between two historical versions.
1415
1328
 
1420
1333
    @display_command
1421
1334
    def run(self, dir=u'.'):
1422
1335
        tree = WorkingTree.open_containing(dir)[0]
1423
 
        self.add_cleanup(tree.lock_read().unlock)
 
1336
        tree.lock_read()
 
1337
        self.add_cleanup(tree.unlock)
1424
1338
        new_inv = tree.inventory
1425
1339
        old_tree = tree.basis_tree()
1426
 
        self.add_cleanup(old_tree.lock_read().unlock)
 
1340
        old_tree.lock_read()
 
1341
        self.add_cleanup(old_tree.unlock)
1427
1342
        old_inv = old_tree.inventory
1428
1343
        renames = []
1429
1344
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1439
1354
 
1440
1355
 
1441
1356
class cmd_update(Command):
1442
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1357
    """Update a tree to have the latest code committed to its branch.
1443
1358
 
1444
1359
    This will perform a merge into the working tree, and may generate
1445
1360
    conflicts. If you have any local changes, you will still
1448
1363
    If you want to discard your local changes, you can just do a
1449
1364
    'bzr revert' instead of 'bzr commit' after the update.
1450
1365
 
1451
 
    If you want to restore a file that has been removed locally, use
1452
 
    'bzr revert' instead of 'bzr update'.
1453
 
 
1454
1366
    If the tree's branch is bound to a master branch, it will also update
1455
1367
    the branch from the master.
1456
1368
    """
1457
1369
 
1458
1370
    _see_also = ['pull', 'working-trees', 'status-flags']
1459
1371
    takes_args = ['dir?']
1460
 
    takes_options = ['revision',
1461
 
                     Option('show-base',
1462
 
                            help="Show base revision text in conflicts."),
1463
 
                     ]
 
1372
    takes_options = ['revision']
1464
1373
    aliases = ['up']
1465
1374
 
1466
 
    def run(self, dir='.', revision=None, show_base=None):
 
1375
    def run(self, dir='.', revision=None):
1467
1376
        if revision is not None and len(revision) != 1:
1468
1377
            raise errors.BzrCommandError(
1469
1378
                        "bzr update --revision takes exactly one revision")
1473
1382
        master = branch.get_master_branch(
1474
1383
            possible_transports=possible_transports)
1475
1384
        if master is not None:
 
1385
            tree.lock_write()
1476
1386
            branch_location = master.base
1477
 
            tree.lock_write()
1478
1387
        else:
 
1388
            tree.lock_tree_write()
1479
1389
            branch_location = tree.branch.base
1480
 
            tree.lock_tree_write()
1481
1390
        self.add_cleanup(tree.unlock)
1482
1391
        # get rid of the final '/' and be ready for display
1483
 
        branch_location = urlutils.unescape_for_display(
1484
 
            branch_location.rstrip('/'),
1485
 
            self.outf.encoding)
 
1392
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
 
1393
                                                        self.outf.encoding)
1486
1394
        existing_pending_merges = tree.get_parent_ids()[1:]
1487
1395
        if master is None:
1488
1396
            old_tip = None
1496
1404
        else:
1497
1405
            revision_id = branch.last_revision()
1498
1406
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1499
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1500
 
            note("Tree is up to date at revision %s of branch %s" %
1501
 
                ('.'.join(map(str, revno)), branch_location))
 
1407
            revno = branch.revision_id_to_revno(revision_id)
 
1408
            note("Tree is up to date at revision %d of branch %s" %
 
1409
                (revno, branch_location))
1502
1410
            return 0
1503
1411
        view_info = _get_view_info_for_change_reporter(tree)
1504
1412
        change_reporter = delta._ChangeReporter(
1509
1417
                change_reporter,
1510
1418
                possible_transports=possible_transports,
1511
1419
                revision=revision_id,
1512
 
                old_tip=old_tip,
1513
 
                show_base=show_base)
 
1420
                old_tip=old_tip)
1514
1421
        except errors.NoSuchRevision, e:
1515
1422
            raise errors.BzrCommandError(
1516
1423
                                  "branch has no revision %s\n"
1517
1424
                                  "bzr update --revision only works"
1518
1425
                                  " for a revision in the branch history"
1519
1426
                                  % (e.revision))
1520
 
        revno = tree.branch.revision_id_to_dotted_revno(
 
1427
        revno = tree.branch.revision_id_to_revno(
1521
1428
            _mod_revision.ensure_null(tree.last_revision()))
1522
 
        note('Updated to revision %s of branch %s' %
1523
 
             ('.'.join(map(str, revno)), branch_location))
1524
 
        parent_ids = tree.get_parent_ids()
1525
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1429
        note('Updated to revision %d of branch %s' %
 
1430
             (revno, branch_location))
 
1431
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1526
1432
            note('Your local commits will now show as pending merges with '
1527
1433
                 "'bzr status', and can be committed with 'bzr commit'.")
1528
1434
        if conflicts != 0:
1532
1438
 
1533
1439
 
1534
1440
class cmd_info(Command):
1535
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1441
    """Show information about a working tree, branch or repository.
1536
1442
 
1537
1443
    This command will show all known locations and formats associated to the
1538
1444
    tree, branch or repository.
1576
1482
 
1577
1483
 
1578
1484
class cmd_remove(Command):
1579
 
    __doc__ = """Remove files or directories.
 
1485
    """Remove files or directories.
1580
1486
 
1581
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1582
 
    delete them if they can easily be recovered using revert otherwise they
1583
 
    will be backed up (adding an extention of the form .~#~). If no options or
1584
 
    parameters are given Bazaar will scan for files that are being tracked by
1585
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1487
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1488
    them if they can easily be recovered using revert. If no options or
 
1489
    parameters are given bzr will scan for files that are being tracked by bzr
 
1490
    but missing in your tree and stop tracking them for you.
1586
1491
    """
1587
1492
    takes_args = ['file*']
1588
1493
    takes_options = ['verbose',
1590
1495
        RegistryOption.from_kwargs('file-deletion-strategy',
1591
1496
            'The file deletion mode to be used.',
1592
1497
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1593
 
            safe='Backup changed files (default).',
 
1498
            safe='Only delete files if they can be'
 
1499
                 ' safely recovered (default).',
1594
1500
            keep='Delete from bzr but leave the working copy.',
1595
 
            no_backup='Don\'t backup changed files.',
1596
1501
            force='Delete all the specified files, even if they can not be '
1597
 
                'recovered and even if they are non-empty directories. '
1598
 
                '(deprecated, use no-backup)')]
 
1502
                'recovered and even if they are non-empty directories.')]
1599
1503
    aliases = ['rm', 'del']
1600
1504
    encoding_type = 'replace'
1601
1505
 
1602
1506
    def run(self, file_list, verbose=False, new=False,
1603
1507
        file_deletion_strategy='safe'):
1604
 
        if file_deletion_strategy == 'force':
1605
 
            note("(The --force option is deprecated, rather use --no-backup "
1606
 
                "in future.)")
1607
 
            file_deletion_strategy = 'no-backup'
1608
 
 
1609
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1508
        tree, file_list = tree_files(file_list)
1610
1509
 
1611
1510
        if file_list is not None:
1612
1511
            file_list = [f for f in file_list]
1613
1512
 
1614
 
        self.add_cleanup(tree.lock_write().unlock)
 
1513
        tree.lock_write()
 
1514
        self.add_cleanup(tree.unlock)
1615
1515
        # Heuristics should probably all move into tree.remove_smart or
1616
1516
        # some such?
1617
1517
        if new:
1632
1532
            file_deletion_strategy = 'keep'
1633
1533
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1634
1534
            keep_files=file_deletion_strategy=='keep',
1635
 
            force=(file_deletion_strategy=='no-backup'))
 
1535
            force=file_deletion_strategy=='force')
1636
1536
 
1637
1537
 
1638
1538
class cmd_file_id(Command):
1639
 
    __doc__ = """Print file_id of a particular file or directory.
 
1539
    """Print file_id of a particular file or directory.
1640
1540
 
1641
1541
    The file_id is assigned when the file is first added and remains the
1642
1542
    same through all revisions where the file exists, even when it is
1658
1558
 
1659
1559
 
1660
1560
class cmd_file_path(Command):
1661
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1561
    """Print path of file_ids to a file or directory.
1662
1562
 
1663
1563
    This prints one line for each directory down to the target,
1664
1564
    starting at the branch root.
1680
1580
 
1681
1581
 
1682
1582
class cmd_reconcile(Command):
1683
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1583
    """Reconcile bzr metadata in a branch.
1684
1584
 
1685
1585
    This can correct data mismatches that may have been caused by
1686
1586
    previous ghost operations or bzr upgrades. You should only
1700
1600
 
1701
1601
    _see_also = ['check']
1702
1602
    takes_args = ['branch?']
1703
 
    takes_options = [
1704
 
        Option('canonicalize-chks',
1705
 
               help='Make sure CHKs are in canonical form (repairs '
1706
 
                    'bug 522637).',
1707
 
               hidden=True),
1708
 
        ]
1709
1603
 
1710
 
    def run(self, branch=".", canonicalize_chks=False):
 
1604
    def run(self, branch="."):
1711
1605
        from bzrlib.reconcile import reconcile
1712
1606
        dir = bzrdir.BzrDir.open(branch)
1713
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1607
        reconcile(dir)
1714
1608
 
1715
1609
 
1716
1610
class cmd_revision_history(Command):
1717
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1611
    """Display the list of revision ids on a branch."""
1718
1612
 
1719
1613
    _see_also = ['log']
1720
1614
    takes_args = ['location?']
1730
1624
 
1731
1625
 
1732
1626
class cmd_ancestry(Command):
1733
 
    __doc__ = """List all revisions merged into this branch."""
 
1627
    """List all revisions merged into this branch."""
1734
1628
 
1735
1629
    _see_also = ['log', 'revision-history']
1736
1630
    takes_args = ['location?']
1748
1642
            b = wt.branch
1749
1643
            last_revision = wt.last_revision()
1750
1644
 
1751
 
        self.add_cleanup(b.repository.lock_read().unlock)
1752
 
        graph = b.repository.get_graph()
1753
 
        revisions = [revid for revid, parents in
1754
 
            graph.iter_ancestry([last_revision])]
1755
 
        for revision_id in reversed(revisions):
1756
 
            if _mod_revision.is_null(revision_id):
1757
 
                continue
 
1645
        revision_ids = b.repository.get_ancestry(last_revision)
 
1646
        revision_ids.pop(0)
 
1647
        for revision_id in revision_ids:
1758
1648
            self.outf.write(revision_id + '\n')
1759
1649
 
1760
1650
 
1761
1651
class cmd_init(Command):
1762
 
    __doc__ = """Make a directory into a versioned branch.
 
1652
    """Make a directory into a versioned branch.
1763
1653
 
1764
1654
    Use this to create an empty branch, or before importing an
1765
1655
    existing project.
1797
1687
                ),
1798
1688
         Option('append-revisions-only',
1799
1689
                help='Never change revnos or the existing log.'
1800
 
                '  Append revisions to it only.'),
1801
 
         Option('no-tree',
1802
 
                'Create a branch without a working tree.')
 
1690
                '  Append revisions to it only.')
1803
1691
         ]
1804
1692
    def run(self, location=None, format=None, append_revisions_only=False,
1805
 
            create_prefix=False, no_tree=False):
 
1693
            create_prefix=False):
1806
1694
        if format is None:
1807
1695
            format = bzrdir.format_registry.make_bzrdir('default')
1808
1696
        if location is None:
1831
1719
        except errors.NotBranchError:
1832
1720
            # really a NotBzrDir error...
1833
1721
            create_branch = bzrdir.BzrDir.create_branch_convenience
1834
 
            if no_tree:
1835
 
                force_new_tree = False
1836
 
            else:
1837
 
                force_new_tree = None
1838
1722
            branch = create_branch(to_transport.base, format=format,
1839
 
                                   possible_transports=[to_transport],
1840
 
                                   force_new_tree=force_new_tree)
 
1723
                                   possible_transports=[to_transport])
1841
1724
            a_bzrdir = branch.bzrdir
1842
1725
        else:
1843
1726
            from bzrlib.transport.local import LocalTransport
1847
1730
                        raise errors.BranchExistsWithoutWorkingTree(location)
1848
1731
                raise errors.AlreadyBranchError(location)
1849
1732
            branch = a_bzrdir.create_branch()
1850
 
            if not no_tree:
1851
 
                a_bzrdir.create_workingtree()
 
1733
            a_bzrdir.create_workingtree()
1852
1734
        if append_revisions_only:
1853
1735
            try:
1854
1736
                branch.set_append_revisions_only(True)
1876
1758
 
1877
1759
 
1878
1760
class cmd_init_repository(Command):
1879
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1761
    """Create a shared repository for branches to share storage space.
1880
1762
 
1881
1763
    New branches created under the repository directory will store their
1882
1764
    revisions in the repository, not in the branch directory.  For branches
1936
1818
 
1937
1819
 
1938
1820
class cmd_diff(Command):
1939
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1821
    """Show differences in the working tree, between revisions or branches.
1940
1822
 
1941
1823
    If no arguments are given, all changes for the current tree are listed.
1942
1824
    If files are given, only the changes in those files are listed.
1948
1830
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1949
1831
    produces patches suitable for "patch -p1".
1950
1832
 
1951
 
    Note that when using the -r argument with a range of revisions, the
1952
 
    differences are computed between the two specified revisions.  That
1953
 
    is, the command does not show the changes introduced by the first 
1954
 
    revision in the range.  This differs from the interpretation of 
1955
 
    revision ranges used by "bzr log" which includes the first revision
1956
 
    in the range.
1957
 
 
1958
1833
    :Exit values:
1959
1834
        1 - changed
1960
1835
        2 - unrepresentable changes
1978
1853
 
1979
1854
            bzr diff -r1..3 xxx
1980
1855
 
1981
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1982
 
 
1983
 
            bzr diff -c2
1984
 
 
1985
 
        To see the changes introduced by revision X::
 
1856
        To see the changes introduced in revision X::
1986
1857
        
1987
1858
            bzr diff -cX
1988
1859
 
1992
1863
 
1993
1864
            bzr diff -r<chosen_parent>..X
1994
1865
 
1995
 
        The changes between the current revision and the previous revision
1996
 
        (equivalent to -c-1 and -r-2..-1)
 
1866
        The changes introduced by revision 2 (equivalent to -r1..2)::
1997
1867
 
1998
 
            bzr diff -r-2..
 
1868
            bzr diff -c2
1999
1869
 
2000
1870
        Show just the differences for file NEWS::
2001
1871
 
2016
1886
        Same as 'bzr diff' but prefix paths with old/ and new/::
2017
1887
 
2018
1888
            bzr diff --prefix old/:new/
2019
 
            
2020
 
        Show the differences using a custom diff program with options::
2021
 
        
2022
 
            bzr diff --using /usr/bin/diff --diff-options -wu
2023
1889
    """
2024
1890
    _see_also = ['status']
2025
1891
    takes_args = ['file*']
2044
1910
            help='Use this command to compare files.',
2045
1911
            type=unicode,
2046
1912
            ),
2047
 
        RegistryOption('format',
2048
 
            short_name='F',
2049
 
            help='Diff format to use.',
2050
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
2051
 
            title='Diff format'),
2052
1913
        ]
2053
1914
    aliases = ['di', 'dif']
2054
1915
    encoding_type = 'exact'
2055
1916
 
2056
1917
    @display_command
2057
1918
    def run(self, revision=None, file_list=None, diff_options=None,
2058
 
            prefix=None, old=None, new=None, using=None, format=None):
2059
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
2060
 
            show_diff_trees)
 
1919
            prefix=None, old=None, new=None, using=None):
 
1920
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
2061
1921
 
2062
1922
        if (prefix is None) or (prefix == '0'):
2063
1923
            # diff -p0 format
2077
1937
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
2078
1938
                                         ' one or two revision specifiers')
2079
1939
 
2080
 
        if using is not None and format is not None:
2081
 
            raise errors.BzrCommandError('--using and --format are mutually '
2082
 
                'exclusive.')
2083
 
 
2084
1940
        (old_tree, new_tree,
2085
1941
         old_branch, new_branch,
2086
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2087
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
2088
 
        # GNU diff on Windows uses ANSI encoding for filenames
2089
 
        path_encoding = osutils.get_diff_header_encoding()
 
1942
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
 
1943
            file_list, revision, old, new, apply_view=True)
2090
1944
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2091
1945
                               specific_files=specific_files,
2092
1946
                               external_diff_options=diff_options,
2093
1947
                               old_label=old_label, new_label=new_label,
2094
 
                               extra_trees=extra_trees,
2095
 
                               path_encoding=path_encoding,
2096
 
                               using=using,
2097
 
                               format_cls=format)
 
1948
                               extra_trees=extra_trees, using=using)
2098
1949
 
2099
1950
 
2100
1951
class cmd_deleted(Command):
2101
 
    __doc__ = """List files deleted in the working tree.
 
1952
    """List files deleted in the working tree.
2102
1953
    """
2103
1954
    # TODO: Show files deleted since a previous revision, or
2104
1955
    # between two revisions.
2107
1958
    # level of effort but possibly much less IO.  (Or possibly not,
2108
1959
    # if the directories are very large...)
2109
1960
    _see_also = ['status', 'ls']
2110
 
    takes_options = ['directory', 'show-ids']
 
1961
    takes_options = ['show-ids']
2111
1962
 
2112
1963
    @display_command
2113
 
    def run(self, show_ids=False, directory=u'.'):
2114
 
        tree = WorkingTree.open_containing(directory)[0]
2115
 
        self.add_cleanup(tree.lock_read().unlock)
 
1964
    def run(self, show_ids=False):
 
1965
        tree = WorkingTree.open_containing(u'.')[0]
 
1966
        tree.lock_read()
 
1967
        self.add_cleanup(tree.unlock)
2116
1968
        old = tree.basis_tree()
2117
 
        self.add_cleanup(old.lock_read().unlock)
 
1969
        old.lock_read()
 
1970
        self.add_cleanup(old.unlock)
2118
1971
        for path, ie in old.inventory.iter_entries():
2119
1972
            if not tree.has_id(ie.file_id):
2120
1973
                self.outf.write(path)
2125
1978
 
2126
1979
 
2127
1980
class cmd_modified(Command):
2128
 
    __doc__ = """List files modified in working tree.
 
1981
    """List files modified in working tree.
2129
1982
    """
2130
1983
 
2131
1984
    hidden = True
2132
1985
    _see_also = ['status', 'ls']
2133
 
    takes_options = ['directory', 'null']
 
1986
    takes_options = [
 
1987
            Option('null',
 
1988
                   help='Write an ascii NUL (\\0) separator '
 
1989
                   'between files rather than a newline.')
 
1990
            ]
2134
1991
 
2135
1992
    @display_command
2136
 
    def run(self, null=False, directory=u'.'):
2137
 
        tree = WorkingTree.open_containing(directory)[0]
2138
 
        self.add_cleanup(tree.lock_read().unlock)
 
1993
    def run(self, null=False):
 
1994
        tree = WorkingTree.open_containing(u'.')[0]
2139
1995
        td = tree.changes_from(tree.basis_tree())
2140
 
        self.cleanup_now()
2141
1996
        for path, id, kind, text_modified, meta_modified in td.modified:
2142
1997
            if null:
2143
1998
                self.outf.write(path + '\0')
2146
2001
 
2147
2002
 
2148
2003
class cmd_added(Command):
2149
 
    __doc__ = """List files added in working tree.
 
2004
    """List files added in working tree.
2150
2005
    """
2151
2006
 
2152
2007
    hidden = True
2153
2008
    _see_also = ['status', 'ls']
2154
 
    takes_options = ['directory', 'null']
 
2009
    takes_options = [
 
2010
            Option('null',
 
2011
                   help='Write an ascii NUL (\\0) separator '
 
2012
                   'between files rather than a newline.')
 
2013
            ]
2155
2014
 
2156
2015
    @display_command
2157
 
    def run(self, null=False, directory=u'.'):
2158
 
        wt = WorkingTree.open_containing(directory)[0]
2159
 
        self.add_cleanup(wt.lock_read().unlock)
 
2016
    def run(self, null=False):
 
2017
        wt = WorkingTree.open_containing(u'.')[0]
 
2018
        wt.lock_read()
 
2019
        self.add_cleanup(wt.unlock)
2160
2020
        basis = wt.basis_tree()
2161
 
        self.add_cleanup(basis.lock_read().unlock)
 
2021
        basis.lock_read()
 
2022
        self.add_cleanup(basis.unlock)
2162
2023
        basis_inv = basis.inventory
2163
2024
        inv = wt.inventory
2164
2025
        for file_id in inv:
2165
 
            if basis_inv.has_id(file_id):
 
2026
            if file_id in basis_inv:
2166
2027
                continue
2167
2028
            if inv.is_root(file_id) and len(basis_inv) == 0:
2168
2029
                continue
2169
2030
            path = inv.id2path(file_id)
2170
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2031
            if not os.access(osutils.abspath(path), os.F_OK):
2171
2032
                continue
2172
2033
            if null:
2173
2034
                self.outf.write(path + '\0')
2176
2037
 
2177
2038
 
2178
2039
class cmd_root(Command):
2179
 
    __doc__ = """Show the tree root directory.
 
2040
    """Show the tree root directory.
2180
2041
 
2181
2042
    The root is the nearest enclosing directory with a .bzr control
2182
2043
    directory."""
2206
2067
 
2207
2068
 
2208
2069
class cmd_log(Command):
2209
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2070
    """Show historical log for a branch or subset of a branch.
2210
2071
 
2211
2072
    log is bzr's default tool for exploring the history of a branch.
2212
2073
    The branch to use is taken from the first parameter. If no parameters
2317
2178
 
2318
2179
    :Other filtering:
2319
2180
 
2320
 
      The --match option can be used for finding revisions that match a
2321
 
      regular expression in a commit message, committer, author or bug.
2322
 
      Specifying the option several times will match any of the supplied
2323
 
      expressions. --match-author, --match-bugs, --match-committer and
2324
 
      --match-message can be used to only match a specific field.
 
2181
      The --message option can be used for finding revisions that match a
 
2182
      regular expression in a commit message.
2325
2183
 
2326
2184
    :Tips & tricks:
2327
2185
 
2328
2186
      GUI tools and IDEs are often better at exploring history than command
2329
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2330
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2331
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2332
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2187
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2188
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2189
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2190
 
 
2191
      Web interfaces are often better at exploring history than command line
 
2192
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2193
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2333
2194
 
2334
2195
      You may find it useful to add the aliases below to ``bazaar.conf``::
2335
2196
 
2376
2237
                   help='Show just the specified revision.'
2377
2238
                   ' See also "help revisionspec".'),
2378
2239
            'log-format',
2379
 
            RegistryOption('authors',
2380
 
                'What names to list as authors - first, all or committer.',
2381
 
                title='Authors',
2382
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2383
 
            ),
2384
2240
            Option('levels',
2385
2241
                   short_name='n',
2386
2242
                   help='Number of levels to display - 0 for all, 1 for flat.',
2387
2243
                   argname='N',
2388
2244
                   type=_parse_levels),
2389
2245
            Option('message',
 
2246
                   short_name='m',
2390
2247
                   help='Show revisions whose message matches this '
2391
2248
                        'regular expression.',
2392
 
                   type=str,
2393
 
                   hidden=True),
 
2249
                   type=str),
2394
2250
            Option('limit',
2395
2251
                   short_name='l',
2396
2252
                   help='Limit the output to the first N revisions.',
2401
2257
                   help='Show changes made in each revision as a patch.'),
2402
2258
            Option('include-merges',
2403
2259
                   help='Show merged revisions like --levels 0 does.'),
2404
 
            Option('exclude-common-ancestry',
2405
 
                   help='Display only the revisions that are not part'
2406
 
                   ' of both ancestries (require -rX..Y)'
2407
 
                   ),
2408
 
            Option('signatures',
2409
 
                   help='Show digital signature validity'),
2410
 
            ListOption('match',
2411
 
                short_name='m',
2412
 
                help='Show revisions whose properties match this '
2413
 
                'expression.',
2414
 
                type=str),
2415
 
            ListOption('match-message',
2416
 
                   help='Show revisions whose message matches this '
2417
 
                   'expression.',
2418
 
                type=str),
2419
 
            ListOption('match-committer',
2420
 
                   help='Show revisions whose committer matches this '
2421
 
                   'expression.',
2422
 
                type=str),
2423
 
            ListOption('match-author',
2424
 
                   help='Show revisions whose authors match this '
2425
 
                   'expression.',
2426
 
                type=str),
2427
 
            ListOption('match-bugs',
2428
 
                   help='Show revisions whose bugs match this '
2429
 
                   'expression.',
2430
 
                type=str)
2431
2260
            ]
2432
2261
    encoding_type = 'replace'
2433
2262
 
2443
2272
            message=None,
2444
2273
            limit=None,
2445
2274
            show_diff=False,
2446
 
            include_merges=False,
2447
 
            authors=None,
2448
 
            exclude_common_ancestry=False,
2449
 
            signatures=False,
2450
 
            match=None,
2451
 
            match_message=None,
2452
 
            match_committer=None,
2453
 
            match_author=None,
2454
 
            match_bugs=None,
2455
 
            ):
 
2275
            include_merges=False):
2456
2276
        from bzrlib.log import (
2457
2277
            Logger,
2458
2278
            make_log_request_dict,
2459
2279
            _get_info_for_log_files,
2460
2280
            )
2461
2281
        direction = (forward and 'forward') or 'reverse'
2462
 
        if (exclude_common_ancestry
2463
 
            and (revision is None or len(revision) != 2)):
2464
 
            raise errors.BzrCommandError(
2465
 
                '--exclude-common-ancestry requires -r with two revisions')
2466
2282
        if include_merges:
2467
2283
            if levels is None:
2468
2284
                levels = 0
2484
2300
        if file_list:
2485
2301
            # find the file ids to log and check for directory filtering
2486
2302
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2487
 
                revision, file_list, self.add_cleanup)
 
2303
                revision, file_list)
 
2304
            self.add_cleanup(b.unlock)
2488
2305
            for relpath, file_id, kind in file_info_list:
2489
2306
                if file_id is None:
2490
2307
                    raise errors.BzrCommandError(
2508
2325
                location = '.'
2509
2326
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2510
2327
            b = dir.open_branch()
2511
 
            self.add_cleanup(b.lock_read().unlock)
 
2328
            b.lock_read()
 
2329
            self.add_cleanup(b.unlock)
2512
2330
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2513
2331
 
2514
 
        if b.get_config().validate_signatures_in_log():
2515
 
            signatures = True
2516
 
 
2517
 
        if signatures:
2518
 
            if not gpg.GPGStrategy.verify_signatures_available():
2519
 
                raise errors.GpgmeNotInstalled(None)
2520
 
 
2521
2332
        # Decide on the type of delta & diff filtering to use
2522
2333
        # TODO: add an --all-files option to make this configurable & consistent
2523
2334
        if not verbose:
2541
2352
                        show_timezone=timezone,
2542
2353
                        delta_format=get_verbosity_level(),
2543
2354
                        levels=levels,
2544
 
                        show_advice=levels is None,
2545
 
                        author_list_handler=authors)
 
2355
                        show_advice=levels is None)
2546
2356
 
2547
2357
        # Choose the algorithm for doing the logging. It's annoying
2548
2358
        # having multiple code paths like this but necessary until
2560
2370
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2561
2371
            or delta_type or partial_history)
2562
2372
 
2563
 
        match_dict = {}
2564
 
        if match:
2565
 
            match_dict[''] = match
2566
 
        if match_message:
2567
 
            match_dict['message'] = match_message
2568
 
        if match_committer:
2569
 
            match_dict['committer'] = match_committer
2570
 
        if match_author:
2571
 
            match_dict['author'] = match_author
2572
 
        if match_bugs:
2573
 
            match_dict['bugs'] = match_bugs
2574
 
            
2575
2373
        # Build the LogRequest and execute it
2576
2374
        if len(file_ids) == 0:
2577
2375
            file_ids = None
2579
2377
            direction=direction, specific_fileids=file_ids,
2580
2378
            start_revision=rev1, end_revision=rev2, limit=limit,
2581
2379
            message_search=message, delta_type=delta_type,
2582
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2583
 
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
2584
 
            signature=signatures
2585
 
            )
 
2380
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
2586
2381
        Logger(b, rqst).show(lf)
2587
2382
 
2588
2383
 
2607
2402
            raise errors.BzrCommandError(
2608
2403
                "bzr %s doesn't accept two revisions in different"
2609
2404
                " branches." % command_name)
2610
 
        if start_spec.spec is None:
2611
 
            # Avoid loading all the history.
2612
 
            rev1 = RevisionInfo(branch, None, None)
2613
 
        else:
2614
 
            rev1 = start_spec.in_history(branch)
 
2405
        rev1 = start_spec.in_history(branch)
2615
2406
        # Avoid loading all of history when we know a missing
2616
2407
        # end of range means the last revision ...
2617
2408
        if end_spec.spec is None:
2646
2437
 
2647
2438
 
2648
2439
class cmd_touching_revisions(Command):
2649
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2440
    """Return revision-ids which affected a particular file.
2650
2441
 
2651
2442
    A more user-friendly interface is "bzr log FILE".
2652
2443
    """
2659
2450
        tree, relpath = WorkingTree.open_containing(filename)
2660
2451
        file_id = tree.path2id(relpath)
2661
2452
        b = tree.branch
2662
 
        self.add_cleanup(b.lock_read().unlock)
 
2453
        b.lock_read()
 
2454
        self.add_cleanup(b.unlock)
2663
2455
        touching_revs = log.find_touching_revisions(b, file_id)
2664
2456
        for revno, revision_id, what in touching_revs:
2665
2457
            self.outf.write("%6d %s\n" % (revno, what))
2666
2458
 
2667
2459
 
2668
2460
class cmd_ls(Command):
2669
 
    __doc__ = """List files in a tree.
 
2461
    """List files in a tree.
2670
2462
    """
2671
2463
 
2672
2464
    _see_also = ['status', 'cat']
2678
2470
                   help='Recurse into subdirectories.'),
2679
2471
            Option('from-root',
2680
2472
                   help='Print paths relative to the root of the branch.'),
2681
 
            Option('unknown', short_name='u',
2682
 
                help='Print unknown files.'),
 
2473
            Option('unknown', help='Print unknown files.'),
2683
2474
            Option('versioned', help='Print versioned files.',
2684
2475
                   short_name='V'),
2685
 
            Option('ignored', short_name='i',
2686
 
                help='Print ignored files.'),
2687
 
            Option('kind', short_name='k',
 
2476
            Option('ignored', help='Print ignored files.'),
 
2477
            Option('null',
 
2478
                   help='Write an ascii NUL (\\0) separator '
 
2479
                   'between files rather than a newline.'),
 
2480
            Option('kind',
2688
2481
                   help='List entries of a particular kind: file, directory, symlink.',
2689
2482
                   type=unicode),
2690
 
            'null',
2691
2483
            'show-ids',
2692
 
            'directory',
2693
2484
            ]
2694
2485
    @display_command
2695
2486
    def run(self, revision=None, verbose=False,
2696
2487
            recursive=False, from_root=False,
2697
2488
            unknown=False, versioned=False, ignored=False,
2698
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2489
            null=False, kind=None, show_ids=False, path=None):
2699
2490
 
2700
2491
        if kind and kind not in ('file', 'directory', 'symlink'):
2701
2492
            raise errors.BzrCommandError('invalid kind specified')
2713
2504
                raise errors.BzrCommandError('cannot specify both --from-root'
2714
2505
                                             ' and PATH')
2715
2506
            fs_path = path
2716
 
        tree, branch, relpath = \
2717
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2507
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2508
            fs_path)
2718
2509
 
2719
2510
        # Calculate the prefix to use
2720
2511
        prefix = None
2735
2526
                view_str = views.view_display_str(view_files)
2736
2527
                note("Ignoring files outside view. View is %s" % view_str)
2737
2528
 
2738
 
        self.add_cleanup(tree.lock_read().unlock)
 
2529
        tree.lock_read()
 
2530
        self.add_cleanup(tree.unlock)
2739
2531
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2740
2532
            from_dir=relpath, recursive=recursive):
2741
2533
            # Apply additional masking
2783
2575
 
2784
2576
 
2785
2577
class cmd_unknowns(Command):
2786
 
    __doc__ = """List unknown files.
 
2578
    """List unknown files.
2787
2579
    """
2788
2580
 
2789
2581
    hidden = True
2790
2582
    _see_also = ['ls']
2791
 
    takes_options = ['directory']
2792
2583
 
2793
2584
    @display_command
2794
 
    def run(self, directory=u'.'):
2795
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2585
    def run(self):
 
2586
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2796
2587
            self.outf.write(osutils.quotefn(f) + '\n')
2797
2588
 
2798
2589
 
2799
2590
class cmd_ignore(Command):
2800
 
    __doc__ = """Ignore specified files or patterns.
 
2591
    """Ignore specified files or patterns.
2801
2592
 
2802
2593
    See ``bzr help patterns`` for details on the syntax of patterns.
2803
2594
 
2811
2602
    After adding, editing or deleting that file either indirectly by
2812
2603
    using this command or directly by using an editor, be sure to commit
2813
2604
    it.
2814
 
    
2815
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2816
 
    the global ignore file can be found in the application data directory as
2817
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2818
 
    Global ignores are not touched by this command. The global ignore file
2819
 
    can be edited directly using an editor.
2820
 
 
2821
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2822
 
    precedence over regular ignores.  Such exceptions are used to specify
2823
 
    files that should be versioned which would otherwise be ignored.
2824
 
    
2825
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2826
 
    precedence over the '!' exception patterns.
2827
 
 
2828
 
    :Notes: 
2829
 
        
2830
 
    * Ignore patterns containing shell wildcards must be quoted from
2831
 
      the shell on Unix.
2832
 
 
2833
 
    * Ignore patterns starting with "#" act as comments in the ignore file.
2834
 
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
2605
 
 
2606
    Note: ignore patterns containing shell wildcards must be quoted from
 
2607
    the shell on Unix.
2835
2608
 
2836
2609
    :Examples:
2837
2610
        Ignore the top level Makefile::
2838
2611
 
2839
2612
            bzr ignore ./Makefile
2840
2613
 
2841
 
        Ignore .class files in all directories...::
 
2614
        Ignore class files in all directories...::
2842
2615
 
2843
2616
            bzr ignore "*.class"
2844
2617
 
2846
2619
 
2847
2620
            bzr ignore "!special.class"
2848
2621
 
2849
 
        Ignore files whose name begins with the "#" character::
2850
 
 
2851
 
            bzr ignore "RE:^#"
2852
 
 
2853
2622
        Ignore .o files under the lib directory::
2854
2623
 
2855
2624
            bzr ignore "lib/**/*.o"
2861
2630
        Ignore everything but the "debian" toplevel directory::
2862
2631
 
2863
2632
            bzr ignore "RE:(?!debian/).*"
2864
 
        
2865
 
        Ignore everything except the "local" toplevel directory,
2866
 
        but always ignore autosave files ending in ~, even under local/::
2867
 
        
2868
 
            bzr ignore "*"
2869
 
            bzr ignore "!./local"
2870
 
            bzr ignore "!!*~"
2871
2633
    """
2872
2634
 
2873
2635
    _see_also = ['status', 'ignored', 'patterns']
2874
2636
    takes_args = ['name_pattern*']
2875
 
    takes_options = ['directory',
2876
 
        Option('default-rules',
2877
 
               help='Display the default ignore rules that bzr uses.')
 
2637
    takes_options = [
 
2638
        Option('old-default-rules',
 
2639
               help='Write out the ignore rules bzr < 0.9 always used.')
2878
2640
        ]
2879
2641
 
2880
 
    def run(self, name_pattern_list=None, default_rules=None,
2881
 
            directory=u'.'):
 
2642
    def run(self, name_pattern_list=None, old_default_rules=None):
2882
2643
        from bzrlib import ignores
2883
 
        if default_rules is not None:
2884
 
            # dump the default rules and exit
2885
 
            for pattern in ignores.USER_DEFAULTS:
2886
 
                self.outf.write("%s\n" % pattern)
 
2644
        if old_default_rules is not None:
 
2645
            # dump the rules and exit
 
2646
            for pattern in ignores.OLD_DEFAULTS:
 
2647
                print pattern
2887
2648
            return
2888
2649
        if not name_pattern_list:
2889
2650
            raise errors.BzrCommandError("ignore requires at least one "
2890
 
                "NAME_PATTERN or --default-rules.")
 
2651
                                  "NAME_PATTERN or --old-default-rules")
2891
2652
        name_pattern_list = [globbing.normalize_pattern(p)
2892
2653
                             for p in name_pattern_list]
2893
 
        bad_patterns = ''
2894
 
        for p in name_pattern_list:
2895
 
            if not globbing.Globster.is_pattern_valid(p):
2896
 
                bad_patterns += ('\n  %s' % p)
2897
 
        if bad_patterns:
2898
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2899
 
            ui.ui_factory.show_error(msg)
2900
 
            raise errors.InvalidPattern('')
2901
2654
        for name_pattern in name_pattern_list:
2902
2655
            if (name_pattern[0] == '/' or
2903
2656
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2904
2657
                raise errors.BzrCommandError(
2905
2658
                    "NAME_PATTERN should not be an absolute path")
2906
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2659
        tree, relpath = WorkingTree.open_containing(u'.')
2907
2660
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2908
2661
        ignored = globbing.Globster(name_pattern_list)
2909
2662
        matches = []
2910
 
        self.add_cleanup(tree.lock_read().unlock)
 
2663
        tree.lock_read()
2911
2664
        for entry in tree.list_files():
2912
2665
            id = entry[3]
2913
2666
            if id is not None:
2914
2667
                filename = entry[0]
2915
2668
                if ignored.match(filename):
2916
 
                    matches.append(filename)
 
2669
                    matches.append(filename.encode('utf-8'))
 
2670
        tree.unlock()
2917
2671
        if len(matches) > 0:
2918
 
            self.outf.write("Warning: the following files are version controlled and"
2919
 
                  " match your ignore pattern:\n%s"
2920
 
                  "\nThese files will continue to be version controlled"
2921
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2672
            print "Warning: the following files are version controlled and" \
 
2673
                  " match your ignore pattern:\n%s" \
 
2674
                  "\nThese files will continue to be version controlled" \
 
2675
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2922
2676
 
2923
2677
 
2924
2678
class cmd_ignored(Command):
2925
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2679
    """List ignored files and the patterns that matched them.
2926
2680
 
2927
2681
    List all the ignored files and the ignore pattern that caused the file to
2928
2682
    be ignored.
2934
2688
 
2935
2689
    encoding_type = 'replace'
2936
2690
    _see_also = ['ignore', 'ls']
2937
 
    takes_options = ['directory']
2938
2691
 
2939
2692
    @display_command
2940
 
    def run(self, directory=u'.'):
2941
 
        tree = WorkingTree.open_containing(directory)[0]
2942
 
        self.add_cleanup(tree.lock_read().unlock)
 
2693
    def run(self):
 
2694
        tree = WorkingTree.open_containing(u'.')[0]
 
2695
        tree.lock_read()
 
2696
        self.add_cleanup(tree.unlock)
2943
2697
        for path, file_class, kind, file_id, entry in tree.list_files():
2944
2698
            if file_class != 'I':
2945
2699
                continue
2949
2703
 
2950
2704
 
2951
2705
class cmd_lookup_revision(Command):
2952
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2706
    """Lookup the revision-id from a revision-number
2953
2707
 
2954
2708
    :Examples:
2955
2709
        bzr lookup-revision 33
2956
2710
    """
2957
2711
    hidden = True
2958
2712
    takes_args = ['revno']
2959
 
    takes_options = ['directory']
2960
2713
 
2961
2714
    @display_command
2962
 
    def run(self, revno, directory=u'.'):
 
2715
    def run(self, revno):
2963
2716
        try:
2964
2717
            revno = int(revno)
2965
2718
        except ValueError:
2966
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2967
 
                                         % revno)
2968
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2969
 
        self.outf.write("%s\n" % revid)
 
2719
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2720
 
 
2721
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2970
2722
 
2971
2723
 
2972
2724
class cmd_export(Command):
2973
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2725
    """Export current or past revision to a destination directory or archive.
2974
2726
 
2975
2727
    If no revision is specified this exports the last committed revision.
2976
2728
 
2997
2749
         zip                          .zip
2998
2750
      =================       =========================
2999
2751
    """
3000
 
    encoding = 'exact'
3001
2752
    takes_args = ['dest', 'branch_or_subdir?']
3002
 
    takes_options = ['directory',
 
2753
    takes_options = [
3003
2754
        Option('format',
3004
2755
               help="Type of file to export to.",
3005
2756
               type=unicode),
3009
2760
        Option('root',
3010
2761
               type=str,
3011
2762
               help="Name of the root directory inside the exported file."),
3012
 
        Option('per-file-timestamps',
3013
 
               help='Set modification time of files to that of the last '
3014
 
                    'revision in which it was changed.'),
3015
2763
        ]
3016
2764
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3017
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2765
        root=None, filters=False):
3018
2766
        from bzrlib.export import export
3019
2767
 
3020
2768
        if branch_or_subdir is None:
3021
 
            tree = WorkingTree.open_containing(directory)[0]
 
2769
            tree = WorkingTree.open_containing(u'.')[0]
3022
2770
            b = tree.branch
3023
2771
            subdir = None
3024
2772
        else:
3027
2775
 
3028
2776
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
3029
2777
        try:
3030
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
3031
 
                   per_file_timestamps=per_file_timestamps)
 
2778
            export(rev_tree, dest, format, root, subdir, filtered=filters)
3032
2779
        except errors.NoSuchExportFormat, e:
3033
2780
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3034
2781
 
3035
2782
 
3036
2783
class cmd_cat(Command):
3037
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2784
    """Write the contents of a file as of a given revision to standard output.
3038
2785
 
3039
2786
    If no revision is nominated, the last revision is used.
3040
2787
 
3043
2790
    """
3044
2791
 
3045
2792
    _see_also = ['ls']
3046
 
    takes_options = ['directory',
 
2793
    takes_options = [
3047
2794
        Option('name-from-revision', help='The path name in the old tree.'),
3048
2795
        Option('filters', help='Apply content filters to display the '
3049
2796
                'convenience form.'),
3054
2801
 
3055
2802
    @display_command
3056
2803
    def run(self, filename, revision=None, name_from_revision=False,
3057
 
            filters=False, directory=None):
 
2804
            filters=False):
3058
2805
        if revision is not None and len(revision) != 1:
3059
2806
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
3060
2807
                                         " one revision specifier")
3061
2808
        tree, branch, relpath = \
3062
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
3063
 
        self.add_cleanup(branch.lock_read().unlock)
 
2809
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2810
        branch.lock_read()
 
2811
        self.add_cleanup(branch.unlock)
3064
2812
        return self._run(tree, branch, relpath, filename, revision,
3065
2813
                         name_from_revision, filters)
3066
2814
 
3069
2817
        if tree is None:
3070
2818
            tree = b.basis_tree()
3071
2819
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3072
 
        self.add_cleanup(rev_tree.lock_read().unlock)
3073
2820
 
3074
2821
        old_file_id = rev_tree.path2id(relpath)
3075
2822
 
3076
 
        # TODO: Split out this code to something that generically finds the
3077
 
        # best id for a path across one or more trees; it's like
3078
 
        # find_ids_across_trees but restricted to find just one. -- mbp
3079
 
        # 20110705.
3080
2823
        if name_from_revision:
3081
2824
            # Try in revision if requested
3082
2825
            if old_file_id is None:
3084
2827
                    "%r is not present in revision %s" % (
3085
2828
                        filename, rev_tree.get_revision_id()))
3086
2829
            else:
3087
 
                actual_file_id = old_file_id
 
2830
                content = rev_tree.get_file_text(old_file_id)
3088
2831
        else:
3089
2832
            cur_file_id = tree.path2id(relpath)
3090
 
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
3091
 
                actual_file_id = cur_file_id
3092
 
            elif old_file_id is not None:
3093
 
                actual_file_id = old_file_id
3094
 
            else:
 
2833
            found = False
 
2834
            if cur_file_id is not None:
 
2835
                # Then try with the actual file id
 
2836
                try:
 
2837
                    content = rev_tree.get_file_text(cur_file_id)
 
2838
                    found = True
 
2839
                except errors.NoSuchId:
 
2840
                    # The actual file id didn't exist at that time
 
2841
                    pass
 
2842
            if not found and old_file_id is not None:
 
2843
                # Finally try with the old file id
 
2844
                content = rev_tree.get_file_text(old_file_id)
 
2845
                found = True
 
2846
            if not found:
 
2847
                # Can't be found anywhere
3095
2848
                raise errors.BzrCommandError(
3096
2849
                    "%r is not present in revision %s" % (
3097
2850
                        filename, rev_tree.get_revision_id()))
3098
2851
        if filtered:
3099
 
            from bzrlib.filter_tree import ContentFilterTree
3100
 
            filter_tree = ContentFilterTree(rev_tree,
3101
 
                rev_tree._content_filter_stack)
3102
 
            content = filter_tree.get_file_text(actual_file_id)
 
2852
            from bzrlib.filters import (
 
2853
                ContentFilterContext,
 
2854
                filtered_output_bytes,
 
2855
                )
 
2856
            filters = rev_tree._content_filter_stack(relpath)
 
2857
            chunks = content.splitlines(True)
 
2858
            content = filtered_output_bytes(chunks, filters,
 
2859
                ContentFilterContext(relpath, rev_tree))
 
2860
            self.outf.writelines(content)
3103
2861
        else:
3104
 
            content = rev_tree.get_file_text(actual_file_id)
3105
 
        self.cleanup_now()
3106
 
        self.outf.write(content)
 
2862
            self.outf.write(content)
3107
2863
 
3108
2864
 
3109
2865
class cmd_local_time_offset(Command):
3110
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2866
    """Show the offset in seconds from GMT to local time."""
3111
2867
    hidden = True
3112
2868
    @display_command
3113
2869
    def run(self):
3114
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2870
        print osutils.local_time_offset()
3115
2871
 
3116
2872
 
3117
2873
 
3118
2874
class cmd_commit(Command):
3119
 
    __doc__ = """Commit changes into a new revision.
 
2875
    """Commit changes into a new revision.
3120
2876
 
3121
2877
    An explanatory message needs to be given for each commit. This is
3122
2878
    often done by using the --message option (getting the message from the
3170
2926
      to trigger updates to external systems like bug trackers. The --fixes
3171
2927
      option can be used to record the association between a revision and
3172
2928
      one or more bugs. See ``bzr help bugs`` for details.
 
2929
 
 
2930
      A selective commit may fail in some cases where the committed
 
2931
      tree would be invalid. Consider::
 
2932
  
 
2933
        bzr init foo
 
2934
        mkdir foo/bar
 
2935
        bzr add foo/bar
 
2936
        bzr commit foo -m "committing foo"
 
2937
        bzr mv foo/bar foo/baz
 
2938
        mkdir foo/bar
 
2939
        bzr add foo/bar
 
2940
        bzr commit foo/bar -m "committing bar but not baz"
 
2941
  
 
2942
      In the example above, the last commit will fail by design. This gives
 
2943
      the user the opportunity to decide whether they want to commit the
 
2944
      rename at the same time, separately first, or not at all. (As a general
 
2945
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
3173
2946
    """
 
2947
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2948
 
 
2949
    # TODO: Strict commit that fails if there are deleted files.
 
2950
    #       (what does "deleted files" mean ??)
 
2951
 
 
2952
    # TODO: Give better message for -s, --summary, used by tla people
 
2953
 
 
2954
    # XXX: verbose currently does nothing
3174
2955
 
3175
2956
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
3176
2957
    takes_args = ['selected*']
3205
2986
                         "the master branch until a normal commit "
3206
2987
                         "is performed."
3207
2988
                    ),
3208
 
             Option('show-diff', short_name='p',
 
2989
             Option('show-diff',
3209
2990
                    help='When no message is supplied, show the diff along'
3210
2991
                    ' with the status summary in the message editor.'),
3211
 
             Option('lossy', 
3212
 
                    help='When committing to a foreign version control '
3213
 
                    'system do not push data that can not be natively '
3214
 
                    'represented.'),
3215
2992
             ]
3216
2993
    aliases = ['ci', 'checkin']
3217
2994
 
3236
3013
 
3237
3014
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3238
3015
            unchanged=False, strict=False, local=False, fixes=None,
3239
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3240
 
            lossy=False):
 
3016
            author=None, show_diff=False, exclude=None, commit_time=None):
3241
3017
        from bzrlib.errors import (
3242
3018
            PointlessCommit,
3243
3019
            ConflictsInTree,
3246
3022
        from bzrlib.msgeditor import (
3247
3023
            edit_commit_message_encoded,
3248
3024
            generate_commit_message_template,
3249
 
            make_commit_message_template_encoded,
3250
 
            set_commit_message,
 
3025
            make_commit_message_template_encoded
3251
3026
        )
3252
3027
 
3253
3028
        commit_stamp = offset = None
3258
3033
                raise errors.BzrCommandError(
3259
3034
                    "Could not parse --commit-time: " + str(e))
3260
3035
 
 
3036
        # TODO: Need a blackbox test for invoking the external editor; may be
 
3037
        # slightly problematic to run this cross-platform.
 
3038
 
 
3039
        # TODO: do more checks that the commit will succeed before
 
3040
        # spending the user's valuable time typing a commit message.
 
3041
 
3261
3042
        properties = {}
3262
3043
 
3263
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3044
        tree, selected_list = tree_files(selected_list)
3264
3045
        if selected_list == ['']:
3265
3046
            # workaround - commit of root of tree should be exactly the same
3266
3047
            # as just default commit in that tree, and succeed even though
3291
3072
                    '(use --file "%(f)s" to take commit message from that file)'
3292
3073
                    % { 'f': message })
3293
3074
                ui.ui_factory.show_warning(warning_msg)
3294
 
            if '\r' in message:
3295
 
                message = message.replace('\r\n', '\n')
3296
 
                message = message.replace('\r', '\n')
3297
 
            if file:
3298
 
                raise errors.BzrCommandError(
3299
 
                    "please specify either --message or --file")
3300
3075
 
3301
3076
        def get_message(commit_obj):
3302
3077
            """Callback to get commit message"""
3303
 
            if file:
3304
 
                f = open(file)
3305
 
                try:
3306
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3307
 
                finally:
3308
 
                    f.close()
3309
 
            elif message is not None:
3310
 
                my_message = message
3311
 
            else:
3312
 
                # No message supplied: make one up.
3313
 
                # text is the status of the tree
3314
 
                text = make_commit_message_template_encoded(tree,
 
3078
            my_message = message
 
3079
            if my_message is not None and '\r' in my_message:
 
3080
                my_message = my_message.replace('\r\n', '\n')
 
3081
                my_message = my_message.replace('\r', '\n')
 
3082
            if my_message is None and not file:
 
3083
                t = make_commit_message_template_encoded(tree,
3315
3084
                        selected_list, diff=show_diff,
3316
3085
                        output_encoding=osutils.get_user_encoding())
3317
 
                # start_message is the template generated from hooks
3318
 
                # XXX: Warning - looks like hooks return unicode,
3319
 
                # make_commit_message_template_encoded returns user encoding.
3320
 
                # We probably want to be using edit_commit_message instead to
3321
 
                # avoid this.
3322
 
                my_message = set_commit_message(commit_obj)
3323
 
                if my_message is None:
3324
 
                    start_message = generate_commit_message_template(commit_obj)
3325
 
                    my_message = edit_commit_message_encoded(text,
3326
 
                        start_message=start_message)
 
3086
                start_message = generate_commit_message_template(commit_obj)
 
3087
                my_message = edit_commit_message_encoded(t,
 
3088
                    start_message=start_message)
3327
3089
                if my_message is None:
3328
3090
                    raise errors.BzrCommandError("please specify a commit"
3329
3091
                        " message with either --message or --file")
 
3092
            elif my_message and file:
 
3093
                raise errors.BzrCommandError(
 
3094
                    "please specify either --message or --file")
 
3095
            if file:
 
3096
                my_message = codecs.open(file, 'rt',
 
3097
                                         osutils.get_user_encoding()).read()
3330
3098
            if my_message == "":
3331
 
                raise errors.BzrCommandError("Empty commit message specified."
3332
 
                        " Please specify a commit message with either"
3333
 
                        " --message or --file or leave a blank message"
3334
 
                        " with --message \"\".")
 
3099
                raise errors.BzrCommandError("empty commit message specified")
3335
3100
            return my_message
3336
3101
 
3337
3102
        # The API permits a commit with a filter of [] to mean 'select nothing'
3345
3110
                        reporter=None, verbose=verbose, revprops=properties,
3346
3111
                        authors=author, timestamp=commit_stamp,
3347
3112
                        timezone=offset,
3348
 
                        exclude=tree.safe_relpath_files(exclude),
3349
 
                        lossy=lossy)
 
3113
                        exclude=safe_relpath_files(tree, exclude))
3350
3114
        except PointlessCommit:
 
3115
            # FIXME: This should really happen before the file is read in;
 
3116
            # perhaps prepare the commit; get the message; then actually commit
3351
3117
            raise errors.BzrCommandError("No changes to commit."
3352
 
                " Please 'bzr add' the files you want to commit, or use"
3353
 
                " --unchanged to force an empty commit.")
 
3118
                              " Use --unchanged to commit anyhow.")
3354
3119
        except ConflictsInTree:
3355
3120
            raise errors.BzrCommandError('Conflicts detected in working '
3356
3121
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3359
3124
            raise errors.BzrCommandError("Commit refused because there are"
3360
3125
                              " unknown files in the working tree.")
3361
3126
        except errors.BoundBranchOutOfDate, e:
3362
 
            e.extra_help = ("\n"
3363
 
                'To commit to master branch, run update and then commit.\n'
3364
 
                'You can also pass --local to commit to continue working '
3365
 
                'disconnected.')
3366
 
            raise
 
3127
            raise errors.BzrCommandError(str(e) + "\n"
 
3128
            'To commit to master branch, run update and then commit.\n'
 
3129
            'You can also pass --local to commit to continue working '
 
3130
            'disconnected.')
3367
3131
 
3368
3132
 
3369
3133
class cmd_check(Command):
3370
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3134
    """Validate working tree structure, branch consistency and repository history.
3371
3135
 
3372
3136
    This command checks various invariants about branch and repository storage
3373
3137
    to detect data corruption or bzr bugs.
3437
3201
 
3438
3202
 
3439
3203
class cmd_upgrade(Command):
3440
 
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3441
 
 
3442
 
    When the default format has changed after a major new release of
3443
 
    Bazaar, you may be informed during certain operations that you
3444
 
    should upgrade. Upgrading to a newer format may improve performance
3445
 
    or make new features available. It may however limit interoperability
3446
 
    with older repositories or with older versions of Bazaar.
3447
 
 
3448
 
    If you wish to upgrade to a particular format rather than the
3449
 
    current default, that can be specified using the --format option.
3450
 
    As a consequence, you can use the upgrade command this way to
3451
 
    "downgrade" to an earlier format, though some conversions are
3452
 
    a one way process (e.g. changing from the 1.x default to the
3453
 
    2.x default) so downgrading is not always possible.
3454
 
 
3455
 
    A backup.bzr.~#~ directory is created at the start of the conversion
3456
 
    process (where # is a number). By default, this is left there on
3457
 
    completion. If the conversion fails, delete the new .bzr directory
3458
 
    and rename this one back in its place. Use the --clean option to ask
3459
 
    for the backup.bzr directory to be removed on successful conversion.
3460
 
    Alternatively, you can delete it by hand if everything looks good
3461
 
    afterwards.
3462
 
 
3463
 
    If the location given is a shared repository, dependent branches
3464
 
    are also converted provided the repository converts successfully.
3465
 
    If the conversion of a branch fails, remaining branches are still
3466
 
    tried.
3467
 
 
3468
 
    For more information on upgrades, see the Bazaar Upgrade Guide,
3469
 
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
 
3204
    """Upgrade branch storage to current format.
 
3205
 
 
3206
    The check command or bzr developers may sometimes advise you to run
 
3207
    this command. When the default format has changed you may also be warned
 
3208
    during other operations to upgrade.
3470
3209
    """
3471
3210
 
3472
 
    _see_also = ['check', 'reconcile', 'formats']
 
3211
    _see_also = ['check']
3473
3212
    takes_args = ['url?']
3474
3213
    takes_options = [
3475
 
        RegistryOption('format',
3476
 
            help='Upgrade to a specific format.  See "bzr help'
3477
 
                 ' formats" for details.',
3478
 
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3479
 
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3480
 
            value_switches=True, title='Branch format'),
3481
 
        Option('clean',
3482
 
            help='Remove the backup.bzr directory if successful.'),
3483
 
        Option('dry-run',
3484
 
            help="Show what would be done, but don't actually do anything."),
3485
 
    ]
 
3214
                    RegistryOption('format',
 
3215
                        help='Upgrade to a specific format.  See "bzr help'
 
3216
                             ' formats" for details.',
 
3217
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3218
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3219
                        value_switches=True, title='Branch format'),
 
3220
                    ]
3486
3221
 
3487
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3222
    def run(self, url='.', format=None):
3488
3223
        from bzrlib.upgrade import upgrade
3489
 
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3490
 
        if exceptions:
3491
 
            if len(exceptions) == 1:
3492
 
                # Compatibility with historical behavior
3493
 
                raise exceptions[0]
3494
 
            else:
3495
 
                return 3
 
3224
        upgrade(url, format)
3496
3225
 
3497
3226
 
3498
3227
class cmd_whoami(Command):
3499
 
    __doc__ = """Show or set bzr user id.
 
3228
    """Show or set bzr user id.
3500
3229
 
3501
3230
    :Examples:
3502
3231
        Show the email of the current user::
3507
3236
 
3508
3237
            bzr whoami "Frank Chu <fchu@example.com>"
3509
3238
    """
3510
 
    takes_options = [ 'directory',
3511
 
                      Option('email',
 
3239
    takes_options = [ Option('email',
3512
3240
                             help='Display email address only.'),
3513
3241
                      Option('branch',
3514
3242
                             help='Set identity for the current branch instead of '
3518
3246
    encoding_type = 'replace'
3519
3247
 
3520
3248
    @display_command
3521
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3249
    def run(self, email=False, branch=False, name=None):
3522
3250
        if name is None:
3523
 
            if directory is None:
3524
 
                # use branch if we're inside one; otherwise global config
3525
 
                try:
3526
 
                    c = Branch.open_containing(u'.')[0].get_config()
3527
 
                except errors.NotBranchError:
3528
 
                    c = _mod_config.GlobalConfig()
3529
 
            else:
3530
 
                c = Branch.open(directory).get_config()
 
3251
            # use branch if we're inside one; otherwise global config
 
3252
            try:
 
3253
                c = Branch.open_containing('.')[0].get_config()
 
3254
            except errors.NotBranchError:
 
3255
                c = config.GlobalConfig()
3531
3256
            if email:
3532
3257
                self.outf.write(c.user_email() + '\n')
3533
3258
            else:
3534
3259
                self.outf.write(c.username() + '\n')
3535
3260
            return
3536
3261
 
3537
 
        if email:
3538
 
            raise errors.BzrCommandError("--email can only be used to display existing "
3539
 
                                         "identity")
3540
 
 
3541
3262
        # display a warning if an email address isn't included in the given name.
3542
3263
        try:
3543
 
            _mod_config.extract_email_address(name)
 
3264
            config.extract_email_address(name)
3544
3265
        except errors.NoEmailInUsername, e:
3545
3266
            warning('"%s" does not seem to contain an email address.  '
3546
3267
                    'This is allowed, but not recommended.', name)
3547
3268
 
3548
3269
        # use global config unless --branch given
3549
3270
        if branch:
3550
 
            if directory is None:
3551
 
                c = Branch.open_containing(u'.')[0].get_config()
3552
 
            else:
3553
 
                c = Branch.open(directory).get_config()
 
3271
            c = Branch.open_containing('.')[0].get_config()
3554
3272
        else:
3555
 
            c = _mod_config.GlobalConfig()
 
3273
            c = config.GlobalConfig()
3556
3274
        c.set_user_option('email', name)
3557
3275
 
3558
3276
 
3559
3277
class cmd_nick(Command):
3560
 
    __doc__ = """Print or set the branch nickname.
 
3278
    """Print or set the branch nickname.
3561
3279
 
3562
3280
    If unset, the tree root directory name is used as the nickname.
3563
3281
    To print the current nickname, execute with no argument.
3568
3286
 
3569
3287
    _see_also = ['info']
3570
3288
    takes_args = ['nickname?']
3571
 
    takes_options = ['directory']
3572
 
    def run(self, nickname=None, directory=u'.'):
3573
 
        branch = Branch.open_containing(directory)[0]
 
3289
    def run(self, nickname=None):
 
3290
        branch = Branch.open_containing(u'.')[0]
3574
3291
        if nickname is None:
3575
3292
            self.printme(branch)
3576
3293
        else:
3578
3295
 
3579
3296
    @display_command
3580
3297
    def printme(self, branch):
3581
 
        self.outf.write('%s\n' % branch.nick)
 
3298
        print branch.nick
3582
3299
 
3583
3300
 
3584
3301
class cmd_alias(Command):
3585
 
    __doc__ = """Set/unset and display aliases.
 
3302
    """Set/unset and display aliases.
3586
3303
 
3587
3304
    :Examples:
3588
3305
        Show the current aliases::
3625
3342
                'bzr alias --remove expects an alias to remove.')
3626
3343
        # If alias is not found, print something like:
3627
3344
        # unalias: foo: not found
3628
 
        c = _mod_config.GlobalConfig()
 
3345
        c = config.GlobalConfig()
3629
3346
        c.unset_alias(alias_name)
3630
3347
 
3631
3348
    @display_command
3632
3349
    def print_aliases(self):
3633
3350
        """Print out the defined aliases in a similar format to bash."""
3634
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3351
        aliases = config.GlobalConfig().get_aliases()
3635
3352
        for key, value in sorted(aliases.iteritems()):
3636
3353
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3637
3354
 
3647
3364
 
3648
3365
    def set_alias(self, alias_name, alias_command):
3649
3366
        """Save the alias in the global config."""
3650
 
        c = _mod_config.GlobalConfig()
 
3367
        c = config.GlobalConfig()
3651
3368
        c.set_alias(alias_name, alias_command)
3652
3369
 
3653
3370
 
3654
3371
class cmd_selftest(Command):
3655
 
    __doc__ = """Run internal test suite.
 
3372
    """Run internal test suite.
3656
3373
 
3657
3374
    If arguments are given, they are regular expressions that say which tests
3658
3375
    should run.  Tests matching any expression are run, and other tests are
3688
3405
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3689
3406
    into a pdb postmortem session.
3690
3407
 
3691
 
    The --coverage=DIRNAME global option produces a report with covered code
3692
 
    indicated.
3693
 
 
3694
3408
    :Examples:
3695
3409
        Run only tests relating to 'ignore'::
3696
3410
 
3705
3419
    def get_transport_type(typestring):
3706
3420
        """Parse and return a transport specifier."""
3707
3421
        if typestring == "sftp":
3708
 
            from bzrlib.tests import stub_sftp
3709
 
            return stub_sftp.SFTPAbsoluteServer
3710
 
        elif typestring == "memory":
3711
 
            from bzrlib.tests import test_server
3712
 
            return memory.MemoryServer
3713
 
        elif typestring == "fakenfs":
3714
 
            from bzrlib.tests import test_server
3715
 
            return test_server.FakeNFSServer
 
3422
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3423
            return SFTPAbsoluteServer
 
3424
        if typestring == "memory":
 
3425
            from bzrlib.transport.memory import MemoryServer
 
3426
            return MemoryServer
 
3427
        if typestring == "fakenfs":
 
3428
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3429
            return FakeNFSServer
3716
3430
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3717
3431
            (typestring)
3718
3432
        raise errors.BzrCommandError(msg)
3729
3443
                                 'throughout the test suite.',
3730
3444
                            type=get_transport_type),
3731
3445
                     Option('benchmark',
3732
 
                            help='Run the benchmarks rather than selftests.',
3733
 
                            hidden=True),
 
3446
                            help='Run the benchmarks rather than selftests.'),
3734
3447
                     Option('lsprof-timed',
3735
3448
                            help='Generate lsprof output for benchmarked'
3736
3449
                                 ' sections of code.'),
3737
3450
                     Option('lsprof-tests',
3738
3451
                            help='Generate lsprof output for each test.'),
 
3452
                     Option('cache-dir', type=str,
 
3453
                            help='Cache intermediate benchmark output in this '
 
3454
                                 'directory.'),
3739
3455
                     Option('first',
3740
3456
                            help='Run all tests, but run specified tests first.',
3741
3457
                            short_name='f',
3750
3466
                     Option('randomize', type=str, argname="SEED",
3751
3467
                            help='Randomize the order of tests using the given'
3752
3468
                                 ' seed or "now" for the current time.'),
3753
 
                     ListOption('exclude', type=str, argname="PATTERN",
3754
 
                                short_name='x',
3755
 
                                help='Exclude tests that match this regular'
3756
 
                                ' expression.'),
 
3469
                     Option('exclude', type=str, argname="PATTERN",
 
3470
                            short_name='x',
 
3471
                            help='Exclude tests that match this regular'
 
3472
                                 ' expression.'),
3757
3473
                     Option('subunit',
3758
3474
                        help='Output test progress via subunit.'),
3759
3475
                     Option('strict', help='Fail on missing dependencies or '
3775
3491
 
3776
3492
    def run(self, testspecs_list=None, verbose=False, one=False,
3777
3493
            transport=None, benchmark=None,
3778
 
            lsprof_timed=None,
 
3494
            lsprof_timed=None, cache_dir=None,
3779
3495
            first=False, list_only=False,
3780
3496
            randomize=None, exclude=None, strict=False,
3781
3497
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3782
3498
            parallel=None, lsprof_tests=False):
3783
 
        from bzrlib import tests
3784
 
 
 
3499
        from bzrlib.tests import selftest
 
3500
        import bzrlib.benchmarks as benchmarks
 
3501
        from bzrlib.benchmarks import tree_creator
 
3502
 
 
3503
        # Make deprecation warnings visible, unless -Werror is set
 
3504
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3505
 
 
3506
        if cache_dir is not None:
 
3507
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3785
3508
        if testspecs_list is not None:
3786
3509
            pattern = '|'.join(testspecs_list)
3787
3510
        else:
3793
3516
                raise errors.BzrCommandError("subunit not available. subunit "
3794
3517
                    "needs to be installed to use --subunit.")
3795
3518
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3796
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3797
 
            # stdout, which would corrupt the subunit stream. 
3798
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3799
 
            # following code can be deleted when it's sufficiently deployed
3800
 
            # -- vila/mgz 20100514
3801
 
            if (sys.platform == "win32"
3802
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3803
 
                import msvcrt
3804
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3805
3519
        if parallel:
3806
3520
            self.additional_selftest_args.setdefault(
3807
3521
                'suite_decorators', []).append(parallel)
3808
3522
        if benchmark:
3809
 
            raise errors.BzrCommandError(
3810
 
                "--benchmark is no longer supported from bzr 2.2; "
3811
 
                "use bzr-usertest instead")
3812
 
        test_suite_factory = None
3813
 
        if not exclude:
3814
 
            exclude_pattern = None
 
3523
            test_suite_factory = benchmarks.test_suite
 
3524
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3525
            verbose = not is_quiet()
 
3526
            # TODO: should possibly lock the history file...
 
3527
            benchfile = open(".perf_history", "at", buffering=1)
 
3528
            self.add_cleanup(benchfile.close)
3815
3529
        else:
3816
 
            exclude_pattern = '(' + '|'.join(exclude) + ')'
 
3530
            test_suite_factory = None
 
3531
            benchfile = None
3817
3532
        selftest_kwargs = {"verbose": verbose,
3818
3533
                          "pattern": pattern,
3819
3534
                          "stop_on_failure": one,
3821
3536
                          "test_suite_factory": test_suite_factory,
3822
3537
                          "lsprof_timed": lsprof_timed,
3823
3538
                          "lsprof_tests": lsprof_tests,
 
3539
                          "bench_history": benchfile,
3824
3540
                          "matching_tests_first": first,
3825
3541
                          "list_only": list_only,
3826
3542
                          "random_seed": randomize,
3827
 
                          "exclude_pattern": exclude_pattern,
 
3543
                          "exclude_pattern": exclude,
3828
3544
                          "strict": strict,
3829
3545
                          "load_list": load_list,
3830
3546
                          "debug_flags": debugflag,
3831
3547
                          "starting_with": starting_with
3832
3548
                          }
3833
3549
        selftest_kwargs.update(self.additional_selftest_args)
3834
 
 
3835
 
        # Make deprecation warnings visible, unless -Werror is set
3836
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3837
 
            override=False)
3838
 
        try:
3839
 
            result = tests.selftest(**selftest_kwargs)
3840
 
        finally:
3841
 
            cleanup()
 
3550
        result = selftest(**selftest_kwargs)
3842
3551
        return int(not result)
3843
3552
 
3844
3553
 
3845
3554
class cmd_version(Command):
3846
 
    __doc__ = """Show version of bzr."""
 
3555
    """Show version of bzr."""
3847
3556
 
3848
3557
    encoding_type = 'replace'
3849
3558
    takes_options = [
3860
3569
 
3861
3570
 
3862
3571
class cmd_rocks(Command):
3863
 
    __doc__ = """Statement of optimism."""
 
3572
    """Statement of optimism."""
3864
3573
 
3865
3574
    hidden = True
3866
3575
 
3867
3576
    @display_command
3868
3577
    def run(self):
3869
 
        self.outf.write("It sure does!\n")
 
3578
        print "It sure does!"
3870
3579
 
3871
3580
 
3872
3581
class cmd_find_merge_base(Command):
3873
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3582
    """Find and print a base revision for merging two branches."""
3874
3583
    # TODO: Options to specify revisions on either side, as if
3875
3584
    #       merging only part of the history.
3876
3585
    takes_args = ['branch', 'other']
3882
3591
 
3883
3592
        branch1 = Branch.open_containing(branch)[0]
3884
3593
        branch2 = Branch.open_containing(other)[0]
3885
 
        self.add_cleanup(branch1.lock_read().unlock)
3886
 
        self.add_cleanup(branch2.lock_read().unlock)
 
3594
        branch1.lock_read()
 
3595
        self.add_cleanup(branch1.unlock)
 
3596
        branch2.lock_read()
 
3597
        self.add_cleanup(branch2.unlock)
3887
3598
        last1 = ensure_null(branch1.last_revision())
3888
3599
        last2 = ensure_null(branch2.last_revision())
3889
3600
 
3890
3601
        graph = branch1.repository.get_graph(branch2.repository)
3891
3602
        base_rev_id = graph.find_unique_lca(last1, last2)
3892
3603
 
3893
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3604
        print 'merge base is revision %s' % base_rev_id
3894
3605
 
3895
3606
 
3896
3607
class cmd_merge(Command):
3897
 
    __doc__ = """Perform a three-way merge.
 
3608
    """Perform a three-way merge.
3898
3609
 
3899
3610
    The source of the merge can be specified either in the form of a branch,
3900
3611
    or in the form of a path to a file containing a merge directive generated
3901
3612
    with bzr send. If neither is specified, the default is the upstream branch
3902
 
    or the branch most recently merged using --remember.  The source of the
3903
 
    merge may also be specified in the form of a path to a file in another
3904
 
    branch:  in this case, only the modifications to that file are merged into
3905
 
    the current working tree.
3906
 
 
3907
 
    When merging from a branch, by default bzr will try to merge in all new
3908
 
    work from the other branch, automatically determining an appropriate base
3909
 
    revision.  If this fails, you may need to give an explicit base.
3910
 
 
3911
 
    To pick a different ending revision, pass "--revision OTHER".  bzr will
3912
 
    try to merge in all new work up to and including revision OTHER.
3913
 
 
3914
 
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
3915
 
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
3916
 
    causes some revisions to be skipped, i.e. if the destination branch does
3917
 
    not already contain revision BASE, such a merge is commonly referred to as
3918
 
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
3919
 
    cherrypicks. The changes look like a normal commit, and the history of the
3920
 
    changes from the other branch is not stored in the commit.
3921
 
 
3922
 
    Revision numbers are always relative to the source branch.
 
3613
    or the branch most recently merged using --remember.
 
3614
 
 
3615
    When merging a branch, by default the tip will be merged. To pick a different
 
3616
    revision, pass --revision. If you specify two values, the first will be used as
 
3617
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3618
    available revisions, like this is commonly referred to as "cherrypicking".
 
3619
 
 
3620
    Revision numbers are always relative to the branch being merged.
 
3621
 
 
3622
    By default, bzr will try to merge in all new work from the other
 
3623
    branch, automatically determining an appropriate base.  If this
 
3624
    fails, you may need to give an explicit base.
3923
3625
 
3924
3626
    Merge will do its best to combine the changes in two branches, but there
3925
3627
    are some kinds of problems only a human can fix.  When it encounters those,
3928
3630
 
3929
3631
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3930
3632
 
3931
 
    If there is no default branch set, the first merge will set it (use
3932
 
    --no-remember to avoid settting it). After that, you can omit the branch
3933
 
    to use the default.  To change the default, use --remember. The value will
3934
 
    only be saved if the remote location can be accessed.
 
3633
    If there is no default branch set, the first merge will set it. After
 
3634
    that, you can omit the branch to use the default.  To change the
 
3635
    default, use --remember. The value will only be saved if the remote
 
3636
    location can be accessed.
3935
3637
 
3936
3638
    The results of the merge are placed into the destination working
3937
3639
    directory, where they can be reviewed (with bzr diff), tested, and then
3938
3640
    committed to record the result of the merge.
3939
3641
 
3940
3642
    merge refuses to run if there are any uncommitted changes, unless
3941
 
    --force is given.  If --force is given, then the changes from the source 
3942
 
    will be merged with the current working tree, including any uncommitted
3943
 
    changes in the tree.  The --force option can also be used to create a
3944
 
    merge revision which has more than two parents.
3945
 
 
3946
 
    If one would like to merge changes from the working tree of the other
3947
 
    branch without merging any committed revisions, the --uncommitted option
3948
 
    can be given.
 
3643
    --force is given.
3949
3644
 
3950
3645
    To select only some changes to merge, use "merge -i", which will prompt
3951
3646
    you to apply each diff hunk and file change, similar to "shelve".
3952
3647
 
3953
3648
    :Examples:
3954
 
        To merge all new revisions from bzr.dev::
 
3649
        To merge the latest revision from bzr.dev::
3955
3650
 
3956
3651
            bzr merge ../bzr.dev
3957
3652
 
3966
3661
        To apply a merge directive contained in /tmp/merge::
3967
3662
 
3968
3663
            bzr merge /tmp/merge
3969
 
 
3970
 
        To create a merge revision with three parents from two branches
3971
 
        feature1a and feature1b:
3972
 
 
3973
 
            bzr merge ../feature1a
3974
 
            bzr merge ../feature1b --force
3975
 
            bzr commit -m 'revision with three parents'
3976
3664
    """
3977
3665
 
3978
3666
    encoding_type = 'exact'
3994
3682
                ' completely merged into the source, pull from the'
3995
3683
                ' source rather than merging.  When this happens,'
3996
3684
                ' you do not need to commit the result.'),
3997
 
        custom_help('directory',
 
3685
        Option('directory',
3998
3686
               help='Branch to merge into, '
3999
 
                    'rather than the one containing the working directory.'),
 
3687
                    'rather than the one containing the working directory.',
 
3688
               short_name='d',
 
3689
               type=unicode,
 
3690
               ),
4000
3691
        Option('preview', help='Instead of merging, show a diff of the'
4001
3692
               ' merge.'),
4002
3693
        Option('interactive', help='Select changes interactively.',
4004
3695
    ]
4005
3696
 
4006
3697
    def run(self, location=None, revision=None, force=False,
4007
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
3698
            merge_type=None, show_base=False, reprocess=None, remember=False,
4008
3699
            uncommitted=False, pull=False,
4009
3700
            directory=None,
4010
3701
            preview=False,
4018
3709
        merger = None
4019
3710
        allow_pending = True
4020
3711
        verified = 'inapplicable'
4021
 
 
4022
3712
        tree = WorkingTree.open_containing(directory)[0]
4023
 
        if tree.branch.revno() == 0:
4024
 
            raise errors.BzrCommandError('Merging into empty branches not currently supported, '
4025
 
                                         'https://bugs.launchpad.net/bzr/+bug/308562')
4026
3713
 
4027
3714
        try:
4028
3715
            basis_tree = tree.revision_tree(tree.last_revision())
4039
3726
            unversioned_filter=tree.is_ignored, view_info=view_info)
4040
3727
        pb = ui.ui_factory.nested_progress_bar()
4041
3728
        self.add_cleanup(pb.finished)
4042
 
        self.add_cleanup(tree.lock_write().unlock)
 
3729
        tree.lock_write()
 
3730
        self.add_cleanup(tree.unlock)
4043
3731
        if location is not None:
4044
3732
            try:
4045
3733
                mergeable = bundle.read_mergeable_from_url(location,
4055
3743
                    raise errors.BzrCommandError(
4056
3744
                        'Cannot use -r with merge directives or bundles')
4057
3745
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
4058
 
                   mergeable, None)
 
3746
                   mergeable, pb)
4059
3747
 
4060
3748
        if merger is None and uncommitted:
4061
3749
            if revision is not None and len(revision) > 0:
4062
3750
                raise errors.BzrCommandError('Cannot use --uncommitted and'
4063
3751
                    ' --revision at the same time.')
4064
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3752
            merger = self.get_merger_from_uncommitted(tree, location, pb)
4065
3753
            allow_pending = False
4066
3754
 
4067
3755
        if merger is None:
4068
3756
            merger, allow_pending = self._get_merger_from_branch(tree,
4069
 
                location, revision, remember, possible_transports, None)
 
3757
                location, revision, remember, possible_transports, pb)
4070
3758
 
4071
3759
        merger.merge_type = merge_type
4072
3760
        merger.reprocess = reprocess
4074
3762
        self.sanity_check_merger(merger)
4075
3763
        if (merger.base_rev_id == merger.other_rev_id and
4076
3764
            merger.other_rev_id is not None):
4077
 
            # check if location is a nonexistent file (and not a branch) to
4078
 
            # disambiguate the 'Nothing to do'
4079
 
            if merger.interesting_files:
4080
 
                if not merger.other_tree.has_filename(
4081
 
                    merger.interesting_files[0]):
4082
 
                    note("merger: " + str(merger))
4083
 
                    raise errors.PathsDoNotExist([location])
4084
3765
            note('Nothing to do.')
4085
3766
            return 0
4086
 
        if pull and not preview:
 
3767
        if pull:
4087
3768
            if merger.interesting_files is not None:
4088
3769
                raise errors.BzrCommandError('Cannot pull individual files')
4089
3770
            if (merger.base_rev_id == tree.last_revision()):
4113
3794
    def _do_preview(self, merger):
4114
3795
        from bzrlib.diff import show_diff_trees
4115
3796
        result_tree = self._get_preview(merger)
4116
 
        path_encoding = osutils.get_diff_header_encoding()
4117
3797
        show_diff_trees(merger.this_tree, result_tree, self.outf,
4118
 
                        old_label='', new_label='',
4119
 
                        path_encoding=path_encoding)
 
3798
                        old_label='', new_label='')
4120
3799
 
4121
3800
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4122
3801
        merger.change_reporter = change_reporter
4198
3877
        if other_revision_id is None:
4199
3878
            other_revision_id = _mod_revision.ensure_null(
4200
3879
                other_branch.last_revision())
4201
 
        # Remember where we merge from. We need to remember if:
4202
 
        # - user specify a location (and we don't merge from the parent
4203
 
        #   branch)
4204
 
        # - user ask to remember or there is no previous location set to merge
4205
 
        #   from and user didn't ask to *not* remember
4206
 
        if (user_location is not None
4207
 
            and ((remember
4208
 
                  or (remember is None
4209
 
                      and tree.branch.get_submit_branch() is None)))):
 
3880
        # Remember where we merge from
 
3881
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3882
             user_location is not None):
4210
3883
            tree.branch.set_submit_branch(other_branch.base)
4211
 
        # Merge tags (but don't set them in the master branch yet, the user
4212
 
        # might revert this merge).  Commit will propagate them.
4213
 
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
3884
        _merge_tags_if_possible(other_branch, tree.branch)
4214
3885
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4215
3886
            other_revision_id, base_revision_id, other_branch, base_branch)
4216
3887
        if other_path != '':
4283
3954
 
4284
3955
 
4285
3956
class cmd_remerge(Command):
4286
 
    __doc__ = """Redo a merge.
 
3957
    """Redo a merge.
4287
3958
 
4288
3959
    Use this if you want to try a different merge technique while resolving
4289
3960
    conflicts.  Some merge techniques are better than others, and remerge
4314
3985
 
4315
3986
    def run(self, file_list=None, merge_type=None, show_base=False,
4316
3987
            reprocess=False):
4317
 
        from bzrlib.conflicts import restore
4318
3988
        if merge_type is None:
4319
3989
            merge_type = _mod_merge.Merge3Merger
4320
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4321
 
        self.add_cleanup(tree.lock_write().unlock)
 
3990
        tree, file_list = tree_files(file_list)
 
3991
        tree.lock_write()
 
3992
        self.add_cleanup(tree.unlock)
4322
3993
        parents = tree.get_parent_ids()
4323
3994
        if len(parents) != 2:
4324
3995
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4360
4031
        # list, we imply that the working tree text has seen and rejected
4361
4032
        # all the changes from the other tree, when in fact those changes
4362
4033
        # have not yet been seen.
 
4034
        pb = ui.ui_factory.nested_progress_bar()
4363
4035
        tree.set_parent_ids(parents[:1])
4364
4036
        try:
4365
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4037
            merger = _mod_merge.Merger.from_revision_ids(pb,
 
4038
                                                         tree, parents[1])
4366
4039
            merger.interesting_ids = interesting_ids
4367
4040
            merger.merge_type = merge_type
4368
4041
            merger.show_base = show_base
4370
4043
            conflicts = merger.do_merge()
4371
4044
        finally:
4372
4045
            tree.set_parent_ids(parents)
 
4046
            pb.finished()
4373
4047
        if conflicts > 0:
4374
4048
            return 1
4375
4049
        else:
4377
4051
 
4378
4052
 
4379
4053
class cmd_revert(Command):
4380
 
    __doc__ = """Revert files to a previous revision.
 
4054
    """Revert files to a previous revision.
4381
4055
 
4382
4056
    Giving a list of files will revert only those files.  Otherwise, all files
4383
4057
    will be reverted.  If the revision is not specified with '--revision', the
4384
4058
    last committed revision is used.
4385
4059
 
4386
4060
    To remove only some changes, without reverting to a prior version, use
4387
 
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
4388
 
    will remove the changes introduced by the second last commit (-2), without
4389
 
    affecting the changes introduced by the last commit (-1).  To remove
4390
 
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
4061
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
4062
    changes introduced by -2, without affecting the changes introduced by -1.
 
4063
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4391
4064
 
4392
4065
    By default, any files that have been manually changed will be backed up
4393
4066
    first.  (Files changed only by merge are not backed up.)  Backup files have
4403
4076
    created as above.  Directories containing unknown files will not be
4404
4077
    deleted.
4405
4078
 
4406
 
    The working tree contains a list of revisions that have been merged but
4407
 
    not yet committed. These revisions will be included as additional parents
4408
 
    of the next commit.  Normally, using revert clears that list as well as
4409
 
    reverting the files.  If any files are specified, revert leaves the list
4410
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4411
 
    .`` in the tree root to revert all files but keep the recorded merges,
4412
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4079
    The working tree contains a list of pending merged revisions, which will
 
4080
    be included as parents in the next commit.  Normally, revert clears that
 
4081
    list as well as reverting the files.  If any files are specified, revert
 
4082
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4083
    revert ." in the tree root to revert all files but keep the merge record,
 
4084
    and "bzr revert --forget-merges" to clear the pending merge list without
4413
4085
    reverting any files.
4414
4086
 
4415
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4416
 
    changes from a branch in a single revision.  To do this, perform the merge
4417
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4418
 
    the content of the tree as it was, but it will clear the list of pending
4419
 
    merges.  The next commit will then contain all of the changes that are
4420
 
    present in the other branch, but without any other parent revisions.
4421
 
    Because this technique forgets where these changes originated, it may
4422
 
    cause additional conflicts on later merges involving the same source and
 
4087
    Using "bzr revert --forget-merges", it is possible to apply the changes
 
4088
    from an arbitrary merge as a single revision.  To do this, perform the
 
4089
    merge as desired.  Then doing revert with the "--forget-merges" option will
 
4090
    keep the content of the tree as it was, but it will clear the list of
 
4091
    pending merges.  The next commit will then contain all of the changes that
 
4092
    would have been in the merge, but without any mention of the other parent
 
4093
    revisions.  Because this technique forgets where these changes originated,
 
4094
    it may cause additional conflicts on later merges involving the source and
4423
4095
    target branches.
4424
4096
    """
4425
4097
 
4426
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4098
    _see_also = ['cat', 'export']
4427
4099
    takes_options = [
4428
4100
        'revision',
4429
4101
        Option('no-backup', "Do not save backups of reverted files."),
4434
4106
 
4435
4107
    def run(self, revision=None, no_backup=False, file_list=None,
4436
4108
            forget_merges=None):
4437
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4438
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4109
        tree, file_list = tree_files(file_list)
 
4110
        tree.lock_write()
 
4111
        self.add_cleanup(tree.unlock)
4439
4112
        if forget_merges:
4440
4113
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4441
4114
        else:
4444
4117
    @staticmethod
4445
4118
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4446
4119
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4447
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4448
 
            report_changes=True)
 
4120
        pb = ui.ui_factory.nested_progress_bar()
 
4121
        try:
 
4122
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4123
                report_changes=True)
 
4124
        finally:
 
4125
            pb.finished()
4449
4126
 
4450
4127
 
4451
4128
class cmd_assert_fail(Command):
4452
 
    __doc__ = """Test reporting of assertion failures"""
 
4129
    """Test reporting of assertion failures"""
4453
4130
    # intended just for use in testing
4454
4131
 
4455
4132
    hidden = True
4459
4136
 
4460
4137
 
4461
4138
class cmd_help(Command):
4462
 
    __doc__ = """Show help on a command or other topic.
 
4139
    """Show help on a command or other topic.
4463
4140
    """
4464
4141
 
4465
4142
    _see_also = ['topics']
4478
4155
 
4479
4156
 
4480
4157
class cmd_shell_complete(Command):
4481
 
    __doc__ = """Show appropriate completions for context.
 
4158
    """Show appropriate completions for context.
4482
4159
 
4483
4160
    For a list of all available commands, say 'bzr shell-complete'.
4484
4161
    """
4493
4170
 
4494
4171
 
4495
4172
class cmd_missing(Command):
4496
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4173
    """Show unmerged/unpulled revisions between two branches.
4497
4174
 
4498
4175
    OTHER_BRANCH may be local or remote.
4499
4176
 
4530
4207
    _see_also = ['merge', 'pull']
4531
4208
    takes_args = ['other_branch?']
4532
4209
    takes_options = [
4533
 
        'directory',
4534
4210
        Option('reverse', 'Reverse the order of revisions.'),
4535
4211
        Option('mine-only',
4536
4212
               'Display changes in the local branch only.'),
4558
4234
            theirs_only=False,
4559
4235
            log_format=None, long=False, short=False, line=False,
4560
4236
            show_ids=False, verbose=False, this=False, other=False,
4561
 
            include_merges=False, revision=None, my_revision=None,
4562
 
            directory=u'.'):
 
4237
            include_merges=False, revision=None, my_revision=None):
4563
4238
        from bzrlib.missing import find_unmerged, iter_log_revisions
4564
4239
        def message(s):
4565
4240
            if not is_quiet():
4578
4253
        elif theirs_only:
4579
4254
            restrict = 'remote'
4580
4255
 
4581
 
        local_branch = Branch.open_containing(directory)[0]
4582
 
        self.add_cleanup(local_branch.lock_read().unlock)
4583
 
 
 
4256
        local_branch = Branch.open_containing(u".")[0]
4584
4257
        parent = local_branch.get_parent()
4585
4258
        if other_branch is None:
4586
4259
            other_branch = parent
4595
4268
        remote_branch = Branch.open(other_branch)
4596
4269
        if remote_branch.base == local_branch.base:
4597
4270
            remote_branch = local_branch
4598
 
        else:
4599
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4600
4271
 
 
4272
        local_branch.lock_read()
 
4273
        self.add_cleanup(local_branch.unlock)
4601
4274
        local_revid_range = _revision_range_to_revid_range(
4602
4275
            _get_revision_range(my_revision, local_branch,
4603
4276
                self.name()))
4604
4277
 
 
4278
        remote_branch.lock_read()
 
4279
        self.add_cleanup(remote_branch.unlock)
4605
4280
        remote_revid_range = _revision_range_to_revid_range(
4606
4281
            _get_revision_range(revision,
4607
4282
                remote_branch, self.name()))
4657
4332
            message("Branches are up to date.\n")
4658
4333
        self.cleanup_now()
4659
4334
        if not status_code and parent is None and other_branch is not None:
4660
 
            self.add_cleanup(local_branch.lock_write().unlock)
 
4335
            local_branch.lock_write()
 
4336
            self.add_cleanup(local_branch.unlock)
4661
4337
            # handle race conditions - a parent might be set while we run.
4662
4338
            if local_branch.get_parent() is None:
4663
4339
                local_branch.set_parent(remote_branch.base)
4665
4341
 
4666
4342
 
4667
4343
class cmd_pack(Command):
4668
 
    __doc__ = """Compress the data within a repository.
4669
 
 
4670
 
    This operation compresses the data within a bazaar repository. As
4671
 
    bazaar supports automatic packing of repository, this operation is
4672
 
    normally not required to be done manually.
4673
 
 
4674
 
    During the pack operation, bazaar takes a backup of existing repository
4675
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4676
 
    automatically when it is safe to do so. To save disk space by removing
4677
 
    the backed up pack files, the --clean-obsolete-packs option may be
4678
 
    used.
4679
 
 
4680
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4681
 
    during or immediately after repacking, you may be left with a state
4682
 
    where the deletion has been written to disk but the new packs have not
4683
 
    been. In this case the repository may be unusable.
4684
 
    """
 
4344
    """Compress the data within a repository."""
4685
4345
 
4686
4346
    _see_also = ['repositories']
4687
4347
    takes_args = ['branch_or_repo?']
4688
 
    takes_options = [
4689
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4690
 
        ]
4691
4348
 
4692
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4349
    def run(self, branch_or_repo='.'):
4693
4350
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4694
4351
        try:
4695
4352
            branch = dir.open_branch()
4696
4353
            repository = branch.repository
4697
4354
        except errors.NotBranchError:
4698
4355
            repository = dir.open_repository()
4699
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4356
        repository.pack()
4700
4357
 
4701
4358
 
4702
4359
class cmd_plugins(Command):
4703
 
    __doc__ = """List the installed plugins.
 
4360
    """List the installed plugins.
4704
4361
 
4705
4362
    This command displays the list of installed plugins including
4706
4363
    version of plugin and a short description of each.
4713
4370
    adding new commands, providing additional network transports and
4714
4371
    customizing log output.
4715
4372
 
4716
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4717
 
    for further information on plugins including where to find them and how to
4718
 
    install them. Instructions are also provided there on how to write new
4719
 
    plugins using the Python programming language.
 
4373
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4374
    information on plugins including where to find them and how to
 
4375
    install them. Instructions are also provided there on how to
 
4376
    write new plugins using the Python programming language.
4720
4377
    """
4721
4378
    takes_options = ['verbose']
4722
4379
 
4723
4380
    @display_command
4724
4381
    def run(self, verbose=False):
4725
 
        from bzrlib import plugin
4726
 
        # Don't give writelines a generator as some codecs don't like that
4727
 
        self.outf.writelines(
4728
 
            list(plugin.describe_plugins(show_paths=verbose)))
 
4382
        import bzrlib.plugin
 
4383
        from inspect import getdoc
 
4384
        result = []
 
4385
        for name, plugin in bzrlib.plugin.plugins().items():
 
4386
            version = plugin.__version__
 
4387
            if version == 'unknown':
 
4388
                version = ''
 
4389
            name_ver = '%s %s' % (name, version)
 
4390
            d = getdoc(plugin.module)
 
4391
            if d:
 
4392
                doc = d.split('\n')[0]
 
4393
            else:
 
4394
                doc = '(no description)'
 
4395
            result.append((name_ver, doc, plugin.path()))
 
4396
        for name_ver, doc, path in sorted(result):
 
4397
            print name_ver
 
4398
            print '   ', doc
 
4399
            if verbose:
 
4400
                print '   ', path
 
4401
            print
4729
4402
 
4730
4403
 
4731
4404
class cmd_testament(Command):
4732
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4405
    """Show testament (signing-form) of a revision."""
4733
4406
    takes_options = [
4734
4407
            'revision',
4735
4408
            Option('long', help='Produce long-format testament.'),
4747
4420
            b = Branch.open_containing(branch)[0]
4748
4421
        else:
4749
4422
            b = Branch.open(branch)
4750
 
        self.add_cleanup(b.lock_read().unlock)
 
4423
        b.lock_read()
 
4424
        self.add_cleanup(b.unlock)
4751
4425
        if revision is None:
4752
4426
            rev_id = b.last_revision()
4753
4427
        else:
4760
4434
 
4761
4435
 
4762
4436
class cmd_annotate(Command):
4763
 
    __doc__ = """Show the origin of each line in a file.
 
4437
    """Show the origin of each line in a file.
4764
4438
 
4765
4439
    This prints out the given file with an annotation on the left side
4766
4440
    indicating which revision, author and date introduced the change.
4777
4451
                     Option('long', help='Show commit date in annotations.'),
4778
4452
                     'revision',
4779
4453
                     'show-ids',
4780
 
                     'directory',
4781
4454
                     ]
4782
4455
    encoding_type = 'exact'
4783
4456
 
4784
4457
    @display_command
4785
4458
    def run(self, filename, all=False, long=False, revision=None,
4786
 
            show_ids=False, directory=None):
4787
 
        from bzrlib.annotate import (
4788
 
            annotate_file_tree,
4789
 
            )
 
4459
            show_ids=False):
 
4460
        from bzrlib.annotate import annotate_file, annotate_file_tree
4790
4461
        wt, branch, relpath = \
4791
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4462
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4792
4463
        if wt is not None:
4793
 
            self.add_cleanup(wt.lock_read().unlock)
 
4464
            wt.lock_read()
 
4465
            self.add_cleanup(wt.unlock)
4794
4466
        else:
4795
 
            self.add_cleanup(branch.lock_read().unlock)
 
4467
            branch.lock_read()
 
4468
            self.add_cleanup(branch.unlock)
4796
4469
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4797
 
        self.add_cleanup(tree.lock_read().unlock)
4798
 
        if wt is not None and revision is None:
 
4470
        tree.lock_read()
 
4471
        self.add_cleanup(tree.unlock)
 
4472
        if wt is not None:
4799
4473
            file_id = wt.path2id(relpath)
4800
4474
        else:
4801
4475
            file_id = tree.path2id(relpath)
4802
4476
        if file_id is None:
4803
4477
            raise errors.NotVersionedError(filename)
 
4478
        file_version = tree.inventory[file_id].revision
4804
4479
        if wt is not None and revision is None:
4805
4480
            # If there is a tree and we're not annotating historical
4806
4481
            # versions, annotate the working tree's content.
4807
4482
            annotate_file_tree(wt, file_id, self.outf, long, all,
4808
4483
                show_ids=show_ids)
4809
4484
        else:
4810
 
            annotate_file_tree(tree, file_id, self.outf, long, all,
4811
 
                show_ids=show_ids, branch=branch)
 
4485
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4486
                          show_ids=show_ids)
4812
4487
 
4813
4488
 
4814
4489
class cmd_re_sign(Command):
4815
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4490
    """Create a digital signature for an existing revision."""
4816
4491
    # TODO be able to replace existing ones.
4817
4492
 
4818
4493
    hidden = True # is this right ?
4819
4494
    takes_args = ['revision_id*']
4820
 
    takes_options = ['directory', 'revision']
 
4495
    takes_options = ['revision']
4821
4496
 
4822
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4497
    def run(self, revision_id_list=None, revision=None):
4823
4498
        if revision_id_list is not None and revision is not None:
4824
4499
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4825
4500
        if revision_id_list is None and revision is None:
4826
4501
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4827
 
        b = WorkingTree.open_containing(directory)[0].branch
4828
 
        self.add_cleanup(b.lock_write().unlock)
 
4502
        b = WorkingTree.open_containing(u'.')[0].branch
 
4503
        b.lock_write()
 
4504
        self.add_cleanup(b.unlock)
4829
4505
        return self._run(b, revision_id_list, revision)
4830
4506
 
4831
4507
    def _run(self, b, revision_id_list, revision):
4877
4553
 
4878
4554
 
4879
4555
class cmd_bind(Command):
4880
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4881
 
    If no branch is supplied, rebind to the last bound location.
 
4556
    """Convert the current branch into a checkout of the supplied branch.
4882
4557
 
4883
4558
    Once converted into a checkout, commits must succeed on the master branch
4884
4559
    before they will be applied to the local branch.
4890
4565
 
4891
4566
    _see_also = ['checkouts', 'unbind']
4892
4567
    takes_args = ['location?']
4893
 
    takes_options = ['directory']
 
4568
    takes_options = []
4894
4569
 
4895
 
    def run(self, location=None, directory=u'.'):
4896
 
        b, relpath = Branch.open_containing(directory)
 
4570
    def run(self, location=None):
 
4571
        b, relpath = Branch.open_containing(u'.')
4897
4572
        if location is None:
4898
4573
            try:
4899
4574
                location = b.get_old_bound_location()
4902
4577
                    'This format does not remember old locations.')
4903
4578
            else:
4904
4579
                if location is None:
4905
 
                    if b.get_bound_location() is not None:
4906
 
                        raise errors.BzrCommandError('Branch is already bound')
4907
 
                    else:
4908
 
                        raise errors.BzrCommandError('No location supplied '
4909
 
                            'and no previous location known')
 
4580
                    raise errors.BzrCommandError('No location supplied and no '
 
4581
                        'previous location known')
4910
4582
        b_other = Branch.open(location)
4911
4583
        try:
4912
4584
            b.bind(b_other)
4918
4590
 
4919
4591
 
4920
4592
class cmd_unbind(Command):
4921
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4593
    """Convert the current checkout into a regular branch.
4922
4594
 
4923
4595
    After unbinding, the local branch is considered independent and subsequent
4924
4596
    commits will be local only.
4926
4598
 
4927
4599
    _see_also = ['checkouts', 'bind']
4928
4600
    takes_args = []
4929
 
    takes_options = ['directory']
 
4601
    takes_options = []
4930
4602
 
4931
 
    def run(self, directory=u'.'):
4932
 
        b, relpath = Branch.open_containing(directory)
 
4603
    def run(self):
 
4604
        b, relpath = Branch.open_containing(u'.')
4933
4605
        if not b.unbind():
4934
4606
            raise errors.BzrCommandError('Local branch is not bound')
4935
4607
 
4936
4608
 
4937
4609
class cmd_uncommit(Command):
4938
 
    __doc__ = """Remove the last committed revision.
 
4610
    """Remove the last committed revision.
4939
4611
 
4940
4612
    --verbose will print out what is being removed.
4941
4613
    --dry-run will go through all the motions, but not actually
4981
4653
            b = control.open_branch()
4982
4654
 
4983
4655
        if tree is not None:
4984
 
            self.add_cleanup(tree.lock_write().unlock)
 
4656
            tree.lock_write()
 
4657
            self.add_cleanup(tree.unlock)
4985
4658
        else:
4986
 
            self.add_cleanup(b.lock_write().unlock)
 
4659
            b.lock_write()
 
4660
            self.add_cleanup(b.unlock)
4987
4661
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4988
4662
 
4989
4663
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
5022
4696
                 end_revision=last_revno)
5023
4697
 
5024
4698
        if dry_run:
5025
 
            self.outf.write('Dry-run, pretending to remove'
5026
 
                            ' the above revisions.\n')
 
4699
            print 'Dry-run, pretending to remove the above revisions.'
 
4700
            if not force:
 
4701
                val = raw_input('Press <enter> to continue')
5027
4702
        else:
5028
 
            self.outf.write('The above revision(s) will be removed.\n')
5029
 
 
5030
 
        if not force:
5031
 
            if not ui.ui_factory.confirm_action(
5032
 
                    u'Uncommit these revisions',
5033
 
                    'bzrlib.builtins.uncommit',
5034
 
                    {}):
5035
 
                self.outf.write('Canceled\n')
5036
 
                return 0
 
4703
            print 'The above revision(s) will be removed.'
 
4704
            if not force:
 
4705
                val = raw_input('Are you sure [y/N]? ')
 
4706
                if val.lower() not in ('y', 'yes'):
 
4707
                    print 'Canceled'
 
4708
                    return 0
5037
4709
 
5038
4710
        mutter('Uncommitting from {%s} to {%s}',
5039
4711
               last_rev_id, rev_id)
5040
4712
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
5041
4713
                 revno=revno, local=local)
5042
 
        self.outf.write('You can restore the old tip by running:\n'
5043
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4714
        note('You can restore the old tip by running:\n'
 
4715
             '  bzr pull . -r revid:%s', last_rev_id)
5044
4716
 
5045
4717
 
5046
4718
class cmd_break_lock(Command):
5047
 
    __doc__ = """Break a dead lock.
5048
 
 
5049
 
    This command breaks a lock on a repository, branch, working directory or
5050
 
    config file.
 
4719
    """Break a dead lock on a repository, branch or working directory.
5051
4720
 
5052
4721
    CAUTION: Locks should only be broken when you are sure that the process
5053
4722
    holding the lock has been stopped.
5054
4723
 
5055
 
    You can get information on what locks are open via the 'bzr info
5056
 
    [location]' command.
 
4724
    You can get information on what locks are open via the 'bzr info' command.
5057
4725
 
5058
4726
    :Examples:
5059
4727
        bzr break-lock
5060
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
5061
 
        bzr break-lock --conf ~/.bazaar
5062
4728
    """
5063
 
 
5064
4729
    takes_args = ['location?']
5065
 
    takes_options = [
5066
 
        Option('config',
5067
 
               help='LOCATION is the directory where the config lock is.'),
5068
 
        Option('force',
5069
 
            help='Do not ask for confirmation before breaking the lock.'),
5070
 
        ]
5071
4730
 
5072
 
    def run(self, location=None, config=False, force=False):
 
4731
    def run(self, location=None, show=False):
5073
4732
        if location is None:
5074
4733
            location = u'.'
5075
 
        if force:
5076
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
5077
 
                None,
5078
 
                {'bzrlib.lockdir.break': True})
5079
 
        if config:
5080
 
            conf = _mod_config.LockableConfig(file_name=location)
5081
 
            conf.break_lock()
5082
 
        else:
5083
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
5084
 
            try:
5085
 
                control.break_lock()
5086
 
            except NotImplementedError:
5087
 
                pass
 
4734
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4735
        try:
 
4736
            control.break_lock()
 
4737
        except NotImplementedError:
 
4738
            pass
5088
4739
 
5089
4740
 
5090
4741
class cmd_wait_until_signalled(Command):
5091
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4742
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5092
4743
 
5093
4744
    This just prints a line to signal when it is ready, then blocks on stdin.
5094
4745
    """
5102
4753
 
5103
4754
 
5104
4755
class cmd_serve(Command):
5105
 
    __doc__ = """Run the bzr server."""
 
4756
    """Run the bzr server."""
5106
4757
 
5107
4758
    aliases = ['server']
5108
4759
 
5119
4770
                    'result in a dynamically allocated port.  The default port '
5120
4771
                    'depends on the protocol.',
5121
4772
               type=str),
5122
 
        custom_help('directory',
5123
 
               help='Serve contents of this directory.'),
 
4773
        Option('directory',
 
4774
               help='Serve contents of this directory.',
 
4775
               type=unicode),
5124
4776
        Option('allow-writes',
5125
4777
               help='By default the server is a readonly server.  Supplying '
5126
4778
                    '--allow-writes enables write access to the contents of '
5153
4805
 
5154
4806
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5155
4807
            protocol=None):
5156
 
        from bzrlib import transport
 
4808
        from bzrlib.transport import get_transport, transport_server_registry
5157
4809
        if directory is None:
5158
4810
            directory = os.getcwd()
5159
4811
        if protocol is None:
5160
 
            protocol = transport.transport_server_registry.get()
 
4812
            protocol = transport_server_registry.get()
5161
4813
        host, port = self.get_host_and_port(port)
5162
4814
        url = urlutils.local_path_to_url(directory)
5163
4815
        if not allow_writes:
5164
4816
            url = 'readonly+' + url
5165
 
        t = transport.get_transport(url)
5166
 
        protocol(t, host, port, inet)
 
4817
        transport = get_transport(url)
 
4818
        protocol(transport, host, port, inet)
5167
4819
 
5168
4820
 
5169
4821
class cmd_join(Command):
5170
 
    __doc__ = """Combine a tree into its containing tree.
 
4822
    """Combine a tree into its containing tree.
5171
4823
 
5172
4824
    This command requires the target tree to be in a rich-root format.
5173
4825
 
5175
4827
    not part of it.  (Such trees can be produced by "bzr split", but also by
5176
4828
    running "bzr branch" with the target inside a tree.)
5177
4829
 
5178
 
    The result is a combined tree, with the subtree no longer an independent
 
4830
    The result is a combined tree, with the subtree no longer an independant
5179
4831
    part.  This is marked as a merge of the subtree into the containing tree,
5180
4832
    and all history is preserved.
5181
4833
    """
5213
4865
 
5214
4866
 
5215
4867
class cmd_split(Command):
5216
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4868
    """Split a subdirectory of a tree into a separate tree.
5217
4869
 
5218
4870
    This command will produce a target tree in a format that supports
5219
4871
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5239
4891
 
5240
4892
 
5241
4893
class cmd_merge_directive(Command):
5242
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4894
    """Generate a merge directive for auto-merge tools.
5243
4895
 
5244
4896
    A directive requests a merge to be performed, and also provides all the
5245
4897
    information necessary to do so.  This means it must either include a
5262
4914
    _see_also = ['send']
5263
4915
 
5264
4916
    takes_options = [
5265
 
        'directory',
5266
4917
        RegistryOption.from_kwargs('patch-type',
5267
4918
            'The type of patch to include in the directive.',
5268
4919
            title='Patch type',
5281
4932
    encoding_type = 'exact'
5282
4933
 
5283
4934
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5284
 
            sign=False, revision=None, mail_to=None, message=None,
5285
 
            directory=u'.'):
 
4935
            sign=False, revision=None, mail_to=None, message=None):
5286
4936
        from bzrlib.revision import ensure_null, NULL_REVISION
5287
4937
        include_patch, include_bundle = {
5288
4938
            'plain': (False, False),
5289
4939
            'diff': (True, False),
5290
4940
            'bundle': (True, True),
5291
4941
            }[patch_type]
5292
 
        branch = Branch.open(directory)
 
4942
        branch = Branch.open('.')
5293
4943
        stored_submit_branch = branch.get_submit_branch()
5294
4944
        if submit_branch is None:
5295
4945
            submit_branch = stored_submit_branch
5340
4990
 
5341
4991
 
5342
4992
class cmd_send(Command):
5343
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4993
    """Mail or create a merge-directive for submitting changes.
5344
4994
 
5345
4995
    A merge directive provides many things needed for requesting merges:
5346
4996
 
5352
5002
      directly from the merge directive, without retrieving data from a
5353
5003
      branch.
5354
5004
 
5355
 
    `bzr send` creates a compact data set that, when applied using bzr
5356
 
    merge, has the same effect as merging from the source branch.  
5357
 
    
5358
 
    By default the merge directive is self-contained and can be applied to any
5359
 
    branch containing submit_branch in its ancestory without needing access to
5360
 
    the source branch.
5361
 
    
5362
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5363
 
    revisions, but only a structured request to merge from the
5364
 
    public_location.  In that case the public_branch is needed and it must be
5365
 
    up-to-date and accessible to the recipient.  The public_branch is always
5366
 
    included if known, so that people can check it later.
5367
 
 
5368
 
    The submit branch defaults to the parent of the source branch, but can be
5369
 
    overridden.  Both submit branch and public branch will be remembered in
5370
 
    branch.conf the first time they are used for a particular branch.  The
5371
 
    source branch defaults to that containing the working directory, but can
5372
 
    be changed using --from.
5373
 
 
5374
 
    Both the submit branch and the public branch follow the usual behavior with
5375
 
    respect to --remember: If there is no default location set, the first send
5376
 
    will set it (use --no-remember to avoid settting it). After that, you can
5377
 
    omit the location to use the default.  To change the default, use
5378
 
    --remember. The value will only be saved if the location can be accessed.
5379
 
 
5380
 
    In order to calculate those changes, bzr must analyse the submit branch.
5381
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5382
 
    If a public location is known for the submit_branch, that location is used
5383
 
    in the merge directive.
5384
 
 
5385
 
    The default behaviour is to send the merge directive by mail, unless -o is
5386
 
    given, in which case it is sent to a file.
 
5005
    If --no-bundle is specified, then public_branch is needed (and must be
 
5006
    up-to-date), so that the receiver can perform the merge using the
 
5007
    public_branch.  The public_branch is always included if known, so that
 
5008
    people can check it later.
 
5009
 
 
5010
    The submit branch defaults to the parent, but can be overridden.  Both
 
5011
    submit branch and public branch will be remembered if supplied.
 
5012
 
 
5013
    If a public_branch is known for the submit_branch, that public submit
 
5014
    branch is used in the merge instructions.  This means that a local mirror
 
5015
    can be used as your actual submit branch, once you have set public_branch
 
5016
    for that mirror.
5387
5017
 
5388
5018
    Mail is sent using your preferred mail program.  This should be transparent
5389
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
5019
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5390
5020
    If the preferred client can't be found (or used), your editor will be used.
5391
5021
 
5392
5022
    To use a specific mail program, set the mail_client configuration option.
5409
5039
 
5410
5040
    The merge directives created by bzr send may be applied using bzr merge or
5411
5041
    bzr pull by specifying a file containing a merge directive as the location.
5412
 
 
5413
 
    bzr send makes extensive use of public locations to map local locations into
5414
 
    URLs that can be used by other people.  See `bzr help configuration` to
5415
 
    set them, and use `bzr info` to display them.
5416
5042
    """
5417
5043
 
5418
5044
    encoding_type = 'exact'
5434
5060
               short_name='f',
5435
5061
               type=unicode),
5436
5062
        Option('output', short_name='o',
5437
 
               help='Write merge directive to this file or directory; '
 
5063
               help='Write merge directive to this file; '
5438
5064
                    'use - for stdout.',
5439
5065
               type=unicode),
5440
5066
        Option('strict',
5451
5077
        ]
5452
5078
 
5453
5079
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5454
 
            no_patch=False, revision=None, remember=None, output=None,
 
5080
            no_patch=False, revision=None, remember=False, output=None,
5455
5081
            format=None, mail_to=None, message=None, body=None,
5456
5082
            strict=None, **kwargs):
5457
5083
        from bzrlib.send import send
5463
5089
 
5464
5090
 
5465
5091
class cmd_bundle_revisions(cmd_send):
5466
 
    __doc__ = """Create a merge-directive for submitting changes.
 
5092
    """Create a merge-directive for submitting changes.
5467
5093
 
5468
5094
    A merge directive provides many things needed for requesting merges:
5469
5095
 
5536
5162
 
5537
5163
 
5538
5164
class cmd_tag(Command):
5539
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5165
    """Create, remove or modify a tag naming a revision.
5540
5166
 
5541
5167
    Tags give human-meaningful names to revisions.  Commands that take a -r
5542
5168
    (--revision) option can be given -rtag:X, where X is any previously
5550
5176
 
5551
5177
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5552
5178
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5553
 
 
5554
 
    If no tag name is specified it will be determined through the 
5555
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5556
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5557
 
    details.
5558
5179
    """
5559
5180
 
5560
5181
    _see_also = ['commit', 'tags']
5561
 
    takes_args = ['tag_name?']
 
5182
    takes_args = ['tag_name']
5562
5183
    takes_options = [
5563
5184
        Option('delete',
5564
5185
            help='Delete this tag rather than placing it.',
5565
5186
            ),
5566
 
        custom_help('directory',
5567
 
            help='Branch in which to place the tag.'),
 
5187
        Option('directory',
 
5188
            help='Branch in which to place the tag.',
 
5189
            short_name='d',
 
5190
            type=unicode,
 
5191
            ),
5568
5192
        Option('force',
5569
5193
            help='Replace existing tags.',
5570
5194
            ),
5571
5195
        'revision',
5572
5196
        ]
5573
5197
 
5574
 
    def run(self, tag_name=None,
 
5198
    def run(self, tag_name,
5575
5199
            delete=None,
5576
5200
            directory='.',
5577
5201
            force=None,
5578
5202
            revision=None,
5579
5203
            ):
5580
5204
        branch, relpath = Branch.open_containing(directory)
5581
 
        self.add_cleanup(branch.lock_write().unlock)
 
5205
        branch.lock_write()
 
5206
        self.add_cleanup(branch.unlock)
5582
5207
        if delete:
5583
 
            if tag_name is None:
5584
 
                raise errors.BzrCommandError("No tag specified to delete.")
5585
5208
            branch.tags.delete_tag(tag_name)
5586
 
            note('Deleted tag %s.' % tag_name)
 
5209
            self.outf.write('Deleted tag %s.\n' % tag_name)
5587
5210
        else:
5588
5211
            if revision:
5589
5212
                if len(revision) != 1:
5593
5216
                revision_id = revision[0].as_revision_id(branch)
5594
5217
            else:
5595
5218
                revision_id = branch.last_revision()
5596
 
            if tag_name is None:
5597
 
                tag_name = branch.automatic_tag_name(revision_id)
5598
 
                if tag_name is None:
5599
 
                    raise errors.BzrCommandError(
5600
 
                        "Please specify a tag name.")
5601
5219
            if (not force) and branch.tags.has_tag(tag_name):
5602
5220
                raise errors.TagAlreadyExists(tag_name)
5603
5221
            branch.tags.set_tag(tag_name, revision_id)
5604
 
            note('Created tag %s.' % tag_name)
 
5222
            self.outf.write('Created tag %s.\n' % tag_name)
5605
5223
 
5606
5224
 
5607
5225
class cmd_tags(Command):
5608
 
    __doc__ = """List tags.
 
5226
    """List tags.
5609
5227
 
5610
5228
    This command shows a table of tag names and the revisions they reference.
5611
5229
    """
5612
5230
 
5613
5231
    _see_also = ['tag']
5614
5232
    takes_options = [
5615
 
        custom_help('directory',
5616
 
            help='Branch whose tags should be displayed.'),
5617
 
        RegistryOption('sort',
 
5233
        Option('directory',
 
5234
            help='Branch whose tags should be displayed.',
 
5235
            short_name='d',
 
5236
            type=unicode,
 
5237
            ),
 
5238
        RegistryOption.from_kwargs('sort',
5618
5239
            'Sort tags by different criteria.', title='Sorting',
5619
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
5240
            alpha='Sort tags lexicographically (default).',
 
5241
            time='Sort tags chronologically.',
5620
5242
            ),
5621
5243
        'show-ids',
5622
5244
        'revision',
5623
5245
    ]
5624
5246
 
5625
5247
    @display_command
5626
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5627
 
        from bzrlib.tag import tag_sort_methods
 
5248
    def run(self,
 
5249
            directory='.',
 
5250
            sort='alpha',
 
5251
            show_ids=False,
 
5252
            revision=None,
 
5253
            ):
5628
5254
        branch, relpath = Branch.open_containing(directory)
5629
5255
 
5630
5256
        tags = branch.tags.get_tag_dict().items()
5631
5257
        if not tags:
5632
5258
            return
5633
5259
 
5634
 
        self.add_cleanup(branch.lock_read().unlock)
 
5260
        branch.lock_read()
 
5261
        self.add_cleanup(branch.unlock)
5635
5262
        if revision:
5636
5263
            graph = branch.repository.get_graph()
5637
5264
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5639
5266
            # only show revisions between revid1 and revid2 (inclusive)
5640
5267
            tags = [(tag, revid) for tag, revid in tags if
5641
5268
                graph.is_between(revid, revid1, revid2)]
5642
 
        if sort is None:
5643
 
            sort = tag_sort_methods.get()
5644
 
        sort(branch, tags)
 
5269
        if sort == 'alpha':
 
5270
            tags.sort()
 
5271
        elif sort == 'time':
 
5272
            timestamps = {}
 
5273
            for tag, revid in tags:
 
5274
                try:
 
5275
                    revobj = branch.repository.get_revision(revid)
 
5276
                except errors.NoSuchRevision:
 
5277
                    timestamp = sys.maxint # place them at the end
 
5278
                else:
 
5279
                    timestamp = revobj.timestamp
 
5280
                timestamps[revid] = timestamp
 
5281
            tags.sort(key=lambda x: timestamps[x[1]])
5645
5282
        if not show_ids:
5646
5283
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5647
5284
            for index, (tag, revid) in enumerate(tags):
5649
5286
                    revno = branch.revision_id_to_dotted_revno(revid)
5650
5287
                    if isinstance(revno, tuple):
5651
5288
                        revno = '.'.join(map(str, revno))
5652
 
                except (errors.NoSuchRevision, errors.GhostRevisionsHaveNoRevno):
 
5289
                except errors.NoSuchRevision:
5653
5290
                    # Bad tag data/merges can lead to tagged revisions
5654
5291
                    # which are not in this branch. Fail gracefully ...
5655
5292
                    revno = '?'
5660
5297
 
5661
5298
 
5662
5299
class cmd_reconfigure(Command):
5663
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5300
    """Reconfigure the type of a bzr directory.
5664
5301
 
5665
5302
    A target configuration must be specified.
5666
5303
 
5713
5350
            unstacked=None):
5714
5351
        directory = bzrdir.BzrDir.open(location)
5715
5352
        if stacked_on and unstacked:
5716
 
            raise errors.BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5353
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5717
5354
        elif stacked_on is not None:
5718
5355
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5719
5356
        elif unstacked:
5751
5388
 
5752
5389
 
5753
5390
class cmd_switch(Command):
5754
 
    __doc__ = """Set the branch of a checkout and update.
 
5391
    """Set the branch of a checkout and update.
5755
5392
 
5756
5393
    For lightweight checkouts, this changes the branch being referenced.
5757
5394
    For heavyweight checkouts, this checks that there are no local commits
5773
5410
    that of the master.
5774
5411
    """
5775
5412
 
5776
 
    takes_args = ['to_location?']
5777
 
    takes_options = ['directory',
5778
 
                     Option('force',
 
5413
    takes_args = ['to_location']
 
5414
    takes_options = [Option('force',
5779
5415
                        help='Switch even if local commits will be lost.'),
5780
 
                     'revision',
5781
5416
                     Option('create-branch', short_name='b',
5782
5417
                        help='Create the target branch from this one before'
5783
5418
                             ' switching to it.'),
5784
 
                    ]
 
5419
                     ]
5785
5420
 
5786
 
    def run(self, to_location=None, force=False, create_branch=False,
5787
 
            revision=None, directory=u'.'):
 
5421
    def run(self, to_location, force=False, create_branch=False):
5788
5422
        from bzrlib import switch
5789
 
        tree_location = directory
5790
 
        revision = _get_one_revision('switch', revision)
 
5423
        tree_location = '.'
5791
5424
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5792
 
        if to_location is None:
5793
 
            if revision is None:
5794
 
                raise errors.BzrCommandError('You must supply either a'
5795
 
                                             ' revision or a location')
5796
 
            to_location = tree_location
5797
5425
        try:
5798
5426
            branch = control_dir.open_branch()
5799
5427
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5813
5441
            to_branch = branch.bzrdir.sprout(to_location,
5814
5442
                                 possible_transports=[branch.bzrdir.root_transport],
5815
5443
                                 source_branch=branch).open_branch()
 
5444
            # try:
 
5445
            #     from_branch = control_dir.open_branch()
 
5446
            # except errors.NotBranchError:
 
5447
            #     raise BzrCommandError('Cannot create a branch from this'
 
5448
            #         ' location when we cannot open this branch')
 
5449
            # from_branch.bzrdir.sprout(
 
5450
            pass
5816
5451
        else:
5817
5452
            try:
5818
5453
                to_branch = Branch.open(to_location)
5820
5455
                this_url = self._get_branch_location(control_dir)
5821
5456
                to_branch = Branch.open(
5822
5457
                    urlutils.join(this_url, '..', to_location))
5823
 
        if revision is not None:
5824
 
            revision = revision.as_revision_id(to_branch)
5825
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5458
        switch.switch(control_dir, to_branch, force)
5826
5459
        if had_explicit_nick:
5827
5460
            branch = control_dir.open_branch() #get the new branch!
5828
5461
            branch.nick = to_branch.nick
5848
5481
 
5849
5482
 
5850
5483
class cmd_view(Command):
5851
 
    __doc__ = """Manage filtered views.
 
5484
    """Manage filtered views.
5852
5485
 
5853
5486
    Views provide a mask over the tree so that users can focus on
5854
5487
    a subset of a tree when doing their work. After creating a view,
5934
5567
            name=None,
5935
5568
            switch=None,
5936
5569
            ):
5937
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5938
 
            apply_view=False)
 
5570
        tree, file_list = tree_files(file_list, apply_view=False)
5939
5571
        current_view, view_dict = tree.views.get_view_info()
5940
5572
        if name is None:
5941
5573
            name = current_view
6003
5635
 
6004
5636
 
6005
5637
class cmd_hooks(Command):
6006
 
    __doc__ = """Show hooks."""
 
5638
    """Show hooks."""
6007
5639
 
6008
5640
    hidden = True
6009
5641
 
6022
5654
                    self.outf.write("    <no hooks installed>\n")
6023
5655
 
6024
5656
 
6025
 
class cmd_remove_branch(Command):
6026
 
    __doc__ = """Remove a branch.
6027
 
 
6028
 
    This will remove the branch from the specified location but 
6029
 
    will keep any working tree or repository in place.
6030
 
 
6031
 
    :Examples:
6032
 
 
6033
 
      Remove the branch at repo/trunk::
6034
 
 
6035
 
        bzr remove-branch repo/trunk
6036
 
 
6037
 
    """
6038
 
 
6039
 
    takes_args = ["location?"]
6040
 
 
6041
 
    aliases = ["rmbranch"]
6042
 
 
6043
 
    def run(self, location=None):
6044
 
        if location is None:
6045
 
            location = "."
6046
 
        branch = Branch.open_containing(location)[0]
6047
 
        branch.bzrdir.destroy_branch()
6048
 
 
6049
 
 
6050
5657
class cmd_shelve(Command):
6051
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5658
    """Temporarily set aside some changes from the current tree.
6052
5659
 
6053
5660
    Shelve allows you to temporarily put changes you've made "on the shelf",
6054
5661
    ie. out of the way, until a later time when you can bring them back from
6070
5677
 
6071
5678
    You can put multiple items on the shelf, and by default, 'unshelve' will
6072
5679
    restore the most recently shelved changes.
6073
 
 
6074
 
    For complicated changes, it is possible to edit the changes in a separate
6075
 
    editor program to decide what the file remaining in the working copy
6076
 
    should look like.  To do this, add the configuration option
6077
 
 
6078
 
        change_editor = PROGRAM @new_path @old_path
6079
 
 
6080
 
    where @new_path is replaced with the path of the new version of the 
6081
 
    file and @old_path is replaced with the path of the old version of 
6082
 
    the file.  The PROGRAM should save the new file with the desired 
6083
 
    contents of the file in the working tree.
6084
 
        
6085
5680
    """
6086
5681
 
6087
5682
    takes_args = ['file*']
6088
5683
 
6089
5684
    takes_options = [
6090
 
        'directory',
6091
5685
        'revision',
6092
5686
        Option('all', help='Shelve all changes.'),
6093
5687
        'message',
6099
5693
        Option('destroy',
6100
5694
               help='Destroy removed changes instead of shelving them.'),
6101
5695
    ]
6102
 
    _see_also = ['unshelve', 'configuration']
 
5696
    _see_also = ['unshelve']
6103
5697
 
6104
5698
    def run(self, revision=None, all=False, file_list=None, message=None,
6105
 
            writer=None, list=False, destroy=False, directory=None):
 
5699
            writer=None, list=False, destroy=False):
6106
5700
        if list:
6107
 
            return self.run_for_list(directory=directory)
 
5701
            return self.run_for_list()
6108
5702
        from bzrlib.shelf_ui import Shelver
6109
5703
        if writer is None:
6110
5704
            writer = bzrlib.option.diff_writer_registry.get()
6111
5705
        try:
6112
5706
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6113
 
                file_list, message, destroy=destroy, directory=directory)
 
5707
                file_list, message, destroy=destroy)
6114
5708
            try:
6115
5709
                shelver.run()
6116
5710
            finally:
6118
5712
        except errors.UserAbort:
6119
5713
            return 0
6120
5714
 
6121
 
    def run_for_list(self, directory=None):
6122
 
        if directory is None:
6123
 
            directory = u'.'
6124
 
        tree = WorkingTree.open_containing(directory)[0]
6125
 
        self.add_cleanup(tree.lock_read().unlock)
 
5715
    def run_for_list(self):
 
5716
        tree = WorkingTree.open_containing('.')[0]
 
5717
        tree.lock_read()
 
5718
        self.add_cleanup(tree.unlock)
6126
5719
        manager = tree.get_shelf_manager()
6127
5720
        shelves = manager.active_shelves()
6128
5721
        if len(shelves) == 0:
6137
5730
 
6138
5731
 
6139
5732
class cmd_unshelve(Command):
6140
 
    __doc__ = """Restore shelved changes.
 
5733
    """Restore shelved changes.
6141
5734
 
6142
5735
    By default, the most recently shelved changes are restored. However if you
6143
5736
    specify a shelf by id those changes will be restored instead.  This works
6146
5739
 
6147
5740
    takes_args = ['shelf_id?']
6148
5741
    takes_options = [
6149
 
        'directory',
6150
5742
        RegistryOption.from_kwargs(
6151
5743
            'action', help="The action to perform.",
6152
5744
            enum_switch=False, value_switches=True,
6153
5745
            apply="Apply changes and remove from the shelf.",
6154
5746
            dry_run="Show changes, but do not apply or remove them.",
6155
 
            preview="Instead of unshelving the changes, show the diff that "
6156
 
                    "would result from unshelving.",
6157
5747
            delete_only="Delete changes without applying them.",
6158
5748
            keep="Apply changes but don't delete them.",
6159
5749
        )
6160
5750
    ]
6161
5751
    _see_also = ['shelve']
6162
5752
 
6163
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5753
    def run(self, shelf_id=None, action='apply'):
6164
5754
        from bzrlib.shelf_ui import Unshelver
6165
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5755
        unshelver = Unshelver.from_args(shelf_id, action)
6166
5756
        try:
6167
5757
            unshelver.run()
6168
5758
        finally:
6170
5760
 
6171
5761
 
6172
5762
class cmd_clean_tree(Command):
6173
 
    __doc__ = """Remove unwanted files from working tree.
 
5763
    """Remove unwanted files from working tree.
6174
5764
 
6175
5765
    By default, only unknown files, not ignored files, are deleted.  Versioned
6176
5766
    files are never deleted.
6184
5774
 
6185
5775
    To check what clean-tree will do, use --dry-run.
6186
5776
    """
6187
 
    takes_options = ['directory',
6188
 
                     Option('ignored', help='Delete all ignored files.'),
6189
 
                     Option('detritus', help='Delete conflict files, merge and revert'
 
5777
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5778
                     Option('detritus', help='Delete conflict files, merge'
6190
5779
                            ' backups, and failed selftest dirs.'),
6191
5780
                     Option('unknown',
6192
5781
                            help='Delete files unknown to bzr (default).'),
6194
5783
                            ' deleting them.'),
6195
5784
                     Option('force', help='Do not prompt before deleting.')]
6196
5785
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6197
 
            force=False, directory=u'.'):
 
5786
            force=False):
6198
5787
        from bzrlib.clean_tree import clean_tree
6199
5788
        if not (unknown or ignored or detritus):
6200
5789
            unknown = True
6201
5790
        if dry_run:
6202
5791
            force = True
6203
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6204
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5792
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5793
                   dry_run=dry_run, no_prompt=force)
6205
5794
 
6206
5795
 
6207
5796
class cmd_reference(Command):
6208
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5797
    """list, view and set branch locations for nested trees.
6209
5798
 
6210
5799
    If no arguments are provided, lists the branch locations for nested trees.
6211
5800
    If one argument is provided, display the branch location for that tree.
6251
5840
            self.outf.write('%s %s\n' % (path, location))
6252
5841
 
6253
5842
 
6254
 
class cmd_export_pot(Command):
6255
 
    __doc__ = """Export command helps and error messages in po format."""
6256
 
 
6257
 
    hidden = True
6258
 
 
6259
 
    def run(self):
6260
 
        from bzrlib.export_pot import export_pot
6261
 
        export_pot(self.outf)
6262
 
 
6263
 
 
6264
 
def _register_lazy_builtins():
6265
 
    # register lazy builtins from other modules; called at startup and should
6266
 
    # be only called once.
6267
 
    for (name, aliases, module_name) in [
6268
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6269
 
        ('cmd_config', [], 'bzrlib.config'),
6270
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6271
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6272
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6273
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6274
 
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6275
 
        ('cmd_verify_signatures', [],
6276
 
                                        'bzrlib.commit_signature_commands'),
6277
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6278
 
        ]:
6279
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5843
# these get imported and then picked up by the scan for cmd_*
 
5844
# TODO: Some more consistent way to split command definitions across files;
 
5845
# we do need to load at least some information about them to know of
 
5846
# aliases.  ideally we would avoid loading the implementation until the
 
5847
# details were needed.
 
5848
from bzrlib.cmd_version_info import cmd_version_info
 
5849
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5850
from bzrlib.bundle.commands import (
 
5851
    cmd_bundle_info,
 
5852
    )
 
5853
from bzrlib.foreign import cmd_dpush
 
5854
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5855
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5856
        cmd_weave_plan_merge, cmd_weave_merge_text