~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Matt Nordhoff
  • Date: 2009-06-23 22:31:59 UTC
  • mto: This revision was merged to the branch mainline in revision 4479.
  • Revision ID: mnordhoff@mattnordhoff.com-20090623223159-fqfgl9c7a4umtafj
bzrlib.util.bencode's deprecation warning used the wrong stacklevel

Show diffs side-by-side

added added

removed removed

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