← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2010-08-23 20:37:18 UTC
  • mto: This revision was merged to the branch mainline in revision 5389.
  • Revision ID: jelmer@samba.org-20100823203718-1fj7rrjsiaxedkp7
Provide bzrlib.bzrdir.format_registry.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 Canonical Ltd
 
1
# Copyright (C) 2005-2010 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
24
23
import cStringIO
25
24
import sys
26
25
import time
31
30
    bundle,
32
31
    btree_index,
33
32
    bzrdir,
 
33
    directory_service,
34
34
    delta,
35
35
    config,
36
36
    errors,
43
43
    reconfigure,
44
44
    rename_map,
45
45
    revision as _mod_revision,
 
46
    static_tuple,
46
47
    symbol_versioning,
 
48
    timestamp,
47
49
    transport,
48
 
    tree as _mod_tree,
49
50
    ui,
50
51
    urlutils,
51
52
    views,
52
53
    )
53
54
from bzrlib.branch import Branch
54
55
from bzrlib.conflicts import ConflictList
 
56
from bzrlib.transport import memory
55
57
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
56
58
from bzrlib.smtp_connection import SMTPConnection
57
59
from bzrlib.workingtree import WorkingTree
58
60
""")
59
61
 
60
 
from bzrlib.commands import Command, display_command
 
62
from bzrlib.commands import (
 
63
    Command,
 
64
    builtin_command_registry,
 
65
    display_command,
 
66
    )
61
67
from bzrlib.option import (
62
68
    ListOption,
63
69
    Option,
68
74
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
69
75
 
70
76
 
 
77
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
71
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
72
79
    apply_view=True):
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]))
 
80
    return internal_tree_files(file_list, default_branch, canonicalize,
 
81
        apply_view)
79
82
 
80
83
 
81
84
def tree_files_for_add(file_list):
82
 
    """Add handles files a bit differently so it a custom implementation."""
 
85
    """
 
86
    Return a tree and list of absolute paths from a file list.
 
87
 
 
88
    Similar to tree_files, but add handles files a bit differently, so it a
 
89
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
90
    absolute paths, which it immediately converts to relative paths.
 
91
    """
 
92
    # FIXME Would be nice to just return the relative paths like
 
93
    # internal_tree_files does, but there are a large number of unit tests
 
94
    # that assume the current interface to mutabletree.smart_add
83
95
    if file_list:
84
 
        tree = WorkingTree.open_containing(file_list[0])[0]
 
96
        tree, relpath = WorkingTree.open_containing(file_list[0])
85
97
        if tree.supports_views():
86
98
            view_files = tree.views.lookup_view()
87
99
            if view_files:
88
100
                for filename in file_list:
89
101
                    if not osutils.is_inside_any(view_files, filename):
90
102
                        raise errors.FileOutsideView(filename, view_files)
 
103
        file_list = file_list[:]
 
104
        file_list[0] = tree.abspath(relpath)
91
105
    else:
92
106
        tree = WorkingTree.open_containing(u'.')[0]
93
107
        if tree.supports_views():
95
109
            if view_files:
96
110
                file_list = view_files
97
111
                view_str = views.view_display_str(view_files)
98
 
                note("ignoring files outside view: %s" % view_str)
 
112
                note("Ignoring files outside view. View is %s" % view_str)
99
113
    return tree, file_list
100
114
 
101
115
 
110
124
 
111
125
 
112
126
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
127
    """Get a revision tree. Not suitable for commands that change the tree.
 
128
    
 
129
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
130
    and doing a commit/uncommit/pull will at best fail due to changing the
 
131
    basis revision data.
 
132
 
 
133
    If tree is passed in, it should be already locked, for lifetime management
 
134
    of the trees internal cached state.
 
135
    """
113
136
    if branch is None:
114
137
        branch = tree.branch
115
138
    if revisions is None:
125
148
 
126
149
# XXX: Bad function name; should possibly also be a class method of
127
150
# WorkingTree rather than a function.
 
151
@symbol_versioning.deprecated_function(symbol_versioning.deprecated_in((2, 3, 0)))
128
152
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
129
153
    apply_view=True):
130
154
    """Convert command-line paths to a WorkingTree and relative paths.
131
155
 
 
156
    Deprecated: use WorkingTree.open_containing_paths instead.
 
157
 
132
158
    This is typically used for command-line processors that take one or
133
159
    more filenames, and infer the workingtree that contains them.
134
160
 
144
170
 
145
171
    :return: workingtree, [relative_paths]
146
172
    """
147
 
    if file_list is None or len(file_list) == 0:
148
 
        tree = WorkingTree.open_containing(default_branch)[0]
149
 
        if tree.supports_views() and apply_view:
150
 
            view_files = tree.views.lookup_view()
151
 
            if view_files:
152
 
                file_list = view_files
153
 
                view_str = views.view_display_str(view_files)
154
 
                note("ignoring files outside view: %s" % view_str)
155
 
        return tree, file_list
156
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
157
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
158
 
        apply_view=apply_view)
159
 
 
160
 
 
161
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
162
 
    """Convert file_list into a list of relpaths in tree.
163
 
 
164
 
    :param tree: A tree to operate on.
165
 
    :param file_list: A list of user provided paths or None.
166
 
    :param apply_view: if True and a view is set, apply it or check that
167
 
        specified files are within it
168
 
    :return: A list of relative paths.
169
 
    :raises errors.PathNotChild: When a provided path is in a different tree
170
 
        than tree.
171
 
    """
172
 
    if file_list is None:
173
 
        return None
174
 
    if tree.supports_views() and apply_view:
175
 
        view_files = tree.views.lookup_view()
176
 
    else:
177
 
        view_files = []
178
 
    new_list = []
179
 
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
180
 
    # doesn't - fix that up here before we enter the loop.
181
 
    if canonicalize:
182
 
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
183
 
    else:
184
 
        fixer = tree.relpath
185
 
    for filename in file_list:
186
 
        try:
187
 
            relpath = fixer(osutils.dereference_path(filename))
188
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
189
 
                raise errors.FileOutsideView(filename, view_files)
190
 
            new_list.append(relpath)
191
 
        except errors.PathNotChild:
192
 
            raise errors.FileInWrongBranch(tree.branch, filename)
193
 
    return new_list
 
173
    return WorkingTree.open_containing_paths(
 
174
        file_list, default_directory='.',
 
175
        canonicalize=True,
 
176
        apply_view=True)
194
177
 
195
178
 
196
179
def _get_view_info_for_change_reporter(tree):
205
188
    return view_info
206
189
 
207
190
 
 
191
def _open_directory_or_containing_tree_or_branch(filename, directory):
 
192
    """Open the tree or branch containing the specified file, unless
 
193
    the --directory option is used to specify a different branch."""
 
194
    if directory is not None:
 
195
        return (None, Branch.open(directory), filename)
 
196
    return bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
197
 
 
198
 
208
199
# TODO: Make sure no commands unconditionally use the working directory as a
209
200
# branch.  If a filename argument is used, the first of them should be used to
210
201
# specify the branch.  (Perhaps this can be factored out into some kind of
212
203
# opens the branch?)
213
204
 
214
205
class cmd_status(Command):
215
 
    """Display status summary.
 
206
    __doc__ = """Display status summary.
216
207
 
217
208
    This reports on versioned and unknown files, reporting them
218
209
    grouped by state.  Possible states are:
238
229
    unknown
239
230
        Not versioned and not matching an ignore pattern.
240
231
 
 
232
    Additionally for directories, symlinks and files with an executable
 
233
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
234
    or '*' respectively.
 
235
 
241
236
    To see ignored files use 'bzr ignored'.  For details on the
242
237
    changes to file texts, use 'bzr diff'.
243
238
 
284
279
            raise errors.BzrCommandError('bzr status --revision takes exactly'
285
280
                                         ' one or two revision specifiers')
286
281
 
287
 
        tree, relfile_list = tree_files(file_list)
 
282
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
288
283
        # Avoid asking for specific files when that is not needed.
289
284
        if relfile_list == ['']:
290
285
            relfile_list = None
301
296
 
302
297
 
303
298
class cmd_cat_revision(Command):
304
 
    """Write out metadata for a revision.
 
299
    __doc__ = """Write out metadata for a revision.
305
300
 
306
301
    The revision to print can either be specified by a specific
307
302
    revision identifier, or you can use --revision.
309
304
 
310
305
    hidden = True
311
306
    takes_args = ['revision_id?']
312
 
    takes_options = ['revision']
 
307
    takes_options = ['directory', 'revision']
313
308
    # cat-revision is more for frontends so should be exact
314
309
    encoding = 'strict'
315
310
 
 
311
    def print_revision(self, revisions, revid):
 
312
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
313
        record = stream.next()
 
314
        if record.storage_kind == 'absent':
 
315
            raise errors.NoSuchRevision(revisions, revid)
 
316
        revtext = record.get_bytes_as('fulltext')
 
317
        self.outf.write(revtext.decode('utf-8'))
 
318
 
316
319
    @display_command
317
 
    def run(self, revision_id=None, revision=None):
 
320
    def run(self, revision_id=None, revision=None, directory=u'.'):
318
321
        if revision_id is not None and revision is not None:
319
322
            raise errors.BzrCommandError('You can only supply one of'
320
323
                                         ' revision_id or --revision')
321
324
        if revision_id is None and revision is None:
322
325
            raise errors.BzrCommandError('You must supply either'
323
326
                                         ' --revision or a revision_id')
324
 
        b = WorkingTree.open_containing(u'.')[0].branch
325
 
 
326
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
327
 
        if revision_id is not None:
328
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
329
 
            try:
330
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
331
 
            except errors.NoSuchRevision:
332
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
333
 
                    revision_id)
334
 
                raise errors.BzrCommandError(msg)
335
 
        elif revision is not None:
336
 
            for rev in revision:
337
 
                if rev is None:
338
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
339
 
                                                 ' revision.')
340
 
                rev_id = rev.as_revision_id(b)
341
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
342
 
 
 
327
        b = WorkingTree.open_containing(directory)[0].branch
 
328
 
 
329
        revisions = b.repository.revisions
 
330
        if revisions is None:
 
331
            raise errors.BzrCommandError('Repository %r does not support '
 
332
                'access to raw revision texts')
 
333
 
 
334
        b.repository.lock_read()
 
335
        try:
 
336
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
337
            if revision_id is not None:
 
338
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
339
                try:
 
340
                    self.print_revision(revisions, revision_id)
 
341
                except errors.NoSuchRevision:
 
342
                    msg = "The repository %s contains no revision %s." % (
 
343
                        b.repository.base, revision_id)
 
344
                    raise errors.BzrCommandError(msg)
 
345
            elif revision is not None:
 
346
                for rev in revision:
 
347
                    if rev is None:
 
348
                        raise errors.BzrCommandError(
 
349
                            'You cannot specify a NULL revision.')
 
350
                    rev_id = rev.as_revision_id(b)
 
351
                    self.print_revision(revisions, rev_id)
 
352
        finally:
 
353
            b.repository.unlock()
 
354
        
343
355
 
344
356
class cmd_dump_btree(Command):
345
 
    """Dump the contents of a btree index file to stdout.
 
357
    __doc__ = """Dump the contents of a btree index file to stdout.
346
358
 
347
359
    PATH is a btree index file, it can be any URL. This includes things like
348
360
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
412
424
        for node in bt.iter_all_entries():
413
425
            # Node is made up of:
414
426
            # (index, key, value, [references])
415
 
            self.outf.write('%s\n' % (node[1:],))
 
427
            try:
 
428
                refs = node[3]
 
429
            except IndexError:
 
430
                refs_as_tuples = None
 
431
            else:
 
432
                refs_as_tuples = static_tuple.as_tuples(refs)
 
433
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
 
434
            self.outf.write('%s\n' % (as_tuple,))
416
435
 
417
436
 
418
437
class cmd_remove_tree(Command):
419
 
    """Remove the working tree from a given branch/checkout.
 
438
    __doc__ = """Remove the working tree from a given branch/checkout.
420
439
 
421
440
    Since a lightweight checkout is little more than a working tree
422
441
    this will refuse to run against one.
424
443
    To re-create the working tree, use "bzr checkout".
425
444
    """
426
445
    _see_also = ['checkout', 'working-trees']
427
 
    takes_args = ['location?']
 
446
    takes_args = ['location*']
428
447
    takes_options = [
429
448
        Option('force',
430
449
               help='Remove the working tree even if it has '
431
 
                    'uncommitted changes.'),
 
450
                    'uncommitted or shelved changes.'),
432
451
        ]
433
452
 
434
 
    def run(self, location='.', force=False):
435
 
        d = bzrdir.BzrDir.open(location)
436
 
 
437
 
        try:
438
 
            working = d.open_workingtree()
439
 
        except errors.NoWorkingTree:
440
 
            raise errors.BzrCommandError("No working tree to remove")
441
 
        except errors.NotLocalUrl:
442
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
443
 
                                         "remote path")
444
 
        if not force:
445
 
            changes = working.changes_from(working.basis_tree())
446
 
            if changes.has_changed():
447
 
                raise errors.UncommittedChanges(working)
448
 
 
449
 
        working_path = working.bzrdir.root_transport.base
450
 
        branch_path = working.branch.bzrdir.root_transport.base
451
 
        if working_path != branch_path:
452
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
453
 
                                         "a lightweight checkout")
454
 
 
455
 
        d.destroy_workingtree()
 
453
    def run(self, location_list, force=False):
 
454
        if not location_list:
 
455
            location_list=['.']
 
456
 
 
457
        for location in location_list:
 
458
            d = bzrdir.BzrDir.open(location)
 
459
            
 
460
            try:
 
461
                working = d.open_workingtree()
 
462
            except errors.NoWorkingTree:
 
463
                raise errors.BzrCommandError("No working tree to remove")
 
464
            except errors.NotLocalUrl:
 
465
                raise errors.BzrCommandError("You cannot remove the working tree"
 
466
                                             " of a remote path")
 
467
            if not force:
 
468
                if (working.has_changes()):
 
469
                    raise errors.UncommittedChanges(working)
 
470
                if working.get_shelf_manager().last_shelf() is not None:
 
471
                    raise errors.ShelvedChanges(working)
 
472
 
 
473
            if working.user_url != working.branch.user_url:
 
474
                raise errors.BzrCommandError("You cannot remove the working tree"
 
475
                                             " from a lightweight checkout")
 
476
 
 
477
            d.destroy_workingtree()
456
478
 
457
479
 
458
480
class cmd_revno(Command):
459
 
    """Show current revision number.
 
481
    __doc__ = """Show current revision number.
460
482
 
461
483
    This is equal to the number of revisions on this branch.
462
484
    """
463
485
 
464
486
    _see_also = ['info']
465
487
    takes_args = ['location?']
 
488
    takes_options = [
 
489
        Option('tree', help='Show revno of working tree'),
 
490
        ]
466
491
 
467
492
    @display_command
468
 
    def run(self, location=u'.'):
469
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
470
 
        self.outf.write('\n')
 
493
    def run(self, tree=False, location=u'.'):
 
494
        if tree:
 
495
            try:
 
496
                wt = WorkingTree.open_containing(location)[0]
 
497
                self.add_cleanup(wt.lock_read().unlock)
 
498
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
499
                raise errors.NoWorkingTree(location)
 
500
            revid = wt.last_revision()
 
501
            try:
 
502
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
503
            except errors.NoSuchRevision:
 
504
                revno_t = ('???',)
 
505
            revno = ".".join(str(n) for n in revno_t)
 
506
        else:
 
507
            b = Branch.open_containing(location)[0]
 
508
            self.add_cleanup(b.lock_read().unlock)
 
509
            revno = b.revno()
 
510
        self.cleanup_now()
 
511
        self.outf.write(str(revno) + '\n')
471
512
 
472
513
 
473
514
class cmd_revision_info(Command):
474
 
    """Show revision number and revision id for a given revision identifier.
 
515
    __doc__ = """Show revision number and revision id for a given revision identifier.
475
516
    """
476
517
    hidden = True
477
518
    takes_args = ['revision_info*']
478
519
    takes_options = [
479
520
        'revision',
480
 
        Option('directory',
 
521
        custom_help('directory',
481
522
            help='Branch to examine, '
482
 
                 'rather than the one containing the working directory.',
483
 
            short_name='d',
484
 
            type=unicode,
485
 
            ),
 
523
                 'rather than the one containing the working directory.'),
 
524
        Option('tree', help='Show revno of working tree'),
486
525
        ]
487
526
 
488
527
    @display_command
489
 
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
528
    def run(self, revision=None, directory=u'.', tree=False,
 
529
            revision_info_list=[]):
490
530
 
491
 
        revs = []
 
531
        try:
 
532
            wt = WorkingTree.open_containing(directory)[0]
 
533
            b = wt.branch
 
534
            self.add_cleanup(wt.lock_read().unlock)
 
535
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
536
            wt = None
 
537
            b = Branch.open_containing(directory)[0]
 
538
            self.add_cleanup(b.lock_read().unlock)
 
539
        revision_ids = []
492
540
        if revision is not None:
493
 
            revs.extend(revision)
 
541
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
494
542
        if revision_info_list is not None:
495
 
            for rev in revision_info_list:
496
 
                revs.append(RevisionSpec.from_string(rev))
497
 
 
498
 
        b = Branch.open_containing(directory)[0]
499
 
 
500
 
        if len(revs) == 0:
501
 
            revs.append(RevisionSpec.from_string('-1'))
502
 
 
503
 
        for rev in revs:
504
 
            revision_id = rev.as_revision_id(b)
 
543
            for rev_str in revision_info_list:
 
544
                rev_spec = RevisionSpec.from_string(rev_str)
 
545
                revision_ids.append(rev_spec.as_revision_id(b))
 
546
        # No arguments supplied, default to the last revision
 
547
        if len(revision_ids) == 0:
 
548
            if tree:
 
549
                if wt is None:
 
550
                    raise errors.NoWorkingTree(directory)
 
551
                revision_ids.append(wt.last_revision())
 
552
            else:
 
553
                revision_ids.append(b.last_revision())
 
554
 
 
555
        revinfos = []
 
556
        maxlen = 0
 
557
        for revision_id in revision_ids:
505
558
            try:
506
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
559
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
560
                revno = '.'.join(str(i) for i in dotted_revno)
507
561
            except errors.NoSuchRevision:
508
 
                dotted_map = b.get_revision_id_to_revno_map()
509
 
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
510
 
            print '%s %s' % (revno, revision_id)
 
562
                revno = '???'
 
563
            maxlen = max(maxlen, len(revno))
 
564
            revinfos.append([revno, revision_id])
 
565
 
 
566
        self.cleanup_now()
 
567
        for ri in revinfos:
 
568
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
511
569
 
512
570
 
513
571
class cmd_add(Command):
514
 
    """Add specified files or directories.
 
572
    __doc__ = """Add specified files or directories.
515
573
 
516
574
    In non-recursive mode, all the named items are added, regardless
517
575
    of whether they were previously ignored.  A warning is given if
543
601
    branches that will be merged later (without showing the two different
544
602
    adds as a conflict). It is also useful when merging another project
545
603
    into a subdirectory of this one.
 
604
    
 
605
    Any files matching patterns in the ignore list will not be added
 
606
    unless they are explicitly mentioned.
546
607
    """
547
608
    takes_args = ['file*']
548
609
    takes_options = [
556
617
               help='Lookup file ids from this tree.'),
557
618
        ]
558
619
    encoding_type = 'replace'
559
 
    _see_also = ['remove']
 
620
    _see_also = ['remove', 'ignore']
560
621
 
561
622
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
562
623
            file_ids_from=None):
579
640
                should_print=(not is_quiet()))
580
641
 
581
642
        if base_tree:
582
 
            base_tree.lock_read()
583
 
        try:
584
 
            file_list = self._maybe_expand_globs(file_list)
585
 
            tree, file_list = tree_files_for_add(file_list)
586
 
            added, ignored = tree.smart_add(file_list, not
587
 
                no_recurse, action=action, save=not dry_run)
588
 
        finally:
589
 
            if base_tree is not None:
590
 
                base_tree.unlock()
 
643
            self.add_cleanup(base_tree.lock_read().unlock)
 
644
        tree, file_list = tree_files_for_add(file_list)
 
645
        added, ignored = tree.smart_add(file_list, not
 
646
            no_recurse, action=action, save=not dry_run)
 
647
        self.cleanup_now()
591
648
        if len(ignored) > 0:
592
649
            if verbose:
593
650
                for glob in sorted(ignored.keys()):
594
651
                    for path in ignored[glob]:
595
652
                        self.outf.write("ignored %s matching \"%s\"\n"
596
653
                                        % (path, glob))
597
 
            else:
598
 
                match_len = 0
599
 
                for glob, paths in ignored.items():
600
 
                    match_len += len(paths)
601
 
                self.outf.write("ignored %d file(s).\n" % match_len)
602
 
            self.outf.write("If you wish to add some of these files,"
603
 
                            " please add them by name.\n")
604
654
 
605
655
 
606
656
class cmd_mkdir(Command):
607
 
    """Create a new versioned directory.
 
657
    __doc__ = """Create a new versioned directory.
608
658
 
609
659
    This is equivalent to creating the directory and then adding it.
610
660
    """
614
664
 
615
665
    def run(self, dir_list):
616
666
        for d in dir_list:
617
 
            os.mkdir(d)
618
667
            wt, dd = WorkingTree.open_containing(d)
619
 
            wt.add([dd])
620
 
            self.outf.write('added %s\n' % d)
 
668
            base = os.path.dirname(dd)
 
669
            id = wt.path2id(base)
 
670
            if id != None:
 
671
                os.mkdir(d)
 
672
                wt.add([dd])
 
673
                self.outf.write('added %s\n' % d)
 
674
            else:
 
675
                raise errors.NotVersionedError(path=base)
621
676
 
622
677
 
623
678
class cmd_relpath(Command):
624
 
    """Show path of a file relative to root"""
 
679
    __doc__ = """Show path of a file relative to root"""
625
680
 
626
681
    takes_args = ['filename']
627
682
    hidden = True
636
691
 
637
692
 
638
693
class cmd_inventory(Command):
639
 
    """Show inventory of the current working copy or a revision.
 
694
    __doc__ = """Show inventory of the current working copy or a revision.
640
695
 
641
696
    It is possible to limit the output to a particular entry
642
697
    type using the --kind option.  For example: --kind file.
662
717
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
663
718
 
664
719
        revision = _get_one_revision('inventory', revision)
665
 
        work_tree, file_list = tree_files(file_list)
666
 
        work_tree.lock_read()
667
 
        try:
668
 
            if revision is not None:
669
 
                tree = revision.as_tree(work_tree.branch)
670
 
 
671
 
                extra_trees = [work_tree]
672
 
                tree.lock_read()
673
 
            else:
674
 
                tree = work_tree
675
 
                extra_trees = []
676
 
 
677
 
            if file_list is not None:
678
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
679
 
                                          require_versioned=True)
680
 
                # find_ids_across_trees may include some paths that don't
681
 
                # exist in 'tree'.
682
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
683
 
                                 for file_id in file_ids if file_id in tree)
684
 
            else:
685
 
                entries = tree.inventory.entries()
686
 
        finally:
687
 
            tree.unlock()
688
 
            if tree is not work_tree:
689
 
                work_tree.unlock()
690
 
 
 
720
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
721
        self.add_cleanup(work_tree.lock_read().unlock)
 
722
        if revision is not None:
 
723
            tree = revision.as_tree(work_tree.branch)
 
724
 
 
725
            extra_trees = [work_tree]
 
726
            self.add_cleanup(tree.lock_read().unlock)
 
727
        else:
 
728
            tree = work_tree
 
729
            extra_trees = []
 
730
 
 
731
        if file_list is not None:
 
732
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
733
                                      require_versioned=True)
 
734
            # find_ids_across_trees may include some paths that don't
 
735
            # exist in 'tree'.
 
736
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
737
                             for file_id in file_ids if file_id in tree)
 
738
        else:
 
739
            entries = tree.inventory.entries()
 
740
 
 
741
        self.cleanup_now()
691
742
        for path, entry in entries:
692
743
            if kind and kind != entry.kind:
693
744
                continue
699
750
 
700
751
 
701
752
class cmd_mv(Command):
702
 
    """Move or rename a file.
 
753
    __doc__ = """Move or rename a file.
703
754
 
704
755
    :Usage:
705
756
        bzr mv OLDNAME NEWNAME
722
773
    takes_args = ['names*']
723
774
    takes_options = [Option("after", help="Move only the bzr identifier"
724
775
        " of the file, because the file has already been moved."),
 
776
        Option('auto', help='Automatically guess renames.'),
 
777
        Option('dry-run', help='Avoid making changes when guessing renames.'),
725
778
        ]
726
779
    aliases = ['move', 'rename']
727
780
    encoding_type = 'replace'
728
781
 
729
 
    def run(self, names_list, after=False):
 
782
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
783
        if auto:
 
784
            return self.run_auto(names_list, after, dry_run)
 
785
        elif dry_run:
 
786
            raise errors.BzrCommandError('--dry-run requires --auto.')
730
787
        if names_list is None:
731
788
            names_list = []
732
 
 
733
789
        if len(names_list) < 2:
734
790
            raise errors.BzrCommandError("missing file argument")
735
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
736
 
        tree.lock_write()
737
 
        try:
738
 
            self._run(tree, names_list, rel_names, after)
739
 
        finally:
740
 
            tree.unlock()
 
791
        tree, rel_names = WorkingTree.open_containing_paths(names_list, canonicalize=False)
 
792
        self.add_cleanup(tree.lock_tree_write().unlock)
 
793
        self._run(tree, names_list, rel_names, after)
 
794
 
 
795
    def run_auto(self, names_list, after, dry_run):
 
796
        if names_list is not None and len(names_list) > 1:
 
797
            raise errors.BzrCommandError('Only one path may be specified to'
 
798
                                         ' --auto.')
 
799
        if after:
 
800
            raise errors.BzrCommandError('--after cannot be specified with'
 
801
                                         ' --auto.')
 
802
        work_tree, file_list = WorkingTree.open_containing_paths(
 
803
            names_list, default_directory='.')
 
804
        self.add_cleanup(work_tree.lock_tree_write().unlock)
 
805
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
741
806
 
742
807
    def _run(self, tree, names_list, rel_names, after):
743
808
        into_existing = osutils.isdir(names_list[-1])
764
829
            # All entries reference existing inventory items, so fix them up
765
830
            # for cicp file-systems.
766
831
            rel_names = tree.get_canonical_inventory_paths(rel_names)
767
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
768
 
                self.outf.write("%s => %s\n" % pair)
 
832
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
833
                if not is_quiet():
 
834
                    self.outf.write("%s => %s\n" % (src, dest))
769
835
        else:
770
836
            if len(names_list) != 2:
771
837
                raise errors.BzrCommandError('to mv multiple files the'
815
881
            dest = osutils.pathjoin(dest_parent, dest_tail)
816
882
            mutter("attempting to move %s => %s", src, dest)
817
883
            tree.rename_one(src, dest, after=after)
818
 
            self.outf.write("%s => %s\n" % (src, dest))
 
884
            if not is_quiet():
 
885
                self.outf.write("%s => %s\n" % (src, dest))
819
886
 
820
887
 
821
888
class cmd_pull(Command):
822
 
    """Turn this branch into a mirror of another branch.
 
889
    __doc__ = """Turn this branch into a mirror of another branch.
823
890
 
824
 
    This command only works on branches that have not diverged.  Branches are
825
 
    considered diverged if the destination branch's most recent commit is one
826
 
    that has not been merged (directly or indirectly) into the parent.
 
891
    By default, this command only works on branches that have not diverged.
 
892
    Branches are considered diverged if the destination branch's most recent 
 
893
    commit is one that has not been merged (directly or indirectly) into the 
 
894
    parent.
827
895
 
828
896
    If branches have diverged, you can use 'bzr merge' to integrate the changes
829
897
    from one into the other.  Once one branch has merged, the other should
830
898
    be able to pull it again.
831
899
 
832
 
    If you want to forget your local changes and just update your branch to
833
 
    match the remote one, use pull --overwrite.
 
900
    If you want to replace your local changes and just want your branch to
 
901
    match the remote one, use pull --overwrite. This will work even if the two
 
902
    branches have diverged.
834
903
 
835
904
    If there is no default location set, the first pull will set it.  After
836
905
    that, you can omit the location to use the default.  To change the
846
915
    takes_options = ['remember', 'overwrite', 'revision',
847
916
        custom_help('verbose',
848
917
            help='Show logs of pulled revisions.'),
849
 
        Option('directory',
 
918
        custom_help('directory',
850
919
            help='Branch to pull into, '
851
 
                 'rather than the one containing the working directory.',
852
 
            short_name='d',
853
 
            type=unicode,
 
920
                 'rather than the one containing the working directory.'),
 
921
        Option('local',
 
922
            help="Perform a local pull in a bound "
 
923
                 "branch.  Local pulls are not applied to "
 
924
                 "the master branch."
854
925
            ),
855
926
        ]
856
927
    takes_args = ['location?']
858
929
 
859
930
    def run(self, location=None, remember=False, overwrite=False,
860
931
            revision=None, verbose=False,
861
 
            directory=None):
 
932
            directory=None, local=False):
862
933
        # FIXME: too much stuff is in the command class
863
934
        revision_id = None
864
935
        mergeable = None
867
938
        try:
868
939
            tree_to = WorkingTree.open_containing(directory)[0]
869
940
            branch_to = tree_to.branch
 
941
            self.add_cleanup(tree_to.lock_write().unlock)
870
942
        except errors.NoWorkingTree:
871
943
            tree_to = None
872
944
            branch_to = Branch.open_containing(directory)[0]
 
945
            self.add_cleanup(branch_to.lock_write().unlock)
 
946
 
 
947
        if local and not branch_to.get_bound_location():
 
948
            raise errors.LocalRequiresBoundBranch()
873
949
 
874
950
        possible_transports = []
875
951
        if location is not None:
903
979
        else:
904
980
            branch_from = Branch.open(location,
905
981
                possible_transports=possible_transports)
 
982
            self.add_cleanup(branch_from.lock_read().unlock)
906
983
 
907
984
            if branch_to.get_parent() is None or remember:
908
985
                branch_to.set_parent(branch_from.base)
910
987
        if revision is not None:
911
988
            revision_id = revision.as_revision_id(branch_from)
912
989
 
913
 
        branch_to.lock_write()
914
 
        try:
915
 
            if tree_to is not None:
916
 
                view_info = _get_view_info_for_change_reporter(tree_to)
917
 
                change_reporter = delta._ChangeReporter(
918
 
                    unversioned_filter=tree_to.is_ignored, view_info=view_info)
919
 
                result = tree_to.pull(branch_from, overwrite, revision_id,
920
 
                                      change_reporter,
921
 
                                      possible_transports=possible_transports)
922
 
            else:
923
 
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
990
        if tree_to is not None:
 
991
            view_info = _get_view_info_for_change_reporter(tree_to)
 
992
            change_reporter = delta._ChangeReporter(
 
993
                unversioned_filter=tree_to.is_ignored,
 
994
                view_info=view_info)
 
995
            result = tree_to.pull(
 
996
                branch_from, overwrite, revision_id, change_reporter,
 
997
                possible_transports=possible_transports, local=local)
 
998
        else:
 
999
            result = branch_to.pull(
 
1000
                branch_from, overwrite, revision_id, local=local)
924
1001
 
925
 
            result.report(self.outf)
926
 
            if verbose and result.old_revid != result.new_revid:
927
 
                log.show_branch_change(branch_to, self.outf, result.old_revno,
928
 
                                       result.old_revid)
929
 
        finally:
930
 
            branch_to.unlock()
 
1002
        result.report(self.outf)
 
1003
        if verbose and result.old_revid != result.new_revid:
 
1004
            log.show_branch_change(
 
1005
                branch_to, self.outf, result.old_revno,
 
1006
                result.old_revid)
931
1007
 
932
1008
 
933
1009
class cmd_push(Command):
934
 
    """Update a mirror of this branch.
 
1010
    __doc__ = """Update a mirror of this branch.
935
1011
 
936
1012
    The target branch will not have its working tree populated because this
937
1013
    is both expensive, and is not supported on remote file systems.
961
1037
        Option('create-prefix',
962
1038
               help='Create the path leading up to the branch '
963
1039
                    'if it does not already exist.'),
964
 
        Option('directory',
 
1040
        custom_help('directory',
965
1041
            help='Branch to push from, '
966
 
                 'rather than the one containing the working directory.',
967
 
            short_name='d',
968
 
            type=unicode,
969
 
            ),
 
1042
                 'rather than the one containing the working directory.'),
970
1043
        Option('use-existing-dir',
971
1044
               help='By default push will fail if the target'
972
1045
                    ' directory exists, but does not already'
980
1053
                'for the commit history. Only the work not present in the '
981
1054
                'referenced branch is included in the branch created.',
982
1055
            type=unicode),
 
1056
        Option('strict',
 
1057
               help='Refuse to push if there are uncommitted changes in'
 
1058
               ' the working tree, --no-strict disables the check.'),
983
1059
        ]
984
1060
    takes_args = ['location?']
985
1061
    encoding_type = 'replace'
987
1063
    def run(self, location=None, remember=False, overwrite=False,
988
1064
        create_prefix=False, verbose=False, revision=None,
989
1065
        use_existing_dir=False, directory=None, stacked_on=None,
990
 
        stacked=False):
 
1066
        stacked=False, strict=None):
991
1067
        from bzrlib.push import _show_push_branch
992
1068
 
993
 
        # Get the source branch and revision_id
994
1069
        if directory is None:
995
1070
            directory = '.'
996
 
        br_from = Branch.open_containing(directory)[0]
 
1071
        # Get the source branch
 
1072
        (tree, br_from,
 
1073
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1074
        # Get the tip's revision_id
997
1075
        revision = _get_one_revision('push', revision)
998
1076
        if revision is not None:
999
1077
            revision_id = revision.in_history(br_from).rev_id
1000
1078
        else:
1001
 
            revision_id = br_from.last_revision()
1002
 
 
 
1079
            revision_id = None
 
1080
        if tree is not None and revision_id is None:
 
1081
            tree.check_changed_or_out_of_date(
 
1082
                strict, 'push_strict',
 
1083
                more_error='Use --no-strict to force the push.',
 
1084
                more_warning='Uncommitted changes will not be pushed.')
1003
1085
        # Get the stacked_on branch, if any
1004
1086
        if stacked_on is not None:
1005
1087
            stacked_on = urlutils.normalize_url(stacked_on)
1037
1119
 
1038
1120
 
1039
1121
class cmd_branch(Command):
1040
 
    """Create a new copy of a branch.
 
1122
    __doc__ = """Create a new branch that is a copy of an existing branch.
1041
1123
 
1042
1124
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1043
1125
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1052
1134
 
1053
1135
    _see_also = ['checkout']
1054
1136
    takes_args = ['from_location', 'to_location?']
1055
 
    takes_options = ['revision', Option('hardlink',
1056
 
        help='Hard-link working tree files where possible.'),
 
1137
    takes_options = ['revision',
 
1138
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1139
        Option('files-from', type=str,
 
1140
               help="Get file contents from this tree."),
1057
1141
        Option('no-tree',
1058
1142
            help="Create a branch without a working-tree."),
 
1143
        Option('switch',
 
1144
            help="Switch the checkout in the current directory "
 
1145
                 "to the new branch."),
1059
1146
        Option('stacked',
1060
1147
            help='Create a stacked branch referring to the source branch. '
1061
1148
                'The new branch will depend on the availability of the source '
1062
1149
                'branch for all operations.'),
1063
1150
        Option('standalone',
1064
1151
               help='Do not use a shared repository, even if available.'),
 
1152
        Option('use-existing-dir',
 
1153
               help='By default branch will fail if the target'
 
1154
                    ' directory exists, but does not already'
 
1155
                    ' have a control directory.  This flag will'
 
1156
                    ' allow branch to proceed.'),
 
1157
        Option('bind',
 
1158
            help="Bind new branch to from location."),
1065
1159
        ]
1066
1160
    aliases = ['get', 'clone']
1067
1161
 
1068
1162
    def run(self, from_location, to_location=None, revision=None,
1069
 
            hardlink=False, stacked=False, standalone=False, no_tree=False):
 
1163
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1164
            use_existing_dir=False, switch=False, bind=False,
 
1165
            files_from=None):
 
1166
        from bzrlib import switch as _mod_switch
1070
1167
        from bzrlib.tag import _merge_tags_if_possible
1071
 
 
1072
1168
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1073
1169
            from_location)
 
1170
        if not (hardlink or files_from):
 
1171
            # accelerator_tree is usually slower because you have to read N
 
1172
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1173
            # explicitly request it
 
1174
            accelerator_tree = None
 
1175
        if files_from is not None and files_from != from_location:
 
1176
            accelerator_tree = WorkingTree.open(files_from)
1074
1177
        revision = _get_one_revision('branch', revision)
1075
 
        br_from.lock_read()
 
1178
        self.add_cleanup(br_from.lock_read().unlock)
 
1179
        if revision is not None:
 
1180
            revision_id = revision.as_revision_id(br_from)
 
1181
        else:
 
1182
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1183
            # None or perhaps NULL_REVISION to mean copy nothing
 
1184
            # RBC 20060209
 
1185
            revision_id = br_from.last_revision()
 
1186
        if to_location is None:
 
1187
            to_location = urlutils.derive_to_location(from_location)
 
1188
        to_transport = transport.get_transport(to_location)
1076
1189
        try:
1077
 
            if revision is not None:
1078
 
                revision_id = revision.as_revision_id(br_from)
 
1190
            to_transport.mkdir('.')
 
1191
        except errors.FileExists:
 
1192
            if not use_existing_dir:
 
1193
                raise errors.BzrCommandError('Target directory "%s" '
 
1194
                    'already exists.' % to_location)
1079
1195
            else:
1080
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
1081
 
                # None or perhaps NULL_REVISION to mean copy nothing
1082
 
                # RBC 20060209
1083
 
                revision_id = br_from.last_revision()
1084
 
            if to_location is None:
1085
 
                to_location = urlutils.derive_to_location(from_location)
1086
 
            to_transport = transport.get_transport(to_location)
1087
 
            try:
1088
 
                to_transport.mkdir('.')
1089
 
            except errors.FileExists:
1090
 
                raise errors.BzrCommandError('Target directory "%s" already'
1091
 
                                             ' exists.' % to_location)
1092
 
            except errors.NoSuchFile:
1093
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
1094
 
                                             % to_location)
1095
 
            try:
1096
 
                # preserve whatever source format we have.
1097
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1098
 
                                            possible_transports=[to_transport],
1099
 
                                            accelerator_tree=accelerator_tree,
1100
 
                                            hardlink=hardlink, stacked=stacked,
1101
 
                                            force_new_repo=standalone,
1102
 
                                            create_tree_if_local=not no_tree,
1103
 
                                            source_branch=br_from)
1104
 
                branch = dir.open_branch()
1105
 
            except errors.NoSuchRevision:
1106
 
                to_transport.delete_tree('.')
1107
 
                msg = "The branch %s has no revision %s." % (from_location,
1108
 
                    revision)
1109
 
                raise errors.BzrCommandError(msg)
1110
 
            _merge_tags_if_possible(br_from, branch)
1111
 
            # If the source branch is stacked, the new branch may
1112
 
            # be stacked whether we asked for that explicitly or not.
1113
 
            # We therefore need a try/except here and not just 'if stacked:'
1114
 
            try:
1115
 
                note('Created new stacked branch referring to %s.' %
1116
 
                    branch.get_stacked_on_url())
1117
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1118
 
                errors.UnstackableRepositoryFormat), e:
1119
 
                note('Branched %d revision(s).' % branch.revno())
1120
 
        finally:
1121
 
            br_from.unlock()
 
1196
                try:
 
1197
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1198
                except errors.NotBranchError:
 
1199
                    pass
 
1200
                else:
 
1201
                    raise errors.AlreadyBranchError(to_location)
 
1202
        except errors.NoSuchFile:
 
1203
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1204
                                         % to_location)
 
1205
        try:
 
1206
            # preserve whatever source format we have.
 
1207
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1208
                                        possible_transports=[to_transport],
 
1209
                                        accelerator_tree=accelerator_tree,
 
1210
                                        hardlink=hardlink, stacked=stacked,
 
1211
                                        force_new_repo=standalone,
 
1212
                                        create_tree_if_local=not no_tree,
 
1213
                                        source_branch=br_from)
 
1214
            branch = dir.open_branch()
 
1215
        except errors.NoSuchRevision:
 
1216
            to_transport.delete_tree('.')
 
1217
            msg = "The branch %s has no revision %s." % (from_location,
 
1218
                revision)
 
1219
            raise errors.BzrCommandError(msg)
 
1220
        _merge_tags_if_possible(br_from, branch)
 
1221
        # If the source branch is stacked, the new branch may
 
1222
        # be stacked whether we asked for that explicitly or not.
 
1223
        # We therefore need a try/except here and not just 'if stacked:'
 
1224
        try:
 
1225
            note('Created new stacked branch referring to %s.' %
 
1226
                branch.get_stacked_on_url())
 
1227
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1228
            errors.UnstackableRepositoryFormat), e:
 
1229
            note('Branched %d revision(s).' % branch.revno())
 
1230
        if bind:
 
1231
            # Bind to the parent
 
1232
            parent_branch = Branch.open(from_location)
 
1233
            branch.bind(parent_branch)
 
1234
            note('New branch bound to %s' % from_location)
 
1235
        if switch:
 
1236
            # Switch to the new branch
 
1237
            wt, _ = WorkingTree.open_containing('.')
 
1238
            _mod_switch.switch(wt.bzrdir, branch)
 
1239
            note('Switched to branch: %s',
 
1240
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1122
1241
 
1123
1242
 
1124
1243
class cmd_checkout(Command):
1125
 
    """Create a new checkout of an existing branch.
 
1244
    __doc__ = """Create a new checkout of an existing branch.
1126
1245
 
1127
1246
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1128
1247
    the branch found in '.'. This is useful if you have removed the working tree
1167
1286
            to_location = branch_location
1168
1287
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1169
1288
            branch_location)
 
1289
        if not (hardlink or files_from):
 
1290
            # accelerator_tree is usually slower because you have to read N
 
1291
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1292
            # explicitly request it
 
1293
            accelerator_tree = None
1170
1294
        revision = _get_one_revision('checkout', revision)
1171
 
        if files_from is not None:
 
1295
        if files_from is not None and files_from != branch_location:
1172
1296
            accelerator_tree = WorkingTree.open(files_from)
1173
1297
        if revision is not None:
1174
1298
            revision_id = revision.as_revision_id(source)
1191
1315
 
1192
1316
 
1193
1317
class cmd_renames(Command):
1194
 
    """Show list of renamed files.
 
1318
    __doc__ = """Show list of renamed files.
1195
1319
    """
1196
1320
    # TODO: Option to show renames between two historical versions.
1197
1321
 
1202
1326
    @display_command
1203
1327
    def run(self, dir=u'.'):
1204
1328
        tree = WorkingTree.open_containing(dir)[0]
1205
 
        tree.lock_read()
1206
 
        try:
1207
 
            new_inv = tree.inventory
1208
 
            old_tree = tree.basis_tree()
1209
 
            old_tree.lock_read()
1210
 
            try:
1211
 
                old_inv = old_tree.inventory
1212
 
                renames = []
1213
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1214
 
                for f, paths, c, v, p, n, k, e in iterator:
1215
 
                    if paths[0] == paths[1]:
1216
 
                        continue
1217
 
                    if None in (paths):
1218
 
                        continue
1219
 
                    renames.append(paths)
1220
 
                renames.sort()
1221
 
                for old_name, new_name in renames:
1222
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1223
 
            finally:
1224
 
                old_tree.unlock()
1225
 
        finally:
1226
 
            tree.unlock()
 
1329
        self.add_cleanup(tree.lock_read().unlock)
 
1330
        new_inv = tree.inventory
 
1331
        old_tree = tree.basis_tree()
 
1332
        self.add_cleanup(old_tree.lock_read().unlock)
 
1333
        old_inv = old_tree.inventory
 
1334
        renames = []
 
1335
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1336
        for f, paths, c, v, p, n, k, e in iterator:
 
1337
            if paths[0] == paths[1]:
 
1338
                continue
 
1339
            if None in (paths):
 
1340
                continue
 
1341
            renames.append(paths)
 
1342
        renames.sort()
 
1343
        for old_name, new_name in renames:
 
1344
            self.outf.write("%s => %s\n" % (old_name, new_name))
1227
1345
 
1228
1346
 
1229
1347
class cmd_update(Command):
1230
 
    """Update a tree to have the latest code committed to its branch.
 
1348
    __doc__ = """Update a tree to have the latest code committed to its branch.
1231
1349
 
1232
1350
    This will perform a merge into the working tree, and may generate
1233
1351
    conflicts. If you have any local changes, you will still
1235
1353
 
1236
1354
    If you want to discard your local changes, you can just do a
1237
1355
    'bzr revert' instead of 'bzr commit' after the update.
 
1356
 
 
1357
    If the tree's branch is bound to a master branch, it will also update
 
1358
    the branch from the master.
1238
1359
    """
1239
1360
 
1240
1361
    _see_also = ['pull', 'working-trees', 'status-flags']
1241
1362
    takes_args = ['dir?']
 
1363
    takes_options = ['revision']
1242
1364
    aliases = ['up']
1243
1365
 
1244
 
    def run(self, dir='.'):
 
1366
    def run(self, dir='.', revision=None):
 
1367
        if revision is not None and len(revision) != 1:
 
1368
            raise errors.BzrCommandError(
 
1369
                        "bzr update --revision takes exactly one revision")
1245
1370
        tree = WorkingTree.open_containing(dir)[0]
 
1371
        branch = tree.branch
1246
1372
        possible_transports = []
1247
 
        master = tree.branch.get_master_branch(
 
1373
        master = branch.get_master_branch(
1248
1374
            possible_transports=possible_transports)
1249
1375
        if master is not None:
 
1376
            branch_location = master.base
1250
1377
            tree.lock_write()
1251
1378
        else:
 
1379
            branch_location = tree.branch.base
1252
1380
            tree.lock_tree_write()
 
1381
        self.add_cleanup(tree.unlock)
 
1382
        # get rid of the final '/' and be ready for display
 
1383
        branch_location = urlutils.unescape_for_display(
 
1384
            branch_location.rstrip('/'),
 
1385
            self.outf.encoding)
 
1386
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1387
        if master is None:
 
1388
            old_tip = None
 
1389
        else:
 
1390
            # may need to fetch data into a heavyweight checkout
 
1391
            # XXX: this may take some time, maybe we should display a
 
1392
            # message
 
1393
            old_tip = branch.update(possible_transports)
 
1394
        if revision is not None:
 
1395
            revision_id = revision[0].as_revision_id(branch)
 
1396
        else:
 
1397
            revision_id = branch.last_revision()
 
1398
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1399
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1400
            note("Tree is up to date at revision %s of branch %s" %
 
1401
                ('.'.join(map(str, revno)), branch_location))
 
1402
            return 0
 
1403
        view_info = _get_view_info_for_change_reporter(tree)
 
1404
        change_reporter = delta._ChangeReporter(
 
1405
            unversioned_filter=tree.is_ignored,
 
1406
            view_info=view_info)
1253
1407
        try:
1254
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1255
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1256
 
            if last_rev == _mod_revision.ensure_null(
1257
 
                tree.branch.last_revision()):
1258
 
                # may be up to date, check master too.
1259
 
                if master is None or last_rev == _mod_revision.ensure_null(
1260
 
                    master.last_revision()):
1261
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1262
 
                    note("Tree is up to date at revision %d." % (revno,))
1263
 
                    return 0
1264
 
            view_info = _get_view_info_for_change_reporter(tree)
1265
1408
            conflicts = tree.update(
1266
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored,
1267
 
                view_info=view_info), possible_transports=possible_transports)
1268
 
            revno = tree.branch.revision_id_to_revno(
1269
 
                _mod_revision.ensure_null(tree.last_revision()))
1270
 
            note('Updated to revision %d.' % (revno,))
1271
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1272
 
                note('Your local commits will now show as pending merges with '
1273
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1274
 
            if conflicts != 0:
1275
 
                return 1
1276
 
            else:
1277
 
                return 0
1278
 
        finally:
1279
 
            tree.unlock()
 
1409
                change_reporter,
 
1410
                possible_transports=possible_transports,
 
1411
                revision=revision_id,
 
1412
                old_tip=old_tip)
 
1413
        except errors.NoSuchRevision, e:
 
1414
            raise errors.BzrCommandError(
 
1415
                                  "branch has no revision %s\n"
 
1416
                                  "bzr update --revision only works"
 
1417
                                  " for a revision in the branch history"
 
1418
                                  % (e.revision))
 
1419
        revno = tree.branch.revision_id_to_dotted_revno(
 
1420
            _mod_revision.ensure_null(tree.last_revision()))
 
1421
        note('Updated to revision %s of branch %s' %
 
1422
             ('.'.join(map(str, revno)), branch_location))
 
1423
        parent_ids = tree.get_parent_ids()
 
1424
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1425
            note('Your local commits will now show as pending merges with '
 
1426
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1427
        if conflicts != 0:
 
1428
            return 1
 
1429
        else:
 
1430
            return 0
1280
1431
 
1281
1432
 
1282
1433
class cmd_info(Command):
1283
 
    """Show information about a working tree, branch or repository.
 
1434
    __doc__ = """Show information about a working tree, branch or repository.
1284
1435
 
1285
1436
    This command will show all known locations and formats associated to the
1286
1437
    tree, branch or repository.
1301
1452
      basic statistics (like the number of files in the working tree and
1302
1453
      number of revisions in the branch and repository):
1303
1454
 
1304
 
        bzr -v info
 
1455
        bzr info -v
1305
1456
 
1306
1457
      Display the above together with number of committers to the branch:
1307
1458
 
1308
 
        bzr -vv info
 
1459
        bzr info -vv
1309
1460
    """
1310
1461
    _see_also = ['revno', 'working-trees', 'repositories']
1311
1462
    takes_args = ['location?']
1324
1475
 
1325
1476
 
1326
1477
class cmd_remove(Command):
1327
 
    """Remove files or directories.
 
1478
    __doc__ = """Remove files or directories.
1328
1479
 
1329
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1330
 
    them if they can easily be recovered using revert. If no options or
1331
 
    parameters are given bzr will scan for files that are being tracked by bzr
1332
 
    but missing in your tree and stop tracking them for you.
 
1480
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1481
    delete them if they can easily be recovered using revert otherwise they
 
1482
    will be backed up (adding an extention of the form .~#~). If no options or
 
1483
    parameters are given Bazaar will scan for files that are being tracked by
 
1484
    Bazaar but missing in your tree and stop tracking them for you.
1333
1485
    """
1334
1486
    takes_args = ['file*']
1335
1487
    takes_options = ['verbose',
1337
1489
        RegistryOption.from_kwargs('file-deletion-strategy',
1338
1490
            'The file deletion mode to be used.',
1339
1491
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1340
 
            safe='Only delete files if they can be'
1341
 
                 ' safely recovered (default).',
1342
 
            keep="Don't delete any files.",
 
1492
            safe='Backup changed files (default).',
 
1493
            keep='Delete from bzr but leave the working copy.',
1343
1494
            force='Delete all the specified files, even if they can not be '
1344
1495
                'recovered and even if they are non-empty directories.')]
1345
1496
    aliases = ['rm', 'del']
1347
1498
 
1348
1499
    def run(self, file_list, verbose=False, new=False,
1349
1500
        file_deletion_strategy='safe'):
1350
 
        tree, file_list = tree_files(file_list)
 
1501
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1351
1502
 
1352
1503
        if file_list is not None:
1353
1504
            file_list = [f for f in file_list]
1354
1505
 
1355
 
        tree.lock_write()
1356
 
        try:
1357
 
            # Heuristics should probably all move into tree.remove_smart or
1358
 
            # some such?
1359
 
            if new:
1360
 
                added = tree.changes_from(tree.basis_tree(),
1361
 
                    specific_files=file_list).added
1362
 
                file_list = sorted([f[0] for f in added], reverse=True)
1363
 
                if len(file_list) == 0:
1364
 
                    raise errors.BzrCommandError('No matching files.')
1365
 
            elif file_list is None:
1366
 
                # missing files show up in iter_changes(basis) as
1367
 
                # versioned-with-no-kind.
1368
 
                missing = []
1369
 
                for change in tree.iter_changes(tree.basis_tree()):
1370
 
                    # Find paths in the working tree that have no kind:
1371
 
                    if change[1][1] is not None and change[6][1] is None:
1372
 
                        missing.append(change[1][1])
1373
 
                file_list = sorted(missing, reverse=True)
1374
 
                file_deletion_strategy = 'keep'
1375
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1376
 
                keep_files=file_deletion_strategy=='keep',
1377
 
                force=file_deletion_strategy=='force')
1378
 
        finally:
1379
 
            tree.unlock()
 
1506
        self.add_cleanup(tree.lock_write().unlock)
 
1507
        # Heuristics should probably all move into tree.remove_smart or
 
1508
        # some such?
 
1509
        if new:
 
1510
            added = tree.changes_from(tree.basis_tree(),
 
1511
                specific_files=file_list).added
 
1512
            file_list = sorted([f[0] for f in added], reverse=True)
 
1513
            if len(file_list) == 0:
 
1514
                raise errors.BzrCommandError('No matching files.')
 
