~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Aaron Bentley
  • Date: 2009-06-20 01:17:38 UTC
  • mto: This revision was merged to the branch mainline in revision 4465.
  • Revision ID: aaron@aaronbentley.com-20090620011738-ui5v1f48fluueiix
ContainerPushParser.accept_bytes handles zero-length records correctly.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2005-2010 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
 
import itertools
25
 
import re
26
25
import sys
27
26
import time
28
27
 
32
31
    bundle,
33
32
    btree_index,
34
33
    bzrdir,
35
 
    directory_service,
36
34
    delta,
37
 
    config as _mod_config,
 
35
    config,
38
36
    errors,
39
37
    globbing,
40
38
    hooks,
45
43
    reconfigure,
46
44
    rename_map,
47
45
    revision as _mod_revision,
48
 
    static_tuple,
49
46
    symbol_versioning,
50
 
    timestamp,
51
47
    transport,
 
48
    tree as _mod_tree,
52
49
    ui,
53
50
    urlutils,
54
51
    views,
55
52
    )
56
53
from bzrlib.branch import Branch
57
54
from bzrlib.conflicts import ConflictList
58
 
from bzrlib.transport import memory
59
55
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
60
56
from bzrlib.smtp_connection import SMTPConnection
61
57
from bzrlib.workingtree import WorkingTree
62
58
""")
63
59
 
64
 
from bzrlib.commands import (
65
 
    Command,
66
 
    builtin_command_registry,
67
 
    display_command,
68
 
    )
 
60
from bzrlib.commands import Command, display_command
69
61
from bzrlib.option import (
70
62
    ListOption,
71
63
    Option,
76
68
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
77
69
 
78
70
 
79
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
80
71
def tree_files(file_list, default_branch=u'.', canonicalize=True,
81
72
    apply_view=True):
82
 
    return internal_tree_files(file_list, default_branch, canonicalize,
83
 
        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]))
84
79
 
85
80
 
86
81
def tree_files_for_add(file_list):
126
121
 
127
122
 
128
123
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
129
 
    """Get a revision tree. Not suitable for commands that change the tree.
130
 
    
131
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
132
 
    and doing a commit/uncommit/pull will at best fail due to changing the
133
 
    basis revision data.
134
 
 
135
 
    If tree is passed in, it should be already locked, for lifetime management
136
 
    of the trees internal cached state.
137
 
    """
138
124
    if branch is None:
139
125
        branch = tree.branch
140
126
    if revisions is None:
150
136
 
151
137
# XXX: Bad function name; should possibly also be a class method of
152
138
# WorkingTree rather than a function.
153
 
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
154
139
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
155
140
    apply_view=True):
156
141
    """Convert command-line paths to a WorkingTree and relative paths.
157
142
 
158
 
    Deprecated: use WorkingTree.open_containing_paths instead.
159
 
 
160
143
    This is typically used for command-line processors that take one or
161
144
    more filenames, and infer the workingtree that contains them.
162
145
 
172
155
 
173
156
    :return: workingtree, [relative_paths]
174
157
    """
175
 
    return WorkingTree.open_containing_paths(
176
 
        file_list, default_directory='.',
177
 
        canonicalize=True,
178
 
        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
179
205
 
180
206
 
181
207
def _get_view_info_for_change_reporter(tree):
190
216
    return view_info
191
217
 
192
218
 
193
 
def _open_directory_or_containing_tree_or_branch(filename, directory):
194
 
    """Open the tree or branch containing the specified file, unless
195
 
    the --directory option is used to specify a different branch."""
196
 
    if directory is not None:
197
 
        return (None, Branch.open(directory), filename)
198
 
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
199
 
 
200
 
 
201
219
# TODO: Make sure no commands unconditionally use the working directory as a
202
220
# branch.  If a filename argument is used, the first of them should be used to
203
221
# specify the branch.  (Perhaps this can be factored out into some kind of
205
223
# opens the branch?)
206
224
 
207
225
class cmd_status(Command):
208
 
    __doc__ = """Display status summary.
 
226
    """Display status summary.
209
227
 
210
228
    This reports on versioned and unknown files, reporting them
211
229
    grouped by state.  Possible states are:
231
249
    unknown
232
250
        Not versioned and not matching an ignore pattern.
233
251
 
234
 
    Additionally for directories, symlinks and files with an executable
235
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
236
 
    or '*' respectively.
237
 
 
238
252
    To see ignored files use 'bzr ignored'.  For details on the
239
253
    changes to file texts, use 'bzr diff'.
240
254
 
252
266
    To skip the display of pending merge information altogether, use
253
267
    the no-pending option or specify a file/directory.
254
268
 
255
 
    To compare the working directory to a specific revision, pass a
256
 
    single revision to the revision argument.
257
 
 
258
 
    To see which files have changed in a specific revision, or between
259
 
    two revisions, pass a revision range to the revision argument.
260
 
    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.
261
271
    """
262
272
 
263
273
    # TODO: --no-recurse, --recurse options
285
295
            raise errors.BzrCommandError('bzr status --revision takes exactly'
286
296
                                         ' one or two revision specifiers')
287
297
 
288
 
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
 
298
        tree, relfile_list = tree_files(file_list)
289
299
        # Avoid asking for specific files when that is not needed.
290
300
        if relfile_list == ['']:
291
301
            relfile_list = None
302
312
 
303
313
 
304
314
class cmd_cat_revision(Command):
305
 
    __doc__ = """Write out metadata for a revision.
 
315
    """Write out metadata for a revision.
306
316
 
307
317
    The revision to print can either be specified by a specific
308
318
    revision identifier, or you can use --revision.
310
320
 
311
321
    hidden = True
312
322
    takes_args = ['revision_id?']
313
 
    takes_options = ['directory', 'revision']
 
323
    takes_options = ['revision']
314
324
    # cat-revision is more for frontends so should be exact
315
325
    encoding = 'strict'
316
326
 
317
 
    def print_revision(self, revisions, revid):
318
 
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
319
 
        record = stream.next()
320
 
        if record.storage_kind == 'absent':
321
 
            raise errors.NoSuchRevision(revisions, revid)
322
 
        revtext = record.get_bytes_as('fulltext')
323
 
        self.outf.write(revtext.decode('utf-8'))
324
 
 
325
327
    @display_command
326
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
328
    def run(self, revision_id=None, revision=None):
327
329
        if revision_id is not None and revision is not None:
328
330
            raise errors.BzrCommandError('You can only supply one of'
329
331
                                         ' revision_id or --revision')
330
332
        if revision_id is None and revision is None:
331
333
            raise errors.BzrCommandError('You must supply either'
332
334
                                         ' --revision or a revision_id')
333
 
        b = WorkingTree.open_containing(directory)[0].branch
334
 
 
335
 
        revisions = b.repository.revisions
336
 
        if revisions is None:
337
 
            raise errors.BzrCommandError('Repository %r does not support '
338
 
                'access to raw revision texts')
339
 
 
340
 
        b.repository.lock_read()
341
 
        try:
342
 
            # TODO: jam 20060112 should cat-revision always output utf-8?
343
 
            if revision_id is not None:
344
 
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
345
 
                try:
346
 
                    self.print_revision(revisions, revision_id)
347
 
                except errors.NoSuchRevision:
348
 
                    msg = "The repository %s contains no revision %s." % (
349
 
                        b.repository.base, revision_id)
350
 
                    raise errors.BzrCommandError(msg)
351
 
            elif revision is not None:
352
 
                for rev in revision:
353
 
                    if rev is None:
354
 
                        raise errors.BzrCommandError(
355
 
                            'You cannot specify a NULL revision.')
356
 
                    rev_id = rev.as_revision_id(b)
357
 
                    self.print_revision(revisions, rev_id)
358
 
        finally:
359
 
            b.repository.unlock()
360
 
        
 
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
 
361
354
 
362
355
class cmd_dump_btree(Command):
363
 
    __doc__ = """Dump the contents of a btree index file to stdout.
 
356
    """Dump the contents of a btree index file to stdout.
364
357
 
365
358
    PATH is a btree index file, it can be any URL. This includes things like
366
359
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
430
423
        for node in bt.iter_all_entries():
431
424
            # Node is made up of:
432
425
            # (index, key, value, [references])
433
 
            try:
434
 
                refs = node[3]
435
 
            except IndexError:
436
 
                refs_as_tuples = None
437
 
            else:
438
 
                refs_as_tuples = static_tuple.as_tuples(refs)
439
 
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
440
 
            self.outf.write('%s\n' % (as_tuple,))
 
426
            self.outf.write('%s\n' % (node[1:],))
441
427
 
442
428
 
443
429
class cmd_remove_tree(Command):
444
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
430
    """Remove the working tree from a given branch/checkout.
445
431
 
446
432
    Since a lightweight checkout is little more than a working tree
447
433
    this will refuse to run against one.
449
435
    To re-create the working tree, use "bzr checkout".
450
436
    """
451
437
    _see_also = ['checkout', 'working-trees']
452
 
    takes_args = ['location*']
 
438
    takes_args = ['location?']
453
439
    takes_options = [
454
440
        Option('force',
455
441
               help='Remove the working tree even if it has '
456
 
                    'uncommitted or shelved changes.'),
 
442
                    'uncommitted changes.'),
457
443
        ]
458
444
 
459
 
    def run(self, location_list, force=False):
460
 
        if not location_list:
461
 
            location_list=['.']
462
 
 
463
 
        for location in location_list:
464
 
            d = bzrdir.BzrDir.open(location)
465
 
            
466
 
            try:
467
 
                working = d.open_workingtree()
468
 
            except errors.NoWorkingTree:
469
 
                raise errors.BzrCommandError("No working tree to remove")
470
 
            except errors.NotLocalUrl:
471
 
                raise errors.BzrCommandError("You cannot remove the working tree"
472
 
                                             " of a remote path")
473
 
            if not force:
474
 
                if (working.has_changes()):
475
 
                    raise errors.UncommittedChanges(working)
476
 
                if working.get_shelf_manager().last_shelf() is not None:
477
 
                    raise errors.ShelvedChanges(working)
478
 
 
479
 
            if working.user_url != working.branch.user_url:
480
 
                raise errors.BzrCommandError("You cannot remove the working tree"
481
 
                                             " from a lightweight checkout")
482
 
 
483
 
            d.destroy_workingtree()
 
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")
 
455
        if not force:
 
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()
484
467
 
485
468
 
486
469
class cmd_revno(Command):
487
 
    __doc__ = """Show current revision number.
 
470
    """Show current revision number.
488
471
 
489
472
    This is equal to the number of revisions on this branch.
490
473
    """
491
474
 
492
475
    _see_also = ['info']
493
476
    takes_args = ['location?']
494
 
    takes_options = [
495
 
        Option('tree', help='Show revno of working tree'),
496
 
        ]
497
477
 
498
478
    @display_command
499
 
    def run(self, tree=False, location=u'.'):
500
 
        if tree:
501
 
            try:
502
 
                wt = WorkingTree.open_containing(location)[0]
503
 
                self.add_cleanup(wt.lock_read().unlock)
504
 
            except (errors.NoWorkingTree, errors.NotLocalUrl):
505
 
                raise errors.NoWorkingTree(location)
506
 
            revid = wt.last_revision()
507
 
            try:
508
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
509
 
            except errors.NoSuchRevision:
510
 
                revno_t = ('???',)
511
 
            revno = ".".join(str(n) for n in revno_t)
512
 
        else:
513
 
            b = Branch.open_containing(location)[0]
514
 
            self.add_cleanup(b.lock_read().unlock)
515
 
            revno = b.revno()
516
 
        self.cleanup_now()
517
 
        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')
518
482
 
519
483
 
520
484
class cmd_revision_info(Command):
521
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
485
    """Show revision number and revision id for a given revision identifier.
522
486
    """
523
487
    hidden = True
524
488
    takes_args = ['revision_info*']
525
489
    takes_options = [
526
490
        'revision',
527
 
        custom_help('directory',
 
491
        Option('directory',
528
492
            help='Branch to examine, '
529
 
                 'rather than the one containing the working directory.'),
530
 
        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
            ),
531
497
        ]
532
498
 
533
499
    @display_command
534
 
    def run(self, revision=None, directory=u'.', tree=False,
535
 
            revision_info_list=[]):
 
500
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
536
501
 
537
 
        try:
538
 
            wt = WorkingTree.open_containing(directory)[0]
539
 
            b = wt.branch
540
 
            self.add_cleanup(wt.lock_read().unlock)
541
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
542
 
            wt = None
543
 
            b = Branch.open_containing(directory)[0]
544
 
            self.add_cleanup(b.lock_read().unlock)
545
 
        revision_ids = []
 
502
        revs = []
546
503
        if revision is not None:
547
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
504
            revs.extend(revision)
548
505
        if revision_info_list is not None:
549
 
            for rev_str in revision_info_list:
550
 
                rev_spec = RevisionSpec.from_string(rev_str)
551
 
                revision_ids.append(rev_spec.as_revision_id(b))
552
 
        # No arguments supplied, default to the last revision
553
 
        if len(revision_ids) == 0:
554
 
            if tree:
555
 
                if wt is None:
556
 
                    raise errors.NoWorkingTree(directory)
557
 
                revision_ids.append(wt.last_revision())
558
 
            else:
559
 
                revision_ids.append(b.last_revision())
560
 
 
561
 
        revinfos = []
562
 
        maxlen = 0
563
 
        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)
564
516
            try:
565
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
566
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
517
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
567
518
            except errors.NoSuchRevision:
568
 
                revno = '???'
569
 
            maxlen = max(maxlen, len(revno))
570
 
            revinfos.append([revno, revision_id])
571
 
 
572
 
        self.cleanup_now()
573
 
        for ri in revinfos:
574
 
            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)
575
522
 
576
523
 
577
524
class cmd_add(Command):
578
 
    __doc__ = """Add specified files or directories.
 
525
    """Add specified files or directories.
579
526
 
580
527
    In non-recursive mode, all the named items are added, regardless
581
528
    of whether they were previously ignored.  A warning is given if
607
554
    branches that will be merged later (without showing the two different
608
555
    adds as a conflict). It is also useful when merging another project
609
556
    into a subdirectory of this one.
610
 
    
611
 
    Any files matching patterns in the ignore list will not be added
612
 
    unless they are explicitly mentioned.
613
557
    """
614
558
    takes_args = ['file*']
615
559
    takes_options = [
623
567
               help='Lookup file ids from this tree.'),
624
568
        ]
625
569
    encoding_type = 'replace'
626
 
    _see_also = ['remove', 'ignore']
 
570
    _see_also = ['remove']
627
571
 
628
572
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
629
573
            file_ids_from=None):
646
590
                should_print=(not is_quiet()))
647
591
 
648
592
        if base_tree:
649
 
            self.add_cleanup(base_tree.lock_read().unlock)
650
 
        tree, file_list = tree_files_for_add(file_list)
651
 
        added, ignored = tree.smart_add(file_list, not
652
 
            no_recurse, action=action, save=not dry_run)
653
 
        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()
654
602
        if len(ignored) > 0:
655
603
            if verbose:
656
604
                for glob in sorted(ignored.keys()):
657
605
                    for path in ignored[glob]:
658
606
                        self.outf.write("ignored %s matching \"%s\"\n"
659
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")
660
616
 
661
617
 
662
618
class cmd_mkdir(Command):
663
 
    __doc__ = """Create a new versioned directory.
 
619
    """Create a new versioned directory.
664
620
 
665
621
    This is equivalent to creating the directory and then adding it.
666
622
    """
670
626
 
671
627
    def run(self, dir_list):
672
628
        for d in dir_list:
 
629
            os.mkdir(d)
673
630
            wt, dd = WorkingTree.open_containing(d)
674
 
            base = os.path.dirname(dd)
675
 
            id = wt.path2id(base)
676
 
            if id != None:
677
 
                os.mkdir(d)
678
 
                wt.add([dd])
679
 
                self.outf.write('added %s\n' % d)
680
 
            else:
681
 
                raise errors.NotVersionedError(path=base)
 
631
            wt.add([dd])
 
632
            self.outf.write('added %s\n' % d)
682
633
 
683
634
 
684
635
class cmd_relpath(Command):
685
 
    __doc__ = """Show path of a file relative to root"""
 
636
    """Show path of a file relative to root"""
686
637
 
687
638
    takes_args = ['filename']
688
639
    hidden = True
697
648
 
698
649
 
699
650
class cmd_inventory(Command):
700
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
651
    """Show inventory of the current working copy or a revision.
701
652
 
702
653
    It is possible to limit the output to a particular entry
703
654
    type using the --kind option.  For example: --kind file.
723
674
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
724
675
 
725
676
        revision = _get_one_revision('inventory', revision)
726
 
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
727
 
        self.add_cleanup(work_tree.lock_read().unlock)
728
 
        if revision is not None:
729
 
            tree = revision.as_tree(work_tree.branch)
730
 
 
731
 
            extra_trees = [work_tree]
732
 
            self.add_cleanup(tree.lock_read().unlock)
733
 
        else:
734
 
            tree = work_tree
735
 
            extra_trees = []
736
 
 
737
 
        if file_list is not None:
738
 
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
739
 
                                      require_versioned=True)
740
 
            # find_ids_across_trees may include some paths that don't
741
 
            # exist in 'tree'.
742
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
743
 
                             for file_id in file_ids if file_id in tree)
744
 
        else:
745
 
            entries = tree.inventory.entries()
746
 
 
747
 
        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
 
748
703
        for path, entry in entries:
749
704
            if kind and kind != entry.kind:
750
705
                continue
756
711
 
757
712
 
758
713
class cmd_mv(Command):
759
 
    __doc__ = """Move or rename a file.
 
714
    """Move or rename a file.
760
715
 
761
716
    :Usage:
762
717
        bzr mv OLDNAME NEWNAME
794
749
            names_list = []
795
750
        if len(names_list) < 2:
796
751
            raise errors.BzrCommandError("missing file argument")
797
 
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
798
 
        self.add_cleanup(tree.lock_tree_write().unlock)
799
 
        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()
800
758
 
801
759
    def run_auto(self, names_list, after, dry_run):
802
760
        if names_list is not None and len(names_list) > 1:
805
763
        if after:
806
764
            raise errors.BzrCommandError('--after cannot be specified with'
807
765
                                         ' --auto.')
808
 
        work_tree, file_list = WorkingTree.open_containing_paths(
809
 
            names_list, default_directory='.')
810
 
        self.add_cleanup(work_tree.lock_tree_write().unlock)
811
 
        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()
812
772
 
813
773
    def _run(self, tree, names_list, rel_names, after):
814
774
        into_existing = osutils.isdir(names_list[-1])
835
795
            # All entries reference existing inventory items, so fix them up
836
796
            # for cicp file-systems.
837
797
            rel_names = tree.get_canonical_inventory_paths(rel_names)
838
 
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
839
 
                if not is_quiet():
840
 
                    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)
841
800
        else:
842
801
            if len(names_list) != 2:
843
802
                raise errors.BzrCommandError('to mv multiple files the'
887
846
            dest = osutils.pathjoin(dest_parent, dest_tail)
888
847
            mutter("attempting to move %s => %s", src, dest)
889
848
            tree.rename_one(src, dest, after=after)
890
 
            if not is_quiet():
891
 
                self.outf.write("%s => %s\n" % (src, dest))
 
849
            self.outf.write("%s => %s\n" % (src, dest))
892
850
 
893
851
 
894
852
class cmd_pull(Command):
895
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
853
    """Turn this branch into a mirror of another branch.
896
854
 
897
 
    By default, this command only works on branches that have not diverged.
898
 
    Branches are considered diverged if the destination branch's most recent 
899
 
    commit is one that has not been merged (directly or indirectly) into the 
900
 
    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.
901
858
 
902
859
    If branches have diverged, you can use 'bzr merge' to integrate the changes
903
860
    from one into the other.  Once one branch has merged, the other should
904
861
    be able to pull it again.
905
862
 
906
 
    If you want to replace your local changes and just want your branch to
907
 
    match the remote one, use pull --overwrite. This will work even if the two
908
 
    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.
909
865
 
910
866
    If there is no default location set, the first pull will set it.  After
911
867
    that, you can omit the location to use the default.  To change the
921
877
    takes_options = ['remember', 'overwrite', 'revision',
922
878
        custom_help('verbose',
923
879
            help='Show logs of pulled revisions.'),
924
 
        custom_help('directory',
 
880
        Option('directory',
925
881
            help='Branch to pull into, '
926
 
                 '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
            ),
927
886
        Option('local',
928
887
            help="Perform a local pull in a bound "
929
888
                 "branch.  Local pulls are not applied to "
930
889
                 "the master branch."
931
890
            ),
932
 
        Option('show-base',
933
 
            help="Show base revision text in conflicts.")
934
891
        ]
935
892
    takes_args = ['location?']
936
893
    encoding_type = 'replace'
937
894
 
938
895
    def run(self, location=None, remember=False, overwrite=False,
939
896
            revision=None, verbose=False,
940
 
            directory=None, local=False,
941
 
            show_base=False):
 
897
            directory=None, local=False):
942
898
        # FIXME: too much stuff is in the command class
943
899
        revision_id = None
944
900
        mergeable = None
947
903
        try:
948
904
            tree_to = WorkingTree.open_containing(directory)[0]
949
905
            branch_to = tree_to.branch
950
 
            self.add_cleanup(tree_to.lock_write().unlock)
951
906
        except errors.NoWorkingTree:
952
907
            tree_to = None
953
908
            branch_to = Branch.open_containing(directory)[0]
954
 
            self.add_cleanup(branch_to.lock_write().unlock)
955
 
 
956
 
        if tree_to is None and show_base:
957
 
            raise errors.BzrCommandError("Need working tree for --show-base.")
958
 
 
 
909
        
959
910
        if local and not branch_to.get_bound_location():
960
911
            raise errors.LocalRequiresBoundBranch()
961
912
 
991
942
        else:
992
943
            branch_from = Branch.open(location,
993
944
                possible_transports=possible_transports)
994
 
            self.add_cleanup(branch_from.lock_read().unlock)
995
945
 
996
946
            if branch_to.get_parent() is None or remember:
997
947
                branch_to.set_parent(branch_from.base)
998
948
 
999
 
        if revision is not None:
1000
 
            revision_id = revision.as_revision_id(branch_from)
1001
 
 
1002
 
        if tree_to is not None:
1003
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1004
 
            change_reporter = delta._ChangeReporter(
1005
 
                unversioned_filter=tree_to.is_ignored,
1006
 
                view_info=view_info)
1007
 
            result = tree_to.pull(
1008
 
                branch_from, overwrite, revision_id, change_reporter,
1009
 
                possible_transports=possible_transports, local=local,
1010
 
                show_base=show_base)
1011
 
        else:
1012
 
            result = branch_to.pull(
1013
 
                branch_from, overwrite, revision_id, local=local)
1014
 
 
1015
 
        result.report(self.outf)
1016
 
        if verbose and result.old_revid != result.new_revid:
1017
 
            log.show_branch_change(
1018
 
                branch_to, self.outf, result.old_revno,
1019
 
                result.old_revid)
 
949
        if branch_from is not branch_to:
 
950
            branch_from.lock_read()
 
951
        try:
 
952
            if revision is not None:
 
953
                revision_id = revision.as_revision_id(branch_from)
 
954
 
 
955
            branch_to.lock_write()
 
956
            try:
 
957
                if tree_to is not None:
 
958
                    view_info = _get_view_info_for_change_reporter(tree_to)
 
959
                    change_reporter = delta._ChangeReporter(
 
960
                        unversioned_filter=tree_to.is_ignored,
 
961
                        view_info=view_info)
 
962
                    result = tree_to.pull(
 
963
                        branch_from, overwrite, revision_id, change_reporter,
 
964
                        possible_transports=possible_transports, local=local)
 
965
                else:
 
966
                    result = branch_to.pull(
 
967
                        branch_from, overwrite, revision_id, local=local)
 
968
 
 
969
                result.report(self.outf)
 
970
                if verbose and result.old_revid != result.new_revid:
 
971
                    log.show_branch_change(
 
972
                        branch_to, self.outf, result.old_revno,
 
973
                        result.old_revid)
 
974
            finally:
 
975
                branch_to.unlock()
 
976
        finally:
 
977
            if branch_from is not branch_to:
 
978
                branch_from.unlock()
1020
979
 
1021
980
 
1022
981
class cmd_push(Command):
1023
 
    __doc__ = """Update a mirror of this branch.
 
982
    """Update a mirror of this branch.
1024
983
 
1025
984
    The target branch will not have its working tree populated because this
1026
985
    is both expensive, and is not supported on remote file systems.
1050
1009
        Option('create-prefix',
1051
1010
               help='Create the path leading up to the branch '
1052
1011
                    'if it does not already exist.'),
1053
 
        custom_help('directory',
 
1012
        Option('directory',
1054
1013
            help='Branch to push from, '
1055
 
                 'rather than the one containing the working directory.'),
 
1014
                 'rather than the one containing the working directory.',
 
1015
            short_name='d',
 
1016
            type=unicode,
 
1017
            ),
1056
1018
        Option('use-existing-dir',
1057
1019
               help='By default push will fail if the target'
1058
1020
                    ' directory exists, but does not already'
1068
1030
            type=unicode),
1069
1031
        Option('strict',
1070
1032
               help='Refuse to push if there are uncommitted changes in'
1071
 
               ' the working tree, --no-strict disables the check.'),
1072
 
        Option('no-tree',
1073
 
               help="Don't populate the working tree, even for protocols"
1074
 
               " that support it."),
 
1033
               ' the working tree.'),
1075
1034
        ]
1076
1035
    takes_args = ['location?']
1077
1036
    encoding_type = 'replace'
1079
1038
    def run(self, location=None, remember=False, overwrite=False,
1080
1039
        create_prefix=False, verbose=False, revision=None,
1081
1040
        use_existing_dir=False, directory=None, stacked_on=None,
1082
 
        stacked=False, strict=None, no_tree=False):
 
1041
        stacked=False, strict=None):
1083
1042
        from bzrlib.push import _show_push_branch
1084
1043
 
1085
1044
        if directory is None:
1086
1045
            directory = '.'
1087
1046
        # Get the source branch
1088
 
        (tree, br_from,
1089
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1047
        tree, br_from = bzrdir.BzrDir.open_tree_or_branch(directory)
 
1048
        if strict is None:
 
1049
            strict = br_from.get_config().get_user_option('push_strict')
 
1050
            if strict is not None:
 
1051
                # FIXME: This should be better supported by config
 
1052
                # -- vila 20090611
 
1053
                bools = dict(yes=True, no=False, on=True, off=False,
 
1054
                             true=True, false=False)
 
1055
                try:
 
1056
                    strict = bools[strict.lower()]
 
1057
                except KeyError:
 
1058
                    strict = None
 
1059
        if strict:
 
1060
            changes = tree.changes_from(tree.basis_tree())
 
1061
            if changes.has_changed():
 
1062
                raise errors.UncommittedChanges(tree)
1090
1063
        # Get the tip's revision_id
1091
1064
        revision = _get_one_revision('push', revision)
1092
1065
        if revision is not None:
1093
1066
            revision_id = revision.in_history(br_from).rev_id
1094
1067
        else:
1095
1068
            revision_id = None
1096
 
        if tree is not None and revision_id is None:
1097
 
            tree.check_changed_or_out_of_date(
1098
 
                strict, 'push_strict',
1099
 
                more_error='Use --no-strict to force the push.',
1100
 
                more_warning='Uncommitted changes will not be pushed.')
 
1069
 
1101
1070
        # Get the stacked_on branch, if any
1102
1071
        if stacked_on is not None:
1103
1072
            stacked_on = urlutils.normalize_url(stacked_on)
1131
1100
        _show_push_branch(br_from, revision_id, location, self.outf,
1132
1101
            verbose=verbose, overwrite=overwrite, remember=remember,
1133
1102
            stacked_on=stacked_on, create_prefix=create_prefix,
1134
 
            use_existing_dir=use_existing_dir, no_tree=no_tree)
 
1103
            use_existing_dir=use_existing_dir)
1135
1104
 
1136
1105
 
1137
1106
class cmd_branch(Command):
1138
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
1107
    """Create a new branch that is a copy of an existing branch.
1139
1108
 
1140
1109
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1141
1110
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1150
1119
 
1151
1120
    _see_also = ['checkout']
1152
1121
    takes_args = ['from_location', 'to_location?']
1153
 
    takes_options = ['revision',
1154
 
        Option('hardlink', help='Hard-link working tree files where possible.'),
1155
 
        Option('files-from', type=str,
1156
 
               help="Get file contents from this tree."),
 
1122
    takes_options = ['revision', Option('hardlink',
 
1123
        help='Hard-link working tree files where possible.'),
1157
1124
        Option('no-tree',
1158
1125
            help="Create a branch without a working-tree."),
1159
 
        Option('switch',
1160
 
            help="Switch the checkout in the current directory "
1161
 
                 "to the new branch."),
1162
1126
        Option('stacked',
1163
1127
            help='Create a stacked branch referring to the source branch. '
1164
1128
                'The new branch will depend on the availability of the source '
1165
1129
                'branch for all operations.'),
1166
1130
        Option('standalone',
1167
1131
               help='Do not use a shared repository, even if available.'),
1168
 
        Option('use-existing-dir',
1169
 
               help='By default branch will fail if the target'
1170
 
                    ' directory exists, but does not already'
1171
 
                    ' have a control directory.  This flag will'
1172
 
                    ' allow branch to proceed.'),
1173
 
        Option('bind',
1174
 
            help="Bind new branch to from location."),
1175
1132
        ]
1176
1133
    aliases = ['get', 'clone']
1177
1134
 
1178
1135
    def run(self, from_location, to_location=None, revision=None,
1179
 
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1180
 
            use_existing_dir=False, switch=False, bind=False,
1181
 
            files_from=None):
1182
 
        from bzrlib import switch as _mod_switch
 
1136
            hardlink=False, stacked=False, standalone=False, no_tree=False):
1183
1137
        from bzrlib.tag import _merge_tags_if_possible
 
1138
 
1184
1139
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1185
1140
            from_location)