1515
        elif file_list is None:
 
1516
            # missing files show up in iter_changes(basis) as
 
1517
            # versioned-with-no-kind.
 
1518
            missing = []
 
1519
            for change in tree.iter_changes(tree.basis_tree()):
 
1520
                # Find paths in the working tree that have no kind:
 
1521
                if change[1][1] is not None and change[6][1] is None:
 
1522
                    missing.append(change[1][1])
 
1523
            file_list = sorted(missing, reverse=True)
 
1524
            file_deletion_strategy = 'keep'
 
1525
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1526
            keep_files=file_deletion_strategy=='keep',
 
1527
            force=file_deletion_strategy=='force')
1380
1528
 
1381
1529
 
1382
1530
class cmd_file_id(Command):
1383
 
    """Print file_id of a particular file or directory.
 
1531
    __doc__ = """Print file_id of a particular file or directory.
1384
1532
 
1385
1533
    The file_id is assigned when the file is first added and remains the
1386
1534
    same through all revisions where the file exists, even when it is
1402
1550
 
1403
1551
 
1404
1552
class cmd_file_path(Command):
1405
 
    """Print path of file_ids to a file or directory.
 
1553
    __doc__ = """Print path of file_ids to a file or directory.
1406
1554
 
1407
1555
    This prints one line for each directory down to the target,
1408
1556
    starting at the branch root.
1424
1572
 
1425
1573
 
1426
1574
class cmd_reconcile(Command):
1427
 
    """Reconcile bzr metadata in a branch.
 
1575
    __doc__ = """Reconcile bzr metadata in a branch.
1428
1576
 
1429
1577
    This can correct data mismatches that may have been caused by
1430
1578
    previous ghost operations or bzr upgrades. You should only
1444
1592
 
1445
1593
    _see_also = ['check']
1446
1594
    takes_args = ['branch?']
 
1595
    takes_options = [
 
1596
        Option('canonicalize-chks',
 
1597
               help='Make sure CHKs are in canonical form (repairs '
 
1598
                    'bug 522637).',
 
1599
               hidden=True),
 
1600
        ]
1447
1601
 
1448
 
    def run(self, branch="."):
 
1602
    def run(self, branch=".", canonicalize_chks=False):
1449
1603
        from bzrlib.reconcile import reconcile
1450
1604
        dir = bzrdir.BzrDir.open(branch)
1451
 
        reconcile(dir)
 
1605
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1452
1606
 
1453
1607
 
1454
1608
class cmd_revision_history(Command):
1455
 
    """Display the list of revision ids on a branch."""
 
1609
    __doc__ = """Display the list of revision ids on a branch."""
1456
1610
 
1457
1611
    _see_also = ['log']
1458
1612
    takes_args = ['location?']
1468
1622
 
1469
1623
 
1470
1624
class cmd_ancestry(Command):
1471
 
    """List all revisions merged into this branch."""
 
1625
    __doc__ = """List all revisions merged into this branch."""
1472
1626
 
1473
1627
    _see_also = ['log', 'revision-history']
1474
1628
    takes_args = ['location?']
1493
1647
 
1494
1648
 
1495
1649
class cmd_init(Command):
1496
 
    """Make a directory into a versioned branch.
 
1650
    __doc__ = """Make a directory into a versioned branch.
1497
1651
 
1498
1652
    Use this to create an empty branch, or before importing an
1499
1653
    existing project.
1527
1681
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1528
1682
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1529
1683
                value_switches=True,
1530
 
                title="Branch Format",
 
1684
                title="Branch format",
1531
1685
                ),
1532
1686
         Option('append-revisions-only',
1533
1687
                help='Never change revnos or the existing log.'
1556
1710
                    "\nYou may supply --create-prefix to create all"
1557
1711
                    " leading parent directories."
1558
1712
                    % location)
1559
 
            _create_prefix(to_transport)
 
1713
            to_transport.create_prefix()
1560
1714
 
1561
1715
        try:
1562
1716
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1580
1734
                branch.set_append_revisions_only(True)
1581
1735
            except errors.UpgradeRequired:
1582
1736
                raise errors.BzrCommandError('This branch format cannot be set'
1583
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1737
                    ' to append-revisions-only.  Try --default.')
1584
1738
        if not is_quiet():
1585
1739
            from bzrlib.info import describe_layout, describe_format
1586
1740
            try:
1602
1756
 
1603
1757
 
1604
1758
class cmd_init_repository(Command):
1605
 
    """Create a shared repository to hold branches.
 
1759
    __doc__ = """Create a shared repository for branches to share storage space.
1606
1760
 
1607
1761
    New branches created under the repository directory will store their
1608
 
    revisions in the repository, not in the branch directory.
 
1762
    revisions in the repository, not in the branch directory.  For branches
 
1763
    with shared history, this reduces the amount of storage needed and 
 
1764
    speeds up the creation of new branches.
1609
1765
 
1610
 
    If the --no-trees option is used then the branches in the repository
1611
 
    will not have working trees by default.
 
1766
    If the --no-trees option is given then the branches in the repository
 
1767
    will not have working trees by default.  They will still exist as 
 
1768
    directories on disk, but they will not have separate copies of the 
 
1769
    files at a certain revision.  This can be useful for repositories that
 
1770
    store branches which are interacted with through checkouts or remote
 
1771
    branches, such as on a server.
1612
1772
 
1613
1773
    :Examples:
1614
 
        Create a shared repositories holding just branches::
 
1774
        Create a shared repository holding just branches::
1615
1775
 
1616
1776
            bzr init-repo --no-trees repo
1617
1777
            bzr init repo/trunk
1656
1816
 
1657
1817
 
1658
1818
class cmd_diff(Command):
1659
 
    """Show differences in the working tree, between revisions or branches.
 
1819
    __doc__ = """Show differences in the working tree, between revisions or branches.
1660
1820
 
1661
1821
    If no arguments are given, all changes for the current tree are listed.
1662
1822
    If files are given, only the changes in those files are listed.
1683
1843
 
1684
1844
            bzr diff -r1
1685
1845
 
1686
 
        Difference between revision 2 and revision 1::
1687
 
 
1688
 
            bzr diff -r1..2
1689
 
 
1690
 
        Difference between revision 2 and revision 1 for branch xxx::
1691
 
 
1692
 
            bzr diff -r1..2 xxx
 
1846
        Difference between revision 3 and revision 1::
 
1847
 
 
1848
            bzr diff -r1..3
 
1849
 
 
1850
        Difference between revision 3 and revision 1 for branch xxx::
 
1851
 
 
1852
            bzr diff -r1..3 xxx
 
1853
 
 
1854
        To see the changes introduced in revision X::
 
1855
        
 
1856
            bzr diff -cX
 
1857
 
 
1858
        Note that in the case of a merge, the -c option shows the changes
 
1859
        compared to the left hand parent. To see the changes against
 
1860
        another parent, use::
 
1861
 
 
1862
            bzr diff -r<chosen_parent>..X
 
1863
 
 
1864
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1865
 
 
1866
            bzr diff -c2
1693
1867
 
1694
1868
        Show just the differences for file NEWS::
1695
1869
 
1710
1884
        Same as 'bzr diff' but prefix paths with old/ and new/::
1711
1885
 
1712
1886
            bzr diff --prefix old/:new/
 
1887
            
 
1888
        Show the differences using a custom diff program with options::
 
1889
        
 
1890
            bzr diff --using /usr/bin/diff --diff-options -wu
1713
1891
    """
1714
1892
    _see_also = ['status']
1715
1893
    takes_args = ['file*']
1734
1912
            help='Use this command to compare files.',
1735
1913
            type=unicode,
1736
1914
            ),
 
1915
        RegistryOption('format',
 
1916
            help='Diff format to use.',
 
1917
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1918
            value_switches=False, title='Diff format'),
1737
1919
        ]
1738
1920
    aliases = ['di', 'dif']
1739
1921
    encoding_type = 'exact'
1740
1922
 
1741
1923
    @display_command
1742
1924
    def run(self, revision=None, file_list=None, diff_options=None,
1743
 
            prefix=None, old=None, new=None, using=None):
1744
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1925
            prefix=None, old=None, new=None, using=None, format=None):
 
1926
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1927
            show_diff_trees)
1745
1928
 
1746
1929
        if (prefix is None) or (prefix == '0'):
1747
1930
            # diff -p0 format
1761
1944
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1762
1945
                                         ' one or two revision specifiers')
1763
1946
 
1764
 
        old_tree, new_tree, specific_files, extra_trees = \
1765
 
                _get_trees_to_diff(file_list, revision, old, new,
1766
 
                apply_view=True)
 
1947
        if using is not None and format is not None:
 
1948
            raise errors.BzrCommandError('--using and --format are mutually '
 
1949
                'exclusive.')
 
1950
 
 
1951
        (old_tree, new_tree,
 
1952
         old_branch, new_branch,
 
1953
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1954
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1955
        # GNU diff on Windows uses ANSI encoding for filenames
 
1956
        path_encoding = osutils.get_diff_header_encoding()
1767
1957
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1768
1958
                               specific_files=specific_files,
1769
1959
                               external_diff_options=diff_options,
1770
1960
                               old_label=old_label, new_label=new_label,
1771
 
                               extra_trees=extra_trees, using=using)
 
1961
                               extra_trees=extra_trees,
 
1962
                               path_encoding=path_encoding,
 
1963
                               using=using,
 
1964
                               format_cls=format)
1772
1965
 
1773
1966
 
1774
1967
class cmd_deleted(Command):
1775
 
    """List files deleted in the working tree.
 
1968
    __doc__ = """List files deleted in the working tree.
1776
1969
    """
1777
1970
    # TODO: Show files deleted since a previous revision, or
1778
1971
    # between two revisions.
1781
1974
    # level of effort but possibly much less IO.  (Or possibly not,
1782
1975
    # if the directories are very large...)
1783
1976
    _see_also = ['status', 'ls']
1784
 
    takes_options = ['show-ids']
 
1977
    takes_options = ['directory', 'show-ids']
1785
1978
 
1786
1979
    @display_command
1787
 
    def run(self, show_ids=False):
1788
 
        tree = WorkingTree.open_containing(u'.')[0]
1789
 
        tree.lock_read()
1790
 
        try:
1791
 
            old = tree.basis_tree()
1792
 
            old.lock_read()
1793
 
            try:
1794
 
                for path, ie in old.inventory.iter_entries():
1795
 
                    if not tree.has_id(ie.file_id):
1796
 
                        self.outf.write(path)
1797
 
                        if show_ids:
1798
 
                            self.outf.write(' ')
1799
 
                            self.outf.write(ie.file_id)
1800
 
                        self.outf.write('\n')
1801
 
            finally:
1802
 
                old.unlock()
1803
 
        finally:
1804
 
            tree.unlock()
 
1980
    def run(self, show_ids=False, directory=u'.'):
 
1981
        tree = WorkingTree.open_containing(directory)[0]
 
1982
        self.add_cleanup(tree.lock_read().unlock)
 
1983
        old = tree.basis_tree()
 
1984
        self.add_cleanup(old.lock_read().unlock)
 
1985
        for path, ie in old.inventory.iter_entries():
 
1986
            if not tree.has_id(ie.file_id):
 
1987
                self.outf.write(path)
 
1988
                if show_ids:
 
1989
                    self.outf.write(' ')
 
1990
                    self.outf.write(ie.file_id)
 
1991
                self.outf.write('\n')
1805
1992
 
1806
1993
 
1807
1994
class cmd_modified(Command):
1808
 
    """List files modified in working tree.
 
1995
    __doc__ = """List files modified in working tree.
1809
1996
    """
1810
1997
 
1811
1998
    hidden = True
1812
1999
    _see_also = ['status', 'ls']
1813
 
    takes_options = [
1814
 
            Option('null',
1815
 
                   help='Write an ascii NUL (\\0) separator '
1816
 
                   'between files rather than a newline.')
1817
 
            ]
 
2000
    takes_options = ['directory', 'null']
1818
2001
 
1819
2002
    @display_command
1820
 
    def run(self, null=False):
1821
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2003
    def run(self, null=False, directory=u'.'):
 
2004
        tree = WorkingTree.open_containing(directory)[0]
1822
2005
        td = tree.changes_from(tree.basis_tree())
1823
2006
        for path, id, kind, text_modified, meta_modified in td.modified:
1824
2007
            if null:
1828
2011
 
1829
2012
 
1830
2013
class cmd_added(Command):
1831
 
    """List files added in working tree.
 
2014
    __doc__ = """List files added in working tree.
1832
2015
    """
1833
2016
 
1834
2017
    hidden = True
1835
2018
    _see_also = ['status', 'ls']
1836
 
    takes_options = [
1837
 
            Option('null',
1838
 
                   help='Write an ascii NUL (\\0) separator '
1839
 
                   'between files rather than a newline.')
1840
 
            ]
 
2019
    takes_options = ['directory', 'null']
1841
2020
 
1842
2021
    @display_command
1843
 
    def run(self, null=False):
1844
 
        wt = WorkingTree.open_containing(u'.')[0]
1845
 
        wt.lock_read()
1846
 
        try:
1847
 
            basis = wt.basis_tree()
1848
 
            basis.lock_read()
1849
 
            try:
1850
 
                basis_inv = basis.inventory
1851
 
                inv = wt.inventory
1852
 
                for file_id in inv:
1853
 
                    if file_id in basis_inv:
1854
 
                        continue
1855
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1856
 
                        continue
1857
 
                    path = inv.id2path(file_id)
1858
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1859
 
                        continue
1860
 
                    if null:
1861
 
                        self.outf.write(path + '\0')
1862
 
                    else:
1863
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1864
 
            finally:
1865
 
                basis.unlock()
1866
 
        finally:
1867
 
            wt.unlock()
 
2022
    def run(self, null=False, directory=u'.'):
 
2023
        wt = WorkingTree.open_containing(directory)[0]
 
2024
        self.add_cleanup(wt.lock_read().unlock)
 
2025
        basis = wt.basis_tree()
 
2026
        self.add_cleanup(basis.lock_read().unlock)
 
2027
        basis_inv = basis.inventory
 
2028
        inv = wt.inventory
 
2029
        for file_id in inv:
 
2030
            if file_id in basis_inv:
 
2031
                continue
 
2032
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2033
                continue
 
2034
            path = inv.id2path(file_id)
 
2035
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2036
                continue
 
2037
            if null:
 
2038
                self.outf.write(path + '\0')
 
2039
            else:
 
2040
                self.outf.write(osutils.quotefn(path) + '\n')
1868
2041
 
1869
2042
 
1870
2043
class cmd_root(Command):
1871
 
    """Show the tree root directory.
 
2044
    __doc__ = """Show the tree root directory.
1872
2045
 
1873
2046
    The root is the nearest enclosing directory with a .bzr control
1874
2047
    directory."""
1898
2071
 
1899
2072
 
1900
2073
class cmd_log(Command):
1901
 
    """Show historical log for a branch or subset of a branch.
 
2074
    __doc__ = """Show historical log for a branch or subset of a branch.
1902
2075
 
1903
2076
    log is bzr's default tool for exploring the history of a branch.
1904
2077
    The branch to use is taken from the first parameter. If no parameters
1933
2106
        --show-ids  display revision-ids (and file-ids), not just revnos
1934
2107
 
1935
2108
      Note that the default number of levels to display is a function of the
1936
 
      log format. If the -n option is not used, ``short`` and ``line`` show
1937
 
      just the top level (mainline) while ``long`` shows all levels of merged
1938
 
      revisions.
 
2109
      log format. If the -n option is not used, the standard log formats show
 
2110
      just the top level (mainline).
1939
2111
 
1940
2112
      Status summaries are shown using status flags like A, M, etc. To see
1941
2113
      the changes explained using words like ``added`` and ``modified``
2016
2188
    :Tips & tricks:
2017
2189
 
2018
2190
      GUI tools and IDEs are often better at exploring history than command
2019
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2020
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2021
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2022
 
 
2023
 
      Web interfaces are often better at exploring history than command line
2024
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2025
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2191
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2192
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2193
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2194
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2026
2195
 
2027
2196
      You may find it useful to add the aliases below to ``bazaar.conf``::
2028
2197
 
2029
2198
        [ALIASES]
2030
 
        tip = log -r-1 -n1
 
2199
        tip = log -r-1
2031
2200
        top = log -l10 --line
2032
 
        show = log -v -p -n1 --long
 
2201
        show = log -v -p
2033
2202
 
2034
2203
      ``bzr tip`` will then show the latest revision while ``bzr top``
2035
2204
      will show the last 10 mainline revisions. To see the details of a
2036
2205
      particular revision X,  ``bzr show -rX``.
2037
2206
 
2038
 
      As many GUI tools and Web interfaces do, you may prefer viewing
2039
 
      history collapsed initially. If you are interested in looking deeper
2040
 
      into a particular merge X, use ``bzr log -n0 -rX``. If you like
2041
 
      working this way, you may wish to either:
2042
 
 
2043
 
      * change your default log format to short (or line)
2044
 
      * add this alias: log = log -n1
 
2207
      If you are interested in looking deeper into a particular merge X,
 
2208
      use ``bzr log -n0 -rX``.
2045
2209
 
2046
2210
      ``bzr log -v`` on a branch with lots of history is currently
2047
2211
      very slow. A fix for this issue is currently under development.
2055
2219
 
2056
2220
      When exploring non-mainline history on large projects with deep
2057
2221
      history, the performance of log can be greatly improved by installing
2058
 
      the revnocache plugin. This plugin buffers historical information
 
2222
      the historycache plugin. This plugin buffers historical information
2059
2223
      trading disk space for faster speed.
2060
2224
    """
2061
2225
    takes_args = ['file*']
2074
2238
                   help='Show just the specified revision.'
2075
2239
                   ' See also "help revisionspec".'),
2076
2240
            'log-format',
 
2241
            RegistryOption('authors',
 
2242
                'What names to list as authors - first, all or committer.',
 
2243
                title='Authors',
 
2244
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2245
            ),
2077
2246
            Option('levels',
2078
2247
                   short_name='n',
2079
2248
                   help='Number of levels to display - 0 for all, 1 for flat.',
2092
2261
            Option('show-diff',
2093
2262
                   short_name='p',
2094
2263
                   help='Show changes made in each revision as a patch.'),
 
2264
            Option('include-merges',
 
2265
                   help='Show merged revisions like --levels 0 does.'),
 
2266
            Option('exclude-common-ancestry',
 
2267
                   help='Display only the revisions that are not part'
 
2268
                   ' of both ancestries (require -rX..Y)'
 
2269
                   )
2095
2270
            ]
2096
2271
    encoding_type = 'replace'
2097
2272
 
2106
2281
            levels=None,
2107
2282
            message=None,
2108
2283
            limit=None,
2109
 
            show_diff=False):
 
2284
            show_diff=False,
 
2285
            include_merges=False,
 
2286
            authors=None,
 
2287
            exclude_common_ancestry=False,
 
2288
            ):
2110
2289
        from bzrlib.log import (
2111
2290
            Logger,
2112
2291
            make_log_request_dict,
2113
2292
            _get_info_for_log_files,
2114
2293
            )
2115
2294
        direction = (forward and 'forward') or 'reverse'
 
2295
        if (exclude_common_ancestry
 
2296
            and (revision is None or len(revision) != 2)):
 
2297
            raise errors.BzrCommandError(
 
2298
                '--exclude-common-ancestry requires -r with two revisions')
 
2299
        if include_merges:
 
2300
            if levels is None:
 
2301
                levels = 0
 
2302
            else:
 
2303
                raise errors.BzrCommandError(
 
2304
                    '--levels and --include-merges are mutually exclusive')
2116
2305
 
2117
2306
        if change is not None:
2118
2307
            if len(change) > 1:
2127
2316
        filter_by_dir = False
2128
2317
        if file_list:
2129
2318
            # find the file ids to log and check for directory filtering
2130
 
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
2131
 
                file_list)
 
2319
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2320
                revision, file_list, self.add_cleanup)
2132
2321
            for relpath, file_id, kind in file_info_list:
2133
2322
                if file_id is None:
2134
2323
                    raise errors.BzrCommandError(
2152
2341
                location = '.'
2153
2342
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2154
2343
            b = dir.open_branch()
 
2344
            self.add_cleanup(b.lock_read().unlock)
2155
2345
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2156
2346
 
2157
2347
        # Decide on the type of delta & diff filtering to use
2167
2357
        else:
2168
2358
            diff_type = 'full'
2169
2359
 
2170
 
        b.lock_read()
2171
 
        try:
2172
 
            # Build the log formatter
2173
 
            if log_format is None:
2174
 
                log_format = log.log_formatter_registry.get_default(b)
2175
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
2176
 
                            show_timezone=timezone,
2177
 
                            delta_format=get_verbosity_level(),
2178
 
                            levels=levels)
2179
 
 
2180
 
            # Choose the algorithm for doing the logging. It's annoying
2181
 
            # having multiple code paths like this but necessary until
2182
 
            # the underlying repository format is faster at generating
2183
 
            # deltas or can provide everything we need from the indices.
2184
 
            # The default algorithm - match-using-deltas - works for
2185
 
            # multiple files and directories and is faster for small
2186
 
            # amounts of history (200 revisions say). However, it's too
2187
 
            # slow for logging a single file in a repository with deep
2188
 
            # history, i.e. > 10K revisions. In the spirit of "do no
2189
 
            # evil when adding features", we continue to use the
2190
 
            # original algorithm - per-file-graph - for the "single
2191
 
            # file that isn't a directory without showing a delta" case.
2192
 
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2193
 
                or delta_type)
2194
 
 
2195
 
            # Build the LogRequest and execute it
2196
 
            if len(file_ids) == 0:
2197
 
                file_ids = None
2198
 
            rqst = make_log_request_dict(
2199
 
                direction=direction, specific_fileids=file_ids,
2200
 
                start_revision=rev1, end_revision=rev2, limit=limit,
2201
 
                message_search=message, delta_type=delta_type,
2202
 
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
2203
 
            Logger(b, rqst).show(lf)
2204
 
        finally:
2205
 
            b.unlock()
 
2360
        # Build the log formatter
 
2361
        if log_format is None:
 
2362
            log_format = log.log_formatter_registry.get_default(b)
 
2363
        # Make a non-encoding output to include the diffs - bug 328007
 
2364
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2365
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2366
                        to_exact_file=unencoded_output,
 
2367
                        show_timezone=timezone,
 
2368
                        delta_format=get_verbosity_level(),
 
2369
                        levels=levels,
 
2370
                        show_advice=levels is None,
 
2371
                        author_list_handler=authors)
 
2372
 
 
2373
        # Choose the algorithm for doing the logging. It's annoying
 
2374
        # having multiple code paths like this but necessary until
 
2375
        # the underlying repository format is faster at generating
 
2376
        # deltas or can provide everything we need from the indices.
 
2377
        # The default algorithm - match-using-deltas - works for
 
2378
        # multiple files and directories and is faster for small
 
2379
        # amounts of history (200 revisions say). However, it's too
 
2380
        # slow for logging a single file in a repository with deep
 
2381
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2382
        # evil when adding features", we continue to use the
 
2383
        # original algorithm - per-file-graph - for the "single
 
2384
        # file that isn't a directory without showing a delta" case.
 
2385
        partial_history = revision and b.repository._format.supports_chks
 
2386
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2387
            or delta_type or partial_history)
 
2388
 
 
2389
        # Build the LogRequest and execute it
 
2390
        if len(file_ids) == 0:
 
2391
            file_ids = None
 
2392
        rqst = make_log_request_dict(
 
2393
            direction=direction, specific_fileids=file_ids,
 
2394
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2395
            message_search=message, delta_type=delta_type,
 
2396
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2397
            exclude_common_ancestry=exclude_common_ancestry,
 
2398
            )
 
2399
        Logger(b, rqst).show(lf)
2206
2400
 
2207
2401
 
2208
2402
def _get_revision_range(revisionspec_list, branch, command_name):
2226
2420
            raise errors.BzrCommandError(
2227
2421
                "bzr %s doesn't accept two revisions in different"
2228
2422
                " branches." % command_name)
2229
 
        rev1 = start_spec.in_history(branch)
 
2423
        if start_spec.spec is None:
 
2424
            # Avoid loading all the history.
 
2425
            rev1 = RevisionInfo(branch, None, None)
 
2426
        else:
 
2427
            rev1 = start_spec.in_history(branch)
2230
2428
        # Avoid loading all of history when we know a missing
2231
2429
        # end of range means the last revision ...
2232
2430
        if end_spec.spec is None:
2261
2459
 
2262
2460
 
2263
2461
class cmd_touching_revisions(Command):
2264
 
    """Return revision-ids which affected a particular file.
 
2462
    __doc__ = """Return revision-ids which affected a particular file.
2265
2463
 
2266
2464
    A more user-friendly interface is "bzr log FILE".
2267
2465
    """
2272
2470
    @display_command
2273
2471
    def run(self, filename):
2274
2472
        tree, relpath = WorkingTree.open_containing(filename)
 
2473
        file_id = tree.path2id(relpath)
2275
2474
        b = tree.branch
2276
 
        file_id = tree.path2id(relpath)
2277
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2475
        self.add_cleanup(b.lock_read().unlock)
 
2476
        touching_revs = log.find_touching_revisions(b, file_id)
 
2477
        for revno, revision_id, what in touching_revs:
2278
2478
            self.outf.write("%6d %s\n" % (revno, what))
2279
2479
 
2280
2480
 
2281
2481
class cmd_ls(Command):
2282
 
    """List files in a tree.
 
2482
    __doc__ = """List files in a tree.
2283
2483
    """
2284
2484
 
2285
2485
    _see_also = ['status', 'cat']
2286
2486
    takes_args = ['path?']
2287
 
    # TODO: Take a revision or remote path and list that tree instead.
2288
2487
    takes_options = [
2289
2488
            'verbose',
2290
2489
            'revision',
2291
 
            Option('non-recursive',
2292
 
                   help='Don\'t recurse into subdirectories.'),
 
2490
            Option('recursive', short_name='R',
 
2491
                   help='Recurse into subdirectories.'),
2293
2492
            Option('from-root',
2294
2493
                   help='Print paths relative to the root of the branch.'),
2295
 
            Option('unknown', help='Print unknown files.'),
 
2494
            Option('unknown', short_name='u',
 
2495
                help='Print unknown files.'),
2296
2496
            Option('versioned', help='Print versioned files.',
2297
2497
                   short_name='V'),
2298
 
            Option('ignored', help='Print ignored files.'),
2299
 
            Option('null',
2300
 
                   help='Write an ascii NUL (\\0) separator '
2301
 
                   'between files rather than a newline.'),
2302
 
            Option('kind',
 
2498
            Option('ignored', short_name='i',
 
2499
                help='Print ignored files.'),
 
2500
            Option('kind', short_name='k',
2303
2501
                   help='List entries of a particular kind: file, directory, symlink.',
2304
2502
                   type=unicode),
 
2503
            'null',
2305
2504
            'show-ids',
 
2505
            'directory',
2306
2506
            ]
2307
2507
    @display_command
2308
2508
    def run(self, revision=None, verbose=False,
2309
 
            non_recursive=False, from_root=False,
 
2509
            recursive=False, from_root=False,
2310
2510
            unknown=False, versioned=False, ignored=False,
2311
 
            null=False, kind=None, show_ids=False, path=None):
 
2511
            null=False, kind=None, show_ids=False, path=None, directory=None):
2312
2512
 
2313
2513
        if kind and kind not in ('file', 'directory', 'symlink'):
2314
2514
            raise errors.BzrCommandError('invalid kind specified')
2321
2521
 
2322
2522
        if path is None:
2323
2523
            fs_path = '.'
2324
 
            prefix = ''
2325
2524
        else:
2326
2525
            if from_root:
2327
2526
                raise errors.BzrCommandError('cannot specify both --from-root'
2328
2527
                                             ' and PATH')
2329
2528
            fs_path = path
2330
 
            prefix = path
2331
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2332
 
            fs_path)
 
2529
        tree, branch, relpath = \
 
2530
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
2531
 
 
2532
        # Calculate the prefix to use
 
2533
        prefix = None
2333
2534
        if from_root:
2334
 
            relpath = u''
2335
 
        elif relpath:
2336
 
            relpath += '/'
 
2535
            if relpath:
 
2536
                prefix = relpath + '/'
 
2537
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2538
            prefix = fs_path + '/'
 
2539
 
2337
2540
        if revision is not None or tree is None:
2338
2541
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2339
2542
 
2343
2546
            if view_files:
2344
2547
                apply_view = True
2345
2548
                view_str = views.view_display_str(view_files)
2346
 
                note("ignoring files outside view: %s" % view_str)
2347
 
 
2348
 
        tree.lock_read()
2349
 
        try:
2350
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
2351
 
                if fp.startswith(relpath):
2352
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
2353
 
                    if non_recursive and '/' in fp:
2354
 
                        continue
2355
 
                    if not all and not selection[fc]:
2356
 
                        continue
2357
 
                    if kind is not None and fkind != kind:
2358
 
                        continue
2359
 
                    if apply_view:
2360
 
                        try:
2361
 
                            views.check_path_in_view(tree, fp)
2362
 
                        except errors.FileOutsideView:
2363
 
                            continue
2364
 
                    kindch = entry.kind_character()
2365
 
                    outstring = fp + kindch
2366
 
                    if verbose:
2367
 
                        outstring = '%-8s %s' % (fc, outstring)
2368
 
                        if show_ids and fid is not None:
2369
 
                            outstring = "%-50s %s" % (outstring, fid)
2370
 
                        self.outf.write(outstring + '\n')
2371
 
                    elif null:
2372
 
                        self.outf.write(fp + '\0')
2373
 
                        if show_ids:
2374
 
                            if fid is not None:
2375
 
                                self.outf.write(fid)
2376
 
                            self.outf.write('\0')
2377
 
                        self.outf.flush()
2378
 
                    else:
2379
 
                        if fid is not None:
2380
 
                            my_id = fid
2381
 
                        else:
2382
 
                            my_id = ''
2383
 
                        if show_ids:
2384
 
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
2385
 
                        else:
2386
 
                            self.outf.write(outstring + '\n')
2387
 
        finally:
2388
 
            tree.unlock()
 
2549
                note("Ignoring files outside view. View is %s" % view_str)
 
2550
 
 
2551
        self.add_cleanup(tree.lock_read().unlock)
 
2552
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2553
            from_dir=relpath, recursive=recursive):
 
2554
            # Apply additional masking
 
2555
            if not all and not selection[fc]:
 
2556
                continue
 
2557
            if kind is not None and fkind != kind:
 
2558
                continue
 
2559
            if apply_view:
 
2560
                try:
 
2561
                    if relpath:
 
2562
                        fullpath = osutils.pathjoin(relpath, fp)
 
2563
                    else:
 
2564
                        fullpath = fp
 
2565
                    views.check_path_in_view(tree, fullpath)
 
2566
                except errors.FileOutsideView:
 
2567
                    continue
 
2568
 
 
2569
            # Output the entry
 
2570
            if prefix:
 
2571
                fp = osutils.pathjoin(prefix, fp)
 
2572
            kindch = entry.kind_character()
 
2573
            outstring = fp + kindch
 
2574
            ui.ui_factory.clear_term()
 
2575
            if verbose:
 
2576
                outstring = '%-8s %s' % (fc, outstring)
 
2577
                if show_ids and fid is not None:
 
2578
                    outstring = "%-50s %s" % (outstring, fid)
 
2579
                self.outf.write(outstring + '\n')
 
2580
            elif null:
 
2581
                self.outf.write(fp + '\0')
 
2582
                if show_ids:
 
2583
                    if fid is not None:
 
2584
                        self.outf.write(fid)
 
2585
                    self.outf.write('\0')
 
2586
                self.outf.flush()
 
2587
            else:
 
2588
                if show_ids:
 
2589
                    if fid is not None:
 
2590
                        my_id = fid
 
2591
                    else:
 
2592
                        my_id = ''
 
2593
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2594
                else:
 
2595
                    self.outf.write(outstring + '\n')
2389
2596
 
2390
2597
 
2391
2598
class cmd_unknowns(Command):
2392
 
    """List unknown files.
 
2599
    __doc__ = """List unknown files.
2393
2600
    """
2394
2601
 
2395
2602
    hidden = True
2396
2603
    _see_also = ['ls']
 
2604
    takes_options = ['directory']
2397
2605
 
2398
2606
    @display_command
2399
 
    def run(self):
2400
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2607
    def run(self, directory=u'.'):
 
2608
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2401
2609
            self.outf.write(osutils.quotefn(f) + '\n')
2402
2610
 
2403
2611
 
2404
2612
class cmd_ignore(Command):
2405
 
    """Ignore specified files or patterns.
 
2613
    __doc__ = """Ignore specified files or patterns.
2406
2614
 
2407
2615
    See ``bzr help patterns`` for details on the syntax of patterns.
2408
2616
 
 
2617
    If a .bzrignore file does not exist, the ignore command
 
2618
    will create one and add the specified files or patterns to the newly
 
2619
    created file. The ignore command will also automatically add the 
 
2620
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2621
    the use of the ignore command will require an explicit add command.
 
2622
 
2409
2623
    To remove patterns from the ignore list, edit the .bzrignore file.
2410
2624
    After adding, editing or deleting that file either indirectly by
2411
2625
    using this command or directly by using an editor, be sure to commit
2412
2626
    it.
 
2627
    
 
2628
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2629
    the global ignore file can be found in the application data directory as
 
2630
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2631
    Global ignores are not touched by this command. The global ignore file
 
2632
    can be edited directly using an editor.
 
2633
 
 
2634
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2635
    precedence over regular ignores.  Such exceptions are used to specify
 
2636
    files that should be versioned which would otherwise be ignored.
 
2637
    
 
2638
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2639
    precedence over the '!' exception patterns.
2413
2640
 
2414
2641
    Note: ignore patterns containing shell wildcards must be quoted from
2415
2642
    the shell on Unix.
2419
2646
 
2420
2647
            bzr ignore ./Makefile
2421
2648
 
2422
 
        Ignore class files in all directories::
 
2649
        Ignore .class files in all directories...::
2423
2650
 
2424
2651
            bzr ignore "*.class"
2425
2652
 
 
2653
        ...but do not ignore "special.class"::
 
2654
 
 
2655
            bzr ignore "!special.class"
 
2656
 
2426
2657
        Ignore .o files under the lib directory::
2427
2658
 
2428
2659
            bzr ignore "lib/**/*.o"
2434
2665
        Ignore everything but the "debian" toplevel directory::
2435
2666
 
2436
2667
            bzr ignore "RE:(?!debian/).*"
 
2668
        
 
2669
        Ignore everything except the "local" toplevel directory,
 
2670
        but always ignore "*~" autosave files, even under local/::
 
2671
        
 
2672
            bzr ignore "*"
 
2673
            bzr ignore "!./local"
 
2674
            bzr ignore "!!*~"
2437
2675
    """
2438
2676
 
2439
2677
    _see_also = ['status', 'ignored', 'patterns']
2440
2678
    takes_args = ['name_pattern*']