1186
 
        if not (hardlink or files_from):
1187
 
            # accelerator_tree is usually slower because you have to read N
1188
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1189
 
            # explicitly request it
 
1141
        if (accelerator_tree is not None and
 
1142
            accelerator_tree.supports_content_filtering()):
1190
1143
            accelerator_tree = None
1191
 
        if files_from is not None and files_from != from_location:
1192
 
            accelerator_tree = WorkingTree.open(files_from)
1193
1144
        revision = _get_one_revision('branch', revision)
1194
 
        self.add_cleanup(br_from.lock_read().unlock)
1195
 
        if revision is not None:
1196
 
            revision_id = revision.as_revision_id(br_from)
1197
 
        else:
1198
 
            # FIXME - wt.last_revision, fallback to branch, fall back to
1199
 
            # None or perhaps NULL_REVISION to mean copy nothing
1200
 
            # RBC 20060209
1201
 
            revision_id = br_from.last_revision()
1202
 
        if to_location is None:
1203
 
            to_location = urlutils.derive_to_location(from_location)
1204
 
        to_transport = transport.get_transport(to_location)
 
1145
        br_from.lock_read()
1205
1146
        try:
1206
 
            to_transport.mkdir('.')
1207
 
        except errors.FileExists:
1208
 
            if not use_existing_dir:
1209
 
                raise errors.BzrCommandError('Target directory "%s" '
1210
 
                    'already exists.' % to_location)
 
1147
            if revision is not None:
 
1148
                revision_id = revision.as_revision_id(br_from)
1211
1149
            else:
1212
 
                try:
1213
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
1214
 
                except errors.NotBranchError:
1215
 
                    pass
1216
 
                else:
1217
 
                    raise errors.AlreadyBranchError(to_location)
1218
 
        except errors.NoSuchFile:
1219
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
1220
 
                                         % to_location)
1221
 
        try:
1222
 
            # preserve whatever source format we have.
1223
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1224
 
                                        possible_transports=[to_transport],
1225
 
                                        accelerator_tree=accelerator_tree,
1226
 
                                        hardlink=hardlink, stacked=stacked,
1227
 
                                        force_new_repo=standalone,
1228
 
                                        create_tree_if_local=not no_tree,
1229
 
                                        source_branch=br_from)
1230
 
            branch = dir.open_branch()
1231
 
        except errors.NoSuchRevision:
1232
 
            to_transport.delete_tree('.')
1233
 
            msg = "The branch %s has no revision %s." % (from_location,
1234
 
                revision)
1235
 
            raise errors.BzrCommandError(msg)
1236
 
        _merge_tags_if_possible(br_from, branch)
1237
 
        # If the source branch is stacked, the new branch may
1238
 
        # be stacked whether we asked for that explicitly or not.
1239
 
        # We therefore need a try/except here and not just 'if stacked:'
1240
 
        try:
1241
 
            note('Created new stacked branch referring to %s.' %
1242
 
                branch.get_stacked_on_url())
1243
 
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1244
 
            errors.UnstackableRepositoryFormat), e:
1245
 
            note('Branched %d revision(s).' % branch.revno())
1246
 
        if bind:
1247
 
            # Bind to the parent
1248
 
            parent_branch = Branch.open(from_location)
1249
 
            branch.bind(parent_branch)
1250
 
            note('New branch bound to %s' % from_location)
1251
 
        if switch:
1252
 
            # Switch to the new branch
1253
 
            wt, _ = WorkingTree.open_containing('.')
1254
 
            _mod_switch.switch(wt.bzrdir, branch)
1255
 
            note('Switched to branch: %s',
1256
 
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1150
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
1151
                # None or perhaps NULL_REVISION to mean copy nothing
 
1152
                # RBC 20060209
 
1153
                revision_id = br_from.last_revision()
 
1154
            if to_location is None:
 
1155
                to_location = urlutils.derive_to_location(from_location)
 
1156
            to_transport = transport.get_transport(to_location)
 
1157
            try:
 
1158
                to_transport.mkdir('.')
 
1159
            except errors.FileExists:
 
1160
                raise errors.BzrCommandError('Target directory "%s" already'
 
1161
                                             ' exists.' % to_location)
 
1162
            except errors.NoSuchFile:
 
1163
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1164
                                             % to_location)
 
1165
            try:
 
1166
                # preserve whatever source format we have.
 
1167
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1168
                                            possible_transports=[to_transport],
 
1169
                                            accelerator_tree=accelerator_tree,
 
1170
                                            hardlink=hardlink, stacked=stacked,
 
1171
                                            force_new_repo=standalone,
 
1172
                                            create_tree_if_local=not no_tree,
 
1173
                                            source_branch=br_from)
 
1174
                branch = dir.open_branch()
 
1175
            except errors.NoSuchRevision:
 
1176
                to_transport.delete_tree('.')
 
1177
                msg = "The branch %s has no revision %s." % (from_location,
 
1178
                    revision)
 
1179
                raise errors.BzrCommandError(msg)
 
1180
            _merge_tags_if_possible(br_from, branch)
 
1181
            # If the source branch is stacked, the new branch may
 
1182
            # be stacked whether we asked for that explicitly or not.
 
1183
            # We therefore need a try/except here and not just 'if stacked:'
 
1184
            try:
 
1185
                note('Created new stacked branch referring to %s.' %
 
1186
                    branch.get_stacked_on_url())
 
1187
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1188
                errors.UnstackableRepositoryFormat), e:
 
1189
                note('Branched %d revision(s).' % branch.revno())
 
1190
        finally:
 
1191
            br_from.unlock()
1257
1192
 
1258
1193
 
1259
1194
class cmd_checkout(Command):
1260
 
    __doc__ = """Create a new checkout of an existing branch.
 
1195
    """Create a new checkout of an existing branch.
1261
1196
 
1262
1197
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1263
1198
    the branch found in '.'. This is useful if you have removed the working tree
1302
1237
            to_location = branch_location
1303
1238
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1304
1239
            branch_location)
1305
 
        if not (hardlink or files_from):
1306
 
            # accelerator_tree is usually slower because you have to read N
1307
 
            # files (no readahead, lots of seeks, etc), but allow the user to
1308
 
            # explicitly request it
1309
 
            accelerator_tree = None
1310
1240
        revision = _get_one_revision('checkout', revision)
1311
 
        if files_from is not None and files_from != branch_location:
 
1241
        if files_from is not None:
1312
1242
            accelerator_tree = WorkingTree.open(files_from)
1313
1243
        if revision is not None:
1314
1244
            revision_id = revision.as_revision_id(source)
1331
1261
 
1332
1262
 
1333
1263
class cmd_renames(Command):
1334
 
    __doc__ = """Show list of renamed files.
 
1264
    """Show list of renamed files.
1335
1265
    """
1336
1266
    # TODO: Option to show renames between two historical versions.
1337
1267
 
1342
1272
    @display_command
1343
1273
    def run(self, dir=u'.'):
1344
1274
        tree = WorkingTree.open_containing(dir)[0]
1345
 
        self.add_cleanup(tree.lock_read().unlock)
1346
 
        new_inv = tree.inventory
1347
 
        old_tree = tree.basis_tree()
1348
 
        self.add_cleanup(old_tree.lock_read().unlock)
1349
 
        old_inv = old_tree.inventory
1350
 
        renames = []
1351
 
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1352
 
        for f, paths, c, v, p, n, k, e in iterator:
1353
 
            if paths[0] == paths[1]:
1354
 
                continue
1355
 
            if None in (paths):
1356
 
                continue
1357
 
            renames.append(paths)
1358
 
        renames.sort()
1359
 
        for old_name, new_name in renames:
1360
 
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1275
        tree.lock_read()
 
1276
        try:
 
1277
            new_inv = tree.inventory
 
1278
            old_tree = tree.basis_tree()
 
1279
            old_tree.lock_read()
 
1280
            try:
 
1281
                old_inv = old_tree.inventory
 
1282
                renames = []
 
1283
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1284
                for f, paths, c, v, p, n, k, e in iterator:
 
1285
                    if paths[0] == paths[1]:
 
1286
                        continue
 
1287
                    if None in (paths):
 
1288
                        continue
 
1289
                    renames.append(paths)
 
1290
                renames.sort()
 
1291
                for old_name, new_name in renames:
 
1292
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1293
            finally:
 
1294
                old_tree.unlock()
 
1295
        finally:
 
1296
            tree.unlock()
1361
1297
 
1362
1298
 
1363
1299
class cmd_update(Command):
1364
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1300
    """Update a tree to have the latest code committed to its branch.
1365
1301
 
1366
1302
    This will perform a merge into the working tree, and may generate
1367
1303
    conflicts. If you have any local changes, you will still
1369
1305
 
1370
1306
    If you want to discard your local changes, you can just do a
1371
1307
    'bzr revert' instead of 'bzr commit' after the update.
1372
 
 
1373
 
    If you want to restore a file that has been removed locally, use
1374
 
    'bzr revert' instead of 'bzr update'.
1375
 
 
1376
 
    If the tree's branch is bound to a master branch, it will also update
1377
 
    the branch from the master.
1378
1308
    """
1379
1309
 
1380
1310
    _see_also = ['pull', 'working-trees', 'status-flags']
1381
1311
    takes_args = ['dir?']
1382
 
    takes_options = ['revision',
1383
 
                     Option('show-base',
1384
 
                            help="Show base revision text in conflicts."),
1385
 
                     ]
1386
1312
    aliases = ['up']
1387
1313
 
1388
 
    def run(self, dir='.', revision=None, show_base=None):
1389
 
        if revision is not None and len(revision) != 1:
1390
 
            raise errors.BzrCommandError(
1391
 
                        "bzr update --revision takes exactly one revision")
 
1314
    def run(self, dir='.'):
1392
1315
        tree = WorkingTree.open_containing(dir)[0]
1393
 
        branch = tree.branch
1394
1316
        possible_transports = []
1395
 
        master = branch.get_master_branch(
 
1317
        master = tree.branch.get_master_branch(
1396
1318
            possible_transports=possible_transports)
1397
1319
        if master is not None:
1398
 
            branch_location = master.base
1399
1320
            tree.lock_write()
1400
1321
        else:
1401
 
            branch_location = tree.branch.base
1402
1322
            tree.lock_tree_write()
1403
 
        self.add_cleanup(tree.unlock)
1404
 
        # get rid of the final '/' and be ready for display
1405
 
        branch_location = urlutils.unescape_for_display(
1406
 
            branch_location.rstrip('/'),
1407
 
            self.outf.encoding)
1408
 
        existing_pending_merges = tree.get_parent_ids()[1:]
1409
 
        if master is None:
1410
 
            old_tip = None
1411
 
        else:
1412
 
            # may need to fetch data into a heavyweight checkout
1413
 
            # XXX: this may take some time, maybe we should display a
1414
 
            # message
1415
 
            old_tip = branch.update(possible_transports)
1416
 
        if revision is not None:
1417
 
            revision_id = revision[0].as_revision_id(branch)
1418
 
        else:
1419
 
            revision_id = branch.last_revision()
1420
 
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1421
 
            revno = branch.revision_id_to_dotted_revno(revision_id)
1422
 
            note("Tree is up to date at revision %s of branch %s" %
1423
 
                ('.'.join(map(str, revno)), branch_location))
1424
 
            return 0
1425
 
        view_info = _get_view_info_for_change_reporter(tree)
1426
 
        change_reporter = delta._ChangeReporter(
1427
 
            unversioned_filter=tree.is_ignored,
1428
 
            view_info=view_info)
1429
1323
        try:
 
1324
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1325
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1326
            if last_rev == _mod_revision.ensure_null(
 
1327
                tree.branch.last_revision()):
 
1328
                # may be up to date, check master too.
 
1329
                if master is None or last_rev == _mod_revision.ensure_null(
 
1330
                    master.last_revision()):
 
1331
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1332
                    note("Tree is up to date at revision %d." % (revno,))
 
1333
                    return 0
 
1334
            view_info = _get_view_info_for_change_reporter(tree)
1430
1335
            conflicts = tree.update(
1431
 
                change_reporter,
1432
 
                possible_transports=possible_transports,
1433
 
                revision=revision_id,
1434
 
                old_tip=old_tip,
1435
 
                show_base=show_base)
1436
 
        except errors.NoSuchRevision, e:
1437
 
            raise errors.BzrCommandError(
1438
 
                                  "branch has no revision %s\n"
1439
 
                                  "bzr update --revision only works"
1440
 
                                  " for a revision in the branch history"
1441
 
                                  % (e.revision))
1442
 
        revno = tree.branch.revision_id_to_dotted_revno(
1443
 
            _mod_revision.ensure_null(tree.last_revision()))
1444
 
        note('Updated to revision %s of branch %s' %
1445
 
             ('.'.join(map(str, revno)), branch_location))
1446
 
        parent_ids = tree.get_parent_ids()
1447
 
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
1448
 
            note('Your local commits will now show as pending merges with '
1449
 
                 "'bzr status', and can be committed with 'bzr commit'.")
1450
 
        if conflicts != 0:
1451
 
            return 1
1452
 
        else:
1453
 
            return 0
 
1336
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
 
1337
                view_info=view_info), possible_transports=possible_transports)
 
1338
            revno = tree.branch.revision_id_to_revno(
 
1339
                _mod_revision.ensure_null(tree.last_revision()))
 
1340
            note('Updated to revision %d.' % (revno,))
 
1341
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1342
                note('Your local commits will now show as pending merges with '
 
1343
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1344
            if conflicts != 0:
 
1345
                return 1
 
1346
            else:
 
1347
                return 0
 
1348
        finally:
 
1349
            tree.unlock()
1454
1350
 
1455
1351
 
1456
1352
class cmd_info(Command):
1457
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1353
    """Show information about a working tree, branch or repository.
1458
1354
 
1459
1355
    This command will show all known locations and formats associated to the
1460
1356
    tree, branch or repository.
1498
1394
 
1499
1395
 
1500
1396
class cmd_remove(Command):
1501
 
    __doc__ = """Remove files or directories.
 
1397
    """Remove files or directories.
1502
1398
 
1503
 
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
1504
 
    delete them if they can easily be recovered using revert otherwise they