2441
 
    takes_options = [
2442
 
        Option('old-default-rules',
2443
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2679
    takes_options = ['directory',
 
2680
        Option('default-rules',
 
2681
               help='Display the default ignore rules that bzr uses.')
2444
2682
        ]
2445
2683
 
2446
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2684
    def run(self, name_pattern_list=None, default_rules=None,
 
2685
            directory=u'.'):
2447
2686
        from bzrlib import ignores
2448
 
        if old_default_rules is not None:
2449
 
            # dump the rules and exit
2450
 
            for pattern in ignores.OLD_DEFAULTS:
2451
 
                print pattern
 
2687
        if default_rules is not None:
 
2688
            # dump the default rules and exit
 
2689
            for pattern in ignores.USER_DEFAULTS:
 
2690
                self.outf.write("%s\n" % pattern)
2452
2691
            return
2453
2692
        if not name_pattern_list:
2454
2693
            raise errors.BzrCommandError("ignore requires at least one "
2455
 
                                  "NAME_PATTERN or --old-default-rules")
 
2694
                "NAME_PATTERN or --default-rules.")
2456
2695
        name_pattern_list = [globbing.normalize_pattern(p)
2457
2696
                             for p in name_pattern_list]
 
2697
        bad_patterns = ''
 
2698
        for p in name_pattern_list:
 
2699
            if not globbing.Globster.is_pattern_valid(p):
 
2700
                bad_patterns += ('\n  %s' % p)
 
2701
        if bad_patterns:
 
2702
            msg = ('Invalid ignore pattern(s) found. %s' % bad_patterns)
 
2703
            ui.ui_factory.show_error(msg)
 
2704
            raise errors.InvalidPattern('')
2458
2705
        for name_pattern in name_pattern_list:
2459
2706
            if (name_pattern[0] == '/' or
2460
2707
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2461
2708
                raise errors.BzrCommandError(
2462
2709
                    "NAME_PATTERN should not be an absolute path")
2463
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
2710
        tree, relpath = WorkingTree.open_containing(directory)
2464
2711
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2465
2712
        ignored = globbing.Globster(name_pattern_list)
2466
2713
        matches = []
2467
 
        tree.lock_read()
 
2714
        self.add_cleanup(tree.lock_read().unlock)
2468
2715
        for entry in tree.list_files():
2469
2716
            id = entry[3]
2470
2717
            if id is not None:
2471
2718
                filename = entry[0]
2472
2719
                if ignored.match(filename):
2473
 
                    matches.append(filename.encode('utf-8'))
2474
 
        tree.unlock()
 
2720
                    matches.append(filename)
2475
2721
        if len(matches) > 0:
2476
 
            print "Warning: the following files are version controlled and" \
2477
 
                  " match your ignore pattern:\n%s" \
2478
 
                  "\nThese files will continue to be version controlled" \
2479
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2722
            self.outf.write("Warning: the following files are version controlled and"
 
2723
                  " match your ignore pattern:\n%s"
 
2724
                  "\nThese files will continue to be version controlled"
 
2725
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2480
2726
 
2481
2727
 
2482
2728
class cmd_ignored(Command):
2483
 
    """List ignored files and the patterns that matched them.
 
2729
    __doc__ = """List ignored files and the patterns that matched them.
2484
2730
 
2485
2731
    List all the ignored files and the ignore pattern that caused the file to
2486
2732
    be ignored.
2492
2738
 
2493
2739
    encoding_type = 'replace'
2494
2740
    _see_also = ['ignore', 'ls']
 
2741
    takes_options = ['directory']
2495
2742
 
2496
2743
    @display_command
2497
 
    def run(self):
2498
 
        tree = WorkingTree.open_containing(u'.')[0]
2499
 
        tree.lock_read()
2500
 
        try:
2501
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2502
 
                if file_class != 'I':
2503
 
                    continue
2504
 
                ## XXX: Slightly inefficient since this was already calculated
2505
 
                pat = tree.is_ignored(path)
2506
 
                self.outf.write('%-50s %s\n' % (path, pat))
2507
 
        finally:
2508
 
            tree.unlock()
 
2744
    def run(self, directory=u'.'):
 
2745
        tree = WorkingTree.open_containing(directory)[0]
 
2746
        self.add_cleanup(tree.lock_read().unlock)
 
2747
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2748
            if file_class != 'I':
 
2749
                continue
 
2750
            ## XXX: Slightly inefficient since this was already calculated
 
2751
            pat = tree.is_ignored(path)
 
2752
            self.outf.write('%-50s %s\n' % (path, pat))
2509
2753
 
2510
2754
 
2511
2755
class cmd_lookup_revision(Command):
2512
 
    """Lookup the revision-id from a revision-number
 
2756
    __doc__ = """Lookup the revision-id from a revision-number
2513
2757
 
2514
2758
    :Examples:
2515
2759
        bzr lookup-revision 33
2516
2760
    """
2517
2761
    hidden = True
2518
2762
    takes_args = ['revno']
 
2763
    takes_options = ['directory']
2519
2764
 
2520
2765
    @display_command
2521
 
    def run(self, revno):
 
2766
    def run(self, revno, directory=u'.'):
2522
2767
        try:
2523
2768
            revno = int(revno)
2524
2769
        except ValueError:
2525
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2526
 
 
2527
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2770
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2771
                                         % revno)
 
2772
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
2773
        self.outf.write("%s\n" % revid)
2528
2774
 
2529
2775
 
2530
2776
class cmd_export(Command):
2531
 
    """Export current or past revision to a destination directory or archive.
 
2777
    __doc__ = """Export current or past revision to a destination directory or archive.
2532
2778
 
2533
2779
    If no revision is specified this exports the last committed revision.
2534
2780
 
2556
2802
      =================       =========================
2557
2803
    """
2558
2804
    takes_args = ['dest', 'branch_or_subdir?']
2559
 
    takes_options = [
 
2805
    takes_options = ['directory',
2560
2806
        Option('format',
2561
2807
               help="Type of file to export to.",
2562
2808
               type=unicode),
2566
2812
        Option('root',
2567
2813
               type=str,
2568
2814
               help="Name of the root directory inside the exported file."),
 
2815
        Option('per-file-timestamps',
 
2816
               help='Set modification time of files to that of the last '
 
2817
                    'revision in which it was changed.'),
2569
2818
        ]
2570
2819
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2571
 
        root=None, filters=False):
 
2820
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2572
2821
        from bzrlib.export import export
2573
2822
 
2574
2823
        if branch_or_subdir is None:
2575
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2824
            tree = WorkingTree.open_containing(directory)[0]
2576
2825
            b = tree.branch
2577
2826
            subdir = None
2578
2827
        else:
2581
2830
 
2582
2831
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2583
2832
        try:
2584
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2833
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2834
                   per_file_timestamps=per_file_timestamps)
2585
2835
        except errors.NoSuchExportFormat, e:
2586
2836
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2587
2837
 
2588
2838
 
2589
2839
class cmd_cat(Command):
2590
 
    """Write the contents of a file as of a given revision to standard output.
 
2840
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2591
2841
 
2592
2842
    If no revision is nominated, the last revision is used.
2593
2843
 
2596
2846
    """
2597
2847
 
2598
2848
    _see_also = ['ls']
2599
 
    takes_options = [
 
2849
    takes_options = ['directory',
2600
2850
        Option('name-from-revision', help='The path name in the old tree.'),
2601
2851
        Option('filters', help='Apply content filters to display the '
2602
2852
                'convenience form.'),
2607
2857
 
2608
2858
    @display_command
2609
2859
    def run(self, filename, revision=None, name_from_revision=False,
2610
 
            filters=False):
 
2860
            filters=False, directory=None):
2611
2861
        if revision is not None and len(revision) != 1:
2612
2862
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2613
2863
                                         " one revision specifier")
2614
2864
        tree, branch, relpath = \
2615
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2616
 
        branch.lock_read()
2617
 
        try:
2618
 
            return self._run(tree, branch, relpath, filename, revision,
2619
 
                             name_from_revision, filters)
2620
 
        finally:
2621
 
            branch.unlock()
 
2865
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
2866
        self.add_cleanup(branch.lock_read().unlock)
 
2867
        return self._run(tree, branch, relpath, filename, revision,
 
2868
                         name_from_revision, filters)
2622
2869
 
2623
2870
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2624
2871
        filtered):
2625
2872
        if tree is None:
2626
2873
            tree = b.basis_tree()
2627
2874
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2875
        self.add_cleanup(rev_tree.lock_read().unlock)
2628
2876
 
2629
2877
        old_file_id = rev_tree.path2id(relpath)
2630
2878
 
2665
2913
            chunks = content.splitlines(True)
2666
2914
            content = filtered_output_bytes(chunks, filters,
2667
2915
                ContentFilterContext(relpath, rev_tree))
 
2916
            self.cleanup_now()
2668
2917
            self.outf.writelines(content)
2669
2918
        else:
 
2919
            self.cleanup_now()
2670
2920
            self.outf.write(content)
2671
2921
 
2672
2922
 
2673
2923
class cmd_local_time_offset(Command):
2674
 
    """Show the offset in seconds from GMT to local time."""
 
2924
    __doc__ = """Show the offset in seconds from GMT to local time."""
2675
2925
    hidden = True
2676
2926
    @display_command
2677
2927
    def run(self):
2678
 
        print osutils.local_time_offset()
 
2928
        self.outf.write("%s\n" % osutils.local_time_offset())
2679
2929
 
2680
2930
 
2681
2931
 
2682
2932
class cmd_commit(Command):
2683
 
    """Commit changes into a new revision.
2684
 
 
2685
 
    If no arguments are given, the entire tree is committed.
2686
 
 
2687
 
    If selected files are specified, only changes to those files are
2688
 
    committed.  If a directory is specified then the directory and everything
2689
 
    within it is committed.
2690
 
 
2691
 
    When excludes are given, they take precedence over selected files.
2692
 
    For example, too commit only changes within foo, but not changes within
2693
 
    foo/bar::
2694
 
 
2695
 
      bzr commit foo -x foo/bar
2696
 
 
2697
 
    If author of the change is not the same person as the committer, you can
2698
 
    specify the author's name using the --author option. The name should be
2699
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2700
 
    If there is more than one author of the change you can specify the option
2701
 
    multiple times, once for each author.
2702
 
 
2703
 
    A selected-file commit may fail in some cases where the committed
2704
 
    tree would be invalid. Consider::
2705
 
 
2706
 
      bzr init foo
2707
 
      mkdir foo/bar
2708
 
      bzr add foo/bar
2709
 
      bzr commit foo -m "committing foo"
2710
 
      bzr mv foo/bar foo/baz
2711
 
      mkdir foo/bar
2712
 
      bzr add foo/bar
2713
 
      bzr commit foo/bar -m "committing bar but not baz"
2714
 
 
2715
 
    In the example above, the last commit will fail by design. This gives
2716
 
    the user the opportunity to decide whether they want to commit the
2717
 
    rename at the same time, separately first, or not at all. (As a general
2718
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2719
 
 
2720
 
    Note: A selected-file commit after a merge is not yet supported.
 
2933
    __doc__ = """Commit changes into a new revision.
 
2934
 
 
2935
    An explanatory message needs to be given for each commit. This is
 
2936
    often done by using the --message option (getting the message from the
 
2937
    command line) or by using the --file option (getting the message from
 
2938
    a file). If neither of these options is given, an editor is opened for
 
2939
    the user to enter the message. To see the changed files in the
 
2940
    boilerplate text loaded into the editor, use the --show-diff option.
 
2941
 
 
2942
    By default, the entire tree is committed and the person doing the
 
2943
    commit is assumed to be the author. These defaults can be overridden
 
2944
    as explained below.
 
2945
 
 
2946
    :Selective commits:
 
2947
 
 
2948
      If selected files are specified, only changes to those files are
 
2949
      committed.  If a directory is specified then the directory and
 
2950
      everything within it is committed.
 
2951
  
 
2952
      When excludes are given, they take precedence over selected files.
 
2953
      For example, to commit only changes within foo, but not changes
 
2954
      within foo/bar::
 
2955
  
 
2956
        bzr commit foo -x foo/bar
 
2957
  
 
2958
      A selective commit after a merge is not yet supported.
 
2959
 
 
2960
    :Custom authors:
 
2961
 
 
2962
      If the author of the change is not the same person as the committer,
 
2963
      you can specify the author's name using the --author option. The
 
2964
      name should be in the same format as a committer-id, e.g.
 
2965
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2966
      the change you can specify the option multiple times, once for each
 
2967
      author.
 
2968
  
 
2969
    :Checks:
 
2970
 
 
2971
      A common mistake is to forget to add a new file or directory before
 
2972
      running the commit command. The --strict option checks for unknown
 
2973
      files and aborts the commit if any are found. More advanced pre-commit
 
2974
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2975
      for details.
 
2976
 
 
2977
    :Things to note:
 
2978
 
 
2979
      If you accidentially commit the wrong changes or make a spelling
 
2980
      mistake in the commit message say, you can use the uncommit command
 
2981
      to undo it. See ``bzr help uncommit`` for details.
 
2982
 
 
2983
      Hooks can also be configured to run after a commit. This allows you
 
2984
      to trigger updates to external systems like bug trackers. The --fixes
 
2985
      option can be used to record the association between a revision and
 
2986
      one or more bugs. See ``bzr help bugs`` for details.
 
2987
 
 
2988
      A selective commit may fail in some cases where the committed
 
2989
      tree would be invalid. Consider::
 
2990
  
 
2991
        bzr init foo
 
2992
        mkdir foo/bar
 
2993
        bzr add foo/bar
 
2994
        bzr commit foo -m "committing foo"
 
2995
        bzr mv foo/bar foo/baz
 
2996
        mkdir foo/bar
 
2997
        bzr add foo/bar
 
2998
        bzr commit foo/bar -m "committing bar but not baz"
 
2999
  
 
3000
      In the example above, the last commit will fail by design. This gives
 
3001
      the user the opportunity to decide whether they want to commit the
 
3002
      rename at the same time, separately first, or not at all. (As a general
 
3003
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2721
3004
    """
2722
3005
    # TODO: Run hooks on tree to-be-committed, and after commit.
2723
3006
 
2728
3011
 
2729
3012
    # XXX: verbose currently does nothing
2730
3013
 
2731
 
    _see_also = ['bugs', 'uncommit']
 
3014
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2732
3015
    takes_args = ['selected*']
2733
3016
    takes_options = [
2734
3017
            ListOption('exclude', type=str, short_name='x',
2746
3029
             Option('strict',
2747
3030
                    help="Refuse to commit if there are unknown "
2748
3031
                    "files in the working tree."),
 
3032
             Option('commit-time', type=str,
 
3033
                    help="Manually set a commit time using commit date "
 
3034
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2749
3035
             ListOption('fixes', type=str,
2750
3036
                    help="Mark a bug as being fixed by this revision "
2751
3037
                         "(see \"bzr help bugs\")."),
2758
3044
                         "the master branch until a normal commit "
2759
3045
                         "is performed."
2760
3046
                    ),
2761
 
              Option('show-diff',
2762
 
                     help='When no message is supplied, show the diff along'
2763
 
                     ' with the status summary in the message editor.'),
 
3047
             Option('show-diff', short_name='p',
 
3048
                    help='When no message is supplied, show the diff along'
 
3049
                    ' with the status summary in the message editor.'),
2764
3050
             ]
2765
3051
    aliases = ['ci', 'checkin']
2766
3052
 
2785
3071
 
2786
3072
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2787
3073
            unchanged=False, strict=False, local=False, fixes=None,
2788
 
            author=None, show_diff=False, exclude=None):
 
3074
            author=None, show_diff=False, exclude=None, commit_time=None):
2789
3075
        from bzrlib.errors import (
2790
3076
            PointlessCommit,
2791
3077
            ConflictsInTree,
2797
3083
            make_commit_message_template_encoded
2798
3084
        )
2799
3085
 
 
3086
        commit_stamp = offset = None
 
3087
        if commit_time is not None:
 
3088
            try:
 
3089
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3090
            except ValueError, e:
 
3091
                raise errors.BzrCommandError(
 
3092
                    "Could not parse --commit-time: " + str(e))
 
3093
 
2800
3094
        # TODO: Need a blackbox test for invoking the external editor; may be
2801
3095
        # slightly problematic to run this cross-platform.
2802
3096
 
2805
3099
 
2806
3100
        properties = {}
2807
3101
 
2808
 
        tree, selected_list = tree_files(selected_list)
 
3102
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
2809
3103
        if selected_list == ['']:
2810
3104
            # workaround - commit of root of tree should be exactly the same
2811
3105
            # as just default commit in that tree, and succeed even though
2822
3116
        if local and not tree.branch.get_bound_location():
2823
3117
            raise errors.LocalRequiresBoundBranch()
2824
3118
 
 
3119
        if message is not None:
 
3120
            try:
 
3121
                file_exists = osutils.lexists(message)
 
3122
            except UnicodeError:
 
3123
                # The commit message contains unicode characters that can't be
 
3124
                # represented in the filesystem encoding, so that can't be a
 
3125
                # file.
 
3126
                file_exists = False
 
3127
            if file_exists:
 
3128
                warning_msg = (
 
3129
                    'The commit message is a file name: "%(f)s".\n'
 
3130
                    '(use --file "%(f)s" to take commit message from that file)'
 
3131
                    % { 'f': message })
 
3132
                ui.ui_factory.show_warning(warning_msg)
 
3133
            if '\r' in message:
 
3134
                message = message.replace('\r\n', '\n')
 
3135
                message = message.replace('\r', '\n')
 
3136
            if file:
 
3137
                raise errors.BzrCommandError(
 
3138
                    "please specify either --message or --file")
 
3139
 
2825
3140
        def get_message(commit_obj):
2826
3141
            """Callback to get commit message"""
2827
 
            my_message = message
2828
 
            if my_message is None and not file:
2829
 
                t = make_commit_message_template_encoded(tree,
 
3142
            if file:
 
3143
                f = open(file)
 
3144
                try:
 
3145
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3146
                finally:
 
3147
                    f.close()
 
3148
            elif message is not None:
 
3149
                my_message = message
 
3150
            else:
 
3151
                # No message supplied: make one up.
 
3152
                # text is the status of the tree
 
3153
                text = make_commit_message_template_encoded(tree,
2830
3154
                        selected_list, diff=show_diff,
2831
3155
                        output_encoding=osutils.get_user_encoding())
 
3156
                # start_message is the template generated from hooks
 
3157
                # XXX: Warning - looks like hooks return unicode,
 
3158
                # make_commit_message_template_encoded returns user encoding.
 
3159
                # We probably want to be using edit_commit_message instead to
 
3160
                # avoid this.
2832
3161
                start_message = generate_commit_message_template(commit_obj)
2833
 
                my_message = edit_commit_message_encoded(t,
 
3162
                my_message = edit_commit_message_encoded(text,
2834
3163
                    start_message=start_message)
2835
3164
                if my_message is None:
2836
3165
                    raise errors.BzrCommandError("please specify a commit"
2837
3166
                        " message with either --message or --file")
2838
 
            elif my_message and file:
2839
 
                raise errors.BzrCommandError(
2840
 
                    "please specify either --message or --file")
2841
 
            if file:
2842
 
                my_message = codecs.open(file, 'rt',
2843
 
                                         osutils.get_user_encoding()).read()
2844
3167
            if my_message == "":
2845
3168
                raise errors.BzrCommandError("empty commit message specified")
2846
3169
            return my_message
2847
3170
 
 
3171
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3172
        # but the command line should not do that.
 
3173
        if not selected_list:
 
3174
            selected_list = None
2848
3175
        try:
2849
3176
            tree.commit(message_callback=get_message,
2850
3177
                        specific_files=selected_list,
2851
3178
                        allow_pointless=unchanged, strict=strict, local=local,
2852
3179
                        reporter=None, verbose=verbose, revprops=properties,
2853
 
                        authors=author,
2854
 
                        exclude=safe_relpath_files(tree, exclude))
 
3180
                        authors=author, timestamp=commit_stamp,
 
3181
                        timezone=offset,
 
3182
                        exclude=tree.safe_relpath_files(exclude))
2855
3183
        except PointlessCommit:
2856
 
            # FIXME: This should really happen before the file is read in;
2857
 
            # perhaps prepare the commit; get the message; then actually commit
2858
 
            raise errors.BzrCommandError("no changes to commit."
2859
 
                              " use --unchanged to commit anyhow")
 
3184
            raise errors.BzrCommandError("No changes to commit."
 
3185
                              " Use --unchanged to commit anyhow.")
2860
3186
        except ConflictsInTree:
2861
3187
            raise errors.BzrCommandError('Conflicts detected in working '
2862
3188
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2865
3191
            raise errors.BzrCommandError("Commit refused because there are"
2866
3192
                              " unknown files in the working tree.")
2867
3193
        except errors.BoundBranchOutOfDate, e:
2868
 
            raise errors.BzrCommandError(str(e) + "\n"
2869
 
            'To commit to master branch, run update and then commit.\n'
2870
 
            'You can also pass --local to commit to continue working '
2871
 
            'disconnected.')
 
3194
            e.extra_help = ("\n"
 
3195
                'To commit to master branch, run update and then commit.\n'
 
3196
                'You can also pass --local to commit to continue working '
 
3197
                'disconnected.')
 
3198
            raise
2872
3199
 
2873
3200
 
2874
3201
class cmd_check(Command):
2875
 
    """Validate working tree structure, branch consistency and repository history.
 
3202
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2876
3203
 
2877
3204
    This command checks various invariants about branch and repository storage
2878
3205
    to detect data corruption or bzr bugs.
2880
3207
    The working tree and branch checks will only give output if a problem is
2881
3208
    detected. The output fields of the repository check are:
2882
3209
 
2883
 
        revisions: This is just the number of revisions checked.  It doesn't
2884
 
            indicate a problem.
2885
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2886
 
            doesn't indicate a problem.
2887
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2888
 
            are not properly referenced by the revision ancestry.  This is a
2889
 
            subtle problem that Bazaar can work around.
2890
 
        unique file texts: This is the total number of unique file contents
2891
 
            seen in the checked revisions.  It does not indicate a problem.
2892
 
        repeated file texts: This is the total number of repeated texts seen
2893
 
            in the checked revisions.  Texts can be repeated when their file
2894
 
            entries are modified, but the file contents are not.  It does not
2895
 
            indicate a problem.
 
3210
    revisions
 
3211
        This is just the number of revisions checked.  It doesn't
 
3212
        indicate a problem.
 
3213
 
 
3214
    versionedfiles
 
3215
        This is just the number of versionedfiles checked.  It
 
3216
        doesn't indicate a problem.
 
3217
 
 
3218
    unreferenced ancestors
 
3219
        Texts that are ancestors of other texts, but
 
3220
        are not properly referenced by the revision ancestry.  This is a
 
3221
        subtle problem that Bazaar can work around.
 
3222
 
 
3223
    unique file texts
 
3224
        This is the total number of unique file contents
 
3225
        seen in the checked revisions.  It does not indicate a problem.
 
3226
 
 
3227
    repeated file texts
 
3228
        This is the total number of repeated texts seen
 
3229
        in the checked revisions.  Texts can be repeated when their file
 
3230
        entries are modified, but the file contents are not.  It does not
 
3231
        indicate a problem.
2896
3232
 
2897
3233
    If no restrictions are specified, all Bazaar data that is found at the given
2898
3234
    location will be checked.
2933
3269
 
2934
3270
 
2935
3271
class cmd_upgrade(Command):
2936
 
    """Upgrade branch storage to current format.
 
3272
    __doc__ = """Upgrade branch storage to current format.
2937
3273
 
2938
3274
    The check command or bzr developers may sometimes advise you to run
2939
3275
    this command. When the default format has changed you may also be warned
2953
3289
 
2954
3290
    def run(self, url='.', format=None):
2955
3291
        from bzrlib.upgrade import upgrade
2956
 
        if format is None:
2957
 
            format = bzrdir.format_registry.make_bzrdir('default')
2958
3292
        upgrade(url, format)
2959
3293
 
2960
3294
 
2961
3295
class cmd_whoami(Command):
2962
 
    """Show or set bzr user id.
 
3296
    __doc__ = """Show or set bzr user id.
2963
3297
 
2964
3298
    :Examples:
2965
3299
        Show the email of the current user::
2970
3304
 
2971
3305
            bzr whoami "Frank Chu <fchu@example.com>"
2972
3306
    """
2973
 
    takes_options = [ Option('email',
 
3307
    takes_options = [ 'directory',
 
3308
                      Option('email',
2974
3309
                             help='Display email address only.'),
2975
3310
                      Option('branch',
2976
3311
                             help='Set identity for the current branch instead of '
2980
3315
    encoding_type = 'replace'
2981
3316
 
2982
3317
    @display_command
2983
 
    def run(self, email=False, branch=False, name=None):
 
3318
    def run(self, email=False, branch=False, name=None, directory=None):
2984
3319
        if name is None:
2985
 
            # use branch if we're inside one; otherwise global config
2986
 
            try:
2987
 
                c = Branch.open_containing('.')[0].get_config()
2988
 
            except errors.NotBranchError:
2989
 
                c = config.GlobalConfig()
 
3320
            if directory is None:
 
3321
                # use branch if we're inside one; otherwise global config
 
3322
                try:
 
3323
                    c = Branch.open_containing(u'.')[0].get_config()
 
3324
                except errors.NotBranchError:
 
3325
                    c = config.GlobalConfig()
 
3326
            else:
 
3327
                c = Branch.open(directory).get_config()
2990
3328
            if email:
2991
3329
                self.outf.write(c.user_email() + '\n')
2992
3330
            else:
3002
3340
 
3003
3341
        # use global config unless --branch given
3004
3342
        if branch:
3005
 
            c = Branch.open_containing('.')[0].get_config()
 
3343
            if directory is None:
 
3344
                c = Branch.open_containing(u'.')[0].get_config()
 
3345
            else:
 
3346
                c = Branch.open(directory).get_config()
3006
3347
        else:
3007
3348
            c = config.GlobalConfig()
3008
3349
        c.set_user_option('email', name)
3009
3350
 
3010
3351
 
3011
3352
class cmd_nick(Command):
3012
 
    """Print or set the branch nickname.
 
3353
    __doc__ = """Print or set the branch nickname.
3013
3354
 
3014
3355
    If unset, the tree root directory name is used as the nickname.
3015
3356
    To print the current nickname, execute with no argument.
3020
3361
 
3021
3362
    _see_also = ['info']
3022
3363
    takes_args = ['nickname?']
3023
 
    def run(self, nickname=None):
3024
 
        branch = Branch.open_containing(u'.')[0]
 
3364
    takes_options = ['directory']
 
3365
    def run(self, nickname=None, directory=u'.'):
 
3366
        branch = Branch.open_containing(directory)[0]
3025
3367
        if nickname is None:
3026
3368
            self.printme(branch)
3027
3369
        else:
3029
3371
 
3030
3372
    @display_command
3031
3373
    def printme(self, branch):
3032
 
        print branch.nick
 
3374
        self.outf.write('%s\n' % branch.nick)
3033
3375
 
3034
3376
 
3035
3377
class cmd_alias(Command):
3036
 
    """Set/unset and display aliases.
 
3378
    __doc__ = """Set/unset and display aliases.
3037
3379
 
3038
3380
    :Examples:
3039
3381
        Show the current aliases::
3103
3445
 
3104
3446
 
3105
3447
class cmd_selftest(Command):
3106
 
    """Run internal test suite.
 
3448
    __doc__ = """Run internal test suite.
3107
3449
 
3108
3450
    If arguments are given, they are regular expressions that say which tests
3109
3451
    should run.  Tests matching any expression are run, and other tests are
3136
3478
    Tests that need working space on disk use a common temporary directory,
3137
3479
    typically inside $TMPDIR or /tmp.
3138
3480
 
 
3481
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3482
    into a pdb postmortem session.
 
3483
 
3139
3484
    :Examples:
3140
3485
        Run only tests relating to 'ignore'::
3141
3486
 
3150
3495
    def get_transport_type(typestring):
3151
3496
        """Parse and return a transport specifier."""
3152
3497
        if typestring == "sftp":
3153
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3154
 
            return SFTPAbsoluteServer
 
3498
            from bzrlib.tests import stub_sftp
 
3499
            return stub_sftp.SFTPAbsoluteServer
3155
3500
        if typestring == "memory":
3156
 
            from bzrlib.transport.memory import MemoryServer
3157
 
            return MemoryServer
 
3501
            from bzrlib.tests import test_server
 
3502
            return memory.MemoryServer
3158
3503
        if typestring == "fakenfs":
3159
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3160
 
            return FakeNFSServer
 
3504
            from bzrlib.tests import test_server
 
3505
            return test_server.FakeNFSServer
3161
3506
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3162
3507
            (typestring)
3163
3508
        raise errors.BzrCommandError(msg)
3174
3519
                                 'throughout the test suite.',
3175
3520
                            type=get_transport_type),
3176
3521
                     Option('benchmark',
3177
 
                            help='Run the benchmarks rather than selftests.'),
 
3522
                            help='Run the benchmarks rather than selftests.',
 
3523
                            hidden=True),
3178
3524
                     Option('lsprof-timed',
3179
3525
                            help='Generate lsprof output for benchmarked'
3180
3526
                                 ' sections of code.'),
3181
 
                     Option('cache-dir', type=str,
3182
 
                            help='Cache intermediate benchmark output in this '
3183
 
                                 'directory.'),
 
3527
                     Option('lsprof-tests',
 
3528
                            help='Generate lsprof output for each test.'),
3184
3529
                     Option('first',
3185
3530
                            help='Run all tests, but run specified tests first.',
3186
3531
                            short_name='f',
3187
3532
                            ),
3188
3533
                     Option('list-only',
3189
3534
                            help='List the tests instead of running them.'),
 
3535
                     RegistryOption('parallel',
 
3536
                        help="Run the test suite in parallel.",
 
3537
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3538
                        value_switches=False,
 
3539
                        ),
3190
3540
                     Option('randomize', type=str, argname="SEED",
3191
3541
                            help='Randomize the order of tests using the given'
3192
3542
                                 ' seed or "now" for the current time.'),
3215
3565
 
3216
3566
    def run(self, testspecs_list=None, verbose=False, one=False,
3217
3567
            transport=None, benchmark=None,
3218
 
            lsprof_timed=None, cache_dir=None,
 
3568
            lsprof_timed=None,
3219
3569
            first=False, list_only=False,
3220
3570
            randomize=None, exclude=None, strict=False,
3221
 
            load_list=None, debugflag=None, starting_with=None, subunit=False):
 
3571
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3572
            parallel=None, lsprof_tests=False):
3222
3573
        from bzrlib.tests import selftest
3223
 
        import bzrlib.benchmarks as benchmarks
3224
 
        from bzrlib.benchmarks import tree_creator
3225
3574
 
3226
3575
        # Make deprecation warnings visible, unless -Werror is set
3227
3576
        symbol_versioning.activate_deprecation_warnings(override=False)
3228
3577
 
3229
 
        if cache_dir is not None:
3230
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
3231
 
        if not list_only:
3232
 
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
3233
 
            print '   %s (%s python%s)' % (
3234
 
                    bzrlib.__path__[0],
3235
 
                    bzrlib.version_string,
3236
 
                    bzrlib._format_version_tuple(sys.version_info),
3237
 
                    )
3238
 
        print
3239
3578
        if testspecs_list is not None:
3240
3579
            pattern = '|'.join(testspecs_list)
3241
3580
        else:
3247
3586
                raise errors.BzrCommandError("subunit not available. subunit "
3248
3587
                    "needs to be installed to use --subunit.")
3249
3588
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3589
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3590
            # stdout, which would corrupt the subunit stream. 
 
3591
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
3592
            # following code can be deleted when it's sufficiently deployed
 
3593
            # -- vila/mgz 20100514
 
3594
            if (sys.platform == "win32"
 
3595
                and getattr(sys.stdout, 'fileno', None) is not None):
 
3596
                import msvcrt
 
3597
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
3598
        if parallel:
 
3599
            self.additional_selftest_args.setdefault(
 
3600
                'suite_decorators', []).append(parallel)
3250
3601
        if benchmark:
3251
 
            test_suite_factory = benchmarks.test_suite
3252
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3253
 
            verbose = not is_quiet()
3254
 
            # TODO: should possibly lock the history file...
3255
 
            benchfile = open(".perf_history", "at", buffering=1)
3256
 
        else:
3257
 
            test_suite_factory = None
3258
 
            benchfile = None
3259
 
        try:
3260
 
            selftest_kwargs = {"verbose": verbose,
3261
 
                              "pattern": pattern,
3262
 
                              "stop_on_failure": one,
3263
 
                              "transport": transport,
3264
 
                              "test_suite_factory": test_suite_factory,
3265
 
                              "lsprof_timed": lsprof_timed,
3266
 
                              "bench_history": benchfile,
3267
 
                              "matching_tests_first": first,
3268
 
                              "list_only": list_only,
3269
 
                              "random_seed": randomize,
3270
 
                              "exclude_pattern": exclude,
3271
 
                              "strict": strict,
3272
 
                              "load_list": load_list,
3273
 
                              "debug_flags": debugflag,
3274
 
                              "starting_with": starting_with
3275
 
                              }
3276
 
            selftest_kwargs.update(self.additional_selftest_args)
3277
 
            result = selftest(**selftest_kwargs)
3278
 
        finally:
3279
 
            if benchfile is not None:
3280
 
                benchfile.close()
3281
 
        if result:
3282
 
            note('tests passed')
3283
 
        else:
3284
 
            note('tests failed')
 
3602
            raise errors.BzrCommandError(
 
3603
                "--benchmark is no longer supported from bzr 2.2; "
 
3604
                "use bzr-usertest instead")
 
3605
        test_suite_factory = None
 
3606
        selftest_kwargs = {"verbose": verbose,
 
3607
                          "pattern": pattern,
 
3608
                          "stop_on_failure": one,
 
3609
                          "transport": transport,
 
3610
                          "test_suite_factory": test_suite_factory,
 
3611
                          "lsprof_timed": lsprof_timed,
 
3612
                          "lsprof_tests": lsprof_tests,
 
3613
                          "matching_tests_first": first,
 
3614
                          "list_only": list_only,
 
3615
                          "random_seed": randomize,
 
3616
                          "exclude_pattern": exclude,
 
3617
                          "strict": strict,
 
3618
                          "load_list": load_list,
 
3619
                          "debug_flags": debugflag,
 
3620
                          "starting_with": starting_with
 
3621
                          }
 
3622
        selftest_kwargs.update(self.additional_selftest_args)
 
3623
        result = selftest(**selftest_kwargs)
3285
3624
        return int(not result)
3286
3625
 
3287
3626
 
3288
3627
class cmd_version(Command):
3289
 
    """Show version of bzr."""
 
3628
    __doc__ = """Show version of bzr."""
3290
3629
 
3291
3630
    encoding_type = 'replace'
3292
3631
    takes_options = [
3303
3642
 
3304
3643
 
3305
3644
class cmd_rocks(Command):
3306
 
    """Statement of optimism."""
 
3645
    __doc__ = """Statement of optimism."""
3307
3646
 
3308
3647
    hidden = True
3309
3648
 
3310
3649
    @display_command
3311
3650
    def run(self):
3312
 
        print "It sure does!"
 
3651
        self.outf.write("It sure does!\n")
3313
3652
 
3314
3653
 
3315
3654
class cmd_find_merge_base(Command):
3316
 
    """Find and print a base revision for merging two branches."""
 
3655
    __doc__ = """Find and print a base revision for merging two branches."""
3317
3656
    # TODO: Options to specify revisions on either side, as if
3318
3657
    #       merging only part of the history.
3319
3658
    takes_args = ['branch', 'other']
3325
3664
 
3326
3665
        branch1 = Branch.open_containing(branch)[0]
3327
3666
        branch2 = Branch.open_containing(other)[0]
3328
 
        branch1.lock_read()
3329
 
        try:
3330
 
            branch2.lock_read()
3331
 
            try:
3332
 
                last1 = ensure_null(branch1.last_revision())
3333
 
                last2 = ensure_null(branch2.last_revision())
3334
 
 
3335
 
                graph = branch1.repository.get_graph(branch2.repository)
3336
 
                base_rev_id = graph.find_unique_lca(last1, last2)
3337
 
 
3338
 
                print 'merge base is revision %s' % base_rev_id
3339
 
            finally:
3340
 
                branch2.unlock()
3341
 
        finally:
3342
 
            branch1.unlock()
 
3667
        self.add_cleanup(branch1.lock_read().unlock)
 
3668
        self.add_cleanup(branch2.lock_read().unlock)
 
3669
        last1 = ensure_null(branch1.last_revision())
 
3670
        last2 = ensure_null(branch2.last_revision())
 
3671
 
 
3672
        graph = branch1.repository.get_graph(branch2.repository)
 
3673
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3674
 
 
3675
        self.outf.write('merge base is revision %s\n' % base_rev_id)
3343
3676
 
3344
3677
 
3345
3678
class cmd_merge(Command):
3346
 
    """Perform a three-way merge.
 
3679
    __doc__ = """Perform a three-way merge.
3347
3680
 
3348
3681
    The source of the merge can be specified either in the form of a branch,
3349
3682
    or in the form of a path to a file containing a merge directive generated
3378
3711
    committed to record the result of the merge.
3379
3712
 
3380
3713
    merge refuses to run if there are any uncommitted changes, unless
3381
 
    --force is given.
 
3714
    --force is given. The --force option can also be used to create a
 
3715
    merge revision which has more than two parents.
 
3716
 
 
3717
    If one would like to merge changes from the working tree of the other
 
3718
    branch without merging any committed revisions, the --uncommitted option
 
3719
    can be given.
 
3720
 
 
3721
    To select only some changes to merge, use "merge -i", which will prompt
 
3722
    you to apply each diff hunk and file change, similar to "shelve".
3382
3723
 
3383
3724
    :Examples:
3384
3725
        To merge the latest revision from bzr.dev::
3393
3734
 
3394
3735
            bzr merge -r 81..82 ../bzr.dev
3395
3736
 
3396
 
        To apply a merge directive contained in in /tmp/merge:
 
3737
        To apply a merge directive contained in /tmp/merge::
3397
3738
 
3398
3739
            bzr merge /tmp/merge
 
3740
 
 
3741
        To create a merge revision with three parents from two branches
 
3742
        feature1a and feature1b:
 
3743
 
 
3744
            bzr merge ../feature1a
 
3745
            bzr merge ../feature1b --force
 
3746
            bzr commit -m 'revision with three parents'
3399
3747
    """
3400
3748
 
3401
3749
    encoding_type = 'exact'
3417
3765
                ' completely merged into the source, pull from the'
3418
3766
                ' source rather than merging.  When this happens,'
3419
3767
                ' you do not need to commit the result.'),
3420
 
        Option('directory',
 
3768
        custom_help('directory',
3421
3769
               help='Branch to merge into, '
3422
 
                    'rather than the one containing the working directory.',
3423
 
               short_name='d',
3424
 
               type=unicode,
3425
 
               ),
3426
 
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3770
                    'rather than the one containing the working directory.'),
 
3771
        Option('preview', help='Instead of merging, show a diff of the'
 
3772
               ' merge.'),
 
3773
        Option('interactive', help='Select changes interactively.',
 
3774
            short_name='i')
3427
3775
    ]
3428
3776
 
3429
3777
    def run(self, location=None, revision=None, force=False,
3431
3779
            uncommitted=False, pull=False,
3432
3780
            directory=None,
3433
3781
            preview=False,
 
3782
            interactive=False,
3434
3783
            ):
3435
3784
        if merge_type is None:
3436
3785
            merge_type = _mod_merge.Merge3Merger
3442
3791
        verified = 'inapplicable'
3443
3792
        tree = WorkingTree.open_containing(directory)[0]
3444
3793
 
3445
 
        # die as quickly as possible if there are uncommitted changes
3446
3794
        try:
3447
3795
            basis_tree = tree.revision_tree(tree.last_revision())
3448
3796
        except errors.NoSuchRevision:
3449
3797
            basis_tree = tree.basis_tree()
 
3798
 
 
3799
        # die as quickly as possible if there are uncommitted changes
3450
3800
        if not force:
3451
 
            changes = tree.changes_from(basis_tree)
3452
 
            if changes.has_changed():
 
3801
            if tree.has_changes():
3453
3802
                raise errors.UncommittedChanges(tree)
3454
3803
 
3455
3804
        view_info = _get_view_info_for_change_reporter(tree)
3456
3805
        change_reporter = delta._ChangeReporter(
3457
3806
            unversioned_filter=tree.is_ignored, view_info=view_info)
3458
 
        cleanups = []
3459
 
        try:
3460
 
            pb = ui.ui_factory.nested_progress_bar()
3461
 
            cleanups.append(pb.finished)
3462
 
            tree.lock_write()
3463
 
            cleanups.append(tree.unlock)
3464
 
            if location is not None:
3465
 
                try:
3466
 
                    mergeable = bundle.read_mergeable_from_url(location,
3467
 
                        possible_transports=possible_transports)
3468
 
                except errors.NotABundle:
3469
 
                    mergeable = None
3470
 
                else:
3471
 
                    if uncommitted:
3472
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3473
 
                            ' with bundles or merge directives.')
3474
 
 
3475
 
                    if revision is not None:
3476
 
                        raise errors.BzrCommandError(
3477
 
                            'Cannot use -r with merge directives or bundles')
3478
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3479
 
                       mergeable, pb)
3480
 
 
3481
 
            if merger is None and uncommitted:
3482
 
                if revision is not None and len(revision) > 0:
3483
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3484
 
                        ' --revision at the same time.')
3485
 
                location = self._select_branch_location(tree, location)[0]
3486
 
                other_tree, other_path = WorkingTree.open_containing(location)
3487
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3488
 
                    pb)
3489
 
                allow_pending = False
3490
 
                if other_path != '':
3491
 
                    merger.interesting_files = [other_path]
3492
 
 
3493
 
            if merger is None:
3494
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3495
 
                    location, revision, remember, possible_transports, pb)
3496
 
 
3497
 
            merger.merge_type = merge_type
3498
 
            merger.reprocess = reprocess
3499
 
            merger.show_base = show_base
3500
 
            self.sanity_check_merger(merger)
3501
 
            if (merger.base_rev_id == merger.other_rev_id and
3502
 
                merger.other_rev_id is not None):
3503
 
                note('Nothing to do.')
 
3807
        pb = ui.ui_factory.nested_progress_bar()
 
3808
        self.add_cleanup(pb.finished)
 
3809
        self.add_cleanup(tree.lock_write().unlock)
 
3810
        if location is not None:
 
3811
            try:
 
3812
                mergeable = bundle.read_mergeable_from_url(location,
 
3813
                    possible_transports=possible_transports)
 
3814
            except errors.NotABundle:
 
3815
                mergeable = None
 
3816
            else:
 
3817
                if uncommitted:
 
3818
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3819
                        ' with bundles or merge directives.')
 
3820
 
 
3821
                if revision is not None:
 
3822
                    raise errors.BzrCommandError(
 
3823
                        'Cannot use -r with merge directives or bundles')
 
3824
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3825
                   mergeable, None)
 
3826
 
 
3827
        if merger is None and uncommitted:
 
3828
            if revision is not None and len(revision) > 0:
 
3829
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3830
                    ' --revision at the same time.')
 
3831
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3832
            allow_pending = False
 
3833
 
 
3834
        if merger is None:
 
3835
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3836
                location, revision, remember, possible_transports, None)
 
3837
 
 
3838
        merger.merge_type = merge_type
 
3839
        merger.reprocess = reprocess
 
3840
        merger.show_base = show_base
 
3841
        self.sanity_check_merger(merger)
 
3842
        if (merger.base_rev_id == merger.other_rev_id and
 
3843
            merger.other_rev_id is not None):
 
3844
            note('Nothing to do.')
 
3845
            return 0
 
3846
        if pull:
 
3847
            if merger.interesting_files is not None:
 
3848
                raise errors.BzrCommandError('Cannot pull individual files')
 
3849
            if (merger.base_rev_id == tree.last_revision()):
 
3850
                result = tree.pull(merger.other_branch, False,
 
3851
                                   merger.other_rev_id)
 
3852
                result.report(self.outf)
3504
3853
                return 0
3505
 
            if pull:
3506
 
                if merger.interesting_files is not None:
3507
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3508
 
                if (merger.base_rev_id == tree.last_revision()):
3509
 
                    result = tree.pull(merger.other_branch, False,
3510
 
                                       merger.other_rev_id)
3511
 
                    result.report(self.outf)
3512
 
                    return 0
3513
 
            merger.check_basis(False)
3514
 
            if preview:
3515
 
                return self._do_preview(merger)
3516
 
            else:
3517
 
                return self._do_merge(merger, change_reporter, allow_pending,
3518
 
                                      verified)
3519
 
        finally:
3520
 
            for cleanup in reversed(cleanups):
3521
 
                cleanup()
 
3854
        if merger.this_basis is None:
 
3855
            raise errors.BzrCommandError(
 
3856
                "This branch has no commits."
 
3857
                " (perhaps you would prefer 'bzr pull')")
 
3858
        if preview:
 
3859
            return self._do_preview(merger)
 