1505
 
    will be backed up (adding an extention of the form .~#~). If no options or
1506
 
    parameters are given Bazaar will scan for files that are being tracked by
1507
 
    Bazaar but missing in your tree and stop tracking them for you.
 
1399
    This makes bzr stop tracking changes to the specified files. bzr will delete
 
1400
    them if they can easily be recovered using revert. If no options or
 
1401
    parameters are given bzr will scan for files that are being tracked by bzr
 
1402
    but missing in your tree and stop tracking them for you.
1508
1403
    """
1509
1404
    takes_args = ['file*']
1510
1405
    takes_options = ['verbose',
1512
1407
        RegistryOption.from_kwargs('file-deletion-strategy',
1513
1408
            'The file deletion mode to be used.',
1514
1409
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1515
 
            safe='Backup changed files (default).',
1516
 
            keep='Delete from bzr but leave the working copy.',
1517
 
            no_backup='Don\'t backup changed files.',
 
1410
            safe='Only delete files if they can be'
 
1411
                 ' safely recovered (default).',
 
1412
            keep="Don't delete any files.",
1518
1413
            force='Delete all the specified files, even if they can not be '
1519
 
                'recovered and even if they are non-empty directories. '
1520
 
                '(deprecated, use no-backup)')]
 
1414
                'recovered and even if they are non-empty directories.')]
1521
1415
    aliases = ['rm', 'del']
1522
1416
    encoding_type = 'replace'
1523
1417
 
1524
1418
    def run(self, file_list, verbose=False, new=False,
1525
1419
        file_deletion_strategy='safe'):
1526
 
        if file_deletion_strategy == 'force':
1527
 
            note("(The --force option is deprecated, rather use --no-backup "
1528
 
                "in future.)")
1529
 
            file_deletion_strategy = 'no-backup'
1530
 
 
1531
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1420
        tree, file_list = tree_files(file_list)
1532
1421
 
1533
1422
        if file_list is not None:
1534
1423
            file_list = [f for f in file_list]
1535
1424
 
1536
 
        self.add_cleanup(tree.lock_write().unlock)
1537
 
        # Heuristics should probably all move into tree.remove_smart or
1538
 
        # some such?
1539
 
        if new:
1540
 
            added = tree.changes_from(tree.basis_tree(),
1541
 
                specific_files=file_list).added
1542
 
            file_list = sorted([f[0] for f in added], reverse=True)
1543
 
            if len(file_list) == 0:
1544
 
                raise errors.BzrCommandError('No matching files.')
1545
 
        elif file_list is None:
1546
 
            # missing files show up in iter_changes(basis) as
1547
 
            # versioned-with-no-kind.
1548
 
            missing = []
1549
 
            for change in tree.iter_changes(tree.basis_tree()):
1550
 
                # Find paths in the working tree that have no kind:
1551
 
                if change[1][1] is not None and change[6][1] is None:
1552
 
                    missing.append(change[1][1])
1553
 
            file_list = sorted(missing, reverse=True)
1554
 
            file_deletion_strategy = 'keep'
1555
 
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1556
 
            keep_files=file_deletion_strategy=='keep',
1557
 
            force=(file_deletion_strategy=='no-backup'))
 
1425
        tree.lock_write()
 
1426
        try:
 
1427
            # Heuristics should probably all move into tree.remove_smart or
 
1428
            # some such?
 
1429
            if new:
 
1430
                added = tree.changes_from(tree.basis_tree(),
 
1431
                    specific_files=file_list).added
 
1432
                file_list = sorted([f[0] for f in added], reverse=True)
 
1433
                if len(file_list) == 0:
 
1434
                    raise errors.BzrCommandError('No matching files.')
 
1435
            elif file_list is None:
 
1436
                # missing files show up in iter_changes(basis) as
 
1437
                # versioned-with-no-kind.
 
1438
                missing = []
 
1439
                for change in tree.iter_changes(tree.basis_tree()):
 
1440
                    # Find paths in the working tree that have no kind:
 
1441
                    if change[1][1] is not None and change[6][1] is None:
 
1442
                        missing.append(change[1][1])
 
1443
                file_list = sorted(missing, reverse=True)
 
1444
                file_deletion_strategy = 'keep'
 
1445
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1446
                keep_files=file_deletion_strategy=='keep',
 
1447
                force=file_deletion_strategy=='force')
 
1448
        finally:
 
1449
            tree.unlock()
1558
1450
 
1559
1451
 
1560
1452
class cmd_file_id(Command):
1561
 
    __doc__ = """Print file_id of a particular file or directory.
 
1453
    """Print file_id of a particular file or directory.
1562
1454
 
1563
1455
    The file_id is assigned when the file is first added and remains the
1564
1456
    same through all revisions where the file exists, even when it is
1580
1472
 
1581
1473
 
1582
1474
class cmd_file_path(Command):
1583
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1475
    """Print path of file_ids to a file or directory.
1584
1476
 
1585
1477
    This prints one line for each directory down to the target,
1586
1478
    starting at the branch root.
1602
1494
 
1603
1495
 
1604
1496
class cmd_reconcile(Command):
1605
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1497
    """Reconcile bzr metadata in a branch.
1606
1498
 
1607
1499
    This can correct data mismatches that may have been caused by
1608
1500
    previous ghost operations or bzr upgrades. You should only
1622
1514
 
1623
1515
    _see_also = ['check']
1624
1516
    takes_args = ['branch?']
1625
 
    takes_options = [
1626
 
        Option('canonicalize-chks',
1627
 
               help='Make sure CHKs are in canonical form (repairs '
1628
 
                    'bug 522637).',
1629
 
               hidden=True),
1630
 
        ]
1631
1517
 
1632
 
    def run(self, branch=".", canonicalize_chks=False):
 
1518
    def run(self, branch="."):
1633
1519
        from bzrlib.reconcile import reconcile
1634
1520
        dir = bzrdir.BzrDir.open(branch)
1635
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1521
        reconcile(dir)
1636
1522
 
1637
1523
 
1638
1524
class cmd_revision_history(Command):
1639
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1525
    """Display the list of revision ids on a branch."""
1640
1526
 
1641
1527
    _see_also = ['log']
1642
1528
    takes_args = ['location?']
1652
1538
 
1653
1539
 
1654
1540
class cmd_ancestry(Command):
1655
 
    __doc__ = """List all revisions merged into this branch."""
 
1541
    """List all revisions merged into this branch."""
1656
1542
 
1657
1543
    _see_also = ['log', 'revision-history']
1658
1544
    takes_args = ['location?']
1677
1563
 
1678
1564
 
1679
1565
class cmd_init(Command):
1680
 
    __doc__ = """Make a directory into a versioned branch.
 
1566
    """Make a directory into a versioned branch.
1681
1567
 
1682
1568
    Use this to create an empty branch, or before importing an
1683
1569
    existing project.
1711
1597
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1712
1598
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1713
1599
                value_switches=True,
1714
 
                title="Branch format",
 
1600
                title="Branch Format",
1715
1601
                ),
1716
1602
         Option('append-revisions-only',
1717
1603
                help='Never change revnos or the existing log.'
1718
 
                '  Append revisions to it only.'),
1719
 
         Option('no-tree',
1720
 
                'Create a branch without a working tree.')
 
1604
                '  Append revisions to it only.')
1721
1605
         ]
1722
1606
    def run(self, location=None, format=None, append_revisions_only=False,
1723
 
            create_prefix=False, no_tree=False):
 
1607
            create_prefix=False):
1724
1608
        if format is None:
1725
1609
            format = bzrdir.format_registry.make_bzrdir('default')
1726
1610
        if location is None:
1749
1633
        except errors.NotBranchError:
1750
1634
            # really a NotBzrDir error...
1751
1635
            create_branch = bzrdir.BzrDir.create_branch_convenience
1752
 
            if no_tree:
1753
 
                force_new_tree = False
1754
 
            else:
1755
 
                force_new_tree = None
1756
1636
            branch = create_branch(to_transport.base, format=format,
1757
 
                                   possible_transports=[to_transport],
1758
 
                                   force_new_tree=force_new_tree)
 
1637
                                   possible_transports=[to_transport])
1759
1638
            a_bzrdir = branch.bzrdir
1760
1639
        else:
1761
1640
            from bzrlib.transport.local import LocalTransport
1765
1644
                        raise errors.BranchExistsWithoutWorkingTree(location)
1766
1645
                raise errors.AlreadyBranchError(location)
1767
1646
            branch = a_bzrdir.create_branch()
1768
 
            if not no_tree:
1769
 
                a_bzrdir.create_workingtree()
 
1647
            a_bzrdir.create_workingtree()
1770
1648
        if append_revisions_only:
1771
1649
            try:
1772
1650
                branch.set_append_revisions_only(True)
1794
1672
 
1795
1673
 
1796
1674
class cmd_init_repository(Command):
1797
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1675
    """Create a shared repository to hold branches.
1798
1676
 
1799
1677
    New branches created under the repository directory will store their
1800
 
    revisions in the repository, not in the branch directory.  For branches
1801
 
    with shared history, this reduces the amount of storage needed and 
1802
 
    speeds up the creation of new branches.
 
1678
    revisions in the repository, not in the branch directory.
1803
1679
 
1804
 
    If the --no-trees option is given then the branches in the repository
1805
 
    will not have working trees by default.  They will still exist as 
1806
 
    directories on disk, but they will not have separate copies of the 
1807
 
    files at a certain revision.  This can be useful for repositories that
1808
 
    store branches which are interacted with through checkouts or remote
1809
 
    branches, such as on a server.
 
1680
    If the --no-trees option is used then the branches in the repository
 
1681
    will not have working trees by default.
1810
1682
 
1811
1683
    :Examples:
1812
 
        Create a shared repository holding just branches::
 
1684
        Create a shared repositories holding just branches::
1813
1685
 
1814
1686
            bzr init-repo --no-trees repo
1815
1687
            bzr init repo/trunk
1854
1726
 
1855
1727
 
1856
1728
class cmd_diff(Command):
1857
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1729
    """Show differences in the working tree, between revisions or branches.
1858
1730
 
1859
1731
    If no arguments are given, all changes for the current tree are listed.
1860
1732
    If files are given, only the changes in those files are listed.
1866
1738
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1867
1739
    produces patches suitable for "patch -p1".
1868
1740
 
1869
 
    Note that when using the -r argument with a range of revisions, the
1870
 
    differences are computed between the two specified revisions.  That
1871
 
    is, the command does not show the changes introduced by the first 
1872
 
    revision in the range.  This differs from the interpretation of 
1873
 
    revision ranges used by "bzr log" which includes the first revision
1874
 
    in the range.
1875
 
 
1876
1741
    :Exit values:
1877
1742
        1 - changed
1878
1743
        2 - unrepresentable changes
1888
1753
 
1889
1754
            bzr diff -r1
1890
1755
 
1891
 
        Difference between revision 3 and revision 1::
1892
 
 
1893
 
            bzr diff -r1..3
1894
 
 
1895
 
        Difference between revision 3 and revision 1 for branch xxx::
1896
 
 
1897
 
            bzr diff -r1..3 xxx
1898
 
 
1899
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
1900
 
 
1901
 
            bzr diff -c2
1902
 
 
1903
 
        To see the changes introduced by revision X::
1904
 
        
1905
 
            bzr diff -cX
1906
 
 
1907
 
        Note that in the case of a merge, the -c option shows the changes
1908
 
        compared to the left hand parent. To see the changes against
1909
 
        another parent, use::
1910
 
 
1911
 
            bzr diff -r<chosen_parent>..X
1912
 
 
1913
 
        The changes between the current revision and the previous revision
1914
 
        (equivalent to -c-1 and -r-2..-1)
1915
 
 
1916
 
            bzr diff -r-2..
 
1756
        Difference between revision 2 and revision 1::
 
1757
 
 
1758
            bzr diff -r1..2
 
1759
 
 
1760
        Difference between revision 2 and revision 1 for branch xxx::
 
1761
 
 
1762
            bzr diff -r1..2 xxx
1917
1763
 
1918
1764
        Show just the differences for file NEWS::
1919
1765
 
1934
1780
        Same as 'bzr diff' but prefix paths with old/ and new/::
1935
1781
 
1936
1782
            bzr diff --prefix old/:new/
1937
 
            
1938
 
        Show the differences using a custom diff program with options::
1939
 
        
1940
 
            bzr diff --using /usr/bin/diff --diff-options -wu
1941
1783
    """
1942
1784
    _see_also = ['status']
1943
1785
    takes_args = ['file*']
1962
1804
            help='Use this command to compare files.',
1963
1805
            type=unicode,
1964
1806
            ),
1965
 
        RegistryOption('format',
1966
 
            help='Diff format to use.',
1967
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1968
 
            value_switches=False, title='Diff format'),
1969
1807
        ]
1970
1808
    aliases = ['di', 'dif']
1971
1809
    encoding_type = 'exact'
1972
1810
 
1973
1811
    @display_command
1974
1812
    def run(self, revision=None, file_list=None, diff_options=None,
1975
 
            prefix=None, old=None, new=None, using=None, format=None):
1976
 
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
1977
 
            show_diff_trees)
 
1813
            prefix=None, old=None, new=None, using=None):
 
1814
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1978
1815
 
1979
1816
        if (prefix is None) or (prefix == '0'):
1980
1817
            # diff -p0 format
1994
1831
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1995
1832
                                         ' one or two revision specifiers')
1996
1833
 
1997
 
        if using is not None and format is not None:
1998
 
            raise errors.BzrCommandError('--using and --format are mutually '
1999
 
                'exclusive.')
2000
 
 
2001
 
        (old_tree, new_tree,
2002
 
         old_branch, new_branch,
2003
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
2004
 
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
2005
 
        # GNU diff on Windows uses ANSI encoding for filenames
2006
 
        path_encoding = osutils.get_diff_header_encoding()
 
1834
        old_tree, new_tree, specific_files, extra_trees = \
 
1835
                _get_trees_to_diff(file_list, revision, old, new,
 
1836
                apply_view=True)
2007
1837
        return show_diff_trees(old_tree, new_tree, sys.stdout,
2008
1838
                               specific_files=specific_files,
2009
1839
                               external_diff_options=diff_options,
2010
1840
                               old_label=old_label, new_label=new_label,
2011
 
                               extra_trees=extra_trees,
2012
 
                               path_encoding=path_encoding,
2013
 
                               using=using,
2014
 
                               format_cls=format)
 
1841
                               extra_trees=extra_trees, using=using)
2015
1842
 
2016
1843
 
2017
1844
class cmd_deleted(Command):
2018
 
    __doc__ = """List files deleted in the working tree.
 
1845
    """List files deleted in the working tree.
2019
1846
    """
2020
1847
    # TODO: Show files deleted since a previous revision, or
2021
1848
    # between two revisions.
2024
1851
    # level of effort but possibly much less IO.  (Or possibly not,
2025
1852
    # if the directories are very large...)
2026
1853
    _see_also = ['status', 'ls']
2027
 
    takes_options = ['directory', 'show-ids']
 
1854
    takes_options = ['show-ids']
2028
1855
 
2029
1856
    @display_command
2030
 
    def run(self, show_ids=False, directory=u'.'):
2031
 
        tree = WorkingTree.open_containing(directory)[0]
2032
 
        self.add_cleanup(tree.lock_read().unlock)
2033
 
        old = tree.basis_tree()
2034
 
        self.add_cleanup(old.lock_read().unlock)
2035
 
        for path, ie in old.inventory.iter_entries():
2036
 
            if not tree.has_id(ie.file_id):
2037
 
                self.outf.write(path)
2038
 
                if show_ids:
2039
 
                    self.outf.write(' ')
2040
 
                    self.outf.write(ie.file_id)
2041
 
                self.outf.write('\n')
 
1857
    def run(self, show_ids=False):
 
1858
        tree = WorkingTree.open_containing(u'.')[0]
 
1859
        tree.lock_read()
 
1860
        try:
 
1861
            old = tree.basis_tree()
 
1862
            old.lock_read()
 
1863
            try:
 
1864
                for path, ie in old.inventory.iter_entries():
 
1865
                    if not tree.has_id(ie.file_id):
 
1866
                        self.outf.write(path)
 
1867
                        if show_ids:
 
1868
                            self.outf.write(' ')
 
1869
                            self.outf.write(ie.file_id)
 
1870
                        self.outf.write('\n')
 
1871
            finally:
 
1872
                old.unlock()
 
1873
        finally:
 
1874
            tree.unlock()
2042
1875
 
2043
1876
 
2044
1877
class cmd_modified(Command):
2045
 
    __doc__ = """List files modified in working tree.
 
1878
    """List files modified in working tree.
2046
1879
    """
2047
1880
 
2048
1881
    hidden = True
2049
1882
    _see_also = ['status', 'ls']
2050
 
    takes_options = ['directory', 'null']
 
1883
    takes_options = [
 
1884
            Option('null',
 
1885
                   help='Write an ascii NUL (\\0) separator '
 
1886
                   'between files rather than a newline.')
 
1887
            ]
2051
1888
 
2052
1889
    @display_command
2053
 
    def run(self, null=False, directory=u'.'):
2054
 
        tree = WorkingTree.open_containing(directory)[0]
 
1890
    def run(self, null=False):
 
1891
        tree = WorkingTree.open_containing(u'.')[0]
2055
1892
        td = tree.changes_from(tree.basis_tree())
2056
1893
        for path, id, kind, text_modified, meta_modified in td.modified:
2057
1894
            if null:
2061
1898
 
2062
1899
 
2063
1900
class cmd_added(Command):
2064
 
    __doc__ = """List files added in working tree.
 
1901
    """List files added in working tree.
2065
1902
    """
2066
1903
 
2067
1904
    hidden = True
2068
1905
    _see_also = ['status', 'ls']
2069
 
    takes_options = ['directory', 'null']
 
1906
    takes_options = [
 
1907
            Option('null',
 
1908
                   help='Write an ascii NUL (\\0) separator '
 
1909
                   'between files rather than a newline.')
 
1910
            ]
2070
1911
 
2071
1912
    @display_command
2072
 
    def run(self, null=False, directory=u'.'):
2073
 
        wt = WorkingTree.open_containing(directory)[0]
2074
 
        self.add_cleanup(wt.lock_read().unlock)
2075
 
        basis = wt.basis_tree()
2076
 
        self.add_cleanup(basis.lock_read().unlock)
2077
 
        basis_inv = basis.inventory
2078
 
        inv = wt.inventory
2079
 
        for file_id in inv:
2080
 
            if file_id in basis_inv:
2081
 
                continue
2082
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2083
 
                continue
2084
 
            path = inv.id2path(file_id)
2085
 
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2086
 
                continue
2087
 
            if null:
2088
 
                self.outf.write(path + '\0')
2089
 
            else:
2090
 
                self.outf.write(osutils.quotefn(path) + '\n')
 
1913
    def run(self, null=False):
 
1914
        wt = WorkingTree.open_containing(u'.')[0]
 
1915
        wt.lock_read()
 
1916
        try:
 
1917
            basis = wt.basis_tree()
 
1918
            basis.lock_read()
 
1919
            try:
 
1920
                basis_inv = basis.inventory
 
1921
                inv = wt.inventory
 
1922
                for file_id in inv:
 
1923
                    if file_id in basis_inv:
 
1924
                        continue
 
1925
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1926
                        continue
 
1927
                    path = inv.id2path(file_id)
 
1928
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1929
                        continue
 
1930
                    if null:
 
1931
                        self.outf.write(path + '\0')
 
1932
                    else:
 
1933
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1934
            finally:
 
1935
                basis.unlock()
 
1936
        finally:
 
1937
            wt.unlock()
2091
1938
 
2092
1939
 
2093
1940
class cmd_root(Command):
2094
 
    __doc__ = """Show the tree root directory.
 
1941
    """Show the tree root directory.
2095
1942
 
2096
1943
    The root is the nearest enclosing directory with a .bzr control
2097
1944
    directory."""
2121
1968
 
2122
1969
 
2123
1970
class cmd_log(Command):
2124
 
    __doc__ = """Show historical log for a branch or subset of a branch.
 
1971
    """Show historical log for a branch or subset of a branch.
2125
1972
 
2126
1973
    log is bzr's default tool for exploring the history of a branch.
2127
1974
    The branch to use is taken from the first parameter. If no parameters
2238
2085
    :Tips & tricks:
2239
2086
 
2240
2087
      GUI tools and IDEs are often better at exploring history than command
2241
 
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
2242
 
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
2243
 
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
2244
 
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2088
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2089
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2090
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2091
 
 
2092
      Web interfaces are often better at exploring history than command line
 
2093
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2094
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
2245
2095
 
2246
2096
      You may find it useful to add the aliases below to ``bazaar.conf``::
2247
2097
 
2288
2138
                   help='Show just the specified revision.'
2289
2139
                   ' See also "help revisionspec".'),
2290
2140
            'log-format',
2291
 
            RegistryOption('authors',
2292
 
                'What names to list as authors - first, all or committer.',
2293
 
                title='Authors',
2294
 
                lazy_registry=('bzrlib.log', 'author_list_registry'),
2295
 
            ),
2296
2141
            Option('levels',
2297
2142
                   short_name='n',
2298
2143
                   help='Number of levels to display - 0 for all, 1 for flat.',
2313
2158
                   help='Show changes made in each revision as a patch.'),
2314
2159
            Option('include-merges',
2315
2160
                   help='Show merged revisions like --levels 0 does.'),
2316
 
            Option('exclude-common-ancestry',
2317
 
                   help='Display only the revisions that are not part'
2318
 
                   ' of both ancestries (require -rX..Y)'
2319
 
                   )
2320
2161
            ]
2321
2162
    encoding_type = 'replace'
2322
2163
 
2332
2173
            message=None,
2333
2174
            limit=None,
2334
2175
            show_diff=False,
2335
 
            include_merges=False,
2336
 
            authors=None,
2337
 
            exclude_common_ancestry=False,
2338
 
            ):
 
2176
            include_merges=False):
2339
2177
        from bzrlib.log import (
2340
2178
            Logger,
2341
2179
            make_log_request_dict,
2342
2180
            _get_info_for_log_files,
2343
2181
            )
2344
2182
        direction = (forward and 'forward') or 'reverse'
2345
 
        if (exclude_common_ancestry
2346
 
            and (revision is None or len(revision) != 2)):
2347
 
            raise errors.BzrCommandError(
2348
 
                '--exclude-common-ancestry requires -r with two revisions')
2349
2183
        if include_merges:
2350
2184
            if levels is None:
2351
2185
                levels = 0
2366
2200
        filter_by_dir = False
2367
2201
        if file_list:
2368
2202
            # find the file ids to log and check for directory filtering
2369
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2370
 
                revision, file_list, self.add_cleanup)
 
2203
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2204
                file_list)
2371
2205
            for relpath, file_id, kind in file_info_list:
2372
2206
                if file_id is None:
2373
2207
                    raise errors.BzrCommandError(
2391
2225
                location = '.'
2392
2226
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2393
2227
            b = dir.open_branch()
2394
 
            self.add_cleanup(b.lock_read().unlock)
2395
2228
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2396
2229
 
2397
2230
        # Decide on the type of delta & diff filtering to use
2407
2240
        else:
2408
2241
            diff_type = 'full'
2409
2242
 
2410
 
        # Build the log formatter
2411
 
        if log_format is None:
2412
 
            log_format = log.log_formatter_registry.get_default(b)
2413
 
        # Make a non-encoding output to include the diffs - bug 328007
2414
 
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
2415
 
        lf = log_format(show_ids=show_ids, to_file=self.outf,
2416
 
                        to_exact_file=unencoded_output,
2417
 
                        show_timezone=timezone,
2418
 
                        delta_format=get_verbosity_level(),
2419
 
                        levels=levels,
2420
 
                        show_advice=levels is None,
2421
 
                        author_list_handler=authors)
2422
 
 
2423
 
        # Choose the algorithm for doing the logging. It's annoying
2424
 
        # having multiple code paths like this but necessary until
2425
 
        # the underlying repository format is faster at generating
2426
 
        # deltas or can provide everything we need from the indices.
2427
 
        # The default algorithm - match-using-deltas - works for
2428
 
        # multiple files and directories and is faster for small
2429
 
        # amounts of history (200 revisions say). However, it's too
2430
 
        # slow for logging a single file in a repository with deep
2431
 
        # history, i.e. > 10K revisions. In the spirit of "do no
2432
 
        # evil when adding features", we continue to use the
2433
 
        # original algorithm - per-file-graph - for the "single
2434
 
        # file that isn't a directory without showing a delta" case.
2435
 
        partial_history = revision and b.repository._format.supports_chks
2436
 
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2437
 
            or delta_type or partial_history)
2438
 
 
2439
 
        # Build the LogRequest and execute it
2440
 
        if len(file_ids) == 0:
2441
 
            file_ids = None
2442
 
        rqst = make_log_request_dict(
2443
 
            direction=direction, specific_fileids=file_ids,
2444
 
            start_revision=rev1, end_revision=rev2, limit=limit,
2445
 
            message_search=message, delta_type=delta_type,
2446
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
2447
 
            exclude_common_ancestry=exclude_common_ancestry,
2448
 
            )
2449
 
        Logger(b, rqst).show(lf)
 
2243
        b.lock_read()
 
2244
        try:
 
2245
            # Build the log formatter
 
2246
            if log_format is None:
 
2247
                log_format = log.log_formatter_registry.get_default(b)
 
2248
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2249
                            show_timezone=timezone,
 
2250
                            delta_format=get_verbosity_level(),
 
2251
                            levels=levels,
 
2252
                            show_advice=levels is None)
 
2253
 
 
2254
            # Choose the algorithm for doing the logging. It's annoying
 
2255
            # having multiple code paths like this but necessary until
 
2256
            # the underlying repository format is faster at generating
 
2257
            # deltas or can provide everything we need from the indices.
 
2258
            # The default algorithm - match-using-deltas - works for
 
2259
            # multiple files and directories and is faster for small
 
2260
            # amounts of history (200 revisions say). However, it's too
 
2261
            # slow for logging a single file in a repository with deep
 
2262
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2263
            # evil when adding features", we continue to use the
 
2264
            # original algorithm - per-file-graph - for the "single
 
2265
            # file that isn't a directory without showing a delta" case.
 
2266
            partial_history = revision and b.repository._format.supports_chks
 
2267
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2268
                or delta_type or partial_history)
 
2269
 
 
2270
            # Build the LogRequest and execute it
 
2271
            if len(file_ids) == 0:
 
2272
                file_ids = None
 
2273
            rqst = make_log_request_dict(
 
2274
                direction=direction, specific_fileids=file_ids,
 
2275
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2276
                message_search=message, delta_type=delta_type,
 
2277
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2278
            Logger(b, rqst).show(lf)
 
2279
        finally:
 
2280
            b.unlock()
2450
2281
 
2451
2282
 
2452
2283
def _get_revision_range(revisionspec_list, branch, command_name):
2470
2301
            raise errors.BzrCommandError(
2471
2302
                "bzr %s doesn't accept two revisions in different"
2472
2303
                " branches." % command_name)
2473
 
        if start_spec.spec is None:
2474
 
            # Avoid loading all the history.
2475
 
            rev1 = RevisionInfo(branch, None, None)
2476
 
        else:
2477
 
            rev1 = start_spec.in_history(branch)
 
2304
        rev1 = start_spec.in_history(branch)
2478
2305
        # Avoid loading all of history when we know a missing
2479
2306
        # end of range means the last revision ...
2480
2307
        if end_spec.spec is None:
2509
2336
 
2510
2337
 
2511
2338
class cmd_touching_revisions(Command):
2512
 
    __doc__ = """Return revision-ids which affected a particular file.
 
2339
    """Return revision-ids which affected a particular file.
2513
2340
 
2514
2341
    A more user-friendly interface is "bzr log FILE".
2515
2342
    """
2520
2347
    @display_command
2521
2348
    def run(self, filename):
2522
2349
        tree, relpath = WorkingTree.open_containing(filename)
 
2350
        b = tree.branch
2523
2351
        file_id = tree.path2id(relpath)
2524
 
        b = tree.branch
2525
 
        self.add_cleanup(b.lock_read().unlock)
2526
 
        touching_revs = log.find_touching_revisions(b, file_id)
2527
 
        for revno, revision_id, what in touching_revs:
 
2352
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2528
2353
            self.outf.write("%6d %s\n" % (revno, what))
2529
2354
 
2530
2355
 
2531
2356
class cmd_ls(Command):
2532
 
    __doc__ = """List files in a tree.
 
2357
    """List files in a tree.
2533
2358
    """
2534
2359
 
2535
2360
    _see_also = ['status', 'cat']
2541
2366
                   help='Recurse into subdirectories.'),
2542
2367
            Option('from-root',
2543
2368
                   help='Print paths relative to the root of the branch.'),
2544
 
            Option('unknown', short_name='u',
2545
 
                help='Print unknown files.'),
 
2369
            Option('unknown', help='Print unknown files.'),
2546
2370
            Option('versioned', help='Print versioned files.',
2547
2371
                   short_name='V'),
2548
 
            Option('ignored', short_name='i',
2549
 
                help='Print ignored files.'),
2550
 
            Option('kind', short_name='k',
 
2372
            Option('ignored', help='Print ignored files.'),
 
2373
            Option('null',
 
2374
                   help='Write an ascii NUL (\\0) separator '
 
2375
                   'between files rather than a newline.'),
 
2376
            Option('kind',
2551
2377
                   help='List entries of a particular kind: file, directory, symlink.',
2552
2378
                   type=unicode),
2553
 
            'null',
2554
2379
            'show-ids',
2555
 
            'directory',
2556
2380
            ]
2557
2381
    @display_command
2558
2382
    def run(self, revision=None, verbose=False,
2559
2383
            recursive=False, from_root=False,
2560
2384
            unknown=False, versioned=False, ignored=False,
2561
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
2385
            null=False, kind=None, show_ids=False, path=None):
2562
2386
 
2563
2387
        if kind and kind not in ('file', 'directory', 'symlink'):
2564
2388
            raise errors.BzrCommandError('invalid kind specified')
2576
2400
                raise errors.BzrCommandError('cannot specify both --from-root'
2577
2401
                                             ' and PATH')
2578
2402
            fs_path = path
2579
 
        tree, branch, relpath = \