3860
        elif interactive:
 
3861
            return self._do_interactive(merger)
 
3862
        else:
 
3863
            return self._do_merge(merger, change_reporter, allow_pending,
 
3864
                                  verified)
 
3865
 
 
3866
    def _get_preview(self, merger):
 
3867
        tree_merger = merger.make_merger()
 
3868
        tt = tree_merger.make_preview_transform()
 
3869
        self.add_cleanup(tt.finalize)
 
3870
        result_tree = tt.get_preview_tree()
 
3871
        return result_tree
3522
3872
 
3523
3873
    def _do_preview(self, merger):
3524
3874
        from bzrlib.diff import show_diff_trees
3525
 
        tree_merger = merger.make_merger()
3526
 
        tt = tree_merger.make_preview_transform()
3527
 
        try:
3528
 
            result_tree = tt.get_preview_tree()
3529
 
            show_diff_trees(merger.this_tree, result_tree, self.outf,
3530
 
                            old_label='', new_label='')
3531
 
        finally:
3532
 
            tt.finalize()
 
3875
        result_tree = self._get_preview(merger)
 
3876
        path_encoding = osutils.get_diff_header_encoding()
 
3877
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3878
                        old_label='', new_label='',
 
3879
                        path_encoding=path_encoding)
3533
3880
 
3534
3881
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3535
3882
        merger.change_reporter = change_reporter
3543
3890
        else:
3544
3891
            return 0
3545
3892
 
 
3893
    def _do_interactive(self, merger):
 
3894
        """Perform an interactive merge.
 
3895
 
 
3896
        This works by generating a preview tree of the merge, then using
 
3897
        Shelver to selectively remove the differences between the working tree
 
3898
        and the preview tree.
 
3899
        """
 
3900
        from bzrlib import shelf_ui
 
3901
        result_tree = self._get_preview(merger)
 
3902
        writer = bzrlib.option.diff_writer_registry.get()
 
3903
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3904
                                   reporter=shelf_ui.ApplyReporter(),
 
3905
                                   diff_writer=writer(sys.stdout))
 
3906
        try:
 
3907
            shelver.run()
 
3908
        finally:
 
3909
            shelver.finalize()
 
3910
 
3546
3911
    def sanity_check_merger(self, merger):
3547
3912
        if (merger.show_base and
3548
3913
            not merger.merge_type is _mod_merge.Merge3Merger):
3583
3948
            base_branch, base_path = Branch.open_containing(base_loc,
3584
3949
                possible_transports)
3585
3950
        # Find the revision ids
3586
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3951
        other_revision_id = None
 
3952
        base_revision_id = None
 
3953
        if revision is not None:
 
3954
            if len(revision) >= 1:
 
3955
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3956
            if len(revision) == 2:
 
3957
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3958
        if other_revision_id is None:
3587
3959
            other_revision_id = _mod_revision.ensure_null(
3588
3960
                other_branch.last_revision())
3589
 
        else:
3590
 
            other_revision_id = revision[-1].as_revision_id(other_branch)
3591
 
        if (revision is not None and len(revision) == 2
3592
 
            and revision[0] is not None):
3593
 
            base_revision_id = revision[0].as_revision_id(base_branch)
3594
 
        else:
3595
 
            base_revision_id = None
3596
3961
        # Remember where we merge from
3597
3962
        if ((remember or tree.branch.get_submit_branch() is None) and
3598
3963
             user_location is not None):
3607
3972
            allow_pending = True
3608
3973
        return merger, allow_pending
3609
3974
 
 
3975
    def get_merger_from_uncommitted(self, tree, location, pb):
 
3976
        """Get a merger for uncommitted changes.
 
3977
 
 
3978
        :param tree: The tree the merger should apply to.
 
3979
        :param location: The location containing uncommitted changes.
 
3980
        :param pb: The progress bar to use for showing progress.
 
3981
        """
 
3982
        location = self._select_branch_location(tree, location)[0]
 
3983
        other_tree, other_path = WorkingTree.open_containing(location)
 
3984
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
3985
        if other_path != '':
 
3986
            merger.interesting_files = [other_path]
 
3987
        return merger
 
3988
 
3610
3989
    def _select_branch_location(self, tree, user_location, revision=None,
3611
3990
                                index=None):
3612
3991
        """Select a branch location, according to possible inputs.
3656
4035
 
3657
4036
 
3658
4037
class cmd_remerge(Command):
3659
 
    """Redo a merge.
 
4038
    __doc__ = """Redo a merge.
3660
4039
 
3661
4040
    Use this if you want to try a different merge technique while resolving
3662
4041
    conflicts.  Some merge techniques are better than others, and remerge
3687
4066
 
3688
4067
    def run(self, file_list=None, merge_type=None, show_base=False,
3689
4068
            reprocess=False):
 
4069
        from bzrlib.conflicts import restore
3690
4070
        if merge_type is None:
3691
4071
            merge_type = _mod_merge.Merge3Merger
3692
 
        tree, file_list = tree_files(file_list)
3693
 
        tree.lock_write()
3694
 
        try:
3695
 
            parents = tree.get_parent_ids()
3696
 
            if len(parents) != 2:
3697
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3698
 
                                             " merges.  Not cherrypicking or"
3699
 
                                             " multi-merges.")
3700
 
            repository = tree.branch.repository
3701
 
            interesting_ids = None
3702
 
            new_conflicts = []
3703
 
            conflicts = tree.conflicts()
3704
 
            if file_list is not None:
3705
 
                interesting_ids = set()
3706
 
                for filename in file_list:
3707
 
                    file_id = tree.path2id(filename)
3708
 
                    if file_id is None:
3709
 
                        raise errors.NotVersionedError(filename)
3710
 
                    interesting_ids.add(file_id)
3711
 
                    if tree.kind(file_id) != "directory":
3712
 
                        continue
 
4072
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4073
        self.add_cleanup(tree.lock_write().unlock)
 
4074
        parents = tree.get_parent_ids()
 
4075
        if len(parents) != 2:
 
4076
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4077
                                         " merges.  Not cherrypicking or"
 
4078
                                         " multi-merges.")
 
4079
        repository = tree.branch.repository
 
4080
        interesting_ids = None
 
4081
        new_conflicts = []
 
4082
        conflicts = tree.conflicts()
 
4083
        if file_list is not None:
 
4084
            interesting_ids = set()
 
4085
            for filename in file_list:
 
4086
                file_id = tree.path2id(filename)
 
4087
                if file_id is None:
 
4088
                    raise errors.NotVersionedError(filename)
 
4089
                interesting_ids.add(file_id)
 
4090
                if tree.kind(file_id) != "directory":
 
4091
                    continue
3713
4092
 
3714
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3715
 
                        interesting_ids.add(ie.file_id)
3716
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3717
 
            else:
3718
 
                # Remerge only supports resolving contents conflicts
3719
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3720
 
                restore_files = [c.path for c in conflicts
3721
 
                                 if c.typestring in allowed_conflicts]
3722
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3723
 
            tree.set_conflicts(ConflictList(new_conflicts))
3724
 
            if file_list is not None:
3725
 
                restore_files = file_list
3726
 
            for filename in restore_files:
3727
 
                try:
3728
 
                    restore(tree.abspath(filename))
3729
 
                except errors.NotConflicted:
3730
 
                    pass
3731
 
            # Disable pending merges, because the file texts we are remerging
3732
 
            # have not had those merges performed.  If we use the wrong parents
3733
 
            # list, we imply that the working tree text has seen and rejected
3734
 
            # all the changes from the other tree, when in fact those changes
3735
 
            # have not yet been seen.
3736
 
            pb = ui.ui_factory.nested_progress_bar()
3737
 
            tree.set_parent_ids(parents[:1])
 
4093
                for name, ie in tree.inventory.iter_entries(file_id):
 
4094
                    interesting_ids.add(ie.file_id)
 
4095
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4096
        else:
 
4097
            # Remerge only supports resolving contents conflicts
 
4098
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4099
            restore_files = [c.path for c in conflicts
 
4100
                             if c.typestring in allowed_conflicts]
 
4101
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4102
        tree.set_conflicts(ConflictList(new_conflicts))
 
4103
        if file_list is not None:
 
4104
            restore_files = file_list
 
4105
        for filename in restore_files:
3738
4106
            try:
3739
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3740
 
                                                             tree, parents[1])
3741
 
                merger.interesting_ids = interesting_ids
3742
 
                merger.merge_type = merge_type
3743
 
                merger.show_base = show_base
3744
 
                merger.reprocess = reprocess
3745
 
                conflicts = merger.do_merge()
3746
 
            finally:
3747
 
                tree.set_parent_ids(parents)
3748
 
                pb.finished()
 
4107
                restore(tree.abspath(filename))
 
4108
            except errors.NotConflicted:
 
4109
                pass
 
4110
        # Disable pending merges, because the file texts we are remerging
 
4111
        # have not had those merges performed.  If we use the wrong parents
 
4112
        # list, we imply that the working tree text has seen and rejected
 
4113
        # all the changes from the other tree, when in fact those changes
 
4114
        # have not yet been seen.
 
4115
        tree.set_parent_ids(parents[:1])
 
4116
        try:
 
4117
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4118
            merger.interesting_ids = interesting_ids
 
4119
            merger.merge_type = merge_type
 
4120
            merger.show_base = show_base
 
4121
            merger.reprocess = reprocess
 
4122
            conflicts = merger.do_merge()
3749
4123
        finally:
3750
 
            tree.unlock()
 
4124
            tree.set_parent_ids(parents)
3751
4125
        if conflicts > 0:
3752
4126
            return 1
3753
4127
        else:
3755
4129
 
3756
4130
 
3757
4131
class cmd_revert(Command):
3758
 
    """Revert files to a previous revision.
 
4132
    __doc__ = """Revert files to a previous revision.
3759
4133
 
3760
4134
    Giving a list of files will revert only those files.  Otherwise, all files
3761
4135
    will be reverted.  If the revision is not specified with '--revision', the
3775
4149
    name.  If you name a directory, all the contents of that directory will be
3776
4150
    reverted.
3777
4151
 
3778
 
    Any files that have been newly added since that revision will be deleted,
3779
 
    with a backup kept if appropriate.  Directories containing unknown files
3780
 
    will not be deleted.
 
4152
    If you have newly added files since the target revision, they will be
 
4153
    removed.  If the files to be removed have been changed, backups will be
 
4154
    created as above.  Directories containing unknown files will not be
 
4155
    deleted.
3781
4156
 
3782
 
    The working tree contains a list of pending merged revisions, which will
3783
 
    be included as parents in the next commit.  Normally, revert clears that
3784
 
    list as well as reverting the files.  If any files are specified, revert
3785
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
3786
 
    revert ." in the tree root to revert all files but keep the merge record,
3787
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4157
    The working tree contains a list of revisions that have been merged but
 
4158
    not yet committed. These revisions will be included as additional parents
 
4159
    of the next commit.  Normally, using revert clears that list as well as
 
4160
    reverting the files.  If any files are specified, revert leaves the list
 
4161
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4162
    .`` in the tree root to revert all files but keep the recorded merges,
 
4163
    and ``bzr revert --forget-merges`` to clear the pending merge list without
3788
4164
    reverting any files.
 
4165
 
 
4166
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4167
    changes from a branch in a single revision.  To do this, perform the merge
 
4168
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4169
    the content of the tree as it was, but it will clear the list of pending
 
4170
    merges.  The next commit will then contain all of the changes that are
 
4171
    present in the other branch, but without any other parent revisions.
 
4172
    Because this technique forgets where these changes originated, it may
 
4173
    cause additional conflicts on later merges involving the same source and
 
4174
    target branches.
3789
4175
    """
3790
4176
 
3791
4177
    _see_also = ['cat', 'export']
3799
4185
 
3800
4186
    def run(self, revision=None, no_backup=False, file_list=None,
3801
4187
            forget_merges=None):
3802
 
        tree, file_list = tree_files(file_list)
3803
 
        tree.lock_write()
3804
 
        try:
3805
 
            if forget_merges:
3806
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
3807
 
            else:
3808
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3809
 
        finally:
3810
 
            tree.unlock()
 
4188
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4189
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4190
        if forget_merges:
 
4191
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4192
        else:
 
4193
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3811
4194
 
3812
4195
    @staticmethod
3813
4196
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3814
4197
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3815
 
        pb = ui.ui_factory.nested_progress_bar()
3816
 
        try:
3817
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
3818
 
                report_changes=True)
3819
 
        finally:
3820
 
            pb.finished()
 
4198
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4199
            report_changes=True)
3821
4200
 
3822
4201
 
3823
4202
class cmd_assert_fail(Command):
3824
 
    """Test reporting of assertion failures"""
 
4203
    __doc__ = """Test reporting of assertion failures"""
3825
4204
    # intended just for use in testing
3826
4205
 
3827
4206
    hidden = True
3831
4210
 
3832
4211
 
3833
4212
class cmd_help(Command):
3834
 
    """Show help on a command or other topic.
 
4213
    __doc__ = """Show help on a command or other topic.
3835
4214
    """
3836
4215
 
3837
4216
    _see_also = ['topics']
3850
4229
 
3851
4230
 
3852
4231
class cmd_shell_complete(Command):
3853
 
    """Show appropriate completions for context.
 
4232
    __doc__ = """Show appropriate completions for context.
3854
4233
 
3855
4234
    For a list of all available commands, say 'bzr shell-complete'.
3856
4235
    """
3865
4244
 
3866
4245
 
3867
4246
class cmd_missing(Command):
3868
 
    """Show unmerged/unpulled revisions between two branches.
 
4247
    __doc__ = """Show unmerged/unpulled revisions between two branches.
3869
4248
 
3870
4249
    OTHER_BRANCH may be local or remote.
3871
4250
 
3872
4251
    To filter on a range of revisions, you can use the command -r begin..end
3873
4252
    -r revision requests a specific revision, -r ..end or -r begin.. are
3874
4253
    also valid.
 
4254
            
 
4255
    :Exit values:
 
4256
        1 - some missing revisions
 
4257
        0 - no missing revisions
3875
4258
 
3876
4259
    :Examples:
3877
4260
 
3898
4281
    _see_also = ['merge', 'pull']
3899
4282
    takes_args = ['other_branch?']
3900
4283
    takes_options = [
 
4284
        'directory',
3901
4285
        Option('reverse', 'Reverse the order of revisions.'),
3902
4286
        Option('mine-only',
3903
4287
               'Display changes in the local branch only.'),
3915
4299
            type=_parse_revision_str,
3916
4300
            help='Filter on local branch revisions (inclusive). '
3917
4301
                'See "help revisionspec" for details.'),
3918
 
        Option('include-merges', 'Show merged revisions.'),
 
4302
        Option('include-merges',
 
4303
               'Show all revisions in addition to the mainline ones.'),
3919
4304
        ]
3920
4305
    encoding_type = 'replace'
3921
4306
 
3924
4309
            theirs_only=False,
3925
4310
            log_format=None, long=False, short=False, line=False,
3926
4311
            show_ids=False, verbose=False, this=False, other=False,
3927
 
            include_merges=False, revision=None, my_revision=None):
 
4312
            include_merges=False, revision=None, my_revision=None,
 
4313
            directory=u'.'):
3928
4314
        from bzrlib.missing import find_unmerged, iter_log_revisions
3929
4315
        def message(s):
3930
4316
            if not is_quiet():
3943
4329
        elif theirs_only:
3944
4330
            restrict = 'remote'
3945
4331
 
3946
 
        local_branch = Branch.open_containing(u".")[0]
 
4332
        local_branch = Branch.open_containing(directory)[0]
 
4333
        self.add_cleanup(local_branch.lock_read().unlock)
 
4334
 
3947
4335
        parent = local_branch.get_parent()
3948
4336
        if other_branch is None:
3949
4337
            other_branch = parent
3958
4346
        remote_branch = Branch.open(other_branch)
3959
4347
        if remote_branch.base == local_branch.base:
3960
4348
            remote_branch = local_branch
 
4349
        else:
 
4350
            self.add_cleanup(remote_branch.lock_read().unlock)
3961
4351
 
3962
4352
        local_revid_range = _revision_range_to_revid_range(
3963
4353
            _get_revision_range(my_revision, local_branch,
3967
4357
            _get_revision_range(revision,
3968
4358
                remote_branch, self.name()))
3969
4359
 
3970
 
        local_branch.lock_read()
3971
 
        try:
3972
 
            remote_branch.lock_read()
3973
 
            try:
3974
 
                local_extra, remote_extra = find_unmerged(
3975
 
                    local_branch, remote_branch, restrict,
3976
 
                    backward=not reverse,
3977
 
                    include_merges=include_merges,
3978
 
                    local_revid_range=local_revid_range,
3979
 
                    remote_revid_range=remote_revid_range)
3980
 
 
3981
 
                if log_format is None:
3982
 
                    registry = log.log_formatter_registry
3983
 
                    log_format = registry.get_default(local_branch)
3984
 
                lf = log_format(to_file=self.outf,
3985
 
                                show_ids=show_ids,
3986
 
                                show_timezone='original')
3987
 
 
3988
 
                status_code = 0
3989
 
                if local_extra and not theirs_only:
3990
 
                    message("You have %d extra revision(s):\n" %
3991
 
                        len(local_extra))
3992
 
                    for revision in iter_log_revisions(local_extra,
3993
 
                                        local_branch.repository,
3994
 
                                        verbose):
3995
 
                        lf.log_revision(revision)
3996
 
                    printed_local = True
3997
 
                    status_code = 1
3998
 
                else:
3999
 
                    printed_local = False
4000
 
 
4001
 
                if remote_extra and not mine_only:
4002
 
                    if printed_local is True:
4003
 
                        message("\n\n\n")
4004
 
                    message("You are missing %d revision(s):\n" %
4005
 
                        len(remote_extra))
4006
 
                    for revision in iter_log_revisions(remote_extra,
4007
 
                                        remote_branch.repository,
4008
 
                                        verbose):
4009
 
                        lf.log_revision(revision)
4010
 
                    status_code = 1
4011
 
 
4012
 
                if mine_only and not local_extra:
4013
 
                    # We checked local, and found nothing extra
4014
 
                    message('This branch is up to date.\n')
4015
 
                elif theirs_only and not remote_extra:
4016
 
                    # We checked remote, and found nothing extra
4017
 
                    message('Other branch is up to date.\n')
4018
 
                elif not (mine_only or theirs_only or local_extra or
4019
 
                          remote_extra):
4020
 
                    # We checked both branches, and neither one had extra
4021
 
                    # revisions
4022
 
                    message("Branches are up to date.\n")
4023
 
            finally:
4024
 
                remote_branch.unlock()
4025
 
        finally:
4026
 
            local_branch.unlock()
 
4360
        local_extra, remote_extra = find_unmerged(
 
4361
            local_branch, remote_branch, restrict,
 
4362
            backward=not reverse,
 
4363
            include_merges=include_merges,
 
4364
            local_revid_range=local_revid_range,
 
4365
            remote_revid_range=remote_revid_range)
 
4366
 
 
4367
        if log_format is None:
 
4368
            registry = log.log_formatter_registry
 
4369
            log_format = registry.get_default(local_branch)
 
4370
        lf = log_format(to_file=self.outf,
 
4371
                        show_ids=show_ids,
 
4372
                        show_timezone='original')
 
4373
 
 
4374
        status_code = 0
 
4375
        if local_extra and not theirs_only:
 
4376
            message("You have %d extra revision(s):\n" %
 
4377
                len(local_extra))
 
4378
            for revision in iter_log_revisions(local_extra,
 
4379
                                local_branch.repository,
 
4380
                                verbose):
 
4381
                lf.log_revision(revision)
 
4382
            printed_local = True
 
4383
            status_code = 1
 
4384
        else:
 
4385
            printed_local = False
 
4386
 
 
4387
        if remote_extra and not mine_only:
 
4388
            if printed_local is True:
 
4389
                message("\n\n\n")
 
4390
            message("You are missing %d revision(s):\n" %
 
4391
                len(remote_extra))
 
4392
            for revision in iter_log_revisions(remote_extra,
 
4393
                                remote_branch.repository,
 
4394
                                verbose):
 
4395
                lf.log_revision(revision)
 
4396
            status_code = 1
 
4397
 
 
4398
        if mine_only and not local_extra:
 
4399
            # We checked local, and found nothing extra
 
4400
            message('This branch is up to date.\n')
 
4401
        elif theirs_only and not remote_extra:
 
4402
            # We checked remote, and found nothing extra
 
4403
            message('Other branch is up to date.\n')
 
4404
        elif not (mine_only or theirs_only or local_extra or
 
4405
                  remote_extra):
 
4406
            # We checked both branches, and neither one had extra
 
4407
            # revisions
 
4408
            message("Branches are up to date.\n")
 
4409
        self.cleanup_now()
4027
4410
        if not status_code and parent is None and other_branch is not None:
4028
 
            local_branch.lock_write()
4029
 
            try:
4030
 
                # handle race conditions - a parent might be set while we run.
4031
 
                if local_branch.get_parent() is None:
4032
 
                    local_branch.set_parent(remote_branch.base)
4033
 
            finally:
4034
 
                local_branch.unlock()
 
4411
            self.add_cleanup(local_branch.lock_write().unlock)
 
4412
            # handle race conditions - a parent might be set while we run.
 
4413
            if local_branch.get_parent() is None:
 
4414
                local_branch.set_parent(remote_branch.base)
4035
4415
        return status_code
4036
4416
 
4037
4417
 
4038
4418
class cmd_pack(Command):
4039
 
    """Compress the data within a repository."""
 
4419
    __doc__ = """Compress the data within a repository.
 
4420
 
 
4421
    This operation compresses the data within a bazaar repository. As
 
4422
    bazaar supports automatic packing of repository, this operation is
 
4423
    normally not required to be done manually.
 
4424
 
 
4425
    During the pack operation, bazaar takes a backup of existing repository
 
4426
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4427
    automatically when it is safe to do so. To save disk space by removing
 
4428
    the backed up pack files, the --clean-obsolete-packs option may be
 
4429
    used.
 
4430
 
 
4431
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4432
    during or immediately after repacking, you may be left with a state
 
4433
    where the deletion has been written to disk but the new packs have not
 
4434
    been. In this case the repository may be unusable.
 
4435
    """
4040
4436
 
4041
4437
    _see_also = ['repositories']
4042
4438
    takes_args = ['branch_or_repo?']
 
4439
    takes_options = [
 
4440
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4441
        ]
4043
4442
 
4044
 
    def run(self, branch_or_repo='.'):
 
4443
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
4045
4444
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4046
4445
        try:
4047
4446
            branch = dir.open_branch()
4048
4447
            repository = branch.repository
4049
4448
        except errors.NotBranchError:
4050
4449
            repository = dir.open_repository()
4051
 
        repository.pack()
 
4450
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4052
4451
 
4053
4452
 
4054
4453
class cmd_plugins(Command):
4055
 
    """List the installed plugins.
 
4454
    __doc__ = """List the installed plugins.
4056
4455
 
4057
4456
    This command displays the list of installed plugins including
4058
4457
    version of plugin and a short description of each.
4065
4464
    adding new commands, providing additional network transports and
4066
4465
    customizing log output.
4067
4466
 
4068
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4069
 
    information on plugins including where to find them and how to
4070
 
    install them. Instructions are also provided there on how to
4071
 
    write new plugins using the Python programming language.
 
4467
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4468
    for further information on plugins including where to find them and how to
 
4469
    install them. Instructions are also provided there on how to write new
 
4470
    plugins using the Python programming language.
4072
4471
    """
4073
4472
    takes_options = ['verbose']
4074
4473
 
4089
4488
                doc = '(no description)'
4090
4489
            result.append((name_ver, doc, plugin.path()))
4091
4490
        for name_ver, doc, path in sorted(result):
4092
 
            print name_ver
4093
 
            print '   ', doc
 
4491
            self.outf.write("%s\n" % name_ver)
 
4492
            self.outf.write("   %s\n" % doc)
4094
4493
            if verbose:
4095
 
                print '   ', path
4096
 
            print
 
4494
                self.outf.write("   %s\n" % path)
 
4495
            self.outf.write("\n")
4097
4496
 
4098
4497
 
4099
4498
class cmd_testament(Command):
4100
 
    """Show testament (signing-form) of a revision."""
 
4499
    __doc__ = """Show testament (signing-form) of a revision."""
4101
4500
    takes_options = [
4102
4501
            'revision',
4103
4502
            Option('long', help='Produce long-format testament.'),
4115
4514
            b = Branch.open_containing(branch)[0]
4116
4515
        else:
4117
4516
            b = Branch.open(branch)
4118
 
        b.lock_read()
4119
 
        try:
4120
 
            if revision is None:
4121
 
                rev_id = b.last_revision()
4122
 
            else:
4123
 
                rev_id = revision[0].as_revision_id(b)
4124
 
            t = testament_class.from_revision(b.repository, rev_id)
4125
 
            if long:
4126
 
                sys.stdout.writelines(t.as_text_lines())
4127
 
            else:
4128
 
                sys.stdout.write(t.as_short_text())
4129
 
        finally:
4130
 
            b.unlock()
 
4517
        self.add_cleanup(b.lock_read().unlock)
 
4518
        if revision is None:
 
4519
            rev_id = b.last_revision()
 
4520
        else:
 
4521
            rev_id = revision[0].as_revision_id(b)
 
4522
        t = testament_class.from_revision(b.repository, rev_id)
 
4523
        if long:
 
4524
            sys.stdout.writelines(t.as_text_lines())
 
4525
        else:
 
4526
            sys.stdout.write(t.as_short_text())
4131
4527
 
4132
4528
 
4133
4529
class cmd_annotate(Command):
4134
 
    """Show the origin of each line in a file.
 
4530
    __doc__ = """Show the origin of each line in a file.
4135
4531
 
4136
4532
    This prints out the given file with an annotation on the left side
4137
4533
    indicating which revision, author and date introduced the change.
4148
4544
                     Option('long', help='Show commit date in annotations.'),
4149
4545
                     'revision',
4150
4546
                     'show-ids',
 
4547
                     'directory',
4151
4548
                     ]
4152
4549
    encoding_type = 'exact'
4153
4550
 
4154
4551
    @display_command
4155
4552
    def run(self, filename, all=False, long=False, revision=None,
4156
 
            show_ids=False):
 
4553
            show_ids=False, directory=None):
4157
4554
        from bzrlib.annotate import annotate_file, annotate_file_tree
4158
4555
        wt, branch, relpath = \
4159
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4160
 
        if wt is not None:
4161
 
            wt.lock_read()
4162
 
        else:
4163
 
            branch.lock_read()
4164
 
        try:
4165
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
4166
 
            if wt is not None:
4167
 
                file_id = wt.path2id(relpath)
4168
 
            else:
4169
 
                file_id = tree.path2id(relpath)
4170
 
            if file_id is None:
4171
 
                raise errors.NotVersionedError(filename)
4172
 
            file_version = tree.inventory[file_id].revision
4173
 
            if wt is not None and revision is None:
4174
 
                # If there is a tree and we're not annotating historical
4175
 
                # versions, annotate the working tree's content.
4176
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
4177
 
                    show_ids=show_ids)
4178
 
            else:
4179
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
4180
 
                              show_ids=show_ids)
4181
 
        finally:
4182
 
            if wt is not None:
4183
 
                wt.unlock()
4184
 
            else:
4185
 
                branch.unlock()
 
4556
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
4557
        if wt is not None:
 
4558
            self.add_cleanup(wt.lock_read().unlock)
 
4559
        else:
 
4560
            self.add_cleanup(branch.lock_read().unlock)
 
4561
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4562
        self.add_cleanup(tree.lock_read().unlock)
 
4563
        if wt is not None:
 
4564
            file_id = wt.path2id(relpath)
 
4565
        else:
 
4566
            file_id = tree.path2id(relpath)
 
4567
        if file_id is None:
 
4568
            raise errors.NotVersionedError(filename)
 
4569
        file_version = tree.inventory[file_id].revision
 
4570
        if wt is not None and revision is None:
 
4571
            # If there is a tree and we're not annotating historical
 
4572
            # versions, annotate the working tree's content.
 
4573
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4574
                show_ids=show_ids)
 
4575
        else:
 
4576
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4577
                          show_ids=show_ids)
4186
4578
 
4187
4579
 
4188
4580
class cmd_re_sign(Command):
4189
 
    """Create a digital signature for an existing revision."""
 
4581
    __doc__ = """Create a digital signature for an existing revision."""
4190
4582
    # TODO be able to replace existing ones.
4191
4583
 
4192
4584
    hidden = True # is this right ?
4193
4585
    takes_args = ['revision_id*']
4194
 
    takes_options = ['revision']
 
4586
    takes_options = ['directory', 'revision']
4195
4587
 
4196
 
    def run(self, revision_id_list=None, revision=None):
 
4588
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4197
4589
        if revision_id_list is not None and revision is not None:
4198
4590
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4199
4591
        if revision_id_list is None and revision is None:
4200
4592
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4201
 
        b = WorkingTree.open_containing(u'.')[0].branch
4202
 
        b.lock_write()
4203
 
        try:
4204
 
            return self._run(b, revision_id_list, revision)
4205
 
        finally:
4206
 
            b.unlock()
 
4593
        b = WorkingTree.open_containing(directory)[0].branch
 
4594
        self.add_cleanup(b.lock_write().unlock)
 
4595
        return self._run(b, revision_id_list, revision)
4207
4596
 
4208
4597
    def _run(self, b, revision_id_list, revision):
4209
4598
        import bzrlib.gpg as gpg
4254
4643
 
4255
4644
 
4256
4645
class cmd_bind(Command):
4257
 
    """Convert the current branch into a checkout of the supplied branch.
 
4646
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4647
    If no branch is supplied, rebind to the last bound location.
4258
4648
 
4259
4649
    Once converted into a checkout, commits must succeed on the master branch
4260
4650
    before they will be applied to the local branch.
4261
4651
 
4262
4652
    Bound branches use the nickname of its master branch unless it is set
4263
 
    locally, in which case binding will update the the local nickname to be
 
4653
    locally, in which case binding will update the local nickname to be
4264
4654
    that of the master.
4265
4655
    """
4266
4656
 
4267
4657
    _see_also = ['checkouts', 'unbind']
4268
4658
    takes_args = ['location?']
4269
 
    takes_options = []
 
4659
    takes_options = ['directory']
4270
4660
 
4271
 
    def run(self, location=None):
4272
 
        b, relpath = Branch.open_containing(u'.')
 
4661
    def run(self, location=None, directory=u'.'):
 
4662
        b, relpath = Branch.open_containing(directory)
4273
4663
        if location is None:
4274
4664
            try:
4275
4665
                location = b.get_old_bound_location()
4278
4668
                    'This format does not remember old locations.')
4279
4669
            else:
4280
4670
                if location is None:
4281
 
                    raise errors.BzrCommandError('No location supplied and no '
4282
 
                        'previous location known')
 
4671
                    if b.get_bound_location() is not None:
 
4672
                        raise errors.BzrCommandError('Branch is already bound')
 
4673
                    else:
 
4674
                        raise errors.BzrCommandError('No location supplied '
 
4675
                            'and no previous location known')
4283
4676
        b_other = Branch.open(location)
4284
4677
        try:
4285
4678
            b.bind(b_other)
4291
4684
 
4292
4685
 
4293
4686
class cmd_unbind(Command):
4294
 
    """Convert the current checkout into a regular branch.
 
4687
    __doc__ = """Convert the current checkout into a regular branch.
4295
4688
 
4296
4689
    After unbinding, the local branch is considered independent and subsequent
4297
4690
    commits will be local only.
4299
4692
 
4300
4693
    _see_also = ['checkouts', 'bind']
4301
4694
    takes_args = []
4302
 
    takes_options = []
 
4695
    takes_options = ['directory']
4303
4696
 
4304
 
    def run(self):
4305
 
        b, relpath = Branch.open_containing(u'.')
 
4697
    def run(self, directory=u'.'):
 
4698
        b, relpath = Branch.open_containing(directory)
4306
4699
        if not b.unbind():
4307
4700
            raise errors.BzrCommandError('Local branch is not bound')
4308
4701
 
4309
4702
 
4310
4703
class cmd_uncommit(Command):
4311
 
    """Remove the last committed revision.
 
4704
    __doc__ = """Remove the last committed revision.
4312
4705
 
4313
4706
    --verbose will print out what is being removed.
4314
4707
    --dry-run will go through all the motions, but not actually
4354
4747
            b = control.open_branch()
4355
4748
 
4356
4749
        if tree is not None:
4357
 
            tree.lock_write()
 
4750
            self.add_cleanup(tree.lock_write().unlock)
4358
4751
        else:
4359
 
            b.lock_write()
4360
 
        try:
4361
 
            return self._run(b, tree, dry_run, verbose, revision, force,
4362
 
                             local=local)
4363
 
        finally:
4364
 
            if tree is not None:
4365
 
                tree.unlock()
4366
 
            else:
4367
 
                b.unlock()
 
4752
            self.add_cleanup(b.lock_write().unlock)
 
4753
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
4368
4754
 
4369
4755
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4370
4756
        from bzrlib.log import log_formatter, show_log
4402
4788
                 end_revision=last_revno)
4403
4789
 
4404
4790
        if dry_run:
4405
 
            print 'Dry-run, pretending to remove the above revisions.'
4406
 
            if not force:
4407
 
                val = raw_input('Press <enter> to continue')
 
4791
            self.outf.write('Dry-run, pretending to remove'
 
4792
                            ' the above revisions.\n')
4408
4793
        else:
4409
 
            print 'The above revision(s) will be removed.'
4410
 
            if not force:
4411
 
                val = raw_input('Are you sure [y/N]? ')
4412
 
                if val.lower() not in ('y', 'yes'):
4413
 
                    print 'Canceled'
4414
 
                    return 0
 
4794
            self.outf.write('The above revision(s) will be removed.\n')
 
4795
 
 
4796
        if not force:
 
4797
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4798
                self.outf.write('Canceled')
 
4799
                return 0
4415
4800
 
4416
4801
        mutter('Uncommitting from {%s} to {%s}',
4417
4802
               last_rev_id, rev_id)
4418
4803
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4419
4804
                 revno=revno, local=local)
4420
 
        note('You can restore the old tip by running:\n'
4421
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4805
        self.outf.write('You can restore the old tip by running:\n'
 
4806
             '  bzr pull . -r revid:%s\n' % last_rev_id)
4422
4807
 
4423
4808
 
4424
4809
class cmd_break_lock(Command):
4425
 
    """Break a dead lock on a repository, branch or working directory.
 
4810
    __doc__ = """Break a dead lock on a repository, branch or working directory.
4426
4811
 
4427
4812
    CAUTION: Locks should only be broken when you are sure that the process
4428
4813
    holding the lock has been stopped.
4429
4814
 
4430
 
    You can get information on what locks are open via the 'bzr info' command.
 
4815
    You can get information on what locks are open via the 'bzr info
 
4816
    [location]' command.
4431
4817
 
4432
4818
    :Examples:
4433
4819
        bzr break-lock
 
4820
        bzr break-lock bzr+ssh://example.com/bzr/foo
4434
4821
    """
4435
4822
    takes_args = ['location?']
4436
4823
 
4445
4832
 
4446
4833
 
4447
4834
class cmd_wait_until_signalled(Command):
4448
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4835
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4449
4836
 
4450
4837
    This just prints a line to signal when it is ready, then blocks on stdin.
4451
4838
    """
4459
4846
 
4460
4847
 
4461
4848
class cmd_serve(Command):
4462
 
    """Run the bzr server."""
 
4849
    __doc__ = """Run the bzr server."""
4463
4850
 
4464
4851
    aliases = ['server']
4465
4852
 
4466
4853
    takes_options = [
4467
4854
        Option('inet',
4468
4855
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4856
        RegistryOption('protocol',
 
4857
               help="Protocol to serve.",
 
4858
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4859
               value_switches=True),
4469
4860
        Option('port',
4470
4861
               help='Listen for connections on nominated port of the form '
4471
4862
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4472
 
                    'result in a dynamically allocated port.  The default port is '
4473
 
                    '4155.',
 
4863
                    'result in a dynamically allocated port.  The default port '
 
4864
                    'depends on the protocol.',
4474
4865
               type=str),
4475
 
        Option('directory',
4476
 
               help='Serve contents of this directory.',
4477
 
               type=unicode),
 
4866
        custom_help('directory',
 
4867
               help='Serve contents of this directory.'),
4478
4868
        Option('allow-writes',
4479
4869
               help='By default the server is a readonly server.  Supplying '
4480
4870
                    '--allow-writes enables write access to the contents of '
4481
 
                    'the served directory and below.'
 
4871
                    'the served directory and below.  Note that ``bzr serve`` '
 
4872
                    'does not perform authentication, so unless some form of '
 
4873
                    'external authentication is arranged supplying this '
 
4874
                    'option leads to global uncontrolled write access to your '
 
4875
                    'file system.'
4482
4876
                ),
4483
4877
        ]
4484
4878
 
4485
 
    def run_smart_server(self, smart_server):
4486
 
        """Run 'smart_server' forever, with no UI output at all."""
4487
 
        # For the duration of this server, no UI output is permitted. note
4488
 
        # that this may cause problems with blackbox tests. This should be
4489
 
        # changed with care though, as we dont want to use bandwidth sending
4490
 
        # progress over stderr to smart server clients!
4491
 
        from bzrlib import lockdir
4492
 
        old_factory = ui.ui_factory
4493
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4494
 
        try:
4495
 
            ui.ui_factory = ui.SilentUIFactory()
4496
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4497
 
            smart_server.serve()
4498
 
        finally:
4499
 
            ui.ui_factory = old_factory
4500
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4501
 
 
4502
4879
    def get_host_and_port(self, port):
4503
4880
        """Return the host and port to run the smart server on.
4504
4881
 
4505
 
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
4506
 
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4882
        If 'port' is None, None will be returned for the host and port.
4507
4883
 
4508
4884
        If 'port' has a colon in it, the string before the colon will be
4509
4885
        interpreted as the host.
4512
4888
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4513
4889
            and port is an integer TCP/IP port.
4514
4890
        """
4515
 
        from bzrlib.smart import medium
4516
 
        host = medium.BZR_DEFAULT_INTERFACE
4517
 
        if port is None:
4518
 
            port = medium.BZR_DEFAULT_PORT
4519
 
        else:
 
4891
        host = None
 
4892
        if port is not None:
4520
4893
            if ':' in port:
4521
4894
                host, port = port.split(':')
4522
4895
            port = int(port)
4523
4896
        return host, port
4524
4897
 
4525
 
    def get_smart_server(self, transport, inet, port):
4526
 
        """Construct a smart server.
4527
 
 
4528
 
        :param transport: The base transport from which branches will be
4529
 
            served.
4530
 
        :param inet: If True, serve over stdin and stdout. Used for running
4531
 
            from inet.
4532
 
        :param port: The port to listen on. By default, it's `
4533
 
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
4534
 
            information.
4535
 
        :return: A smart server.
4536
 
        """
4537
 
        from bzrlib.smart import medium, server
4538
 
        if inet:
4539
 
            smart_server = medium.SmartServerPipeStreamMedium(
4540
 
                sys.stdin, sys.stdout, transport)
4541
 
        else:
4542
 
            host, port = self.get_host_and_port(port)
4543
 
            smart_server = server.SmartTCPServer(
4544
 
                transport, host=host, port=port)
4545
 
            note('listening on port: %s' % smart_server.port)
4546
 
        return smart_server
4547
 
 
4548
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
4549
 
        from bzrlib.transport import get_transport
4550
 
        from bzrlib.transport.chroot import ChrootServer
 
4898
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4899
            protocol=None):
 
4900
        from bzrlib import transport
4551
4901
        if directory is None:
4552
4902
            directory = os.getcwd()
 
4903
        if protocol is None:
 
4904
            protocol = transport.transport_server_registry.get()
 
4905
        host, port = self.get_host_and_port(port)
4553
4906
        url = urlutils.local_path_to_url(directory)
4554
4907
        if not allow_writes:
4555
4908
            url = 'readonly+' + url
4556
 
        chroot_server = ChrootServer(get_transport(url))
4557
 
        chroot_server.setUp()
4558
 
        t = get_transport(chroot_server.get_url())
4559
 
        smart_server = self.get_smart_server(t, inet, port)
4560
 
        self.run_smart_server(smart_server)
 
4909
        t = transport.get_transport(url)
 
4910
        protocol(t, host, port, inet)
4561
4911
 
4562
4912
 
4563
4913
class cmd_join(Command):
4564
 
    """Combine a subtree into its containing tree.
 
4914
    __doc__ = """Combine a tree into its containing tree.
4565
4915
 
4566
 
    This command is for experimental use only.  It requires the target tree
4567
 
    to be in dirstate-with-subtree format, which cannot be converted into
4568
 
    earlier formats.
 
4916
    This command requires the target tree to be in a rich-root format.
4569
4917
 
4570
4918
    The TREE argument should be an independent tree, inside another tree, but
4571
4919
    not part of it.  (Such trees can be produced by "bzr split", but also by
4574
4922
    The result is a combined tree, with the subtree no longer an independant
4575
4923
    part.  This is marked as a merge of the subtree into the containing tree,
4576
4924
    and all history is preserved.
4577
 
 
4578
 
    If --reference is specified, the subtree retains its independence.  It can
4579
 
    be branched by itself, and can be part of multiple projects at the same
4580
 
    time.  But operations performed in the containing tree, such as commit
4581
 
    and merge, will recurse into the subtree.
4582
4925
    """
4583
4926
 
4584
4927
    _see_also = ['split']
4585
4928
    takes_args = ['tree']
4586
4929
    takes_options = [
4587
 
            Option('reference', help='Join by reference.'),
 
4930
            Option('reference', help='Join by reference.', hidden=True),
4588
4931
            ]
4589
 
    hidden = True
4590
4932
 
4591
4933
    def run(self, tree, reference=False):
4592
4934
        sub_tree = WorkingTree.open(tree)
4615
4957
 
4616
4958
 
4617
4959
class cmd_split(Command):
4618
 
    """Split a subdirectory of a tree into a separate tree.
 
4960
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4619
4961
 
4620
4962
    This command will produce a target tree in a format that supports
4621
4963
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4626
4968
    branch.  Commits in the top-level tree will not apply to the new subtree.
4627
4969
    """
4628
4970
 
4629
 
    # join is not un-hidden yet
4630
 
    #_see_also = ['join']
 
4971
    _see_also = ['join']
4631
4972
    takes_args = ['tree']
4632
4973
 
4633
4974
    def run(self, tree):
4638
4979
        try:
4639
4980
            containing_tree.extract(sub_id)
4640
4981
        except errors.RootNotRich:
4641
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4982
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4642
4983
 
4643
4984
 
4644
4985
class cmd_merge_directive(Command):
4645
 
    """Generate a merge directive for auto-merge tools.
 
4986
    __doc__ = """Generate a merge directive for auto-merge tools.
4646
4987
 
4647
4988
    A directive requests a merge to be performed, and also provides all the
4648
4989
    information necessary to do so.  This means it must either include a
4665
5006
    _see_also = ['send']
4666
5007
 
4667
5008
    takes_options = [
 
5009
        'directory',
4668
5010
        RegistryOption.from_kwargs('patch-type',
4669
5011
            'The type of patch to include in the directive.',
4670
5012
            title='Patch type',
4683
5025
    encoding_type = 'exact'
4684
5026
 
4685
5027
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4686
 
            sign=False, revision=None, mail_to=None, message=None):
 
5028
            sign=False, revision=None, mail_to=None, message=None,
 
5029
            directory=u'.'):
4687
5030
        from bzrlib.revision import ensure_null, NULL_REVISION
4688
5031
        include_patch, include_bundle = {
4689
5032
            'plain': (False, False),
4690
5033
            'diff': (True, False),
4691
5034
            'bundle': (True, True),
4692
5035
            }[patch_type]
4693
 
        branch = Branch.open('.')
 
5036
        branch = Branch.open(directory)
4694
5037
        stored_submit_branch = branch.get_submit_branch()
4695
5038
        if submit_branch is None:
4696
5039
            submit_branch = stored_submit_branch
4741
5084
 
4742
5085
 
4743
5086
class cmd_send(Command):
4744
 
    """Mail or create a merge-directive for submitting changes.
 
5087
    __doc__ = """Mail or create a merge-directive for submitting changes.
4745
5088
 
4746
5089
    A merge directive provides many things needed for requesting merges:
4747
5090
 
4753
5096
      directly from the merge directive, without retrieving data from a
4754
5097
      branch.
4755
5098
 
4756
 
    If --no-bundle is specified, then public_branch is needed (and must be
4757
 
    up-to-date), so that the receiver can perform the merge using the
4758
 
    public_branch.  The public_branch is always included if known, so that
4759
 
    people can check it later.
4760
 
 
4761
 
    The submit branch defaults to the parent, but can be overridden.  Both
4762
 
    submit branch and public branch will be remembered if supplied.
4763
 
 
4764
 
    If a public_branch is known for the submit_branch, that public submit
4765
 
    branch is used in the merge instructions.  This means that a local mirror
4766
 
    can be used as your actual submit branch, once you have set public_branch
4767
 
    for that mirror.
 
5099
    `bzr send` creates a compact data set that, when applied using bzr
 
5100
    merge, has the same effect as merging from the source branch.  
 
5101
    
 
5102
    By default the merge directive is self-contained and can be applied to any
 
5103
    branch containing submit_branch in its ancestory without needing access to
 
5104
    the source branch.
 
5105
    
 
5106
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5107
    revisions, but only a structured request to merge from the
 
5108
    public_location.  In that case the public_branch is needed and it must be
 
5109
    up-to-date and accessible to the recipient.  The public_branch is always
 
5110
    included if known, so that people can check it later.
 
5111
 
 
5112
    The submit branch defaults to the parent of the source branch, but can be
 
5113
    overridden.  Both submit branch and public branch will be remembered in
 
5114
    branch.conf the first time they are used for a particular branch.  The
 
5115
    source branch defaults to that containing the working directory, but can
 
5116
    be changed using --from.
 
5117
 
 
5118
    In order to calculate those changes, bzr must analyse the submit branch.
 
5119
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5120
    If a public location is known for the submit_branch, that location is used
 
5121
    in the merge directive.
 
5122
 
 
5123
    The default behaviour is to send the merge directive by mail, unless -o is
 
5124
    given, in which case it is sent to a file.
4768
5125
 
4769
5126
    Mail is sent using your preferred mail program.  This should be transparent
4770
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5127
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4771
5128
    If the preferred client can't be found (or used), your editor will be used.
4772
5129
 
4773
5130
    To use a specific mail program, set the mail_client configuration option.
4774
5131
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4775
 
    specific clients are "claws", "evolution", "kmail", "mutt", and
4776
 
    "thunderbird"; generic options are "default", "editor", "emacsclient",
4777
 
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
5132
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5133
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5134
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5135
    supported clients.
4778
5136
 
4779
5137
    If mail is being sent, a to address is required.  This can be supplied
4780
5138
    either on the commandline, by setting the submit_to configuration
4789
5147
 
4790
5148
    The merge directives created by bzr send may be applied using bzr merge or
4791
5149
    bzr pull by specifying a file containing a merge directive as the location.
 
5150
 
 
5151
    bzr send makes extensive use of public locations to map local locations into
 
5152
    URLs that can be used by other people.  See `bzr help configuration` to
 
5153
    set them, and use `bzr info` to display them.
4792
5154
    """
4793
5155
 
4794
5156
    encoding_type = 'exact'
4810
5172
               short_name='f',
4811
5173
               type=unicode),
4812
5174
        Option('output', short_name='o',
4813
 
               help='Write merge directive to this file; '
 
5175
               help='Write merge directive to this file or directory; '
4814
5176
                    'use - for stdout.',
4815
5177
               type=unicode),
 
5178
        Option('strict',
 
5179
               help='Refuse to send if there are uncommitted changes in'
 
5180
               ' the working tree, --no-strict disables the check.'),
4816
5181
        Option('mail-to', help='Mail the request to this address.',
4817
5182
               type=unicode),
4818
5183
        'revision',
4819
5184
        'message',
4820
5185
        Option('body', help='Body for the email.', type=unicode),
4821
 
        RegistryOption.from_kwargs('format',
4822
 
        'Use the specified output format.',
4823
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4824
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5186
        RegistryOption('format',
 
5187
                       help='Use the specified output format.',
 
5188
                       lazy_registry=('bzrlib.send', 'format_registry')),
4825
5189
        ]
4826
5190
 
4827
5191
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4828
5192
            no_patch=False, revision=None, remember=False, output=None,
4829
 
            format='4', mail_to=None, message=None, body=None, **kwargs):
4830
 
        return self._run(submit_branch, revision, public_branch, remember,
4831
 
                         format, no_bundle, no_patch, output,
4832
 
                         kwargs.get('from', '.'), mail_to, message, body)
4833
 
 
4834
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
4835
 
             no_bundle, no_patch, output, from_, mail_to, message, body):
4836
 
        from bzrlib.revision import NULL_REVISION
4837
 
        branch = Branch.open_containing(from_)[0]
4838
 
        if output is None:
4839
 
            outfile = cStringIO.StringIO()
4840
 
        elif output == '-':
4841
 
            outfile = self.outf
4842
 
        else:
4843
 
            outfile = open(output, 'wb')
4844
 
        # we may need to write data into branch's repository to calculate
4845
 
        # the data to send.
4846
 
        branch.lock_write()
4847
 
        try:
4848
 
            if output is None:
4849
 
                config = branch.get_config()
4850
 
                if mail_to is None:
4851
 
                    mail_to = config.get_user_option('submit_to')
4852
 
                mail_client = config.get_mail_client()
4853
 
                if (not getattr(mail_client, 'supports_body', False)
4854
 
                    and body is not None):
4855
 
                    raise errors.BzrCommandError(
4856
 
                        'Mail client "%s" does not support specifying body' %
4857
 
                        mail_client.__class__.__name__)
4858
 
            if remember and submit_branch is None:
4859
 
                raise errors.BzrCommandError(
4860
 
                    '--remember requires a branch to be specified.')
4861
 
            stored_submit_branch = branch.get_submit_branch()
4862
 
            remembered_submit_branch = None
4863
 
            if submit_branch is None:
4864
 
                submit_branch = stored_submit_branch
4865
 
                remembered_submit_branch = "submit"
4866
 
            else:
4867
 
                if stored_submit_branch is None or remember:
4868
 
                    branch.set_submit_branch(submit_branch)
4869
 
            if submit_branch is None:
4870
 
                submit_branch = branch.get_parent()
4871
 
                remembered_submit_branch = "parent"
4872
 
            if submit_branch is None:
4873
 
                raise errors.BzrCommandError('No submit branch known or'
4874
 
                                             ' specified')
4875
 
            if remembered_submit_branch is not None:
4876
 
                note('Using saved %s location "%s" to determine what '
4877
 
                        'changes to submit.', remembered_submit_branch,
4878
 
                        submit_branch)
4879
 
 
4880
 
            if mail_to is None:
4881
 
                submit_config = Branch.open(submit_branch).get_config()
4882
 
                mail_to = submit_config.get_user_option("child_submit_to")
4883
 
 
4884
 
            stored_public_branch = branch.get_public_branch()
4885
 
            if public_branch is None:
4886
 
                public_branch = stored_public_branch
4887
 
            elif stored_public_branch is None or remember:
4888
 
                branch.set_public_branch(public_branch)
4889
 
            if no_bundle and public_branch is None:
4890
 
                raise errors.BzrCommandError('No public branch specified or'
4891
 
                                             ' known')
4892
 
            base_revision_id = None
4893
 
            revision_id = None
4894
 
            if revision is not None:
4895
 
                if len(revision) > 2:
4896
 
                    raise errors.BzrCommandError('bzr send takes '
4897
 
                        'at most two one revision identifiers')
4898
 
                revision_id = revision[-1].as_revision_id(branch)
4899
 
                if len(revision) == 2:
4900
 
                    base_revision_id = revision[0].as_revision_id(branch)
4901
 
            if revision_id is None:
4902
 
                revision_id = branch.last_revision()
4903
 
            if revision_id == NULL_REVISION:
4904
 
                raise errors.BzrCommandError('No revisions to submit.')
4905
 
            if format == '4':
4906
 
                directive = merge_directive.MergeDirective2.from_objects(
4907
 
                    branch.repository, revision_id, time.time(),
4908
 
                    osutils.local_time_offset(), submit_branch,
4909
 
                    public_branch=public_branch, include_patch=not no_patch,
4910
 
                    include_bundle=not no_bundle, message=message,
4911
 
                    base_revision_id=base_revision_id)
4912
 
            elif format == '0.9':
4913
 
                if not no_bundle:
4914
 
                    if not no_patch:
4915
 
                        patch_type = 'bundle'
4916
 
                    else:
4917
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4918
 
                            ' permit bundle with no patch')
4919
 
                else:
4920
 
                    if not no_patch:
4921
 
                        patch_type = 'diff'
4922
 
                    else:
4923
 
                        patch_type = None
4924
 
                directive = merge_directive.MergeDirective.from_objects(
4925
 
                    branch.repository, revision_id, time.time(),
4926
 
                    osutils.local_time_offset(), submit_branch,
4927
 
                    public_branch=public_branch, patch_type=patch_type,
4928
 
                    message=message)
4929
 
 
4930
 
            outfile.writelines(directive.to_lines())
4931
 
            if output is None:
4932
 
                subject = '[MERGE] '
4933
 
                if message is not None:
4934
 
                    subject += message
4935
 
                else:
4936
 
                    revision = branch.repository.get_revision(revision_id)
4937
 
                    subject += revision.get_summary()
4938
 
                basename = directive.get_disk_name(branch)
4939
 
                mail_client.compose_merge_request(mail_to, subject,
4940
 
                                                  outfile.getvalue(),
4941
 
                                                  basename, body)
4942
 
        finally:
4943
 
            if output != '-':
4944
 
                outfile.close()
4945
 
            branch.unlock()
 
5193
            format=None, mail_to=None, message=None, body=None,
 
5194
            strict=None, **kwargs):
 
5195
        from bzrlib.send import send
 
5196
        return send(submit_branch, revision, public_branch, remember,
 
5197
                    format, no_bundle, no_patch, output,
 
5198
                    kwargs.get('from', '.'), mail_to, message, body,
 
5199
                    self.outf,
 
5200
                    strict=strict)
4946
5201
 
4947
5202
 
4948
5203
class cmd_bundle_revisions(cmd_send):
4949
 
 
4950
 
    """Create a merge-directive for submitting changes.
 
5204
    __doc__ = """Create a merge-directive for submitting changes.
4951
5205
 
4952
5206
    A merge directive provides many things needed for requesting merges:
4953
5207
 
4993
5247
               type=unicode),
4994
5248
        Option('output', short_name='o', help='Write directive to this file.',
4995
5249
               type=unicode),
 
5250
        Option('strict',
 
5251
               help='Refuse to bundle revisions if there are uncommitted'
 
5252
               ' changes in the working tree, --no-strict disables the check.'),
4996
5253
        'revision',
4997
 
        RegistryOption.from_kwargs('format',
4998
 
        'Use the specified output format.',
4999
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
5000
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5254
        RegistryOption('format',
 
5255
                       help='Use the specified output format.',
 
5256
                       lazy_registry=('bzrlib.send', 'format_registry')),
5001
5257
        ]
5002
5258
    aliases = ['bundle']
5003
5259
 
5007
5263
 
5008
5264
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5009
5265
            no_patch=False, revision=None, remember=False, output=None,
5010
 
            format='4', **kwargs):
 
5266
            format=None, strict=None, **kwargs):
5011
5267
        if output is None:
5012
5268
            output = '-'
5013
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5269
        from bzrlib.send import send
 
5270
        return send(submit_branch, revision, public_branch, remember,
5014
5271
                         format, no_bundle, no_patch, output,
5015
 
                         kwargs.get('from', '.'), None, None, None)
 
5272
                         kwargs.get('from', '.'), None, None, None,
 
5273
                         self.outf, strict=strict)
5016
5274
 
5017
5275
 
5018
5276
class cmd_tag(Command):
5019
 
    """Create, remove or modify a tag naming a revision.
 
5277
    __doc__ = """Create, remove or modify a tag naming a revision.
5020
5278
 
5021
5279
    Tags give human-meaningful names to revisions.  Commands that take a -r
5022
5280
    (--revision) option can be given -rtag:X, where X is any previously
5030
5288
 
5031
5289
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5032
5290
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5291
 
 
5292
    If no tag name is specified it will be determined through the 
 
5293
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5294
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5295
    details.
5033
5296
    """
5034
5297
 
5035
5298
    _see_also = ['commit', 'tags']
5036
 
    takes_args = ['tag_name']
 
5299
    takes_args = ['tag_name?']
5037
5300
    takes_options = [
5038
5301
        Option('delete',
5039
5302
            help='Delete this tag rather than placing it.',
5040
5303
            ),
5041
 
        Option('directory',
5042
 
            help='Branch in which to place the tag.',
5043
 
            short_name='d',
5044
 
            type=unicode,
5045
 
            ),
 
5304
        custom_help('directory',
 
5305
            help='Branch in which to place the tag.'),
5046
5306
        Option('force',
5047
5307
            help='Replace existing tags.',
5048
5308
            ),
5049
5309
        'revision',
5050
5310
        ]
5051
5311
 
5052
 
    def run(self, tag_name,
 
5312
    def run(self, tag_name=None,
5053
5313
            delete=None,
5054
5314
            directory='.',
5055
5315
            force=None,
5056
5316
            revision=None,
5057
5317
            ):
5058
5318
        branch, relpath = Branch.open_containing(directory)
5059
 
        branch.lock_write()
5060
 
        try:
5061
 
            if delete:
5062
 
                branch.tags.delete_tag(tag_name)
5063
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5319
        self.add_cleanup(branch.lock_write().unlock)
 
5320
        if delete:
 
5321
            if tag_name is None:
 
5322
                raise errors.BzrCommandError("No tag specified to delete.")
 
5323
            branch.tags.delete_tag(tag_name)
 
5324
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5325
        else:
 
5326
            if revision:
 
5327
                if len(revision) != 1:
 
5328
                    raise errors.BzrCommandError(
 
5329
                        "Tags can only be placed on a single revision, "
 
5330
                        "not on a range")
 
5331
                revision_id = revision[0].as_revision_id(branch)
5064
5332
            else:
5065
 
                if revision:
5066
 
                    if len(revision) != 1:
5067
 
                        raise errors.BzrCommandError(
5068
 
                            "Tags can only be placed on a single revision, "
5069
 
                            "not on a range")
5070
 
                    revision_id = revision[0].as_revision_id(branch)
5071
 
                else:
5072
 
                    revision_id = branch.last_revision()
5073
 
                if (not force) and branch.tags.has_tag(tag_name):
5074
 
                    raise errors.TagAlreadyExists(tag_name)
5075
 
                branch.tags.set_tag(tag_name, revision_id)
5076
 
                self.outf.write('Created tag %s.\n' % tag_name)
5077
 
        finally:
5078
 
            branch.unlock()
 
5333
                revision_id = branch.last_revision()
 
5334
            if tag_name is None:
 
5335
                tag_name = branch.automatic_tag_name(revision_id)
 
5336
                if tag_name is None:
 
5337
                    raise errors.BzrCommandError(
 
5338
                        "Please specify a tag name.")
 
5339
            if (not force) and branch.tags.has_tag(tag_name):
 
5340
                raise errors.TagAlreadyExists(tag_name)
 
5341
            branch.tags.set_tag(tag_name, revision_id)
 
5342
            self.outf.write('Created tag %s.\n' % tag_name)
5079
5343
 
5080
5344
 
5081
5345
class cmd_tags(Command):
5082
 
    """List tags.
 
5346
    __doc__ = """List tags.
5083
5347
 
5084
5348
    This command shows a table of tag names and the revisions they reference.
5085
5349
    """
5086
5350
 
5087
5351
    _see_also = ['tag']
5088
5352
    takes_options = [
5089
 
        Option('directory',
5090
 
            help='Branch whose tags should be displayed.',
5091
 
            short_name='d',
5092
 
            type=unicode,
5093
 
            ),
 
5353
        custom_help('directory',
 
5354
            help='Branch whose tags should be displayed.'),
5094
5355
        RegistryOption.from_kwargs('sort',
5095
5356
            'Sort tags by different criteria.', title='Sorting',
5096
5357
            alpha='Sort tags lexicographically (default).',
5113
5374
        if not tags:
5114
5375
            return
5115
5376
 
 
5377
        self.add_cleanup(branch.lock_read().unlock)
5116
5378
        if revision:
5117
 
            branch.lock_read()
5118
 
            try:
5119
 
                graph = branch.repository.get_graph()
5120
 
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
5121
 
                revid1, revid2 = rev1.rev_id, rev2.rev_id
5122
 
                # only show revisions between revid1 and revid2 (inclusive)
5123
 
                tags = [(tag, revid) for tag, revid in tags if
5124
 
                    graph.is_between(revid, revid1, revid2)]
5125
 
            finally:
5126
 
                branch.unlock()
 
5379
            graph = branch.repository.get_graph()
 
5380
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5381
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5382
            # only show revisions between revid1 and revid2 (inclusive)
 
5383
            tags = [(tag, revid) for tag, revid in tags if
 
5384
                graph.is_between(revid, revid1, revid2)]
5127
5385
        if sort == 'alpha':
5128
5386
            tags.sort()
5129
5387
        elif sort == 'time':
5139
5397
            tags.sort(key=lambda x: timestamps[x[1]])
5140
5398
        if not show_ids:
5141
5399
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5142
 
            revno_map = branch.get_revision_id_to_revno_map()
5143
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
5144
 
                        for tag, revid in tags ]
 
5400
            for index, (tag, revid) in enumerate(tags):
 
5401
                try:
 
5402
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5403
                    if isinstance(revno, tuple):
 
5404
                        revno = '.'.join(map(str, revno))
 
5405
                except errors.NoSuchRevision:
 
5406
                    # Bad tag data/merges can lead to tagged revisions
 
5407
                    # which are not in this branch. Fail gracefully ...
 
5408
                    revno = '?'
 
5409
                tags[index] = (tag, revno)
 
5410
        self.cleanup_now()
5145
5411
        for tag, revspec in tags:
5146
5412
            self.outf.write('%-20s %s\n' % (tag, revspec))
5147
5413
 
5148
5414
 
5149
5415
class cmd_reconfigure(Command):
5150
 
    """Reconfigure the type of a bzr directory.
 
5416
    __doc__ = """Reconfigure the type of a bzr directory.
5151
5417
 
5152
5418
    A target configuration must be specified.
5153
5419
 
5183
5449
            ),
5184
5450
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5185
5451
        Option('force',
5186
 
               help='Perform reconfiguration even if local changes'
5187
 
               ' will be lost.')
 
5452
            help='Perform reconfiguration even if local changes'
 
5453
            ' will be lost.'),
 
5454
        Option('stacked-on',
 
5455
            help='Reconfigure a branch to be stacked on another branch.',
 
5456
            type=unicode,
 
5457
            ),
 
5458
        Option('unstacked',
 
5459
            help='Reconfigure a branch to be unstacked.  This '
 
5460
                'may require copying substantial data into it.',
 
5461
            ),
5188
5462
        ]
5189
5463
 
5190
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5464
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5465
            stacked_on=None,
 
5466
            unstacked=None):
5191
5467
        directory = bzrdir.BzrDir.open(location)
 
5468
        if stacked_on and unstacked:
 
5469
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5470
        elif stacked_on is not None:
 
5471
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5472
        elif unstacked:
 
5473
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5474
        # At the moment you can use --stacked-on and a different
 
5475
        # reconfiguration shape at the same time; there seems no good reason
 
5476
        # to ban it.
5192
5477
        if target_type is None:
5193
 
            raise errors.BzrCommandError('No target configuration specified')
 
5478
            if stacked_on or unstacked:
 
5479
                return
 
5480
            else:
 
5481
                raise errors.BzrCommandError('No target configuration '
 
5482
                    'specified')
5194
5483
        elif target_type == 'branch':
5195
5484
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5196
5485
        elif target_type == 'tree':
5215
5504
 
5216
5505
 
5217
5506
class cmd_switch(Command):
5218
 
    """Set the branch of a checkout and update.
 
5507
    __doc__ = """Set the branch of a checkout and update.
5219
5508
 
5220
5509
    For lightweight checkouts, this changes the branch being referenced.
5221
5510
    For heavyweight checkouts, this checks that there are no local commits
5233
5522
    /path/to/newbranch.
5234
5523
 
5235
5524
    Bound branches use the nickname of its master branch unless it is set
5236
 
    locally, in which case switching will update the the local nickname to be
 
5525
    locally, in which case switching will update the local nickname to be
5237
5526
    that of the master.
5238
5527
    """
5239
5528
 
5240
 
    takes_args = ['to_location']
5241
 
    takes_options = [Option('force',
5242
 
                        help='Switch even if local commits will be lost.')
5243
 
                     ]
 
5529
    takes_args = ['to_location?']
 
5530
    takes_options = ['directory',
 
5531
                     Option('force',
 
5532
                        help='Switch even if local commits will be lost.'),
 
5533
                     'revision',
 
5534
                     Option('create-branch', short_name='b',
 
5535
                        help='Create the target branch from this one before'
 
5536
                             ' switching to it.'),
 
5537
                    ]
5244
5538
 
5245
 
    def run(self, to_location, force=False):
 
5539
    def run(self, to_location=None, force=False, create_branch=False,
 
5540
            revision=None, directory=u'.'):
5246
5541
        from bzrlib import switch
5247
 
        tree_location = '.'
 
5542
        tree_location = directory
 
5543
        revision = _get_one_revision('switch', revision)
5248
5544
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5249
 
        branch = control_dir.open_branch()
 
5545
        if to_location is None:
 
5546
            if revision is None:
 
5547
                raise errors.BzrCommandError('You must supply either a'
 
5548
                                             ' revision or a location')
 
5549
            to_location = tree_location
5250
5550
        try:
5251
 
            to_branch = Branch.open(to_location)
 
5551
            branch = control_dir.open_branch()
 
5552
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5252
5553
        except errors.NotBranchError:
5253
 
            this_branch = control_dir.open_branch()
5254
 
            # This may be a heavy checkout, where we want the master branch
5255
 
            this_url = this_branch.get_bound_location()
5256
 
            # If not, use a local sibling
5257
 
            if this_url is None:
5258
 
                this_url = this_branch.base
5259
 
            to_branch = Branch.open(
5260
 
                urlutils.join(this_url, '..', to_location))
5261
 
        switch.switch(control_dir, to_branch, force)
5262
 
        if branch.get_config().has_explicit_nickname():
 
5554
            branch = None
 
5555
            had_explicit_nick = False
 
5556
        if create_branch:
 
5557
            if branch is None:
 
5558
                raise errors.BzrCommandError('cannot create branch without'
 
5559
                                             ' source branch')
 
5560
            to_location = directory_service.directories.dereference(
 
5561
                              to_location)
 
5562
            if '/' not in to_location and '\\' not in to_location:
 
5563
                # This path is meant to be relative to the existing branch
 
5564
                this_url = self._get_branch_location(control_dir)
 
5565
                to_location = urlutils.join(this_url, '..', to_location)
 
5566
            to_branch = branch.bzrdir.sprout(to_location,
 
5567
                                 possible_transports=[branch.bzrdir.root_transport],
 
5568
                                 source_branch=branch).open_branch()
 
5569
        else:
 
5570
            try:
 
5571
                to_branch = Branch.open(to_location)
 
5572
            except errors.NotBranchError:
 
5573
                this_url = self._get_branch_location(control_dir)
 
5574
                to_branch = Branch.open(
 
5575
                    urlutils.join(this_url, '..', to_location))
 
5576
        if revision is not None:
 
5577
            revision = revision.as_revision_id(to_branch)
 
5578
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5579
        if had_explicit_nick:
5263
5580
            branch = control_dir.open_branch() #get the new branch!
5264
5581
            branch.nick = to_branch.nick
5265
5582
        note('Switched to branch: %s',
5266
5583
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5267
5584
 
5268
 
 
5269
 
class cmd_guess_renames(Command):
5270
 
    """Guess which files have been have been renamed, based on their content.
5271
 
 
5272
 
    Only versioned files which have been deleted are candidates for rename
5273
 
    detection, and renames to ignored files will not be detected.
5274
 
    """
5275
 
 
5276
 
    def run(self):
5277
 
        work_tree, file_list = tree_files(None, default_branch='.')
5278
 
        work_tree.lock_write()
 
5585
    def _get_branch_location(self, control_dir):
 
5586
        """Return location of branch for this control dir."""
5279
5587
        try:
5280
 
            rename_map.RenameMap.guess_renames(work_tree)
5281
 
        finally:
5282
 
            work_tree.unlock()
 
5588
            this_branch = control_dir.open_branch()
 
5589
            # This may be a heavy checkout, where we want the master branch
 
5590
            master_location = this_branch.get_bound_location()
 
5591
            if master_location is not None:
 
5592
                return master_location
 
5593
            # If not, use a local sibling
 
5594
            return this_branch.base
 
5595
        except errors.NotBranchError:
 
5596
            format = control_dir.find_branch_format()
 
5597
            if getattr(format, 'get_reference', None) is not None:
 
5598
                return format.get_reference(control_dir)
 
5599
            else:
 
5600
                return control_dir.root_transport.base
5283
5601
 
5284
5602
 
5285
5603
class cmd_view(Command):
5286
 
    """Manage filtered views.
 
5604
    __doc__ = """Manage filtered views.
5287
5605
 
5288
5606
    Views provide a mask over the tree so that users can focus on
5289
5607
    a subset of a tree when doing their work. After creating a view,
5369
5687
            name=None,
5370
5688
            switch=None,
5371
5689
            ):
5372
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
5690
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
5691
            apply_view=False)
5373
5692
        current_view, view_dict = tree.views.get_view_info()
5374
5693
        if name is None:
5375
5694
            name = current_view
5437
5756
 
5438
5757
 
5439
5758
class cmd_hooks(Command):
5440
 
    """Show hooks."""
 
5759
    __doc__ = """Show hooks."""
5441
5760
 
5442
5761
    hidden = True
5443
5762
 
5456
5775
                    self.outf.write("    <no hooks installed>\n")
5457
5776
 
5458
5777
 
 
5778
class cmd_remove_branch(Command):
 
5779
    __doc__ = """Remove a branch.
 
5780
 
 
5781
    This will remove the branch from the specified location but 
 
5782
    will keep any working tree or repository in place.
 
5783
 
 
5784
    :Examples:
 
5785
 
 
5786
      Remove the branch at repo/trunk::
 
5787
 
 
5788
        bzr remove-branch repo/trunk
 
5789
 
 
5790
    """
 
5791
 
 
5792
    takes_args = ["location?"]
 
5793
 
 
5794
    aliases = ["rmbranch"]
 
5795
 
 
5796
    def run(self, location=None):
 
5797
        if location is None:
 
5798
            location = "."
 
5799
        branch = Branch.open_containing(location)[0]
 
5800
        branch.bzrdir.destroy_branch()
 
5801
        
 
5802
 
5459
5803
class cmd_shelve(Command):
5460
 
    """Temporarily set aside some changes from the current tree.
 
5804
    __doc__ = """Temporarily set aside some changes from the current tree.
5461
5805
 
5462
5806
    Shelve allows you to temporarily put changes you've made "on the shelf",
5463
5807
    ie. out of the way, until a later time when you can bring them back from
5484
5828
    takes_args = ['file*']
5485
5829
 
5486
5830
    takes_options = [
 
5831
        'directory',
5487
5832
        'revision',
5488
5833
        Option('all', help='Shelve all changes.'),
5489
5834
        'message',
5498
5843
    _see_also = ['unshelve']
5499
5844
 
5500
5845
    def run(self, revision=None, all=False, file_list=None, message=None,
5501
 
            writer=None, list=False, destroy=False):
 
5846
            writer=None, list=False, destroy=False, directory=u'.'):
5502
5847
        if list:
5503
5848
            return self.run_for_list()
5504
5849
        from bzrlib.shelf_ui import Shelver
5505
5850
        if writer is None:
5506
5851
            writer = bzrlib.option.diff_writer_registry.get()
5507
5852
        try:
5508
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
5509
 
                              message, destroy=destroy).run()
 