2580
 
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2403
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2404
            fs_path)
2581
2405
 
2582
2406
        # Calculate the prefix to use
2583
2407
        prefix = None
2584
2408
        if from_root:
2585
2409
            if relpath:
2586
2410
                prefix = relpath + '/'
2587
 
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2411
        elif fs_path != '.':
2588
2412
            prefix = fs_path + '/'
2589
2413
 
2590
2414
        if revision is not None or tree is None:
2598
2422
                view_str = views.view_display_str(view_files)
2599
2423
                note("Ignoring files outside view. View is %s" % view_str)
2600
2424
 
2601
 
        self.add_cleanup(tree.lock_read().unlock)
2602
 
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2603
 
            from_dir=relpath, recursive=recursive):
2604
 
            # Apply additional masking
2605
 
            if not all and not selection[fc]:
2606
 
                continue
2607
 
            if kind is not None and fkind != kind:
2608
 
                continue
2609
 
            if apply_view:
2610
 
                try:
2611
 
                    if relpath:
2612
 
                        fullpath = osutils.pathjoin(relpath, fp)
2613
 
                    else:
2614
 
                        fullpath = fp
2615
 
                    views.check_path_in_view(tree, fullpath)
2616
 
                except errors.FileOutsideView:
2617
 
                    continue
 
2425
        tree.lock_read()
 
2426
        try:
 
2427
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2428
                from_dir=relpath, recursive=recursive):
 
2429
                # Apply additional masking
 
2430
                if not all and not selection[fc]:
 
2431
                    continue
 
2432
                if kind is not None and fkind != kind:
 
2433
                    continue
 
2434
                if apply_view:
 
2435
                    try:
 
2436
                        if relpath:
 
2437
                            fullpath = osutils.pathjoin(relpath, fp)
 
2438
                        else:
 
2439
                            fullpath = fp
 
2440
                        views.check_path_in_view(tree, fullpath)
 
2441
                    except errors.FileOutsideView:
 
2442
                        continue
2618
2443
 
2619
 
            # Output the entry
2620
 
            if prefix:
2621
 
                fp = osutils.pathjoin(prefix, fp)
2622
 
            kindch = entry.kind_character()
2623
 
            outstring = fp + kindch
2624
 
            ui.ui_factory.clear_term()
2625
 
            if verbose:
2626
 
                outstring = '%-8s %s' % (fc, outstring)
2627
 
                if show_ids and fid is not None:
2628
 
                    outstring = "%-50s %s" % (outstring, fid)
2629
 
                self.outf.write(outstring + '\n')
2630
 
            elif null:
2631
 
                self.outf.write(fp + '\0')
2632
 
                if show_ids:
2633
 
                    if fid is not None:
2634
 
                        self.outf.write(fid)
2635
 
                    self.outf.write('\0')
2636
 
                self.outf.flush()
2637
 
            else:
2638
 
                if show_ids:
2639
 
                    if fid is not None:
2640
 
                        my_id = fid
2641
 
                    else:
2642
 
                        my_id = ''
2643
 
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
2644
 
                else:
 
2444
                # Output the entry
 
2445
                if prefix:
 
2446
                    fp = osutils.pathjoin(prefix, fp)
 
2447
                kindch = entry.kind_character()
 
2448
                outstring = fp + kindch
 
2449
                ui.ui_factory.clear_term()
 
2450
                if verbose:
 
2451
                    outstring = '%-8s %s' % (fc, outstring)
 
2452
                    if show_ids and fid is not None:
 
2453
                        outstring = "%-50s %s" % (outstring, fid)
2645
2454
                    self.outf.write(outstring + '\n')
 
2455
                elif null:
 
2456
                    self.outf.write(fp + '\0')
 
2457
                    if show_ids:
 
2458
                        if fid is not None:
 
2459
                            self.outf.write(fid)
 
2460
                        self.outf.write('\0')
 
2461
                    self.outf.flush()
 
2462
                else:
 
2463
                    if show_ids:
 
2464
                        if fid is not None:
 
2465
                            my_id = fid
 
2466
                        else:
 
2467
                            my_id = ''
 
2468
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2469
                    else:
 
2470
                        self.outf.write(outstring + '\n')
 
2471
        finally:
 
2472
            tree.unlock()
2646
2473
 
2647
2474
 
2648
2475
class cmd_unknowns(Command):
2649
 
    __doc__ = """List unknown files.
 
2476
    """List unknown files.
2650
2477
    """
2651
2478
 
2652
2479
    hidden = True
2653
2480
    _see_also = ['ls']
2654
 
    takes_options = ['directory']
2655
2481
 
2656
2482
    @display_command
2657
 
    def run(self, directory=u'.'):
2658
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
2483
    def run(self):
 
2484
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2659
2485
            self.outf.write(osutils.quotefn(f) + '\n')
2660
2486
 
2661
2487
 
2662
2488
class cmd_ignore(Command):
2663
 
    __doc__ = """Ignore specified files or patterns.
 
2489
    """Ignore specified files or patterns.
2664
2490
 
2665
2491
    See ``bzr help patterns`` for details on the syntax of patterns.
2666
2492
 
2667
 
    If a .bzrignore file does not exist, the ignore command
2668
 
    will create one and add the specified files or patterns to the newly
2669
 
    created file. The ignore command will also automatically add the 
2670
 
    .bzrignore file to be versioned. Creating a .bzrignore file without
2671
 
    the use of the ignore command will require an explicit add command.
2672
 
 
2673
2493
    To remove patterns from the ignore list, edit the .bzrignore file.
2674
2494
    After adding, editing or deleting that file either indirectly by
2675
2495
    using this command or directly by using an editor, be sure to commit
2676
2496
    it.
2677
 
    
2678
 
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
2679
 
    the global ignore file can be found in the application data directory as
2680
 
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
2681
 
    Global ignores are not touched by this command. The global ignore file
2682
 
    can be edited directly using an editor.
2683
 
 
2684
 
    Patterns prefixed with '!' are exceptions to ignore patterns and take
2685
 
    precedence over regular ignores.  Such exceptions are used to specify
2686
 
    files that should be versioned which would otherwise be ignored.
2687
 
    
2688
 
    Patterns prefixed with '!!' act as regular ignore patterns, but have
2689
 
    precedence over the '!' exception patterns.
2690
 
 
2691
 
    :Notes: 
2692
 
        
2693
 
    * Ignore patterns containing shell wildcards must be quoted from
2694
 
      the shell on Unix.
2695
 
 
2696
 
    * Ignore patterns starting with "#" act as comments in the ignore file.
2697
 
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
2497
 
 
2498
    Note: ignore patterns containing shell wildcards must be quoted from
 
2499
    the shell on Unix.
2698
2500
 
2699
2501
    :Examples:
2700
2502
        Ignore the top level Makefile::
2701
2503
 
2702
2504
            bzr ignore ./Makefile
2703
2505
 
2704
 
        Ignore .class files in all directories...::
 
2506
        Ignore class files in all directories::
2705
2507
 
2706
2508
            bzr ignore "*.class"
2707
2509
 
2708
 
        ...but do not ignore "special.class"::
2709
 
 
2710
 
            bzr ignore "!special.class"
2711
 
 
2712
 
        Ignore files whose name begins with the "#" character::
2713
 
 
2714
 
            bzr ignore "RE:^#"
2715
 
 
2716
2510
        Ignore .o files under the lib directory::
2717
2511
 
2718
2512
            bzr ignore "lib/**/*.o"
2724
2518
        Ignore everything but the "debian" toplevel directory::
2725
2519
 
2726
2520
            bzr ignore "RE:(?!debian/).*"
2727
 
        
2728
 
        Ignore everything except the "local" toplevel directory,
2729
 
        but always ignore "*~" autosave files, even under local/::
2730
 
        
2731
 
            bzr ignore "*"
2732
 
            bzr ignore "!./local"
2733
 
            bzr ignore "!!*~"
2734
2521
    """
2735
2522
 
2736
2523
    _see_also = ['status', 'ignored', 'patterns']
2737
2524
    takes_args = ['name_pattern*']
2738
 
    takes_options = ['directory',
2739
 
        Option('default-rules',
2740
 
               help='Display the default ignore rules that bzr uses.')
 
2525
    takes_options = [
 
2526
        Option('old-default-rules',
 
2527
               help='Write out the ignore rules bzr < 0.9 always used.')
2741
2528
        ]
2742
2529
 
2743
 
    def run(self, name_pattern_list=None, default_rules=None,
2744
 
            directory=u'.'):
 
2530
    def run(self, name_pattern_list=None, old_default_rules=None):
2745
2531
        from bzrlib import ignores
2746
 
        if default_rules is not None:
2747
 
            # dump the default rules and exit
2748
 
            for pattern in ignores.USER_DEFAULTS:
2749
 
                self.outf.write("%s\n" % pattern)
 
2532
        if old_default_rules is not None:
 
2533
            # dump the rules and exit
 
2534
            for pattern in ignores.OLD_DEFAULTS:
 
2535
                print pattern
2750
2536
            return
2751
2537
        if not name_pattern_list:
2752
2538
            raise errors.BzrCommandError("ignore requires at least one "
2753
 
                "NAME_PATTERN or --default-rules.")
 
2539
                                  "NAME_PATTERN or --old-default-rules")
2754
2540
        name_pattern_list = [globbing.normalize_pattern(p)
2755
2541
                             for p in name_pattern_list]
2756
 
        bad_patterns = ''
2757
 
        for p in name_pattern_list:
2758
 
            if not globbing.Globster.is_pattern_valid(p):
2759
 
                bad_patterns += ('\n  %s' % p)
2760
 
        if bad_patterns:
2761
 
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
2762
 
            ui.ui_factory.show_error(msg)
2763
 
            raise errors.InvalidPattern('')
2764
2542
        for name_pattern in name_pattern_list:
2765
2543
            if (name_pattern[0] == '/' or
2766
2544
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2767
2545
                raise errors.BzrCommandError(
2768
2546
                    "NAME_PATTERN should not be an absolute path")
2769
 
        tree, relpath = WorkingTree.open_containing(directory)
 
2547
        tree, relpath = WorkingTree.open_containing(u'.')
2770
2548
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2771
2549
        ignored = globbing.Globster(name_pattern_list)
2772
2550
        matches = []
2773
 
        self.add_cleanup(tree.lock_read().unlock)
 
2551
        tree.lock_read()
2774
2552
        for entry in tree.list_files():
2775
2553
            id = entry[3]
2776
2554
            if id is not None:
2777
2555
                filename = entry[0]
2778
2556
                if ignored.match(filename):
2779
 
                    matches.append(filename)
 
2557
                    matches.append(filename.encode('utf-8'))
 
2558
        tree.unlock()
2780
2559
        if len(matches) > 0:
2781
 
            self.outf.write("Warning: the following files are version controlled and"
2782
 
                  " match your ignore pattern:\n%s"
2783
 
                  "\nThese files will continue to be version controlled"
2784
 
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2560
            print "Warning: the following files are version controlled and" \
 
2561
                  " match your ignore pattern:\n%s" \
 
2562
                  "\nThese files will continue to be version controlled" \
 
2563
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
2785
2564
 
2786
2565
 
2787
2566
class cmd_ignored(Command):
2788
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2567
    """List ignored files and the patterns that matched them.
2789
2568
 
2790
2569
    List all the ignored files and the ignore pattern that caused the file to
2791
2570
    be ignored.
2797
2576
 
2798
2577
    encoding_type = 'replace'
2799
2578
    _see_also = ['ignore', 'ls']
2800
 
    takes_options = ['directory']
2801
2579
 
2802
2580
    @display_command
2803
 
    def run(self, directory=u'.'):
2804
 
        tree = WorkingTree.open_containing(directory)[0]
2805
 
        self.add_cleanup(tree.lock_read().unlock)
2806
 
        for path, file_class, kind, file_id, entry in tree.list_files():
2807
 
            if file_class != 'I':
2808
 
                continue
2809
 
            ## XXX: Slightly inefficient since this was already calculated
2810
 
            pat = tree.is_ignored(path)
2811
 
            self.outf.write('%-50s %s\n' % (path, pat))
 
2581
    def run(self):
 
2582
        tree = WorkingTree.open_containing(u'.')[0]
 
2583
        tree.lock_read()
 
2584
        try:
 
2585
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2586
                if file_class != 'I':
 
2587
                    continue
 
2588
                ## XXX: Slightly inefficient since this was already calculated
 
2589
                pat = tree.is_ignored(path)
 
2590
                self.outf.write('%-50s %s\n' % (path, pat))
 
2591
        finally:
 
2592
            tree.unlock()
2812
2593
 
2813
2594
 
2814
2595
class cmd_lookup_revision(Command):
2815
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2596
    """Lookup the revision-id from a revision-number
2816
2597
 
2817
2598
    :Examples:
2818
2599
        bzr lookup-revision 33
2819
2600
    """
2820
2601
    hidden = True
2821
2602
    takes_args = ['revno']
2822
 
    takes_options = ['directory']
2823
2603
 
2824
2604
    @display_command
2825
 
    def run(self, revno, directory=u'.'):
 
2605
    def run(self, revno):
2826
2606
        try:
2827
2607
            revno = int(revno)
2828
2608
        except ValueError:
2829
 
            raise errors.BzrCommandError("not a valid revision-number: %r"
2830
 
                                         % revno)
2831
 
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
2832
 
        self.outf.write("%s\n" % revid)
 
2609
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2610
 
 
2611
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2833
2612
 
2834
2613
 
2835
2614
class cmd_export(Command):
2836
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2615
    """Export current or past revision to a destination directory or archive.
2837
2616
 
2838
2617
    If no revision is specified this exports the last committed revision.
2839
2618
 
2861
2640
      =================       =========================
2862
2641
    """
2863
2642
    takes_args = ['dest', 'branch_or_subdir?']
2864
 
    takes_options = ['directory',
 
2643
    takes_options = [
2865
2644
        Option('format',
2866
2645
               help="Type of file to export to.",
2867
2646
               type=unicode),
2871
2650
        Option('root',
2872
2651
               type=str,
2873
2652
               help="Name of the root directory inside the exported file."),
2874
 
        Option('per-file-timestamps',
2875
 
               help='Set modification time of files to that of the last '
2876
 
                    'revision in which it was changed.'),
2877
2653
        ]
2878
2654
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2879
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2655
        root=None, filters=False):
2880
2656
        from bzrlib.export import export
2881
2657
 
2882
2658
        if branch_or_subdir is None:
2883
 
            tree = WorkingTree.open_containing(directory)[0]
 
2659
            tree = WorkingTree.open_containing(u'.')[0]
2884
2660
            b = tree.branch
2885
2661
            subdir = None
2886
2662
        else:
2889
2665
 
2890
2666
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2891
2667
        try:
2892
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2893
 
                   per_file_timestamps=per_file_timestamps)
 
2668
            export(rev_tree, dest, format, root, subdir, filtered=filters)
2894
2669
        except errors.NoSuchExportFormat, e:
2895
2670
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2896
2671
 
2897
2672
 
2898
2673
class cmd_cat(Command):
2899
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2674
    """Write the contents of a file as of a given revision to standard output.
2900
2675
 
2901
2676
    If no revision is nominated, the last revision is used.
2902
2677
 
2905
2680
    """
2906
2681
 
2907
2682
    _see_also = ['ls']
2908
 
    takes_options = ['directory',
 
2683
    takes_options = [
2909
2684
        Option('name-from-revision', help='The path name in the old tree.'),
2910
2685
        Option('filters', help='Apply content filters to display the '
2911
2686
                'convenience form.'),
2916
2691
 
2917
2692
    @display_command
2918
2693
    def run(self, filename, revision=None, name_from_revision=False,
2919
 
            filters=False, directory=None):
 
2694
            filters=False):
2920
2695
        if revision is not None and len(revision) != 1:
2921
2696
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2922
2697
                                         " one revision specifier")
2923
2698
        tree, branch, relpath = \
2924
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
2925
 
        self.add_cleanup(branch.lock_read().unlock)
2926
 
        return self._run(tree, branch, relpath, filename, revision,
2927
 
                         name_from_revision, filters)
 
2699
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2700
        branch.lock_read()
 
2701
        try:
 
2702
            return self._run(tree, branch, relpath, filename, revision,
 
2703
                             name_from_revision, filters)
 
2704
        finally:
 
2705
            branch.unlock()
2928
2706
 
2929
2707
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2930
2708
        filtered):
2931
2709
        if tree is None:
2932
2710
            tree = b.basis_tree()
2933
2711
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2934
 
        self.add_cleanup(rev_tree.lock_read().unlock)
2935
2712
 
2936
2713
        old_file_id = rev_tree.path2id(relpath)
2937
2714
 
2972
2749
            chunks = content.splitlines(True)
2973
2750
            content = filtered_output_bytes(chunks, filters,
2974
2751
                ContentFilterContext(relpath, rev_tree))
2975
 
            self.cleanup_now()
2976
2752
            self.outf.writelines(content)
2977
2753
        else:
2978
 
            self.cleanup_now()
2979
2754
            self.outf.write(content)
2980
2755
 
2981
2756
 
2982
2757
class cmd_local_time_offset(Command):
2983
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2758
    """Show the offset in seconds from GMT to local time."""
2984
2759
    hidden = True
2985
2760
    @display_command
2986
2761
    def run(self):
2987
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2762
        print osutils.local_time_offset()
2988
2763
 
2989
2764
 
2990
2765
 
2991
2766
class cmd_commit(Command):
2992
 
    __doc__ = """Commit changes into a new revision.
 
2767
    """Commit changes into a new revision.
2993
2768
 
2994
2769
    An explanatory message needs to be given for each commit. This is
2995
2770
    often done by using the --message option (getting the message from the
3088
2863
             Option('strict',
3089
2864
                    help="Refuse to commit if there are unknown "
3090
2865
                    "files in the working tree."),
3091
 
             Option('commit-time', type=str,
3092
 
                    help="Manually set a commit time using commit date "
3093
 
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
3094
2866
             ListOption('fixes', type=str,
3095
2867
                    help="Mark a bug as being fixed by this revision "
3096
2868
                         "(see \"bzr help bugs\")."),
3103
2875
                         "the master branch until a normal commit "
3104
2876
                         "is performed."
3105
2877
                    ),
3106
 
             Option('show-diff', short_name='p',
3107
 
                    help='When no message is supplied, show the diff along'
3108
 
                    ' with the status summary in the message editor.'),
 
2878
              Option('show-diff',
 
2879
                     help='When no message is supplied, show the diff along'
 
2880
                     ' with the status summary in the message editor.'),
3109
2881
             ]
3110
2882
    aliases = ['ci', 'checkin']
3111
2883
 
3130
2902
 
3131
2903
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3132
2904
            unchanged=False, strict=False, local=False, fixes=None,
3133
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2905
            author=None, show_diff=False, exclude=None):
3134
2906
        from bzrlib.errors import (
3135
2907
            PointlessCommit,
3136
2908
            ConflictsInTree,
3142
2914
            make_commit_message_template_encoded
3143
2915
        )
3144
2916
 
3145
 
        commit_stamp = offset = None
3146
 
        if commit_time is not None:
3147
 
            try:
3148
 
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3149
 
            except ValueError, e:
3150
 
                raise errors.BzrCommandError(
3151
 
                    "Could not parse --commit-time: " + str(e))
3152
 
 
3153
2917
        # TODO: Need a blackbox test for invoking the external editor; may be
3154
2918
        # slightly problematic to run this cross-platform.
3155
2919
 
3158
2922
 
3159
2923
        properties = {}
3160
2924
 
3161
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
2925
        tree, selected_list = tree_files(selected_list)
3162
2926
        if selected_list == ['']:
3163
2927
            # workaround - commit of root of tree should be exactly the same
3164
2928
            # as just default commit in that tree, and succeed even though
3175
2939
        if local and not tree.branch.get_bound_location():
3176
2940
            raise errors.LocalRequiresBoundBranch()
3177
2941
 
3178
 
        if message is not None:
3179
 
            try:
3180
 
                file_exists = osutils.lexists(message)
3181
 
            except UnicodeError:
3182
 
                # The commit message contains unicode characters that can't be
3183
 
                # represented in the filesystem encoding, so that can't be a
3184
 
                # file.
3185
 
                file_exists = False
3186
 
            if file_exists:
3187
 
                warning_msg = (
3188
 
                    'The commit message is a file name: "%(f)s".\n'
3189
 
                    '(use --file "%(f)s" to take commit message from that file)'
3190
 
                    % { 'f': message })
3191
 
                ui.ui_factory.show_warning(warning_msg)
3192
 
            if '\r' in message:
3193
 
                message = message.replace('\r\n', '\n')
3194
 
                message = message.replace('\r', '\n')
3195
 
            if file:
3196
 
                raise errors.BzrCommandError(
3197
 
                    "please specify either --message or --file")
3198
 
 
3199
2942
        def get_message(commit_obj):
3200
2943
            """Callback to get commit message"""
3201
 
            if file:
3202
 
                f = open(file)
3203
 
                try:
3204
 
                    my_message = f.read().decode(osutils.get_user_encoding())
3205
 
                finally:
3206
 
                    f.close()
3207
 
            elif message is not None:
3208
 
                my_message = message
3209
 
            else:
3210
 
                # No message supplied: make one up.
3211
 
                # text is the status of the tree
3212
 
                text = make_commit_message_template_encoded(tree,
 
2944
            my_message = message
 
2945
            if my_message is None and not file:
 
2946
                t = make_commit_message_template_encoded(tree,
3213
2947
                        selected_list, diff=show_diff,
3214
2948
                        output_encoding=osutils.get_user_encoding())
3215
 
                # start_message is the template generated from hooks
3216
 
                # XXX: Warning - looks like hooks return unicode,
3217
 
                # make_commit_message_template_encoded returns user encoding.
3218
 
                # We probably want to be using edit_commit_message instead to
3219
 
                # avoid this.
3220
2949
                start_message = generate_commit_message_template(commit_obj)
3221
 
                my_message = edit_commit_message_encoded(text,
 
2950
                my_message = edit_commit_message_encoded(t,
3222
2951
                    start_message=start_message)
3223
2952
                if my_message is None:
3224
2953
                    raise errors.BzrCommandError("please specify a commit"
3225
2954
                        " message with either --message or --file")
 
2955
            elif my_message and file:
 
2956
                raise errors.BzrCommandError(
 
2957
                    "please specify either --message or --file")
 
2958
            if file:
 
2959
                my_message = codecs.open(file, 'rt',
 
2960
                                         osutils.get_user_encoding()).read()
3226
2961
            if my_message == "":
3227
2962
                raise errors.BzrCommandError("empty commit message specified")
3228
2963
            return my_message
3229
2964
 
3230
 
        # The API permits a commit with a filter of [] to mean 'select nothing'
3231
 
        # but the command line should not do that.
3232
 
        if not selected_list:
3233
 
            selected_list = None
3234
2965
        try:
3235
2966
            tree.commit(message_callback=get_message,
3236
2967
                        specific_files=selected_list,
3237
2968
                        allow_pointless=unchanged, strict=strict, local=local,
3238
2969
                        reporter=None, verbose=verbose, revprops=properties,
3239
 
                        authors=author, timestamp=commit_stamp,
3240
 
                        timezone=offset,
3241
 
                        exclude=tree.safe_relpath_files(exclude))
 
2970
                        authors=author,
 
2971
                        exclude=safe_relpath_files(tree, exclude))
3242
2972
        except PointlessCommit:
 
2973
            # FIXME: This should really happen before the file is read in;
 
2974
            # perhaps prepare the commit; get the message; then actually commit
3243
2975
            raise errors.BzrCommandError("No changes to commit."
3244
2976
                              " Use --unchanged to commit anyhow.")
3245
2977
        except ConflictsInTree:
3250
2982
            raise errors.BzrCommandError("Commit refused because there are"
3251
2983
                              " unknown files in the working tree.")
3252
2984
        except errors.BoundBranchOutOfDate, e:
3253
 
            e.extra_help = ("\n"
3254
 
                'To commit to master branch, run update and then commit.\n'
3255
 
                'You can also pass --local to commit to continue working '
3256
 
                'disconnected.')
3257
 
            raise
 
2985
            raise errors.BzrCommandError(str(e) + "\n"
 
2986
            'To commit to master branch, run update and then commit.\n'
 
2987
            'You can also pass --local to commit to continue working '
 
2988
            'disconnected.')
3258
2989
 
3259
2990
 
3260
2991
class cmd_check(Command):
3261
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2992
    """Validate working tree structure, branch consistency and repository history.
3262
2993
 
3263
2994
    This command checks various invariants about branch and repository storage
3264
2995
    to detect data corruption or bzr bugs.
3328
3059
 
3329
3060
 
3330
3061
class cmd_upgrade(Command):
3331
 
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
3332
 
 
3333
 
    When the default format has changed after a major new release of
3334
 
    Bazaar, you may be informed during certain operations that you
3335
 
    should upgrade. Upgrading to a newer format may improve performance
3336
 
    or make new features available. It may however limit interoperability
3337
 
    with older repositories or with older versions of Bazaar.
3338
 
 
3339
 
    If you wish to upgrade to a particular format rather than the
3340
 
    current default, that can be specified using the --format option.
3341
 
    As a consequence, you can use the upgrade command this way to
3342
 
    "downgrade" to an earlier format, though some conversions are
3343
 
    a one way process (e.g. changing from the 1.x default to the
3344
 
    2.x default) so downgrading is not always possible.
3345
 
 
3346
 
    A backup.bzr.~#~ directory is created at the start of the conversion
3347
 
    process (where # is a number). By default, this is left there on
3348
 
    completion. If the conversion fails, delete the new .bzr directory
3349
 
    and rename this one back in its place. Use the --clean option to ask
3350
 
    for the backup.bzr directory to be removed on successful conversion.
3351
 
    Alternatively, you can delete it by hand if everything looks good
3352
 
    afterwards.
3353
 
 
3354
 
    If the location given is a shared repository, dependent branches
3355
 
    are also converted provided the repository converts successfully.
3356
 
    If the conversion of a branch fails, remaining branches are still
3357
 
    tried.
3358
 
 
3359
 
    For more information on upgrades, see the Bazaar Upgrade Guide,
3360
 
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
 
3062
    """Upgrade branch storage to current format.
 
3063
 
 
3064
    The check command or bzr developers may sometimes advise you to run
 
3065
    this command. When the default format has changed you may also be warned
 
3066
    during other operations to upgrade.
3361
3067
    """
3362
3068
 
3363
 
    _see_also = ['check', 'reconcile', 'formats']
 
3069
    _see_also = ['check']
3364
3070
    takes_args = ['url?']
3365
3071
    takes_options = [
3366
 
        RegistryOption('format',
3367
 
            help='Upgrade to a specific format.  See "bzr help'
3368
 
                 ' formats" for details.',
3369
 
            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3370
 
            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3371
 
            value_switches=True, title='Branch format'),
3372
 
        Option('clean',
3373
 
            help='Remove the backup.bzr directory if successful.'),
3374
 
        Option('dry-run',
3375
 
            help="Show what would be done, but don't actually do anything."),
3376
 
    ]
 
3072
                    RegistryOption('format',
 
3073
                        help='Upgrade to a specific format.  See "bzr help'
 
3074
                             ' formats" for details.',
 
3075
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3076
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3077
                        value_switches=True, title='Branch format'),
 
3078
                    ]
3377
3079
 
3378
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
3080
    def run(self, url='.', format=None):
3379
3081
        from bzrlib.upgrade import upgrade
3380
 
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
3381
 
        if exceptions:
3382
 
            if len(exceptions) == 1:
3383
 
                # Compatibility with historical behavior
3384
 
                raise exceptions[0]
3385
 
            else:
3386
 
                return 3
 
3082
        upgrade(url, format)
3387
3083
 
3388
3084
 
3389
3085
class cmd_whoami(Command):
3390
 
    __doc__ = """Show or set bzr user id.
 
3086
    """Show or set bzr user id.
3391
3087
 
3392
3088
    :Examples:
3393
3089
        Show the email of the current user::
3398
3094
 
3399
3095
            bzr whoami "Frank Chu <fchu@example.com>"
3400
3096
    """
3401
 
    takes_options = [ 'directory',
3402
 
                      Option('email',
 
3097
    takes_options = [ Option('email',
3403
3098
                             help='Display email address only.'),
3404
3099
                      Option('branch',
3405
3100
                             help='Set identity for the current branch instead of '
3409
3104
    encoding_type = 'replace'
3410
3105
 
3411
3106
    @display_command
3412
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
3107
    def run(self, email=False, branch=False, name=None):
3413
3108
        if name is None:
3414
 
            if directory is None:
3415
 
                # use branch if we're inside one; otherwise global config
3416
 
                try:
3417
 
                    c = Branch.open_containing(u'.')[0].get_config()
3418
 
                except errors.NotBranchError:
3419
 
                    c = _mod_config.GlobalConfig()
3420
 
            else:
3421
 
                c = Branch.open(directory).get_config()
 
3109
            # use branch if we're inside one; otherwise global config
 
3110
            try:
 
3111
                c = Branch.open_containing('.')[0].get_config()
 
3112
            except errors.NotBranchError:
 
3113
                c = config.GlobalConfig()
3422
3114
            if email:
3423
3115
                self.outf.write(c.user_email() + '\n')
3424
3116
            else:
3427
3119
 
3428
3120
        # display a warning if an email address isn't included in the given name.
3429
3121
        try:
3430
 
            _mod_config.extract_email_address(name)
 
3122
            config.extract_email_address(name)
3431
3123
        except errors.NoEmailInUsername, e:
3432
3124
            warning('"%s" does not seem to contain an email address.  '
3433
3125
                    'This is allowed, but not recommended.', name)
3434
3126
 
3435
3127
        # use global config unless --branch given
3436
3128
        if branch:
3437
 
            if directory is None:
3438
 
                c = Branch.open_containing(u'.')[0].get_config()
3439
 
            else:
3440
 
                c = Branch.open(directory).get_config()
 
3129
            c = Branch.open_containing('.')[0].get_config()
3441
3130
        else:
3442
 
            c = _mod_config.GlobalConfig()
 
3131
            c = config.GlobalConfig()
3443
3132
        c.set_user_option('email', name)
3444
3133
 
3445
3134
 
3446
3135
class cmd_nick(Command):
3447
 
    __doc__ = """Print or set the branch nickname.
 
3136
    """Print or set the branch nickname.
3448
3137
 
3449
3138
    If unset, the tree root directory name is used as the nickname.
3450
3139
    To print the current nickname, execute with no argument.
3455
3144
 
3456
3145
    _see_also = ['info']
3457
3146
    takes_args = ['nickname?']
3458
 
    takes_options = ['directory']
3459
 
    def run(self, nickname=None, directory=u'.'):
3460
 
        branch = Branch.open_containing(directory)[0]
 
3147
    def run(self, nickname=None):
 
3148
        branch = Branch.open_containing(u'.')[0]
3461
3149
        if nickname is None:
3462
3150
            self.printme(branch)
3463
3151
        else:
3465
3153
 
3466
3154
    @display_command
3467
3155
    def printme(self, branch):
3468
 
        self.outf.write('%s\n' % branch.nick)
 
3156
        print branch.nick
3469
3157
 
3470
3158
 
3471
3159
class cmd_alias(Command):
3472
 
    __doc__ = """Set/unset and display aliases.
 
3160
    """Set/unset and display aliases.
3473
3161
 
3474
3162
    :Examples:
3475
3163
        Show the current aliases::
3512
3200
                'bzr alias --remove expects an alias to remove.')
3513
3201
        # If alias is not found, print something like:
3514
3202
        # unalias: foo: not found
3515
 
        c = _mod_config.GlobalConfig()
 
3203
        c = config.GlobalConfig()
3516
3204
        c.unset_alias(alias_name)
3517
3205
 
3518
3206
    @display_command
3519
3207
    def print_aliases(self):
3520
3208
        """Print out the defined aliases in a similar format to bash."""
3521
 
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3209
        aliases = config.GlobalConfig().get_aliases()
3522
3210
        for key, value in sorted(aliases.iteritems()):
3523
3211
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3524
3212
 
3534
3222
 
3535
3223
    def set_alias(self, alias_name, alias_command):
3536
3224
        """Save the alias in the global config."""
3537
 
        c = _mod_config.GlobalConfig()
 
3225
        c = config.GlobalConfig()
3538
3226
        c.set_alias(alias_name, alias_command)
3539
3227
 
3540
3228
 
3541
3229
class cmd_selftest(Command):
3542
 
    __doc__ = """Run internal test suite.
 
3230
    """Run internal test suite.
3543
3231
 
3544
3232
    If arguments are given, they are regular expressions that say which tests
3545
3233
    should run.  Tests matching any expression are run, and other tests are
3572
3260
    Tests that need working space on disk use a common temporary directory,
3573
3261
    typically inside $TMPDIR or /tmp.
3574
3262
 
3575
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3576
 
    into a pdb postmortem session.
3577
 
 
3578
 
    The --coverage=DIRNAME global option produces a report with covered code
3579
 
    indicated.
3580
 
 
3581
3263
    :Examples:
3582
3264
        Run only tests relating to 'ignore'::
3583
3265
 
3592
3274
    def get_transport_type(typestring):
3593
3275
        """Parse and return a transport specifier."""
3594
3276
        if typestring == "sftp":
3595
 
            from bzrlib.tests import stub_sftp
3596
 
            return stub_sftp.SFTPAbsoluteServer
 
3277
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3278
            return SFTPAbsoluteServer
3597
3279
        if typestring == "memory":
3598
 
            from bzrlib.tests import test_server
3599
 
            return memory.MemoryServer
 
3280
            from bzrlib.transport.memory import MemoryServer
 
3281
            return MemoryServer
3600
3282
        if typestring == "fakenfs":
3601
 
            from bzrlib.tests import test_server
3602
 
            return test_server.FakeNFSServer
 
3283
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3284
            return FakeNFSServer
3603
3285
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3604
3286
            (typestring)
3605
3287
        raise errors.BzrCommandError(msg)
3616
3298
                                 'throughout the test suite.',
3617
3299
                            type=get_transport_type),
3618
3300
                     Option('benchmark',
3619
 
                            help='Run the benchmarks rather than selftests.',
3620
 
                            hidden=True),
 
3301
                            help='Run the benchmarks rather than selftests.'),
3621
3302
                     Option('lsprof-timed',
3622
3303
                            help='Generate lsprof output for benchmarked'
3623
3304
                                 ' sections of code.'),
3624
 
                     Option('lsprof-tests',
3625
 
                            help='Generate lsprof output for each test.'),
 
3305
                     Option('cache-dir', type=str,
 
3306
                            help='Cache intermediate benchmark output in this '
 
3307
                                 'directory.'),
3626
3308
                     Option('first',
3627
3309
                            help='Run all tests, but run specified tests first.',
3628
3310
                            short_name='f',
3662
3344
 
3663
3345
    def run(self, testspecs_list=None, verbose=False, one=False,
3664
3346
            transport=None, benchmark=None,
3665
 
            lsprof_timed=None,
 
3347
            lsprof_timed=None, cache_dir=None,
3666
3348
            first=False, list_only=False,
3667
3349
            randomize=None, exclude=None, strict=False,
3668
3350
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3669
 
            parallel=None, lsprof_tests=False):
3670
 
        from bzrlib import tests
3671
 
 
 
3351
            parallel=None):
 
3352
        from bzrlib.tests import selftest
 
3353
        import bzrlib.benchmarks as benchmarks
 
3354
        from bzrlib.benchmarks import tree_creator
 
3355
 
 
3356
        # Make deprecation warnings visible, unless -Werror is set
 
3357
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3358
 
 
3359
        if cache_dir is not None:
 
3360
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3672
3361
        if testspecs_list is not None:
3673
3362
            pattern = '|'.join(testspecs_list)
3674
3363
        else:
3680
3369
                raise errors.BzrCommandError("subunit not available. subunit "
3681
3370
                    "needs to be installed to use --subunit.")
3682
3371
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
3683
 
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
3684
 
            # stdout, which would corrupt the subunit stream. 
3685
 
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
3686
 
            # following code can be deleted when it's sufficiently deployed
3687
 
            # -- vila/mgz 20100514
3688
 
            if (sys.platform == "win32"
3689
 
                and getattr(sys.stdout, 'fileno', None) is not None):
3690
 
                import msvcrt
3691
 
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3692
3372
        if parallel:
3693
3373
            self.additional_selftest_args.setdefault(
3694
3374
                'suite_decorators', []).append(parallel)
3695
3375
        if benchmark:
3696
 
            raise errors.BzrCommandError(
3697
 
                "--benchmark is no longer supported from bzr 2.2; "
3698
 
                "use bzr-usertest instead")
3699
 
        test_suite_factory = None
3700
 
        selftest_kwargs = {"verbose": verbose,
3701
 
                          "pattern": pattern,
3702
 
                          "stop_on_failure": one,
3703
 
                          "transport": transport,
3704
 
                          "test_suite_factory": test_suite_factory,
3705
 
                          "lsprof_timed": lsprof_timed,
3706
 
                          "lsprof_tests": lsprof_tests,
3707
 
                          "matching_tests_first": first,
3708
 
                          "list_only": list_only,
3709
 
                          "random_seed": randomize,
3710
 
                          "exclude_pattern": exclude,
3711
 
                          "strict": strict,
3712
 
                          "load_list": load_list,
3713
 
                          "debug_flags": debugflag,
3714
 
                          "starting_with": starting_with
3715
 
                          }
3716
 
        selftest_kwargs.update(self.additional_selftest_args)
3717
 
 
3718
 
        # Make deprecation warnings visible, unless -Werror is set
3719
 
        cleanup = symbol_versioning.activate_deprecation_warnings(
3720
 
            override=False)
 
3376
            test_suite_factory = benchmarks.test_suite
 
3377
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3378
            verbose = not is_quiet()
 
3379
            # TODO: should possibly lock the history file...
 
3380
            benchfile = open(".perf_history", "at", buffering=1)
 
3381
        else:
 
3382
            test_suite_factory = None
 
3383
            benchfile = None
3721
3384
        try:
3722
 
            result = tests.selftest(**selftest_kwargs)
 
3385
            selftest_kwargs = {"verbose": verbose,
 
3386
                              "pattern": pattern,
 
3387
                              "stop_on_failure": one,
 
3388
                              "transport": transport,
 
3389
                              "test_suite_factory": test_suite_factory,
 
3390
                              "lsprof_timed": lsprof_timed,
 
3391
                              "bench_history": benchfile,
 
3392
                              "matching_tests_first": first,
 
3393
                              "list_only": list_only,
 
3394
                              "random_seed": randomize,
 
3395
                              "exclude_pattern": exclude,
 
3396
                              "strict": strict,
 
3397
                              "load_list": load_list,
 
3398
                              "debug_flags": debugflag,
 
3399
                              "starting_with": starting_with
 
3400
                              }
 
3401
            selftest_kwargs.update(self.additional_selftest_args)
 
3402
            result = selftest(**selftest_kwargs)
3723
3403
        finally:
3724
 
            cleanup()
 
3404
            if benchfile is not None:
 
3405
                benchfile.close()
3725
3406
        return int(not result)
3726
3407
 
3727
3408
 
3728
3409
class cmd_version(Command):
3729
 
    __doc__ = """Show version of bzr."""
 
3410
    """Show version of bzr."""
3730
3411
 
3731
3412
    encoding_type = 'replace'
3732
3413
    takes_options = [
3743
3424
 
3744
3425
 
3745
3426
class cmd_rocks(Command):
3746
 
    __doc__ = """Statement of optimism."""
 
3427
    """Statement of optimism."""
3747
3428
 
3748
3429
    hidden = True
3749
3430
 
3750
3431
    @display_command
3751
3432
    def run(self):
3752
 
        self.outf.write("It sure does!\n")
 
3433
        print "It sure does!"
3753
3434
 
3754
3435
 
3755
3436
class cmd_find_merge_base(Command):
3756
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
3437
    """Find and print a base revision for merging two branches."""
3757
3438
    # TODO: Options to specify revisions on either side, as if
3758
3439
    #       merging only part of the history.
3759
3440
    takes_args = ['branch', 'other']
3765
3446
 
3766
3447
        branch1 = Branch.open_containing(branch)[0]
3767
3448
        branch2 = Branch.open_containing(other)[0]
3768
 
        self.add_cleanup(branch1.lock_read().unlock)
3769
 
        self.add_cleanup(branch2.lock_read().unlock)
3770
 
        last1 = ensure_null(branch1.last_revision())
3771
 
        last2 = ensure_null(branch2.last_revision())
3772
 
 
3773
 
        graph = branch1.repository.get_graph(branch2.repository)
3774
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3775
 
 
3776
 
        self.outf.write('merge base is revision %s\n' % base_rev_id)
 
3449
        branch1.lock_read()
 
3450
        try:
 
3451
            branch2.lock_read()
 
3452
            try:
 
3453
                last1 = ensure_null(branch1.last_revision())
 
3454
                last2 = ensure_null(branch2.last_revision())
 
3455
 
 
3456
                graph = branch1.repository.get_graph(branch2.repository)
 
3457
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3458
 
 
3459
                print 'merge base is revision %s' % base_rev_id
 
3460
            finally:
 
3461
                branch2.unlock()
 
3462
        finally:
 
3463
            branch1.unlock()
3777
3464
 
3778
3465
 
3779
3466
class cmd_merge(Command):
3780
 
    __doc__ = """Perform a three-way merge.
 
3467
    """Perform a three-way merge.
3781
3468
 
3782
3469
    The source of the merge can be specified either in the form of a branch,
3783
3470
    or in the form of a path to a file containing a merge directive generated
3784
3471
    with bzr send. If neither is specified, the default is the upstream branch
3785
3472
    or the branch most recently merged using --remember.
3786
3473
 
3787
 
    When merging from a branch, by default bzr will try to merge in all new
3788
 
    work from the other branch, automatically determining an appropriate base
3789
 
    revision.  If this fails, you may need to give an explicit base.
3790
 
 
3791
 
    To pick a different ending revision, pass "--revision OTHER".  bzr will
3792
 
    try to merge in all new work up to and including revision OTHER.
3793
 
 
3794
 
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
3795
 
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
3796
 
    causes some revisions to be skipped, i.e. if the destination branch does
3797
 
    not already contain revision BASE, such a merge is commonly referred to as
3798
 
    a "cherrypick".
3799
 
 
3800
 
    Revision numbers are always relative to the source branch.
 
3474
    When merging a branch, by default the tip will be merged. To pick a different
 
3475
    revision, pass --revision. If you specify two values, the first will be used as
 
3476
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3477
    available revisions, like this is commonly referred to as "cherrypicking".
 
3478
 
 
3479
    Revision numbers are always relative to the branch being merged.
 
3480
 
 
3481
    By default, bzr will try to merge in all new work from the other
 
3482
    branch, automatically determining an appropriate base.  If this
 
3483
    fails, you may need to give an explicit base.
3801
3484
 
3802
3485
    Merge will do its best to combine the changes in two branches, but there
3803
3486
    are some kinds of problems only a human can fix.  When it encounters those,
3816
3499
    committed to record the result of the merge.
3817
3500
 
3818
3501
    merge refuses to run if there are any uncommitted changes, unless
3819
 
    --force is given. The --force option can also be used to create a
3820
 
    merge revision which has more than two parents.
3821
 
 
3822
 
    If one would like to merge changes from the working tree of the other
3823
 
    branch without merging any committed revisions, the --uncommitted option
3824
 
    can be given.
3825
 
 
3826
 
    To select only some changes to merge, use "merge -i", which will prompt
3827
 
    you to apply each diff hunk and file change, similar to "shelve".
 
3502
    --force is given.
3828
3503
 
3829
3504
    :Examples:
3830
 
        To merge all new revisions from bzr.dev::
 
3505
        To merge the latest revision from bzr.dev::
3831
3506
 
3832
3507
            bzr merge ../bzr.dev
3833
3508
 
3839
3514
 
3840
3515
            bzr merge -r 81..82 ../bzr.dev
3841
3516
 
3842
 
        To apply a merge directive contained in /tmp/merge::
 
3517
        To apply a merge directive contained in /tmp/merge:
3843
3518
 
3844
3519
            bzr merge /tmp/merge
3845
 
 
3846
 
        To create a merge revision with three parents from two branches
3847
 
        feature1a and feature1b:
3848
 
 
3849
 
            bzr merge ../feature1a
3850
 
            bzr merge ../feature1b --force
3851
 
            bzr commit -m 'revision with three parents'
3852
3520
    """
3853
3521
 
3854
3522
    encoding_type = 'exact'
3870
3538
                ' completely merged into the source, pull from the'
3871
3539
                ' source rather than merging.  When this happens,'
3872
3540
                ' you do not need to commit the result.'),
3873
 
        custom_help('directory',
 
3541
        Option('directory',
3874
3542
               help='Branch to merge into, '
3875
 
                    'rather than the one containing the working directory.'),
3876
 
        Option('preview', help='Instead of merging, show a diff of the'
3877
 
               ' merge.'),
3878
 
        Option('interactive', help='Select changes interactively.',
3879
 
            short_name='i')
 
3543
                    'rather than the one containing the working directory.',
 
3544
               short_name='d',
 
3545
               type=unicode,
 
3546
               ),
 
3547
        Option('preview', help='Instead of merging, show a diff of the merge.')
3880
3548
    ]
3881
3549
 
3882
3550
    def run(self, location=None, revision=None, force=False,
3884
3552
            uncommitted=False, pull=False,
3885
3553
            directory=None,
3886
3554
            preview=False,
3887
 
            interactive=False,
3888
3555
            ):
3889
3556
        if merge_type is None:
3890
3557
            merge_type = _mod_merge.Merge3Merger
3896
3563
        verified = 'inapplicable'
3897
3564
        tree = WorkingTree.open_containing(directory)[0]
3898
3565
 
 
3566
        # die as quickly as possible if there are uncommitted changes
3899
3567
        try:
3900
3568
            basis_tree = tree.revision_tree(tree.last_revision())
3901
3569
        except errors.NoSuchRevision:
3902
3570
            basis_tree = tree.basis_tree()
3903
 
 
3904
 
        # die as quickly as possible if there are uncommitted changes
3905
3571
        if not force:
3906
 
            if tree.has_changes():
 
3572
            changes = tree.changes_from(basis_tree)
 
3573
            if changes.has_changed():
3907
3574
                raise errors.UncommittedChanges(tree)
3908
3575
 
3909
3576
        view_info = _get_view_info_for_change_reporter(tree)
3910
3577
        change_reporter = delta._ChangeReporter(
3911
3578
            unversioned_filter=tree.is_ignored, view_info=view_info)
3912
 
        pb = ui.ui_factory.nested_progress_bar()
3913
 
        self.add_cleanup(pb.finished)
3914
 
        self.add_cleanup(tree.lock_write().unlock)
3915
 
        if location is not None:
3916
 
            try:
3917
 
                mergeable = bundle.read_mergeable_from_url(location,
3918
 
                    possible_transports=possible_transports)
3919
 
            except errors.NotABundle:
3920
 
                mergeable = None
 
3579
        cleanups = []
 
3580
        try:
 
3581
            pb = ui.ui_factory.nested_progress_bar()
 
3582
            cleanups.append(pb.finished)
 
3583
            tree.lock_write()
 
3584
            cleanups.append(tree.unlock)
 
3585
            if location is not None:
 
3586
                try:
 
3587
                    mergeable = bundle.read_mergeable_from_url(location,
 
3588
                        possible_transports=possible_transports)
 
3589
                except errors.NotABundle:
 
3590
                    mergeable = None
 
3591
                else:
 
3592
                    if uncommitted:
 
3593
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3594
                            ' with bundles or merge directives.')
 
3595
 
 
3596
                    if revision is not None:
 
3597
                        raise errors.BzrCommandError(
 
3598
                            'Cannot use -r with merge directives or bundles')
 
3599
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3600
                       mergeable, pb)
 
3601
 
 
3602
            if merger is None and uncommitted:
 
3603
                if revision is not None and len(revision) > 0:
 
3604
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3605
                        ' --revision at the same time.')
 
3606
                location = self._select_branch_location(tree, location)[0]
 
3607
                other_tree, other_path = WorkingTree.open_containing(location)
 
3608
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3609
                    pb)
 
3610
                allow_pending = False
 
3611
                if other_path != '':
 
3612
                    merger.interesting_files = [other_path]
 
3613
 
 
3614
            if merger is None:
 
3615
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3616
                    location, revision, remember, possible_transports, pb)
 
3617
 
 
3618
            merger.merge_type = merge_type
 
3619
            merger.reprocess = reprocess
 
3620
            merger.show_base = show_base
 
3621
            self.sanity_check_merger(merger)
 
3622
            if (merger.base_rev_id == merger.other_rev_id and
 
3623
                merger.other_rev_id is not None):
 
3624
                note('Nothing to do.')
 
3625
                return 0
 
3626
            if pull:
 
3627
                if merger.interesting_files is not None:
 
3628
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3629
                if (merger.base_rev_id == tree.last_revision()):
 
3630
                    result = tree.pull(merger.other_branch, False,
 
3631
                                       merger.other_rev_id)
 
3632
                    result.report(self.outf)
 
3633
                    return 0
 
3634
            merger.check_basis(False)
 
3635
            if preview:
 
3636
                return self._do_preview(merger)
3921
3637
            else:
3922
 
                if uncommitted:
3923
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3924
 
                        ' with bundles or merge directives.')
3925
 
 
3926
 
                if revision is not None:
3927
 
                    raise errors.BzrCommandError(
3928
 
                        'Cannot use -r with merge directives or bundles')
3929
 
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3930
 
                   mergeable, None)
3931
 
 
3932
 
        if merger is None and uncommitted:
3933
 
            if revision is not None and len(revision) > 0:
3934
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3935
 
                    ' --revision at the same time.')
3936
 
            merger = self.get_merger_from_uncommitted(tree, location, None)
3937
 
            allow_pending = False
3938
 
 
3939
 
        if merger is None:
3940
 
            merger, allow_pending = self._get_merger_from_branch(tree,
3941
 
                location, revision, remember, possible_transports, None)
3942
 
 
3943
 
        merger.merge_type = merge_type
3944
 
        merger.reprocess = reprocess
3945
 
        merger.show_base = show_base
3946
 
        self.sanity_check_merger(merger)
3947
 
        if (merger.base_rev_id == merger.other_rev_id and
3948
 
            merger.other_rev_id is not None):
3949
 
            note('Nothing to do.')
3950
 
            return 0
3951
 
        if pull:
3952
 
            if merger.interesting_files is not None:
3953
 
                raise errors.BzrCommandError('Cannot pull individual files')
3954
 
            if (merger.base_rev_id == tree.last_revision()):
3955
 
                result = tree.pull(merger.other_branch, False,
3956
 
                                   merger.other_rev_id)
3957
 
                result.report(self.outf)
3958
 
                return 0
3959
 
        if merger.this_basis is None:
3960
 
            raise errors.BzrCommandError(
3961
 
                "This branch has no commits."
3962
 
                " (perhaps you would prefer 'bzr pull')")
3963
 
        if preview:
3964
 
            return self._do_preview(merger)
3965
 
        elif interactive:
3966
 
            return self._do_interactive(merger)
3967
 
        else:
3968
 
            return self._do_merge(merger, change_reporter, allow_pending,
3969
 
                                  verified)
3970
 
 
3971
 
    def _get_preview(self, merger):
 
3638
                return self._do_merge(merger, change_reporter, allow_pending,
 
3639
                                      verified)
 
3640
        finally:
 
3641
            for cleanup in reversed(cleanups):
 
3642
                cleanup()
 
3643
 
 
3644
    def _do_preview(self, merger):
 
3645
        from bzrlib.diff import show_diff_trees
3972
3646
        tree_merger = merger.make_merger()
3973
3647
        tt = tree_merger.make_preview_transform()
3974
 
        self.add_cleanup(tt.finalize)
3975
 
        result_tree = tt.get_preview_tree()
3976
 
        return result_tree
3977
 
 
3978
 
    def _do_preview(self, merger):
3979
 
        from bzrlib.diff import show_diff_trees
3980
 
        result_tree = self._get_preview(merger)
3981
 
        path_encoding = osutils.get_diff_header_encoding()
3982
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3983
 
                        old_label='', new_label='',
3984
 
                        path_encoding=path_encoding)
 
3648
        try:
 
3649
            result_tree = tt.get_preview_tree()
 
3650
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3651
                            old_label='', new_label='')
 
3652
        finally:
 
3653
            tt.finalize()
3985
3654
 
3986
3655
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3987
3656
        merger.change_reporter = change_reporter
3995
3664
        else:
3996
3665
            return 0
3997
3666
 
3998
 
    def _do_interactive(self, merger):
3999
 
        """Perform an interactive merge.
4000
 
 
4001
 
        This works by generating a preview tree of the merge, then using
4002
 
        Shelver to selectively remove the differences between the working tree
4003
 
        and the preview tree.
4004
 
        """
4005
 
        from bzrlib import shelf_ui
4006
 
        result_tree = self._get_preview(merger)
4007
 
        writer = bzrlib.option.diff_writer_registry.get()
4008
 
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
4009
 
                                   reporter=shelf_ui.ApplyReporter(),
4010
 
                                   diff_writer=writer(sys.stdout))
4011
 
        try:
4012
 
            shelver.run()
4013
 
        finally:
4014
 
            shelver.finalize()
4015
 
 
4016
3667
    def sanity_check_merger(self, merger):
4017
3668
        if (merger.show_base and
4018
3669
            not merger.merge_type is _mod_merge.Merge3Merger):
4053
3704
            base_branch, base_path = Branch.open_containing(base_loc,
4054
3705
                possible_transports)
4055
3706
        # Find the revision ids
4056
 
        other_revision_id = None
4057
 
        base_revision_id = None
4058
 
        if revision is not None:
4059
 
            if len(revision) >= 1:
4060
 
                other_revision_id = revision[-1].as_revision_id(other_branch)
4061
 
            if len(revision) == 2:
4062
 
                base_revision_id = revision[0].as_revision_id(base_branch)
4063
 
        if other_revision_id is None:
 
3707
        if revision is None or len(revision) < 1 or revision[-1] is None:
4064
3708
            other_revision_id = _mod_revision.ensure_null(
4065
3709
                other_branch.last_revision())
 
3710
        else:
 
3711
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3712
        if (revision is not None and len(revision) == 2
 
3713
            and revision[0] is not None):
 
3714
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3715
        else:
 
3716
            base_revision_id = None
4066
3717
        # Remember where we merge from
4067
3718
        if ((remember or tree.branch.get_submit_branch() is None) and
4068
3719
             user_location is not None):
4069
3720
            tree.branch.set_submit_branch(other_branch.base)
4070
 
        # Merge tags (but don't set them in the master branch yet, the user
4071
 
        # might revert this merge).  Commit will propagate them.
4072
 
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
3721
        _merge_tags_if_possible(other_branch, tree.branch)
4073
3722
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4074
3723
            other_revision_id, base_revision_id, other_branch, base_branch)
4075
3724
        if other_path != '':
4079
3728
            allow_pending = True
4080
3729
        return merger, allow_pending
4081
3730
 
4082
 
    def get_merger_from_uncommitted(self, tree, location, pb):
4083
 
        """Get a merger for uncommitted changes.
4084
 
 
4085
 
        :param tree: The tree the merger should apply to.
4086
 
        :param location: The location containing uncommitted changes.
4087
 
        :param pb: The progress bar to use for showing progress.
4088
 
        """
4089
 
        location = self._select_branch_location(tree, location)[0]
4090
 
        other_tree, other_path = WorkingTree.open_containing(location)
4091
 
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
4092
 
        if other_path != '':
4093
 
            merger.interesting_files = [other_path]
4094
 
        return merger
4095
 
 
4096
3731
    def _select_branch_location(self, tree, user_location, revision=None,
4097
3732
                                index=None):
4098
3733
        """Select a branch location, according to possible inputs.
4142
3777
 
4143
3778
 
4144
3779
class cmd_remerge(Command):
4145
 
    __doc__ = """Redo a merge.
 
3780
    """Redo a merge.
4146
3781
 
4147
3782
    Use this if you want to try a different merge technique while resolving
4148
3783
    conflicts.  Some merge techniques are better than others, and remerge
4173
3808
 
4174
3809
    def run(self, file_list=None, merge_type=None, show_base=False,
4175
3810
            reprocess=False):
4176
 
        from bzrlib.conflicts import restore
4177
3811
        if merge_type is None:
4178
3812
            merge_type = _mod_merge.Merge3Merger
4179
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4180
 
        self.add_cleanup(tree.lock_write().unlock)
4181
 
        parents = tree.get_parent_ids()
4182
 
        if len(parents) != 2:
4183
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
4184
 
                                         " merges.  Not cherrypicking or"
4185
 
                                         " multi-merges.")
4186
 
        repository = tree.branch.repository
4187
 
        interesting_ids = None
4188
 
        new_conflicts = []
4189
 
        conflicts = tree.conflicts()
4190
 
        if file_list is not None:
4191
 
            interesting_ids = set()
4192
 
            for filename in file_list:
4193
 
                file_id = tree.path2id(filename)
4194
 
                if file_id is None:
4195
 
                    raise errors.NotVersionedError(filename)
4196
 
                interesting_ids.add(file_id)
4197
 
                if tree.kind(file_id) != "directory":
4198
 
                    continue
 
3813
        tree, file_list = tree_files(file_list)
 
3814
        tree.lock_write()
 
3815
        try:
 
3816
            parents = tree.get_parent_ids()
 
3817
            if len(parents) != 2:
 
3818
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3819
                                             " merges.  Not cherrypicking or"
 
3820
                                             " multi-merges.")
 
3821
            repository = tree.branch.repository
 
3822
            interesting_ids = None
 
3823
            new_conflicts = []
 
3824
            conflicts = tree.conflicts()
 
3825
            if file_list is not None:
 
3826
                interesting_ids = set()
 
3827
                for filename in file_list:
 
3828
                    file_id = tree.path2id(filename)
 
3829
                    if file_id is None:
 
3830
                        raise errors.NotVersionedError(filename)
 
3831
                    interesting_ids.add(file_id)
 
3832
                    if tree.kind(file_id) != "directory":
 
3833
                        continue
4199
3834
 
4200
 
                for name, ie in tree.inventory.iter_entries(file_id):
4201
 
                    interesting_ids.add(ie.file_id)
4202
 
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4203
 
        else:
4204
 
            # Remerge only supports resolving contents conflicts
4205
 
            allowed_conflicts = ('text conflict', 'contents conflict')
4206
 
            restore_files = [c.path for c in conflicts
4207
 
                             if c.typestring in allowed_conflicts]
4208
 
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
4209
 
        tree.set_conflicts(ConflictList(new_conflicts))
4210
 
        if file_list is not None:
4211
 
            restore_files = file_list
4212
 
        for filename in restore_files:
 
3835
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3836
                        interesting_ids.add(ie.file_id)
 
3837
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3838
            else:
 
3839
                # Remerge only supports resolving contents conflicts
 
3840
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3841
                restore_files = [c.path for c in conflicts
 
3842
                                 if c.typestring in allowed_conflicts]
 
3843
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3844
            tree.set_conflicts(ConflictList(new_conflicts))
 
3845
            if file_list is not None:
 
3846
                restore_files = file_list
 
3847
            for filename in restore_files:
 
3848
                try:
 
3849
                    restore(tree.abspath(filename))
 
3850
                except errors.NotConflicted:
 
3851
                    pass
 
3852
            # Disable pending merges, because the file texts we are remerging
 
3853
            # have not had those merges performed.  If we use the wrong parents
 
3854
            # list, we imply that the working tree text has seen and rejected
 
3855
            # all the changes from the other tree, when in fact those changes
 
3856
            # have not yet been seen.
 
3857
            pb = ui.ui_factory.nested_progress_bar()
 
3858
            tree.set_parent_ids(parents[:1])
4213
3859
            try:
4214
 
                restore(tree.abspath(filename))
4215
 
            except errors.NotConflicted:
4216
 
                pass
4217
 
        # Disable pending merges, because the file texts we are remerging
4218
 
        # have not had those merges performed.  If we use the wrong parents
4219
 
        # list, we imply that the working tree text has seen and rejected
4220
 
        # all the changes from the other tree, when in fact those changes
4221
 
        # have not yet been seen.
4222
 
        tree.set_parent_ids(parents[:1])
4223
 
        try:
4224
 
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4225
 
            merger.interesting_ids = interesting_ids
4226
 
            merger.merge_type = merge_type
4227
 
            merger.show_base = show_base
4228
 
            merger.reprocess = reprocess
4229
 
            conflicts = merger.do_merge()
 
3860
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3861
                                                             tree, parents[1])
 
3862
                merger.interesting_ids = interesting_ids
 
3863
                merger.merge_type = merge_type
 
3864
                merger.show_base = show_base
 
3865
                merger.reprocess = reprocess
 
3866
                conflicts = merger.do_merge()
 
3867
            finally:
 
3868
                tree.set_parent_ids(parents)
 
3869
                pb.finished()
4230
3870
        finally:
4231
 
            tree.set_parent_ids(parents)
 
3871
            tree.unlock()
4232
3872
        if conflicts > 0:
4233
3873
            return 1
4234
3874
        else:
4236
3876
 
4237
3877
 
4238
3878
class cmd_revert(Command):
4239
 
    __doc__ = """Revert files to a previous revision.
 
3879
    """Revert files to a previous revision.
4240
3880
 
4241
3881
    Giving a list of files will revert only those files.  Otherwise, all files
4242
3882
    will be reverted.  If the revision is not specified with '--revision', the
4243
3883
    last committed revision is used.
4244
3884
 
4245
3885
    To remove only some changes, without reverting to a prior version, use
4246
 
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
4247
 
    will remove the changes introduced by the second last commit (-2), without
4248
 
    affecting the changes introduced by the last commit (-1).  To remove
4249
 
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
3886
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3887
    changes introduced by -2, without affecting the changes introduced by -1.
 
3888
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4250
3889
 
4251
3890
    By default, any files that have been manually changed will be backed up
4252
3891
    first.  (Files changed only by merge are not backed up.)  Backup files have
4257
3896
    name.  If you name a directory, all the contents of that directory will be
4258
3897
    reverted.
4259
3898
 
4260
 
    If you have newly added files since the target revision, they will be
4261
 
    removed.  If the files to be removed have been changed, backups will be
4262
 
    created as above.  Directories containing unknown files will not be
4263
 
    deleted.
 
3899
    Any files that have been newly added since that revision will be deleted,
 
3900
    with a backup kept if appropriate.  Directories containing unknown files
 
3901
    will not be deleted.
4264
3902
 
4265
 
    The working tree contains a list of revisions that have been merged but
4266
 
    not yet committed. These revisions will be included as additional parents
4267
 
    of the next commit.  Normally, using revert clears that list as well as
4268
 
    reverting the files.  If any files are specified, revert leaves the list
4269
 
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
4270
 
    .`` in the tree root to revert all files but keep the recorded merges,
4271
 
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
3903
    The working tree contains a list of pending merged revisions, which will
 
3904
    be included as parents in the next commit.  Normally, revert clears that
 
3905
    list as well as reverting the files.  If any files are specified, revert
 
3906
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3907
    revert ." in the tree root to revert all files but keep the merge record,
 
3908
    and "bzr revert --forget-merges" to clear the pending merge list without
4272
3909
    reverting any files.
4273
 
 
4274
 
    Using "bzr revert --forget-merges", it is possible to apply all of the
4275
 
    changes from a branch in a single revision.  To do this, perform the merge
4276
 
    as desired.  Then doing revert with the "--forget-merges" option will keep
4277
 
    the content of the tree as it was, but it will clear the list of pending
4278
 
    merges.  The next commit will then contain all of the changes that are
4279
 
    present in the other branch, but without any other parent revisions.
4280
 
    Because this technique forgets where these changes originated, it may
4281
 
    cause additional conflicts on later merges involving the same source and
4282
 
    target branches.
4283
3910
    """
4284
3911
 
4285
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
3912
    _see_also = ['cat', 'export']
4286
3913
    takes_options = [
4287
3914
        'revision',
4288
3915
        Option('no-backup', "Do not save backups of reverted files."),
4293
3920
 
4294
3921
    def run(self, revision=None, no_backup=False, file_list=None,
4295
3922
            forget_merges=None):
4296
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4297
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4298
 
        if forget_merges:
4299
 
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4300
 
        else:
4301
 
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3923
        tree, file_list = tree_files(file_list)
 
3924
        tree.lock_write()
 
3925
        try:
 
3926
            if forget_merges:
 
3927
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3928
            else:
 
3929
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3930
        finally:
 
3931
            tree.unlock()
4302
3932
 
4303
3933
    @staticmethod
4304
3934
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4305
3935
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4306
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4307
 
            report_changes=True)
 
3936
        pb = ui.ui_factory.nested_progress_bar()
 
3937
        try:
 
3938
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3939
                report_changes=True)
 
3940
        finally:
 
3941
            pb.finished()
4308
3942
 
4309
3943
 
4310
3944
class cmd_assert_fail(Command):
4311
 
    __doc__ = """Test reporting of assertion failures"""
 
3945
    """Test reporting of assertion failures"""
4312
3946
    # intended just for use in testing
4313
3947
 
4314
3948
    hidden = True
4318
3952
 
4319
3953
 
4320
3954
class cmd_help(Command):
4321
 
    __doc__ = """Show help on a command or other topic.
 
3955
    """Show help on a command or other topic.
4322
3956
    """
4323
3957
 
4324
3958
    _see_also = ['topics']
4337
3971
 
4338
3972
 
4339
3973
class cmd_shell_complete(Command):
4340
 
    __doc__ = """Show appropriate completions for context.
 
3974
    """Show appropriate completions for context.
4341
3975
 
4342
3976
    For a list of all available commands, say 'bzr shell-complete'.
4343
3977
    """
4352
3986
 
4353
3987
 
4354
3988
class cmd_missing(Command):
4355
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
3989
    """Show unmerged/unpulled revisions between two branches.
4356
3990
 
4357
3991
    OTHER_BRANCH may be local or remote.
4358
3992
 
4359
3993
    To filter on a range of revisions, you can use the command -r begin..end
4360
3994
    -r revision requests a specific revision, -r ..end or -r begin.. are
4361
3995
    also valid.
4362
 
            
4363
 
    :Exit values:
4364
 
        1 - some missing revisions
4365
 
        0 - no missing revisions
4366
3996
 
4367
3997
    :Examples:
4368
3998
 
4389
4019
    _see_also = ['merge', 'pull']
4390
4020
    takes_args = ['other_branch?']
4391
4021
    takes_options = [
4392
 
        'directory',
4393
4022
        Option('reverse', 'Reverse the order of revisions.'),
4394
4023
        Option('mine-only',
4395
4024
               'Display changes in the local branch only.'),
4417
4046
            theirs_only=False,
4418
4047
            log_format=None, long=False, short=False, line=False,
4419
4048
            show_ids=False, verbose=False, this=False, other=False,
4420
 
            include_merges=False, revision=None, my_revision=None,
4421
 
            directory=u'.'):
 
4049
            include_merges=False, revision=None, my_revision=None):
4422
4050
        from bzrlib.missing import find_unmerged, iter_log_revisions
4423
4051
        def message(s):
4424
4052
            if not is_quiet():
4437
4065
        elif theirs_only:
4438
4066
            restrict = 'remote'
4439
4067
 
4440
 
        local_branch = Branch.open_containing(directory)[0]
4441
 
        self.add_cleanup(local_branch.lock_read().unlock)
4442
 
 
 
4068
        local_branch = Branch.open_containing(u".")[0]
4443
4069
        parent = local_branch.get_parent()
4444
4070
        if other_branch is None:
4445
4071
            other_branch = parent
4454
4080
        remote_branch = Branch.open(other_branch)
4455
4081
        if remote_branch.base == local_branch.base:
4456
4082
            remote_branch = local_branch
4457
 
        else:
4458
 
            self.add_cleanup(remote_branch.lock_read().unlock)
4459
4083
 
4460
4084
        local_revid_range = _revision_range_to_revid_range(
4461
4085
            _get_revision_range(my_revision, local_branch,
4465
4089
            _get_revision_range(revision,
4466
4090
                remote_branch, self.name()))
4467
4091
 
4468
 
        local_extra, remote_extra = find_unmerged(
4469
 
            local_branch, remote_branch, restrict,
4470
 
            backward=not reverse,
4471
 
            include_merges=include_merges,
4472
 
            local_revid_range=local_revid_range,
4473
 
            remote_revid_range=remote_revid_range)
4474
 
 
4475
 
        if log_format is None:
4476
 
            registry = log.log_formatter_registry
4477
 
            log_format = registry.get_default(local_branch)
4478
 
        lf = log_format(to_file=self.outf,
4479
 
                        show_ids=show_ids,
4480
 
                        show_timezone='original')
4481
 
 
4482
 
        status_code = 0
4483
 
        if local_extra and not theirs_only:
4484
 
            message("You have %d extra revision(s):\n" %
4485
 
                len(local_extra))
4486
 
            for revision in iter_log_revisions(local_extra,
4487
 
                                local_branch.repository,
4488
 
                                verbose):
4489
 
                lf.log_revision(revision)
4490
 
            printed_local = True
4491
 
            status_code = 1
4492
 
        else:
4493
 
            printed_local = False
4494
 
 
4495
 
        if remote_extra and not mine_only:
4496
 
            if printed_local is True:
4497
 
                message("\n\n\n")
4498
 
            message("You are missing %d revision(s):\n" %
4499
 
                len(remote_extra))
4500
 
            for revision in iter_log_revisions(remote_extra,
4501
 
                                remote_branch.repository,
4502
 
                                verbose):
4503
 
                lf.log_revision(revision)
4504
 
            status_code = 1
4505
 
 
4506
 
        if mine_only and not local_extra:
4507
 
            # We checked local, and found nothing extra
4508
 
            message('This branch is up to date.\n')
4509
 
        elif theirs_only and not remote_extra:
4510
 
            # We checked remote, and found nothing extra
4511
 
            message('Other branch is up to date.\n')
4512
 
        elif not (mine_only or theirs_only or local_extra or
4513
 
                  remote_extra):
4514
 
            # We checked both branches, and neither one had extra
4515
 
            # revisions
4516
 
            message("Branches are up to date.\n")
4517
 
        self.cleanup_now()
 
4092
        local_branch.lock_read()
 
4093
        try:
 
4094
            remote_branch.lock_read()
 
4095
            try:
 
4096
                local_extra, remote_extra = find_unmerged(
 
4097
                    local_branch, remote_branch, restrict,
 
4098
                    backward=not reverse,
 
4099
                    include_merges=include_merges,
 
4100
                    local_revid_range=local_revid_range,
 
4101
                    remote_revid_range=remote_revid_range)
 
4102
 
 
4103
                if log_format is None:
 
4104
                    registry = log.log_formatter_registry
 
4105
                    log_format = registry.get_default(local_branch)
 
4106
                lf = log_format(to_file=self.outf,
 
4107
                                show_ids=show_ids,
 
4108
                                show_timezone='original')
 
4109
 
 
4110
                status_code = 0
 
4111
                if local_extra and not theirs_only:
 
4112
                    message("You have %d extra revision(s):\n" %
 
4113
                        len(local_extra))
 
4114
                    for revision in iter_log_revisions(local_extra,
 
4115
                                        local_branch.repository,
 
4116
                                        verbose):
 
4117
                        lf.log_revision(revision)
 
4118
                    printed_local = True
 
4119
                    status_code = 1
 
4120
                else:
 
4121
                    printed_local = False
 
4122
 
 
4123
                if remote_extra and not mine_only:
 
4124
                    if printed_local is True:
 
4125
                        message("\n\n\n")
 
4126
                    message("You are missing %d revision(s):\n" %
 
4127
                        len(remote_extra))
 
4128
                    for revision in iter_log_revisions(remote_extra,
 
4129
                                        remote_branch.repository,
 
4130
                                        verbose):
 
4131
                        lf.log_revision(revision)
 
4132
                    status_code = 1
 
4133
 
 
4134
                if mine_only and not local_extra:
 
4135
                    # We checked local, and found nothing extra
 
4136
                    message('This branch is up to date.\n')
 
4137
                elif theirs_only and not remote_extra:
 
4138
                    # We checked remote, and found nothing extra
 
4139
                    message('Other branch is up to date.\n')
 
4140
                elif not (mine_only or theirs_only or local_extra or
 
4141
                          remote_extra):
 
4142
                    # We checked both branches, and neither one had extra
 
4143
                    # revisions
 
4144
                    message("Branches are up to date.\n")
 
4145
            finally:
 
4146
                remote_branch.unlock()
 
4147
        finally:
 
4148
            local_branch.unlock()
4518
4149
        if not status_code and parent is None and other_branch is not None:
4519
 
            self.add_cleanup(local_branch.lock_write().unlock)
4520
 
            # handle race conditions - a parent might be set while we run.
4521
 
            if local_branch.get_parent() is None:
4522
 
                local_branch.set_parent(remote_branch.base)
 
4150
            local_branch.lock_write()
 
4151
            try:
 
4152
                # handle race conditions - a parent might be set while we run.
 
4153
                if local_branch.get_parent() is None:
 
4154
                    local_branch.set_parent(remote_branch.base)
 
4155
            finally:
 
4156
                local_branch.unlock()
4523
4157
        return status_code
4524
4158
 
4525
4159
 
4526
4160
class cmd_pack(Command):
4527
 
    __doc__ = """Compress the data within a repository.
4528
 
 
4529
 
    This operation compresses the data within a bazaar repository. As
4530
 
    bazaar supports automatic packing of repository, this operation is
4531
 
    normally not required to be done manually.
4532
 
 
4533
 
    During the pack operation, bazaar takes a backup of existing repository
4534
 
    data, i.e. pack files. This backup is eventually removed by bazaar
4535
 
    automatically when it is safe to do so. To save disk space by removing
4536
 
    the backed up pack files, the --clean-obsolete-packs option may be
4537
 
    used.
4538
 
 
4539
 
    Warning: If you use --clean-obsolete-packs and your machine crashes
4540
 
    during or immediately after repacking, you may be left with a state
4541
 
    where the deletion has been written to disk but the new packs have not
4542
 
    been. In this case the repository may be unusable.
4543
 
    """
 
4161
    """Compress the data within a repository."""
4544
4162
 
4545
4163
    _see_also = ['repositories']
4546
4164
    takes_args = ['branch_or_repo?']
4547
 
    takes_options = [
4548
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4549
 
        ]
4550
4165
 
4551
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
4166
    def run(self, branch_or_repo='.'):
4552
4167
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4553
4168
        try:
4554
4169
            branch = dir.open_branch()
4555
4170
            repository = branch.repository
4556
4171
        except errors.NotBranchError:
4557
4172
            repository = dir.open_repository()
4558
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
4173
        repository.pack()
4559
4174
 
4560
4175
 
4561
4176
class cmd_plugins(Command):
4562
 
    __doc__ = """List the installed plugins.
 
4177
    """List the installed plugins.
4563
4178
 
4564
4179
    This command displays the list of installed plugins including
4565
4180
    version of plugin and a short description of each.
4572
4187
    adding new commands, providing additional network transports and
4573
4188
    customizing log output.
4574
4189
 
4575
 
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
4576
 
    for further information on plugins including where to find them and how to
4577
 
    install them. Instructions are also provided there on how to write new
4578
 
    plugins using the Python programming language.
 
4190
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4191
    information on plugins including where to find them and how to
 
4192
    install them. Instructions are also provided there on how to
 
4193
    write new plugins using the Python programming language.
4579
4194
    """
4580
4195
    takes_options = ['verbose']
4581
4196
 
4596
4211
                doc = '(no description)'
4597
4212
            result.append((name_ver, doc, plugin.path()))
4598
4213
        for name_ver, doc, path in sorted(result):
4599
 
            self.outf.write("%s\n" % name_ver)
4600
 
            self.outf.write("   %s\n" % doc)
 
4214
            print name_ver
 
4215
            print '   ', doc
4601
4216
            if verbose:
4602
 
                self.outf.write("   %s\n" % path)
4603
 
            self.outf.write("\n")
 
4217
                print '   ', path
 
4218
            print
4604
4219
 
4605
4220
 
4606
4221
class cmd_testament(Command):
4607
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
4222
    """Show testament (signing-form) of a revision."""
4608
4223
    takes_options = [
4609
4224
            'revision',
4610
4225
            Option('long', help='Produce long-format testament.'),
4622
4237
            b = Branch.open_containing(branch)[0]
4623
4238
        else:
4624
4239
            b = Branch.open(branch)
4625
 
        self.add_cleanup(b.lock_read().unlock)
4626
 
        if revision is None:
4627
 
            rev_id = b.last_revision()
4628
 
        else:
4629
 
            rev_id = revision[0].as_revision_id(b)
4630
 
        t = testament_class.from_revision(b.repository, rev_id)
4631
 
        if long:
4632
 
            sys.stdout.writelines(t.as_text_lines())
4633
 
        else:
4634
 
            sys.stdout.write(t.as_short_text())
 
4240
        b.lock_read()
 
4241
        try:
 
4242
            if revision is None:
 
4243
                rev_id = b.last_revision()
 
4244
            else:
 
4245
                rev_id = revision[0].as_revision_id(b)
 
4246
            t = testament_class.from_revision(b.repository, rev_id)
 
4247
            if long:
 
4248
                sys.stdout.writelines(t.as_text_lines())
 
4249
            else:
 
4250
                sys.stdout.write(t.as_short_text())
 
4251
        finally:
 
4252
            b.unlock()
4635
4253
 
4636
4254
 
4637
4255
class cmd_annotate(Command):
4638
 
    __doc__ = """Show the origin of each line in a file.
 
4256
    """Show the origin of each line in a file.
4639
4257
 
4640
4258
    This prints out the given file with an annotation on the left side
4641
4259
    indicating which revision, author and date introduced the change.
4652
4270
                     Option('long', help='Show commit date in annotations.'),
4653
4271
                     'revision',
4654
4272
                     'show-ids',
4655
 
                     'directory',
4656
4273
                     ]
4657
4274
    encoding_type = 'exact'
4658
4275
 
4659
4276
    @display_command
4660
4277
    def run(self, filename, all=False, long=False, revision=None,
4661
 
            show_ids=False, directory=None):
 
4278
            show_ids=False):
4662
4279
        from bzrlib.annotate import annotate_file, annotate_file_tree
4663
4280
        wt, branch, relpath = \
4664
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
4665
 
        if wt is not None:
4666
 
            self.add_cleanup(wt.lock_read().unlock)
4667
 
        else:
4668
 
            self.add_cleanup(branch.lock_read().unlock)
4669
 
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4670
 
        self.add_cleanup(tree.lock_read().unlock)
4671
 
        if wt is not None:
4672
 
            file_id = wt.path2id(relpath)
4673
 
        else:
4674
 
            file_id = tree.path2id(relpath)
4675
 
        if file_id is None:
4676
 
            raise errors.NotVersionedError(filename)
4677
 
        file_version = tree.inventory[file_id].revision
4678
 
        if wt is not None and revision is None:
4679
 
            # If there is a tree and we're not annotating historical
4680
 
            # versions, annotate the working tree's content.
4681
 
            annotate_file_tree(wt, file_id, self.outf, long, all,
4682
 
                show_ids=show_ids)
4683
 
        else:
4684
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4685
 
                          show_ids=show_ids)
 
4281
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4282
        if wt is not None:
 
4283
            wt.lock_read()
 
4284
        else:
 
4285
            branch.lock_read()
 
4286
        try:
 
4287
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4288
            if wt is not None:
 
4289
                file_id = wt.path2id(relpath)
 
4290
            else:
 
4291
                file_id = tree.path2id(relpath)
 
4292
            if file_id is None:
 
4293
                raise errors.NotVersionedError(filename)
 
4294
            file_version = tree.inventory[file_id].revision
 
4295
            if wt is not None and revision is None:
 
4296
                # If there is a tree and we're not annotating historical
 
4297
                # versions, annotate the working tree's content.
 
4298
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4299
                    show_ids=show_ids)
 
4300
            else:
 
4301
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4302
                              show_ids=show_ids)
 
4303
        finally:
 
4304
            if wt is not None:
 
4305
                wt.unlock()
 
4306
            else:
 
4307
                branch.unlock()
4686
4308
 
4687
4309
 
4688
4310
class cmd_re_sign(Command):
4689
 
    __doc__ = """Create a digital signature for an existing revision."""
 
4311
    """Create a digital signature for an existing revision."""
4690
4312
    # TODO be able to replace existing ones.
4691
4313
 
4692
4314
    hidden = True # is this right ?
4693
4315
    takes_args = ['revision_id*']
4694
 
    takes_options = ['directory', 'revision']
 
4316
    takes_options = ['revision']
4695
4317
 
4696
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
4318
    def run(self, revision_id_list=None, revision=None):
4697
4319
        if revision_id_list is not None and revision is not None:
4698
4320
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4699
4321
        if revision_id_list is None and revision is None:
4700
4322
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4701
 
        b = WorkingTree.open_containing(directory)[0].branch
4702
 
        self.add_cleanup(b.lock_write().unlock)
4703
 
        return self._run(b, revision_id_list, revision)
 
4323
        b = WorkingTree.open_containing(u'.')[0].branch
 
4324
        b.lock_write()
 
4325
        try:
 
4326
            return self._run(b, revision_id_list, revision)
 
4327
        finally:
 
4328
            b.unlock()
4704
4329
 
4705
4330
    def _run(self, b, revision_id_list, revision):
4706
4331
        import bzrlib.gpg as gpg
4751
4376
 
4752
4377
 
4753
4378
class cmd_bind(Command):
4754
 
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
4755
 
    If no branch is supplied, rebind to the last bound location.
 
4379
    """Convert the current branch into a checkout of the supplied branch.
4756
4380
 
4757
4381
    Once converted into a checkout, commits must succeed on the master branch
4758
4382
    before they will be applied to the local branch.
4759
4383
 
4760
4384
    Bound branches use the nickname of its master branch unless it is set
4761
 
    locally, in which case binding will update the local nickname to be
 
4385
    locally, in which case binding will update the the local nickname to be
4762
4386
    that of the master.
4763
4387
    """
4764
4388
 
4765
4389
    _see_also = ['checkouts', 'unbind']
4766
4390
    takes_args = ['location?']
4767
 
    takes_options = ['directory']
 
4391
    takes_options = []
4768
4392
 
4769
 
    def run(self, location=None, directory=u'.'):
4770
 
        b, relpath = Branch.open_containing(directory)
 
4393
    def run(self, location=None):
 
4394
        b, relpath = Branch.open_containing(u'.')
4771
4395
        if location is None:
4772
4396
            try:
4773
4397
                location = b.get_old_bound_location()
4776
4400
                    'This format does not remember old locations.')
4777
4401
            else:
4778
4402
                if location is None:
4779
 
                    if b.get_bound_location() is not None:
4780
 
                        raise errors.BzrCommandError('Branch is already bound')
4781
 
                    else:
4782
 
                        raise errors.BzrCommandError('No location supplied '
4783
 
                            'and no previous location known')
 
4403
                    raise errors.BzrCommandError('No location supplied and no '
 
4404
                        'previous location known')
4784
4405
        b_other = Branch.open(location)
4785
4406
        try:
4786
4407
            b.bind(b_other)
4792
4413
 
4793
4414
 
4794
4415
class cmd_unbind(Command):
4795
 
    __doc__ = """Convert the current checkout into a regular branch.
 
4416
    """Convert the current checkout into a regular branch.
4796
4417
 
4797
4418
    After unbinding, the local branch is considered independent and subsequent
4798
4419
    commits will be local only.
4800
4421
 
4801
4422
    _see_also = ['checkouts', 'bind']
4802
4423
    takes_args = []
4803
 
    takes_options = ['directory']
 
4424
    takes_options = []
4804
4425
 
4805
 
    def run(self, directory=u'.'):
4806
 
        b, relpath = Branch.open_containing(directory)
 
4426
    def run(self):
 
4427
        b, relpath = Branch.open_containing(u'.')
4807
4428
        if not b.unbind():
4808
4429
            raise errors.BzrCommandError('Local branch is not bound')
4809
4430
 
4810
4431
 
4811
4432
class cmd_uncommit(Command):
4812
 
    __doc__ = """Remove the last committed revision.
 
4433
    """Remove the last committed revision.
4813
4434
 
4814
4435
    --verbose will print out what is being removed.
4815
4436
    --dry-run will go through all the motions, but not actually
4855
4476
            b = control.open_branch()
4856
4477
 
4857
4478
        if tree is not None:
4858
 
            self.add_cleanup(tree.lock_write().unlock)
 
4479
            tree.lock_write()
4859
4480
        else:
4860
 
            self.add_cleanup(b.lock_write().unlock)
4861
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
4481
            b.lock_write()
 
4482
        try:
 
4483
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4484
                             local=local)
 
4485
        finally:
 
4486
            if tree is not None:
 
4487
                tree.unlock()
 
4488
            else:
 
4489
                b.unlock()
4862
4490
 
4863
4491
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4864
4492
        from bzrlib.log import log_formatter, show_log
4896
4524
                 end_revision=last_revno)
4897
4525
 
4898
4526
        if dry_run:
4899
 
            self.outf.write('Dry-run, pretending to remove'
4900
 
                            ' the above revisions.\n')
 
4527
            print 'Dry-run, pretending to remove the above revisions.'
 
4528
            if not force:
 
4529
                val = raw_input('Press <enter> to continue')
4901
4530
        else:
4902
 
            self.outf.write('The above revision(s) will be removed.\n')
4903
 
 
4904
 
        if not force:
4905
 
            if not ui.ui_factory.confirm_action(
4906
 
                    'Uncommit these revisions',
4907
 
                    'bzrlib.builtins.uncommit',
4908
 
                    {}):
4909
 
                self.outf.write('Canceled\n')
4910
 
                return 0
 
4531
            print 'The above revision(s) will be removed.'
 
4532
            if not force:
 
4533
                val = raw_input('Are you sure [y/N]? ')
 
4534
                if val.lower() not in ('y', 'yes'):
 
4535
                    print 'Canceled'
 
4536
                    return 0
4911
4537
 
4912
4538
        mutter('Uncommitting from {%s} to {%s}',
4913
4539
               last_rev_id, rev_id)
4914
4540
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4915
4541
                 revno=revno, local=local)
4916
 
        self.outf.write('You can restore the old tip by running:\n'
4917
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
4542
        note('You can restore the old tip by running:\n'
 
4543
             '  bzr pull . -r revid:%s', last_rev_id)
4918
4544
 
4919
4545
 
4920
4546
class cmd_break_lock(Command):
4921
 
    __doc__ = """Break a dead lock.
4922
 
 
4923
 
    This command breaks a lock on a repository, branch, working directory or
4924
 
    config file.
 
4547
    """Break a dead lock on a repository, branch or working directory.
4925
4548
 
4926
4549
    CAUTION: Locks should only be broken when you are sure that the process
4927
4550
    holding the lock has been stopped.
4928
4551
 
4929
 
    You can get information on what locks are open via the 'bzr info
4930
 
    [location]' command.
 
4552
    You can get information on what locks are open via the 'bzr info' command.
4931
4553
 
4932
4554
    :Examples:
4933
4555
        bzr break-lock
4934
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4935
 
        bzr break-lock --conf ~/.bazaar
4936
4556
    """
4937
 
 
4938
4557
    takes_args = ['location?']
4939
 
    takes_options = [
4940
 
        Option('config',
4941
 
               help='LOCATION is the directory where the config lock is.'),
4942
 
        Option('force',
4943
 
            help='Do not ask for confirmation before breaking the lock.'),
4944
 
        ]
4945
4558
 
4946
 
    def run(self, location=None, config=False, force=False):
 
4559
    def run(self, location=None, show=False):
4947
4560
        if location is None:
4948
4561
            location = u'.'
4949
 
        if force:
4950
 
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
4951
 
                None,
4952
 
                {'bzrlib.lockdir.break': True})
4953
 
        if config:
4954
 
            conf = _mod_config.LockableConfig(file_name=location)
4955
 
            conf.break_lock()
4956
 
        else:
4957
 
            control, relpath = bzrdir.BzrDir.open_containing(location)
4958
 
            try:
4959
 
                control.break_lock()
4960
 
            except NotImplementedError:
4961
 
                pass
 
4562
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4563
        try:
 
4564
            control.break_lock()
 
4565
        except NotImplementedError:
 
4566
            pass
4962
4567
 
4963
4568
 
4964
4569
class cmd_wait_until_signalled(Command):
4965
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4570
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4966
4571
 
4967
4572
    This just prints a line to signal when it is ready, then blocks on stdin.
4968
4573
    """
4976
4581
 
4977
4582
 
4978
4583
class cmd_serve(Command):
4979
 
    __doc__ = """Run the bzr server."""
 
4584
    """Run the bzr server."""
4980
4585
 
4981
4586
    aliases = ['server']
4982
4587
 
4983
4588
    takes_options = [
4984
4589
        Option('inet',
4985
4590
               help='Serve on stdin/out for use from inetd or sshd.'),
4986
 
        RegistryOption('protocol',
4987
 
               help="Protocol to serve.",
 
4591
        RegistryOption('protocol', 
 
4592
               help="Protocol to serve.", 
4988
4593
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4989
4594
               value_switches=True),
4990
4595
        Option('port',
4993
4598
                    'result in a dynamically allocated port.  The default port '
4994
4599
                    'depends on the protocol.',
4995
4600
               type=str),
4996
 
        custom_help('directory',
4997
 
               help='Serve contents of this directory.'),
 
4601
        Option('directory',
 
4602
               help='Serve contents of this directory.',
 
4603
               type=unicode),
4998
4604
        Option('allow-writes',
4999
4605
               help='By default the server is a readonly server.  Supplying '
5000
4606
                    '--allow-writes enables write access to the contents of '
5001
 
                    'the served directory and below.  Note that ``bzr serve`` '
5002
 
                    'does not perform authentication, so unless some form of '
5003
 
                    'external authentication is arranged supplying this '
5004
 
                    'option leads to global uncontrolled write access to your '
5005
 
                    'file system.'
 
4607
                    'the served directory and below.'
5006
4608
                ),
5007
4609
        ]
5008
4610
 
5027
4629
 
5028
4630
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5029
4631
            protocol=None):
5030
 
        from bzrlib import transport
 
4632
        from bzrlib.transport import get_transport, transport_server_registry
5031
4633
        if directory is None:
5032
4634
            directory = os.getcwd()
5033
4635
        if protocol is None:
5034
 
            protocol = transport.transport_server_registry.get()
 
4636
            protocol = transport_server_registry.get()
5035
4637
        host, port = self.get_host_and_port(port)
5036
4638
        url = urlutils.local_path_to_url(directory)
5037
4639
        if not allow_writes:
5038
4640
            url = 'readonly+' + url
5039
 
        t = transport.get_transport(url)
5040
 
        protocol(t, host, port, inet)
 
4641
        transport = get_transport(url)
 
4642
        protocol(transport, host, port, inet)
5041
4643
 
5042
4644
 
5043
4645
class cmd_join(Command):
5044
 
    __doc__ = """Combine a tree into its containing tree.
 
4646
    """Combine a tree into its containing tree.
5045
4647
 
5046
4648
    This command requires the target tree to be in a rich-root format.
5047
4649
 
5049
4651
    not part of it.  (Such trees can be produced by "bzr split", but also by
5050
4652
    running "bzr branch" with the target inside a tree.)
5051
4653
 
5052
 
    The result is a combined tree, with the subtree no longer an independent
 
4654
    The result is a combined tree, with the subtree no longer an independant
5053
4655
    part.  This is marked as a merge of the subtree into the containing tree,
5054
4656
    and all history is preserved.
5055
4657
    """
5087
4689
 
5088
4690
 
5089
4691
class cmd_split(Command):
5090
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
4692
    """Split a subdirectory of a tree into a separate tree.
5091
4693
 
5092
4694
    This command will produce a target tree in a format that supports
5093
4695
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5113
4715
 
5114
4716
 
5115
4717
class cmd_merge_directive(Command):
5116
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4718
    """Generate a merge directive for auto-merge tools.
5117
4719
 
5118
4720
    A directive requests a merge to be performed, and also provides all the
5119
4721
    information necessary to do so.  This means it must either include a
5136
4738
    _see_also = ['send']
5137
4739
 
5138
4740
    takes_options = [
5139
 
        'directory',
5140
4741
        RegistryOption.from_kwargs('patch-type',
5141
4742
            'The type of patch to include in the directive.',
5142
4743
            title='Patch type',
5155
4756
    encoding_type = 'exact'
5156
4757
 
5157
4758
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5158
 
            sign=False, revision=None, mail_to=None, message=None,
5159
 
            directory=u'.'):
 
4759
            sign=False, revision=None, mail_to=None, message=None):
5160
4760
        from bzrlib.revision import ensure_null, NULL_REVISION
5161
4761
        include_patch, include_bundle = {
5162
4762
            'plain': (False, False),
5163
4763
            'diff': (True, False),
5164
4764
            'bundle': (True, True),
5165
4765
            }[patch_type]
5166
 
        branch = Branch.open(directory)
 
4766
        branch = Branch.open('.')
5167
4767
        stored_submit_branch = branch.get_submit_branch()
5168
4768
        if submit_branch is None:
5169
4769
            submit_branch = stored_submit_branch
5214
4814
 
5215
4815
 
5216
4816
class cmd_send(Command):
5217
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4817
    """Mail or create a merge-directive for submitting changes.
5218
4818
 
5219
4819
    A merge directive provides many things needed for requesting merges:
5220
4820
 
5226
4826
      directly from the merge directive, without retrieving data from a
5227
4827
      branch.
5228
4828
 
5229
 
    `bzr send` creates a compact data set that, when applied using bzr
5230
 
    merge, has the same effect as merging from the source branch.  
5231
 
    
5232
 
    By default the merge directive is self-contained and can be applied to any
5233
 
    branch containing submit_branch in its ancestory without needing access to
5234
 
    the source branch.
5235
 
    
5236
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5237
 
    revisions, but only a structured request to merge from the
5238
 
    public_location.  In that case the public_branch is needed and it must be
5239
 
    up-to-date and accessible to the recipient.  The public_branch is always
5240
 
    included if known, so that people can check it later.
5241
 
 
5242
 
    The submit branch defaults to the parent of the source branch, but can be
5243
 
    overridden.  Both submit branch and public branch will be remembered in
5244
 
    branch.conf the first time they are used for a particular branch.  The
5245
 
    source branch defaults to that containing the working directory, but can
5246
 
    be changed using --from.
5247
 
 
5248
 
    In order to calculate those changes, bzr must analyse the submit branch.
5249
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5250
 
    If a public location is known for the submit_branch, that location is used
5251
 
    in the merge directive.
5252
 
 
5253
 
    The default behaviour is to send the merge directive by mail, unless -o is
5254
 
    given, in which case it is sent to a file.
 
4829
    If --no-bundle is specified, then public_branch is needed (and must be
 
4830
    up-to-date), so that the receiver can perform the merge using the
 
4831
    public_branch.  The public_branch is always included if known, so that
 
4832
    people can check it later.
 
4833
 
 
4834
    The submit branch defaults to the parent, but can be overridden.  Both
 
4835
    submit branch and public branch will be remembered if supplied.
 
4836
 
 
4837
    If a public_branch is known for the submit_branch, that public submit
 
4838
    branch is used in the merge instructions.  This means that a local mirror
 
4839
    can be used as your actual submit branch, once you have set public_branch
 
4840
    for that mirror.
5255
4841
 
5256
4842
    Mail is sent using your preferred mail program.  This should be transparent
5257
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4843
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5258
4844
    If the preferred client can't be found (or used), your editor will be used.
5259
4845
 
5260
4846
    To use a specific mail program, set the mail_client configuration option.
5261
4847
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5262
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5263
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5264
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5265
 
    supported clients.
 
4848
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4849
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4850
    "mapi", and "xdg-email".  Plugins may also add supported clients.
5266
4851
 
5267
4852
    If mail is being sent, a to address is required.  This can be supplied
5268
4853
    either on the commandline, by setting the submit_to configuration
5277
4862
 
5278
4863
    The merge directives created by bzr send may be applied using bzr merge or
5279
4864
    bzr pull by specifying a file containing a merge directive as the location.
5280
 
 
5281
 
    bzr send makes extensive use of public locations to map local locations into
5282
 
    URLs that can be used by other people.  See `bzr help configuration` to
5283
 
    set them, and use `bzr info` to display them.
5284
4865
    """
5285
4866
 
5286
4867
    encoding_type = 'exact'
5302
4883
               short_name='f',
5303
4884
               type=unicode),
5304
4885
        Option('output', short_name='o',
5305
 
               help='Write merge directive to this file or directory; '
 
4886
               help='Write merge directive to this file; '
5306
4887
                    'use - for stdout.',
5307
4888
               type=unicode),
5308
 
        Option('strict',
5309
 
               help='Refuse to send if there are uncommitted changes in'
5310
 
               ' the working tree, --no-strict disables the check.'),
5311
4889
        Option('mail-to', help='Mail the request to this address.',
5312
4890
               type=unicode),
5313
4891
        'revision',
5314
4892
        'message',
5315
4893
        Option('body', help='Body for the email.', type=unicode),
5316
4894
        RegistryOption('format',
5317
 
                       help='Use the specified output format.',
5318
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4895
                       help='Use the specified output format.', 
 
4896
                       lazy_registry=('bzrlib.send', 'format_registry'))
5319
4897
        ]
5320
4898
 
5321
4899
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5322
4900
            no_patch=False, revision=None, remember=False, output=None,
5323
 
            format=None, mail_to=None, message=None, body=None,
5324
 
            strict=None, **kwargs):
 
4901
            format=None, mail_to=None, message=None, body=None, **kwargs):
5325
4902
        from bzrlib.send import send
5326
4903
        return send(submit_branch, revision, public_branch, remember,
5327
 
                    format, no_bundle, no_patch, output,
5328
 
                    kwargs.get('from', '.'), mail_to, message, body,
5329
 
                    self.outf,
5330
 
                    strict=strict)
 
4904
                         format, no_bundle, no_patch, output,
 
4905
                         kwargs.get('from', '.'), mail_to, message, body,
 
4906
                         self.outf)
5331
4907
 
5332
4908
 
5333
4909
class cmd_bundle_revisions(cmd_send):
5334
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4910
    """Create a merge-directive for submitting changes.
5335
4911
 
5336
4912
    A merge directive provides many things needed for requesting merges:
5337
4913
 
5377
4953
               type=unicode),
5378
4954
        Option('output', short_name='o', help='Write directive to this file.',
5379
4955
               type=unicode),