5853
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5854
                file_list, message, destroy=destroy, directory=directory)
 
5855
            try:
 
5856
                shelver.run()
 
5857
            finally:
 
5858
                shelver.finalize()
5510
5859
        except errors.UserAbort:
5511
5860
            return 0
5512
5861
 
5513
5862
    def run_for_list(self):
5514
5863
        tree = WorkingTree.open_containing('.')[0]
5515
 
        tree.lock_read()
5516
 
        try:
5517
 
            manager = tree.get_shelf_manager()
5518
 
            shelves = manager.active_shelves()
5519
 
            if len(shelves) == 0:
5520
 
                note('No shelved changes.')
5521
 
                return 0
5522
 
            for shelf_id in reversed(shelves):
5523
 
                message = manager.get_metadata(shelf_id).get('message')
5524
 
                if message is None:
5525
 
                    message = '<no message>'
5526
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
5527
 
            return 1
5528
 
        finally:
5529
 
            tree.unlock()
 
5864
        self.add_cleanup(tree.lock_read().unlock)
 
5865
        manager = tree.get_shelf_manager()
 
5866
        shelves = manager.active_shelves()
 
5867
        if len(shelves) == 0:
 
5868
            note('No shelved changes.')
 
5869
            return 0
 
5870
        for shelf_id in reversed(shelves):
 
5871
            message = manager.get_metadata(shelf_id).get('message')
 
5872
            if message is None:
 
5873
                message = '<no message>'
 
5874
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5875
        return 1
5530
5876
 
5531
5877
 
5532
5878
class cmd_unshelve(Command):
5533
 
    """Restore shelved changes.
 
5879
    __doc__ = """Restore shelved changes.
5534
5880
 
5535
5881
    By default, the most recently shelved changes are restored. However if you
5536
5882
    specify a shelf by id those changes will be restored instead.  This works
5539
5885
 
5540
5886
    takes_args = ['shelf_id?']
5541
5887
    takes_options = [
 
5888
        'directory',
5542
5889
        RegistryOption.from_kwargs(
5543
5890
            'action', help="The action to perform.",
5544
5891
            enum_switch=False, value_switches=True,
5545
5892
            apply="Apply changes and remove from the shelf.",
5546
5893
            dry_run="Show changes, but do not apply or remove them.",
5547
 
            delete_only="Delete changes without applying them."
 
5894
            preview="Instead of unshelving the changes, show the diff that "
 
5895
                    "would result from unshelving.",
 
5896
            delete_only="Delete changes without applying them.",
 
5897
            keep="Apply changes but don't delete them.",
5548
5898
        )
5549
5899
    ]
5550
5900
    _see_also = ['shelve']
5551
5901
 
5552
 
    def run(self, shelf_id=None, action='apply'):
 
5902
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5553
5903
        from bzrlib.shelf_ui import Unshelver
5554
 
        Unshelver.from_args(shelf_id, action).run()
 
5904
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
 
5905
        try:
 
5906
            unshelver.run()
 
5907
        finally:
 
5908
            unshelver.tree.unlock()
5555
5909
 
5556
5910
 
5557
5911
class cmd_clean_tree(Command):
5558
 
    """Remove unwanted files from working tree.
 
5912
    __doc__ = """Remove unwanted files from working tree.
5559
5913
 
5560
5914
    By default, only unknown files, not ignored files, are deleted.  Versioned
5561
5915
    files are never deleted.
5569
5923
 
5570
5924
    To check what clean-tree will do, use --dry-run.
5571
5925
    """
5572
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5926
    takes_options = ['directory',
 
5927
                     Option('ignored', help='Delete all ignored files.'),
5573
5928
                     Option('detritus', help='Delete conflict files, merge'
5574
5929
                            ' backups, and failed selftest dirs.'),
5575
5930
                     Option('unknown',
5578
5933
                            ' deleting them.'),
5579
5934
                     Option('force', help='Do not prompt before deleting.')]
5580
5935
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5581
 
            force=False):
 
5936
            force=False, directory=u'.'):
5582
5937
        from bzrlib.clean_tree import clean_tree
5583
5938
        if not (unknown or ignored or detritus):
5584
5939
            unknown = True
5585
5940
        if dry_run:
5586
5941
            force = True
5587
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5588
 
                   dry_run=dry_run, no_prompt=force)
5589
 
 
5590
 
 
5591
 
def _create_prefix(cur_transport):
5592
 
    needed = [cur_transport]
5593
 
    # Recurse upwards until we can create a directory successfully
5594
 
    while True:
5595
 
        new_transport = cur_transport.clone('..')
5596
 
        if new_transport.base == cur_transport.base:
5597
 
            raise errors.BzrCommandError(
5598
 
                "Failed to create path prefix for %s."
5599
 
                % cur_transport.base)
5600
 
        try:
5601
 
            new_transport.mkdir('.')
5602
 
        except errors.NoSuchFile:
5603
 
            needed.append(new_transport)
5604
 
            cur_transport = new_transport
 
5942
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
5943
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
 
5944
 
 
5945
 
 
5946
class cmd_reference(Command):
 
5947
    __doc__ = """list, view and set branch locations for nested trees.
 
5948
 
 
5949
    If no arguments are provided, lists the branch locations for nested trees.
 
5950
    If one argument is provided, display the branch location for that tree.
 
5951
    If two arguments are provided, set the branch location for that tree.
 
5952
    """
 
5953
 
 
5954
    hidden = True
 
5955
 
 
5956
    takes_args = ['path?', 'location?']
 
5957
 
 
5958
    def run(self, path=None, location=None):
 
5959
        branchdir = '.'
 
5960
        if path is not None:
 
5961
            branchdir = path
 
5962
        tree, branch, relpath =(
 
5963
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5964
        if path is not None:
 
5965
            path = relpath
 
5966
        if tree is None:
 
5967
            tree = branch.basis_tree()
 
5968
        if path is None:
 
5969
            info = branch._get_all_reference_info().iteritems()
 
5970
            self._display_reference_info(tree, branch, info)
5605
5971
        else:
5606
 
            break
5607
 
    # Now we only need to create child directories
5608
 
    while needed:
5609
 
        cur_transport = needed.pop()
5610
 
        cur_transport.ensure_base()
5611
 
 
5612
 
 
5613
 
# these get imported and then picked up by the scan for cmd_*
5614
 
# TODO: Some more consistent way to split command definitions across files;
5615
 
# we do need to load at least some information about them to know of
5616
 
# aliases.  ideally we would avoid loading the implementation until the
5617
 
# details were needed.
5618
 
from bzrlib.cmd_version_info import cmd_version_info
5619
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5620
 
from bzrlib.bundle.commands import (
5621
 
    cmd_bundle_info,
5622
 
    )
5623
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5624
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5625
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
5972
            file_id = tree.path2id(path)
 
5973
            if file_id is None:
 
5974
                raise errors.NotVersionedError(path)
 
5975
            if location is None:
 
5976
                info = [(file_id, branch.get_reference_info(file_id))]
 
5977
                self._display_reference_info(tree, branch, info)
 
5978
            else:
 
5979
                branch.set_reference_info(file_id, path, location)
 
5980
 
 
5981
    def _display_reference_info(self, tree, branch, info):
 
5982
        ref_list = []
 
5983
        for file_id, (path, location) in info:
 
5984
            try:
 
5985
                path = tree.id2path(file_id)
 
5986
            except errors.NoSuchId:
 
5987
                pass
 
5988
            ref_list.append((path, location))
 
5989
        for path, location in sorted(ref_list):
 
5990
            self.outf.write('%s %s\n' % (path, location))
 
5991
 
 
5992
 
 
5993
def _register_lazy_builtins():
 
5994
    # register lazy builtins from other modules; called at startup and should
 
5995
    # be only called once.
 
5996
    for (name, aliases, module_name) in [
 
5997
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
5998
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
5999
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6000
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6001
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6002
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6003
        ]:
 
6004
        builtin_command_registry.register_lazy(name, aliases, module_name)