5380
 
        Option('strict',
5381
 
               help='Refuse to bundle revisions if there are uncommitted'
5382
 
               ' changes in the working tree, --no-strict disables the check.'),
5383
4956
        'revision',
5384
4957
        RegistryOption('format',
5385
4958
                       help='Use the specified output format.',
5393
4966
 
5394
4967
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5395
4968
            no_patch=False, revision=None, remember=False, output=None,
5396
 
            format=None, strict=None, **kwargs):
 
4969
            format=None, **kwargs):
5397
4970
        if output is None:
5398
4971
            output = '-'
5399
4972
        from bzrlib.send import send
5400
4973
        return send(submit_branch, revision, public_branch, remember,
5401
4974
                         format, no_bundle, no_patch, output,
5402
4975
                         kwargs.get('from', '.'), None, None, None,
5403
 
                         self.outf, strict=strict)
 
4976
                         self.outf)
5404
4977
 
5405
4978
 
5406
4979
class cmd_tag(Command):
5407
 
    __doc__ = """Create, remove or modify a tag naming a revision.
 
4980
    """Create, remove or modify a tag naming a revision.
5408
4981
 
5409
4982
    Tags give human-meaningful names to revisions.  Commands that take a -r
5410
4983
    (--revision) option can be given -rtag:X, where X is any previously
5418
4991
 
5419
4992
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5420
4993
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5421
 
 
5422
 
    If no tag name is specified it will be determined through the 
5423
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5424
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5425
 
    details.
5426
4994
    """
5427
4995
 
5428
4996
    _see_also = ['commit', 'tags']
5429
 
    takes_args = ['tag_name?']
 
4997
    takes_args = ['tag_name']
5430
4998
    takes_options = [
5431
4999
        Option('delete',
5432
5000
            help='Delete this tag rather than placing it.',
5433
5001
            ),
5434
 
        custom_help('directory',
5435
 
            help='Branch in which to place the tag.'),
 
5002
        Option('directory',
 
5003
            help='Branch in which to place the tag.',
 
5004
            short_name='d',
 
5005
            type=unicode,
 
5006
            ),
5436
5007
        Option('force',
5437
5008
            help='Replace existing tags.',
5438
5009
            ),
5439
5010
        'revision',
5440
5011
        ]
5441
5012
 
5442
 
    def run(self, tag_name=None,
 
5013
    def run(self, tag_name,
5443
5014
            delete=None,
5444
5015
            directory='.',
5445
5016
            force=None,
5446
5017
            revision=None,
5447
5018
            ):
5448
5019
        branch, relpath = Branch.open_containing(directory)
5449
 
        self.add_cleanup(branch.lock_write().unlock)
5450
 
        if delete:
5451
 
            if tag_name is None:
5452
 
                raise errors.BzrCommandError("No tag specified to delete.")
5453
 
            branch.tags.delete_tag(tag_name)
5454
 
            note('Deleted tag %s.' % tag_name)
5455
 
        else:
5456
 
            if revision:
5457
 
                if len(revision) != 1:
5458
 
                    raise errors.BzrCommandError(
5459
 
                        "Tags can only be placed on a single revision, "
5460
 
                        "not on a range")
5461
 
                revision_id = revision[0].as_revision_id(branch)
 
5020
        branch.lock_write()
 
5021
        try:
 
5022
            if delete:
 
5023
                branch.tags.delete_tag(tag_name)
 
5024
                self.outf.write('Deleted tag %s.\n' % tag_name)
5462
5025
            else:
5463
 
                revision_id = branch.last_revision()
5464
 
            if tag_name is None:
5465
 
                tag_name = branch.automatic_tag_name(revision_id)
5466
 
                if tag_name is None:
5467
 
                    raise errors.BzrCommandError(
5468
 
                        "Please specify a tag name.")
5469
 
            if (not force) and branch.tags.has_tag(tag_name):
5470
 
                raise errors.TagAlreadyExists(tag_name)
5471
 
            branch.tags.set_tag(tag_name, revision_id)
5472
 
            note('Created tag %s.' % tag_name)
 
5026
                if revision:
 
5027
                    if len(revision) != 1:
 
5028
                        raise errors.BzrCommandError(
 
5029
                            "Tags can only be placed on a single revision, "
 
5030
                            "not on a range")
 
5031
                    revision_id = revision[0].as_revision_id(branch)
 
5032
                else:
 
5033
                    revision_id = branch.last_revision()
 
5034
                if (not force) and branch.tags.has_tag(tag_name):
 
5035
                    raise errors.TagAlreadyExists(tag_name)
 
5036
                branch.tags.set_tag(tag_name, revision_id)
 
5037
                self.outf.write('Created tag %s.\n' % tag_name)
 
5038
        finally:
 
5039
            branch.unlock()
5473
5040
 
5474
5041
 
5475
5042
class cmd_tags(Command):
5476
 
    __doc__ = """List tags.
 
5043
    """List tags.
5477
5044
 
5478
5045
    This command shows a table of tag names and the revisions they reference.
5479
5046
    """
5480
5047
 
5481
5048
    _see_also = ['tag']
5482
5049
    takes_options = [
5483
 
        custom_help('directory',
5484
 
            help='Branch whose tags should be displayed.'),
 
5050
        Option('directory',
 
5051
            help='Branch whose tags should be displayed.',
 
5052
            short_name='d',
 
5053
            type=unicode,
 
5054
            ),
5485
5055
        RegistryOption.from_kwargs('sort',
5486
5056
            'Sort tags by different criteria.', title='Sorting',
5487
 
            natural='Sort numeric substrings as numbers:'
5488
 
                    ' suitable for version numbers. (default)',
5489
 
            alpha='Sort tags lexicographically.',
 
5057
            alpha='Sort tags lexicographically (default).',
5490
5058
            time='Sort tags chronologically.',
5491
5059
            ),
5492
5060
        'show-ids',
5496
5064
    @display_command
5497
5065
    def run(self,
5498
5066
            directory='.',
5499
 
            sort='natural',
 
5067
            sort='alpha',
5500
5068
            show_ids=False,
5501
5069
            revision=None,
5502
5070
            ):
5506
5074
        if not tags:
5507
5075
            return
5508
5076
 
5509
 
        self.add_cleanup(branch.lock_read().unlock)
5510
 
        if revision:
5511
 
            graph = branch.repository.get_graph()
5512
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5513
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5514
 
            # only show revisions between revid1 and revid2 (inclusive)
5515
 
            tags = [(tag, revid) for tag, revid in tags if
5516
 
                graph.is_between(revid, revid1, revid2)]
5517
 
        if sort == 'natural':
5518
 
            def natural_sort_key(tag):
5519
 
                return [f(s) for f,s in 
5520
 
                        zip(itertools.cycle((unicode.lower,int)),
5521
 
                                            re.split('([0-9]+)', tag[0]))]
5522
 
            tags.sort(key=natural_sort_key)
5523
 
        elif sort == 'alpha':
5524
 
            tags.sort()
5525
 
        elif sort == 'time':
5526
 
            timestamps = {}
5527
 
            for tag, revid in tags:
5528
 
                try:
5529
 
                    revobj = branch.repository.get_revision(revid)
5530
 
                except errors.NoSuchRevision:
5531
 
                    timestamp = sys.maxint # place them at the end
5532
 
                else:
5533
 
                    timestamp = revobj.timestamp
5534
 
                timestamps[revid] = timestamp
5535
 
            tags.sort(key=lambda x: timestamps[x[1]])
5536
 
        if not show_ids:
5537
 
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5538
 
            for index, (tag, revid) in enumerate(tags):
5539
 
                try:
5540
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5541
 
                    if isinstance(revno, tuple):
5542
 
                        revno = '.'.join(map(str, revno))
5543
 
                except errors.NoSuchRevision:
5544
 
                    # Bad tag data/merges can lead to tagged revisions
5545
 
                    # which are not in this branch. Fail gracefully ...
5546
 
                    revno = '?'
5547
 
                tags[index] = (tag, revno)
5548
 
        self.cleanup_now()
 
5077
        branch.lock_read()
 
5078
        try:
 
5079
            if revision:
 
5080
                graph = branch.repository.get_graph()
 
5081
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5082
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5083
                # only show revisions between revid1 and revid2 (inclusive)
 
5084
                tags = [(tag, revid) for tag, revid in tags if
 
5085
                    graph.is_between(revid, revid1, revid2)]
 
5086
            if sort == 'alpha':
 
5087
                tags.sort()
 
5088
            elif sort == 'time':
 
5089
                timestamps = {}
 
5090
                for tag, revid in tags:
 
5091
                    try:
 
5092
                        revobj = branch.repository.get_revision(revid)
 
5093
                    except errors.NoSuchRevision:
 
5094
                        timestamp = sys.maxint # place them at the end
 
5095
                    else:
 
5096
                        timestamp = revobj.timestamp
 
5097
                    timestamps[revid] = timestamp
 
5098
                tags.sort(key=lambda x: timestamps[x[1]])
 
5099
            if not show_ids:
 
5100
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5101
                for index, (tag, revid) in enumerate(tags):
 
5102
                    try:
 
5103
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5104
                        if isinstance(revno, tuple):
 
5105
                            revno = '.'.join(map(str, revno))
 
5106
                    except errors.NoSuchRevision:
 
5107
                        # Bad tag data/merges can lead to tagged revisions
 
5108
                        # which are not in this branch. Fail gracefully ...
 
5109
                        revno = '?'
 
5110
                    tags[index] = (tag, revno)
 
5111
        finally:
 
5112
            branch.unlock()
5549
5113
        for tag, revspec in tags:
5550
5114
            self.outf.write('%-20s %s\n' % (tag, revspec))
5551
5115
 
5552
5116
 
5553
5117
class cmd_reconfigure(Command):
5554
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
5118
    """Reconfigure the type of a bzr directory.
5555
5119
 
5556
5120
    A target configuration must be specified.
5557
5121
 
5587
5151
            ),
5588
5152
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5589
5153
        Option('force',
5590
 
            help='Perform reconfiguration even if local changes'
5591
 
            ' will be lost.'),
5592
 
        Option('stacked-on',
5593
 
            help='Reconfigure a branch to be stacked on another branch.',
5594
 
            type=unicode,
5595
 
            ),
5596
 
        Option('unstacked',
5597
 
            help='Reconfigure a branch to be unstacked.  This '
5598
 
                'may require copying substantial data into it.',
5599
 
            ),
 
5154
               help='Perform reconfiguration even if local changes'
 
5155
               ' will be lost.')
5600
5156
        ]
5601
5157
 
5602
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5603
 
            stacked_on=None,
5604
 
            unstacked=None):
 
5158
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5605
5159
        directory = bzrdir.BzrDir.open(location)
5606
 
        if stacked_on and unstacked:
5607
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
5608
 
        elif stacked_on is not None:
5609
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5610
 
        elif unstacked:
5611
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5612
 
        # At the moment you can use --stacked-on and a different
5613
 
        # reconfiguration shape at the same time; there seems no good reason
5614
 
        # to ban it.
5615
5160
        if target_type is None:
5616
 
            if stacked_on or unstacked:
5617
 
                return
5618
 
            else:
5619
 
                raise errors.BzrCommandError('No target configuration '
5620
 
                    'specified')
 
5161
            raise errors.BzrCommandError('No target configuration specified')
5621
5162
        elif target_type == 'branch':
5622
5163
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5623
5164
        elif target_type == 'tree':
5642
5183
 
5643
5184
 
5644
5185
class cmd_switch(Command):
5645
 
    __doc__ = """Set the branch of a checkout and update.
 
5186
    """Set the branch of a checkout and update.
5646
5187
 
5647
5188
    For lightweight checkouts, this changes the branch being referenced.
5648
5189
    For heavyweight checkouts, this checks that there are no local commits
5660
5201
    /path/to/newbranch.
5661
5202
 
5662
5203
    Bound branches use the nickname of its master branch unless it is set
5663
 
    locally, in which case switching will update the local nickname to be
 
5204
    locally, in which case switching will update the the local nickname to be
5664
5205
    that of the master.
5665
5206
    """
5666
5207
 
5667
 
    takes_args = ['to_location?']
5668
 
    takes_options = ['directory',
5669
 
                     Option('force',
5670
 
                        help='Switch even if local commits will be lost.'),
5671
 
                     'revision',
5672
 
                     Option('create-branch', short_name='b',
5673
 
                        help='Create the target branch from this one before'
5674
 
                             ' switching to it.'),
5675
 
                    ]
 
5208
    takes_args = ['to_location']
 
5209
    takes_options = [Option('force',
 
5210
                        help='Switch even if local commits will be lost.')
 
5211
                     ]
5676
5212
 
5677
 
    def run(self, to_location=None, force=False, create_branch=False,
5678
 
            revision=None, directory=u'.'):
 
5213
    def run(self, to_location, force=False):
5679
5214
        from bzrlib import switch
5680
 
        tree_location = directory
5681
 
        revision = _get_one_revision('switch', revision)
 
5215
        tree_location = '.'
5682
5216
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5683
 
        if to_location is None:
5684
 
            if revision is None:
5685
 
                raise errors.BzrCommandError('You must supply either a'
5686
 
                                             ' revision or a location')
5687
 
            to_location = tree_location
5688
5217
        try:
5689
5218
            branch = control_dir.open_branch()
5690
5219
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5691
5220
        except errors.NotBranchError:
5692
 
            branch = None
5693
5221
            had_explicit_nick = False
5694
 
        if create_branch:
5695
 
            if branch is None:
5696
 
                raise errors.BzrCommandError('cannot create branch without'
5697
 
                                             ' source branch')
5698
 
            to_location = directory_service.directories.dereference(
5699
 
                              to_location)
5700
 
            if '/' not in to_location and '\\' not in to_location:
5701
 
                # This path is meant to be relative to the existing branch
5702
 
                this_url = self._get_branch_location(control_dir)
5703
 
                to_location = urlutils.join(this_url, '..', to_location)
5704
 
            to_branch = branch.bzrdir.sprout(to_location,
5705
 
                                 possible_transports=[branch.bzrdir.root_transport],
5706
 
                                 source_branch=branch).open_branch()
5707
 
        else:
5708
 
            try:
5709
 
                to_branch = Branch.open(to_location)
5710
 
            except errors.NotBranchError:
5711
 
                this_url = self._get_branch_location(control_dir)
5712
 
                to_branch = Branch.open(
5713
 
                    urlutils.join(this_url, '..', to_location))
5714
 
        if revision is not None:
5715
 
            revision = revision.as_revision_id(to_branch)
5716
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5222
        try:
 
5223
            to_branch = Branch.open(to_location)
 
5224
        except errors.NotBranchError:
 
5225
            this_url = self._get_branch_location(control_dir)
 
5226
            to_branch = Branch.open(
 
5227
                urlutils.join(this_url, '..', to_location))
 
5228
        switch.switch(control_dir, to_branch, force)
5717
5229
        if had_explicit_nick:
5718
5230
            branch = control_dir.open_branch() #get the new branch!
5719
5231
            branch.nick = to_branch.nick
5739
5251
 
5740
5252
 
5741
5253
class cmd_view(Command):
5742
 
    __doc__ = """Manage filtered views.
 
5254
    """Manage filtered views.
5743
5255
 
5744
5256
    Views provide a mask over the tree so that users can focus on
5745
5257
    a subset of a tree when doing their work. After creating a view,
5825
5337
            name=None,
5826
5338
            switch=None,
5827
5339
            ):
5828
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
5829
 
            apply_view=False)
 
5340
        tree, file_list = tree_files(file_list, apply_view=False)
5830
5341
        current_view, view_dict = tree.views.get_view_info()
5831
5342
        if name is None:
5832
5343
            name = current_view
5894
5405
 
5895
5406
 
5896
5407
class cmd_hooks(Command):
5897
 
    __doc__ = """Show hooks."""
 
5408
    """Show hooks."""
5898
5409
 
5899
5410
    hidden = True
5900
5411
 
5913
5424
                    self.outf.write("    <no hooks installed>\n")
5914
5425
 
5915
5426
 
5916
 
class cmd_remove_branch(Command):
5917
 
    __doc__ = """Remove a branch.
5918
 
 
5919
 
    This will remove the branch from the specified location but 
5920
 
    will keep any working tree or repository in place.
5921
 
 
5922
 
    :Examples:
5923
 
 
5924
 
      Remove the branch at repo/trunk::
5925
 
 
5926
 
        bzr remove-branch repo/trunk
5927
 
 
5928
 
    """
5929
 
 
5930
 
    takes_args = ["location?"]
5931
 
 
5932
 
    aliases = ["rmbranch"]
5933
 
 
5934
 
    def run(self, location=None):
5935
 
        if location is None:
5936
 
            location = "."
5937
 
        branch = Branch.open_containing(location)[0]
5938
 
        branch.bzrdir.destroy_branch()
5939
 
 
5940
 
 
5941
5427
class cmd_shelve(Command):
5942
 
    __doc__ = """Temporarily set aside some changes from the current tree.
 
5428
    """Temporarily set aside some changes from the current tree.
5943
5429
 
5944
5430
    Shelve allows you to temporarily put changes you've made "on the shelf",
5945
5431
    ie. out of the way, until a later time when you can bring them back from
5961
5447
 
5962
5448
    You can put multiple items on the shelf, and by default, 'unshelve' will
5963
5449
    restore the most recently shelved changes.
5964
 
 
5965
 
    For complicated changes, it is possible to edit the changes in a separate
5966
 
    editor program to decide what the file remaining in the working copy
5967
 
    should look like.  To do this, add the configuration option
5968
 
 
5969
 
        change_editor = PROGRAM @new_path @old_path
5970
 
 
5971
 
    where @new_path is replaced with the path of the new version of the 
5972
 
    file and @old_path is replaced with the path of the old version of 
5973
 
    the file.  The PROGRAM should save the new file with the desired 
5974
 
    contents of the file in the working tree.
5975
 
        
5976
5450
    """
5977
5451
 
5978
5452
    takes_args = ['file*']
5979
5453
 
5980
5454
    takes_options = [
5981
 
        'directory',
5982
5455
        'revision',
5983
5456
        Option('all', help='Shelve all changes.'),
5984
5457
        'message',
5990
5463
        Option('destroy',
5991
5464
               help='Destroy removed changes instead of shelving them.'),
5992
5465
    ]
5993
 
    _see_also = ['unshelve', 'configuration']
 
5466
    _see_also = ['unshelve']
5994
5467
 
5995
5468
    def run(self, revision=None, all=False, file_list=None, message=None,
5996
 
            writer=None, list=False, destroy=False, directory=None):
 
5469
            writer=None, list=False, destroy=False):
5997
5470
        if list:
5998
 
            return self.run_for_list(directory=directory)
 
5471
            return self.run_for_list()
5999
5472
        from bzrlib.shelf_ui import Shelver
6000
5473
        if writer is None:
6001
5474
            writer = bzrlib.option.diff_writer_registry.get()
6002
5475
        try:
6003
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6004
 
                file_list, message, destroy=destroy, directory=directory)
6005
 
            try:
6006
 
                shelver.run()
6007
 
            finally:
6008
 
                shelver.finalize()
 
5476
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5477
                              message, destroy=destroy).run()
6009
5478
        except errors.UserAbort:
6010
5479
            return 0
6011
5480
 
6012
 
    def run_for_list(self, directory=None):
6013
 
        if directory is None:
6014
 
            directory = u'.'
6015
 
        tree = WorkingTree.open_containing(directory)[0]
6016
 
        self.add_cleanup(tree.lock_read().unlock)
6017
 
        manager = tree.get_shelf_manager()
6018
 
        shelves = manager.active_shelves()
6019
 
        if len(shelves) == 0:
6020
 
            note('No shelved changes.')
6021
 
            return 0
6022
 
        for shelf_id in reversed(shelves):
6023
 
            message = manager.get_metadata(shelf_id).get('message')
6024
 
            if message is None:
6025
 
                message = '<no message>'
6026
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
6027
 
        return 1
 
5481
    def run_for_list(self):
 
5482
        tree = WorkingTree.open_containing('.')[0]
 
5483
        tree.lock_read()
 
5484
        try:
 
5485
            manager = tree.get_shelf_manager()
 
5486
            shelves = manager.active_shelves()
 
5487
            if len(shelves) == 0:
 
5488
                note('No shelved changes.')
 
5489
                return 0
 
5490
            for shelf_id in reversed(shelves):
 
5491
                message = manager.get_metadata(shelf_id).get('message')
 
5492
                if message is None:
 
5493
                    message = '<no message>'
 
5494
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5495
            return 1
 
5496
        finally:
 
5497
            tree.unlock()
6028
5498
 
6029
5499
 
6030
5500
class cmd_unshelve(Command):
6031
 
    __doc__ = """Restore shelved changes.
 
5501
    """Restore shelved changes.
6032
5502
 
6033
5503
    By default, the most recently shelved changes are restored. However if you
6034
5504
    specify a shelf by id those changes will be restored instead.  This works
6037
5507
 
6038
5508
    takes_args = ['shelf_id?']
6039
5509
    takes_options = [
6040
 
        'directory',
6041
5510
        RegistryOption.from_kwargs(
6042
5511
            'action', help="The action to perform.",
6043
5512
            enum_switch=False, value_switches=True,
6044
5513
            apply="Apply changes and remove from the shelf.",
6045
5514
            dry_run="Show changes, but do not apply or remove them.",
6046
 
            preview="Instead of unshelving the changes, show the diff that "
6047
 
                    "would result from unshelving.",
6048
 
            delete_only="Delete changes without applying them.",
6049
 
            keep="Apply changes but don't delete them.",
 
5515
            delete_only="Delete changes without applying them."
6050
5516
        )
6051
5517
    ]
6052
5518
    _see_also = ['shelve']
6053
5519
 
6054
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
 
5520
    def run(self, shelf_id=None, action='apply'):
6055
5521
        from bzrlib.shelf_ui import Unshelver
6056
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6057
 
        try:
6058
 
            unshelver.run()
6059
 
        finally:
6060
 
            unshelver.tree.unlock()
 
5522
        Unshelver.from_args(shelf_id, action).run()
6061
5523
 
6062
5524
 
6063
5525
class cmd_clean_tree(Command):
6064
 
    __doc__ = """Remove unwanted files from working tree.
 
5526
    """Remove unwanted files from working tree.
6065
5527
 
6066
5528
    By default, only unknown files, not ignored files, are deleted.  Versioned
6067
5529
    files are never deleted.
6075
5537
 
6076
5538
    To check what clean-tree will do, use --dry-run.
6077
5539
    """
6078
 
    takes_options = ['directory',
6079
 
                     Option('ignored', help='Delete all ignored files.'),
 
5540
    takes_options = [Option('ignored', help='Delete all ignored files.'),
6080
5541
                     Option('detritus', help='Delete conflict files, merge'
6081
5542
                            ' backups, and failed selftest dirs.'),
6082
5543
                     Option('unknown',
6085
5546
                            ' deleting them.'),
6086
5547
                     Option('force', help='Do not prompt before deleting.')]
6087
5548
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6088
 
            force=False, directory=u'.'):
 
5549
            force=False):
6089
5550
        from bzrlib.clean_tree import clean_tree
6090
5551
        if not (unknown or ignored or detritus):
6091
5552
            unknown = True
6092
5553
        if dry_run:
6093
5554
            force = True
6094
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6095
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5555
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5556
                   dry_run=dry_run, no_prompt=force)
6096
5557
 
6097
5558
 
6098
5559
class cmd_reference(Command):
6099
 
    __doc__ = """list, view and set branch locations for nested trees.
 
5560
    """list, view and set branch locations for nested trees.
6100
5561
 
6101
5562
    If no arguments are provided, lists the branch locations for nested trees.
6102
5563
    If one argument is provided, display the branch location for that tree.
6142
5603
            self.outf.write('%s %s\n' % (path, location))
6143
5604
 
6144
5605
 
6145
 
def _register_lazy_builtins():
6146
 
    # register lazy builtins from other modules; called at startup and should
6147
 
    # be only called once.
6148
 
    for (name, aliases, module_name) in [
6149
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6150
 
        ('cmd_config', [], 'bzrlib.config'),
6151
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6152
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6153
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6154
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6155
 
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
6156
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6157
 
        ]:
6158
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
5606
# these get imported and then picked up by the scan for cmd_*
 
5607
# TODO: Some more consistent way to split command definitions across files;
 
5608
# we do need to load at least some information about them to know of
 
5609
# aliases.  ideally we would avoid loading the implementation until the
 
5610
# details were needed.
 
5611
from bzrlib.cmd_version_info import cmd_version_info
 
5612
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5613
from bzrlib.bundle.commands import (
 
5614
    cmd_bundle_info,
 
5615
    )
 
5616
from bzrlib.foreign import cmd_dpush
 
5617
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5618
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5619
        cmd_weave_plan_merge, cmd_weave_merge_text