/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008 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
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
31
31
    bundle,
32
32
    btree_index,
33
33
    bzrdir,
 
34
    directory_service,
34
35
    delta,
35
36
    config,
36
37
    errors,
37
38
    globbing,
 
39
    hooks,
38
40
    log,
39
41
    merge as _mod_merge,
40
42
    merge_directive,
41
43
    osutils,
42
44
    reconfigure,
 
45
    rename_map,
43
46
    revision as _mod_revision,
 
47
    static_tuple,
44
48
    symbol_versioning,
 
49
    timestamp,
45
50
    transport,
46
 
    tree as _mod_tree,
47
51
    ui,
48
52
    urlutils,
 
53
    views,
49
54
    )
50
55
from bzrlib.branch import Branch
51
56
from bzrlib.conflicts import ConflictList
52
 
from bzrlib.revisionspec import RevisionSpec
 
57
from bzrlib.transport import memory
 
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
53
59
from bzrlib.smtp_connection import SMTPConnection
54
60
from bzrlib.workingtree import WorkingTree
55
61
""")
56
62
 
57
 
from bzrlib.commands import Command, display_command
58
 
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
 
from bzrlib.trace import mutter, note, warning, is_quiet
60
 
 
61
 
 
62
 
def tree_files(file_list, default_branch=u'.'):
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
 
68
from bzrlib.option import (
 
69
    ListOption,
 
70
    Option,
 
71
    RegistryOption,
 
72
    custom_help,
 
73
    _parse_revision_str,
 
74
    )
 
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
76
 
 
77
 
 
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
 
79
    apply_view=True):
63
80
    try:
64
 
        return internal_tree_files(file_list, default_branch)
 
81
        return internal_tree_files(file_list, default_branch, canonicalize,
 
82
            apply_view)
65
83
    except errors.FileInWrongBranch, e:
66
84
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
85
                                     (e.path, file_list[0]))
68
86
 
69
87
 
 
88
def tree_files_for_add(file_list):
 
89
    """
 
90
    Return a tree and list of absolute paths from a file list.
 
91
 
 
92
    Similar to tree_files, but add handles files a bit differently, so it a
 
93
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
94
    absolute paths, which it immediately converts to relative paths.
 
95
    """
 
96
    # FIXME Would be nice to just return the relative paths like
 
97
    # internal_tree_files does, but there are a large number of unit tests
 
98
    # that assume the current interface to mutabletree.smart_add
 
99
    if file_list:
 
100
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
101
        if tree.supports_views():
 
102
            view_files = tree.views.lookup_view()
 
103
            if view_files:
 
104
                for filename in file_list:
 
105
                    if not osutils.is_inside_any(view_files, filename):
 
106
                        raise errors.FileOutsideView(filename, view_files)
 
107
        file_list = file_list[:]
 
108
        file_list[0] = tree.abspath(relpath)
 
109
    else:
 
110
        tree = WorkingTree.open_containing(u'.')[0]
 
111
        if tree.supports_views():
 
112
            view_files = tree.views.lookup_view()
 
113
            if view_files:
 
114
                file_list = view_files
 
115
                view_str = views.view_display_str(view_files)
 
116
                note("Ignoring files outside view. View is %s" % view_str)
 
117
    return tree, file_list
 
118
 
 
119
 
 
120
def _get_one_revision(command_name, revisions):
 
121
    if revisions is None:
 
122
        return None
 
123
    if len(revisions) != 1:
 
124
        raise errors.BzrCommandError(
 
125
            'bzr %s --revision takes exactly one revision identifier' % (
 
126
                command_name,))
 
127
    return revisions[0]
 
128
 
 
129
 
70
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
131
    """Get a revision tree. Not suitable for commands that change the tree.
 
132
    
 
133
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
134
    and doing a commit/uncommit/pull will at best fail due to changing the
 
135
    basis revision data.
 
136
 
 
137
    If tree is passed in, it should be already locked, for lifetime management
 
138
    of the trees internal cached state.
 
139
    """
71
140
    if branch is None:
72
141
        branch = tree.branch
73
142
    if revisions is None:
76
145
        else:
77
146
            rev_tree = branch.basis_tree()
78
147
    else:
79
 
        if len(revisions) != 1:
80
 
            raise errors.BzrCommandError(
81
 
                'bzr %s --revision takes exactly one revision identifier' % (
82
 
                    command_name,))
83
 
        rev_tree = revisions[0].as_tree(branch)
 
148
        revision = _get_one_revision(command_name, revisions)
 
149
        rev_tree = revision.as_tree(branch)
84
150
    return rev_tree
85
151
 
86
152
 
87
153
# XXX: Bad function name; should possibly also be a class method of
88
154
# WorkingTree rather than a function.
89
 
def internal_tree_files(file_list, default_branch=u'.'):
 
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
 
156
    apply_view=True):
90
157
    """Convert command-line paths to a WorkingTree and relative paths.
91
158
 
92
159
    This is typically used for command-line processors that take one or
94
161
 
95
162
    The filenames given are not required to exist.
96
163
 
97
 
    :param file_list: Filenames to convert.  
 
164
    :param file_list: Filenames to convert.
98
165
 
99
166
    :param default_branch: Fallback tree path to use if file_list is empty or
100
167
        None.
101
168
 
 
169
    :param apply_view: if True and a view is set, apply it or check that
 
170
        specified files are within it
 
171
 
102
172
    :return: workingtree, [relative_paths]
103
173
    """
104
174
    if file_list is None or len(file_list) == 0:
105
 
        return WorkingTree.open_containing(default_branch)[0], file_list
 
175
        tree = WorkingTree.open_containing(default_branch)[0]
 
176
        if tree.supports_views() and apply_view:
 
177
            view_files = tree.views.lookup_view()
 
178
            if view_files:
 
179
                file_list = view_files
 
180
                view_str = views.view_display_str(view_files)
 
181
                note("Ignoring files outside view. View is %s" % view_str)
 
182
        return tree, file_list
106
183
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
107
 
    return tree, safe_relpath_files(tree, file_list)
108
 
 
109
 
 
110
 
def safe_relpath_files(tree, file_list):
 
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
185
        apply_view=apply_view)
 
186
 
 
187
 
 
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
111
189
    """Convert file_list into a list of relpaths in tree.
112
190
 
113
191
    :param tree: A tree to operate on.
114
192
    :param file_list: A list of user provided paths or None.
 
193
    :param apply_view: if True and a view is set, apply it or check that
 
194
        specified files are within it
115
195
    :return: A list of relative paths.
116
196
    :raises errors.PathNotChild: When a provided path is in a different tree
117
197
        than tree.
118
198
    """
119
199
    if file_list is None:
120
200
        return None
 
201
    if tree.supports_views() and apply_view:
 
202
        view_files = tree.views.lookup_view()
 
203
    else:
 
204
        view_files = []
121
205
    new_list = []
 
206
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
207
    # doesn't - fix that up here before we enter the loop.
 
208
    if canonicalize:
 
209
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
210
    else:
 
211
        fixer = tree.relpath
122
212
    for filename in file_list:
123
213
        try:
124
 
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
214
            relpath = fixer(osutils.dereference_path(filename))
 
215
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
216
                raise errors.FileOutsideView(filename, view_files)
 
217
            new_list.append(relpath)
125
218
        except errors.PathNotChild:
126
219
            raise errors.FileInWrongBranch(tree.branch, filename)
127
220
    return new_list
128
221
 
129
222
 
 
223
def _get_view_info_for_change_reporter(tree):
 
224
    """Get the view information from a tree for change reporting."""
 
225
    view_info = None
 
226
    try:
 
227
        current_view = tree.views.get_view_info()[0]
 
228
        if current_view is not None:
 
229
            view_info = (current_view, tree.views.lookup_view())
 
230
    except errors.ViewsNotSupported:
 
231
        pass
 
232
    return view_info
 
233
 
 
234
 
130
235
# TODO: Make sure no commands unconditionally use the working directory as a
131
236
# branch.  If a filename argument is used, the first of them should be used to
132
237
# specify the branch.  (Perhaps this can be factored out into some kind of
134
239
# opens the branch?)
135
240
 
136
241
class cmd_status(Command):
137
 
    """Display status summary.
 
242
    __doc__ = """Display status summary.
138
243
 
139
244
    This reports on versioned and unknown files, reporting them
140
245
    grouped by state.  Possible states are:
160
265
    unknown
161
266
        Not versioned and not matching an ignore pattern.
162
267
 
 
268
    Additionally for directories, symlinks and files with an executable
 
269
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
270
    or '*' respectively.
 
271
 
163
272
    To see ignored files use 'bzr ignored'.  For details on the
164
273
    changes to file texts, use 'bzr diff'.
165
 
    
 
274
 
166
275
    Note that --short or -S gives status flags for each item, similar
167
276
    to Subversion's status command. To get output similar to svn -q,
168
277
    use bzr status -SV.
172
281
    files or directories is reported.  If a directory is given, status
173
282
    is reported for everything inside that directory.
174
283
 
 
284
    Before merges are committed, the pending merge tip revisions are
 
285
    shown. To see all pending merge revisions, use the -v option.
 
286
    To skip the display of pending merge information altogether, use
 
287
    the no-pending option or specify a file/directory.
 
288
 
175
289
    If a revision argument is given, the status is calculated against
176
290
    that revision, or between two revisions if two are provided.
177
291
    """
178
 
    
 
292
 
179
293
    # TODO: --no-recurse, --recurse options
180
 
    
 
294
 
181
295
    takes_args = ['file*']
182
 
    takes_options = ['show-ids', 'revision', 'change',
 
296
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
183
297
                     Option('short', help='Use short status indicators.',
184
298
                            short_name='S'),
185
299
                     Option('versioned', help='Only show versioned files.',
191
305
 
192
306
    encoding_type = 'replace'
193
307
    _see_also = ['diff', 'revert', 'status-flags']
194
 
    
 
308
 
195
309
    @display_command
196
310
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
197
 
            versioned=False, no_pending=False):
 
311
            versioned=False, no_pending=False, verbose=False):
198
312
        from bzrlib.status import show_tree_status
199
313
 
200
314
        if revision and len(revision) > 2:
214
328
        show_tree_status(tree, show_ids=show_ids,
215
329
                         specific_files=relfile_list, revision=revision,
216
330
                         to_file=self.outf, short=short, versioned=versioned,
217
 
                         show_pending=(not no_pending))
 
331
                         show_pending=(not no_pending), verbose=verbose)
218
332
 
219
333
 
220
334
class cmd_cat_revision(Command):
221
 
    """Write out metadata for a revision.
222
 
    
 
335
    __doc__ = """Write out metadata for a revision.
 
336
 
223
337
    The revision to print can either be specified by a specific
224
338
    revision identifier, or you can use --revision.
225
339
    """
229
343
    takes_options = ['revision']
230
344
    # cat-revision is more for frontends so should be exact
231
345
    encoding = 'strict'
232
 
    
 
346
 
 
347
    def print_revision(self, revisions, revid):
 
348
        stream = revisions.get_record_stream([(revid,)], 'unordered', True)
 
349
        record = stream.next()
 
350
        if record.storage_kind == 'absent':
 
351
            raise errors.NoSuchRevision(revisions, revid)
 
352
        revtext = record.get_bytes_as('fulltext')
 
353
        self.outf.write(revtext.decode('utf-8'))
 
354
 
233
355
    @display_command
234
356
    def run(self, revision_id=None, revision=None):
235
357
        if revision_id is not None and revision is not None:
240
362
                                         ' --revision or a revision_id')
241
363
        b = WorkingTree.open_containing(u'.')[0].branch
242
364
 
243
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
244
 
        if revision_id is not None:
245
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
246
 
            try:
247
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
248
 
            except errors.NoSuchRevision:
249
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
250
 
                    revision_id)
251
 
                raise errors.BzrCommandError(msg)
252
 
        elif revision is not None:
253
 
            for rev in revision:
254
 
                if rev is None:
255
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
256
 
                                                 ' revision.')
257
 
                rev_id = rev.as_revision_id(b)
258
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
365
        revisions = b.repository.revisions
 
366
        if revisions is None:
 
367
            raise errors.BzrCommandError('Repository %r does not support '
 
368
                'access to raw revision texts')
259
369
 
 
370
        b.repository.lock_read()
 
371
        try:
 
372
            # TODO: jam 20060112 should cat-revision always output utf-8?
 
373
            if revision_id is not None:
 
374
                revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
375
                try:
 
376
                    self.print_revision(revisions, revision_id)
 
377
                except errors.NoSuchRevision:
 
378
                    msg = "The repository %s contains no revision %s." % (
 
379
                        b.repository.base, revision_id)
 
380
                    raise errors.BzrCommandError(msg)
 
381
            elif revision is not None:
 
382
                for rev in revision:
 
383
                    if rev is None:
 
384
                        raise errors.BzrCommandError(
 
385
                            'You cannot specify a NULL revision.')
 
386
                    rev_id = rev.as_revision_id(b)
 
387
                    self.print_revision(revisions, rev_id)
 
388
        finally:
 
389
            b.repository.unlock()
 
390
        
260
391
 
261
392
class cmd_dump_btree(Command):
262
 
    """Dump the contents of a btree index file to stdout.
 
393
    __doc__ = """Dump the contents of a btree index file to stdout.
263
394
 
264
395
    PATH is a btree index file, it can be any URL. This includes things like
265
396
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
329
460
        for node in bt.iter_all_entries():
330
461
            # Node is made up of:
331
462
            # (index, key, value, [references])
332
 
            self.outf.write('%s\n' % (node[1:],))
 
463
            try:
 
464
                refs = node[3]
 
465
            except IndexError:
 
466
                refs_as_tuples = None
 
467
            else:
 
468
                refs_as_tuples = static_tuple.as_tuples(refs)
 
469
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
 
470
            self.outf.write('%s\n' % (as_tuple,))
333
471
 
334
472
 
335
473
class cmd_remove_tree(Command):
336
 
    """Remove the working tree from a given branch/checkout.
 
474
    __doc__ = """Remove the working tree from a given branch/checkout.
337
475
 
338
476
    Since a lightweight checkout is little more than a working tree
339
477
    this will refuse to run against one.
341
479
    To re-create the working tree, use "bzr checkout".
342
480
    """
343
481
    _see_also = ['checkout', 'working-trees']
344
 
    takes_args = ['location?']
 
482
    takes_args = ['location*']
345
483
    takes_options = [
346
484
        Option('force',
347
485
               help='Remove the working tree even if it has '
348
486
                    'uncommitted changes.'),
349
487
        ]
350
488
 
351
 
    def run(self, location='.', force=False):
352
 
        d = bzrdir.BzrDir.open(location)
353
 
        
354
 
        try:
355
 
            working = d.open_workingtree()
356
 
        except errors.NoWorkingTree:
357
 
            raise errors.BzrCommandError("No working tree to remove")
358
 
        except errors.NotLocalUrl:
359
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
360
 
                                         "remote path")
361
 
        if not force:
362
 
            changes = working.changes_from(working.basis_tree())
363
 
            if changes.has_changed():
364
 
                raise errors.UncommittedChanges(working)
365
 
 
366
 
        working_path = working.bzrdir.root_transport.base
367
 
        branch_path = working.branch.bzrdir.root_transport.base
368
 
        if working_path != branch_path:
369
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
370
 
                                         "a lightweight checkout")
371
 
        
372
 
        d.destroy_workingtree()
373
 
        
 
489
    def run(self, location_list, force=False):
 
490
        if not location_list:
 
491
            location_list=['.']
 
492
 
 
493
        for location in location_list:
 
494
            d = bzrdir.BzrDir.open(location)
 
495
            
 
496
            try:
 
497
                working = d.open_workingtree()
 
498
            except errors.NoWorkingTree:
 
499
                raise errors.BzrCommandError("No working tree to remove")
 
500
            except errors.NotLocalUrl:
 
501
                raise errors.BzrCommandError("You cannot remove the working tree"
 
502
                                             " of a remote path")
 
503
            if not force:
 
504
                if (working.has_changes()):
 
505
                    raise errors.UncommittedChanges(working)
 
506
 
 
507
            if working.user_url != working.branch.user_url:
 
508
                raise errors.BzrCommandError("You cannot remove the working tree"
 
509
                                             " from a lightweight checkout")
 
510
 
 
511
            d.destroy_workingtree()
 
512
 
374
513
 
375
514
class cmd_revno(Command):
376
 
    """Show current revision number.
 
515
    __doc__ = """Show current revision number.
377
516
 
378
517
    This is equal to the number of revisions on this branch.
379
518
    """
380
519
 
381
520
    _see_also = ['info']
382
521
    takes_args = ['location?']
 
522
    takes_options = [
 
523
        Option('tree', help='Show revno of working tree'),
 
524
        ]
383
525
 
384
526
    @display_command
385
 
    def run(self, location=u'.'):
386
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
387
 
        self.outf.write('\n')
 
527
    def run(self, tree=False, location=u'.'):
 
528
        if tree:
 
529
            try:
 
530
                wt = WorkingTree.open_containing(location)[0]
 
531
                wt.lock_read()
 
532
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
533
                raise errors.NoWorkingTree(location)
 
534
            self.add_cleanup(wt.unlock)
 
535
            revid = wt.last_revision()
 
536
            try:
 
537
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
 
538
            except errors.NoSuchRevision:
 
539
                revno_t = ('???',)
 
540
            revno = ".".join(str(n) for n in revno_t)
 
541
        else:
 
542
            b = Branch.open_containing(location)[0]
 
543
            b.lock_read()
 
544
            self.add_cleanup(b.unlock)
 
545
            revno = b.revno()
 
546
        self.cleanup_now()
 
547
        self.outf.write(str(revno) + '\n')
388
548
 
389
549
 
390
550
class cmd_revision_info(Command):
391
 
    """Show revision number and revision id for a given revision identifier.
 
551
    __doc__ = """Show revision number and revision id for a given revision identifier.
392
552
    """
393
553
    hidden = True
394
554
    takes_args = ['revision_info*']
400
560
            short_name='d',
401
561
            type=unicode,
402
562
            ),
 
563
        Option('tree', help='Show revno of working tree'),
403
564
        ]
404
565
 
405
566
    @display_command
406
 
    def run(self, revision=None, directory=u'.', revision_info_list=[]):
 
567
    def run(self, revision=None, directory=u'.', tree=False,
 
568
            revision_info_list=[]):
407
569
 
408
 
        revs = []
 
570
        try:
 
571
            wt = WorkingTree.open_containing(directory)[0]
 
572
            b = wt.branch
 
573
            wt.lock_read()
 
574
            self.add_cleanup(wt.unlock)
 
575
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
576
            wt = None
 
577
            b = Branch.open_containing(directory)[0]
 
578
            b.lock_read()
 
579
            self.add_cleanup(b.unlock)
 
580
        revision_ids = []
409
581
        if revision is not None:
410
 
            revs.extend(revision)
 
582
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
411
583
        if revision_info_list is not None:
412
 
            for rev in revision_info_list:
413
 
                revs.append(RevisionSpec.from_string(rev))
414
 
 
415
 
        b = Branch.open_containing(directory)[0]
416
 
 
417
 
        if len(revs) == 0:
418
 
            revs.append(RevisionSpec.from_string('-1'))
419
 
 
420
 
        for rev in revs:
421
 
            revision_id = rev.as_revision_id(b)
 
584
            for rev_str in revision_info_list:
 
585
                rev_spec = RevisionSpec.from_string(rev_str)
 
586
                revision_ids.append(rev_spec.as_revision_id(b))
 
587
        # No arguments supplied, default to the last revision
 
588
        if len(revision_ids) == 0:
 
589
            if tree:
 
590
                if wt is None:
 
591
                    raise errors.NoWorkingTree(directory)
 
592
                revision_ids.append(wt.last_revision())
 
593
            else:
 
594
                revision_ids.append(b.last_revision())
 
595
 
 
596
        revinfos = []
 
597
        maxlen = 0
 
598
        for revision_id in revision_ids:
422
599
            try:
423
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
600
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
601
                revno = '.'.join(str(i) for i in dotted_revno)
424
602
            except errors.NoSuchRevision:
425
 
                dotted_map = b.get_revision_id_to_revno_map()
426
 
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
427
 
            print '%s %s' % (revno, revision_id)
428
 
 
429
 
    
 
603
                revno = '???'
 
604
            maxlen = max(maxlen, len(revno))
 
605
            revinfos.append([revno, revision_id])
 
606
 
 
607
        self.cleanup_now()
 
608
        for ri in revinfos:
 
609
            self.outf.write('%*s %s\n' % (maxlen, ri[0], ri[1]))
 
610
 
 
611
 
430
612
class cmd_add(Command):
431
 
    """Add specified files or directories.
 
613
    __doc__ = """Add specified files or directories.
432
614
 
433
615
    In non-recursive mode, all the named items are added, regardless
434
616
    of whether they were previously ignored.  A warning is given if
450
632
    you should never need to explicitly add a directory, they'll just
451
633
    get added when you add a file in the directory.
452
634
 
453
 
    --dry-run will show which files would be added, but not actually 
 
635
    --dry-run will show which files would be added, but not actually
454
636
    add them.
455
637
 
456
638
    --file-ids-from will try to use the file ids from the supplied path.
460
642
    branches that will be merged later (without showing the two different
461
643
    adds as a conflict). It is also useful when merging another project
462
644
    into a subdirectory of this one.
 
645
    
 
646
    Any files matching patterns in the ignore list will not be added
 
647
    unless they are explicitly mentioned.
463
648
    """
464
649
    takes_args = ['file*']
465
650
    takes_options = [
473
658
               help='Lookup file ids from this tree.'),
474
659
        ]
475
660
    encoding_type = 'replace'
476
 
    _see_also = ['remove']
 
661
    _see_also = ['remove', 'ignore']
477
662
 
478
663
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
479
664
            file_ids_from=None):
497
682
 
498
683
        if base_tree:
499
684
            base_tree.lock_read()
500
 
        try:
501
 
            file_list = self._maybe_expand_globs(file_list)
502
 
            if file_list:
503
 
                tree = WorkingTree.open_containing(file_list[0])[0]
504
 
            else:
505
 
                tree = WorkingTree.open_containing(u'.')[0]
506
 
            added, ignored = tree.smart_add(file_list, not
507
 
                no_recurse, action=action, save=not dry_run)
508
 
        finally:
509
 
            if base_tree is not None:
510
 
                base_tree.unlock()
 
685
            self.add_cleanup(base_tree.unlock)
 
686
        tree, file_list = tree_files_for_add(file_list)
 
687
        added, ignored = tree.smart_add(file_list, not
 
688
            no_recurse, action=action, save=not dry_run)
 
689
        self.cleanup_now()
511
690
        if len(ignored) > 0:
512
691
            if verbose:
513
692
                for glob in sorted(ignored.keys()):
514
693
                    for path in ignored[glob]:
515
 
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
694
                        self.outf.write("ignored %s matching \"%s\"\n"
516
695
                                        % (path, glob))
517
 
            else:
518
 
                match_len = 0
519
 
                for glob, paths in ignored.items():
520
 
                    match_len += len(paths)
521
 
                self.outf.write("ignored %d file(s).\n" % match_len)
522
 
            self.outf.write("If you wish to add some of these files,"
523
 
                            " please add them by name.\n")
524
696
 
525
697
 
526
698
class cmd_mkdir(Command):
527
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
528
700
 
529
701
    This is equivalent to creating the directory and then adding it.
530
702
    """
534
706
 
535
707
    def run(self, dir_list):
536
708
        for d in dir_list:
537
 
            os.mkdir(d)
538
709
            wt, dd = WorkingTree.open_containing(d)
539
 
            wt.add([dd])
540
 
            self.outf.write('added %s\n' % d)
 
710
            base = os.path.dirname(dd)
 
711
            id = wt.path2id(base)
 
712
            if id != None:
 
713
                os.mkdir(d)
 
714
                wt.add([dd])
 
715
                self.outf.write('added %s\n' % d)
 
716
            else:
 
717
                raise errors.NotVersionedError(path=base)
541
718
 
542
719
 
543
720
class cmd_relpath(Command):
544
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
545
722
 
546
723
    takes_args = ['filename']
547
724
    hidden = True
548
 
    
 
725
 
549
726
    @display_command
550
727
    def run(self, filename):
551
728
        # TODO: jam 20050106 Can relpath return a munged path if
556
733
 
557
734
 
558
735
class cmd_inventory(Command):
559
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
560
737
 
561
738
    It is possible to limit the output to a particular entry
562
739
    type using the --kind option.  For example: --kind file.
581
758
        if kind and kind not in ['file', 'directory', 'symlink']:
582
759
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
583
760
 
 
761
        revision = _get_one_revision('inventory', revision)
584
762
        work_tree, file_list = tree_files(file_list)
585
763
        work_tree.lock_read()
586
 
        try:
587
 
            if revision is not None:
588
 
                if len(revision) > 1:
589
 
                    raise errors.BzrCommandError(
590
 
                        'bzr inventory --revision takes exactly one revision'
591
 
                        ' identifier')
592
 
                tree = revision[0].as_tree(work_tree.branch)
593
 
 
594
 
                extra_trees = [work_tree]
595
 
                tree.lock_read()
596
 
            else:
597
 
                tree = work_tree
598
 
                extra_trees = []
599
 
 
600
 
            if file_list is not None:
601
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
602
 
                                          require_versioned=True)
603
 
                # find_ids_across_trees may include some paths that don't
604
 
                # exist in 'tree'.
605
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
606
 
                                 for file_id in file_ids if file_id in tree)
607
 
            else:
608
 
                entries = tree.inventory.entries()
609
 
        finally:
610
 
            tree.unlock()
611
 
            if tree is not work_tree:
612
 
                work_tree.unlock()
613
 
 
 
764
        self.add_cleanup(work_tree.unlock)
 
765
        if revision is not None:
 
766
            tree = revision.as_tree(work_tree.branch)
 
767
 
 
768
            extra_trees = [work_tree]
 
769
            tree.lock_read()
 
770
            self.add_cleanup(tree.unlock)
 
771
        else:
 
772
            tree = work_tree
 
773
            extra_trees = []
 
774
 
 
775
        if file_list is not None:
 
776
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
777
                                      require_versioned=True)
 
778
            # find_ids_across_trees may include some paths that don't
 
779
            # exist in 'tree'.
 
780
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
781
                             for file_id in file_ids if file_id in tree)
 
782
        else:
 
783
            entries = tree.inventory.entries()
 
784
 
 
785
        self.cleanup_now()
614
786
        for path, entry in entries:
615
787
            if kind and kind != entry.kind:
616
788
                continue
622
794
 
623
795
 
624
796
class cmd_mv(Command):
625
 
    """Move or rename a file.
 
797
    __doc__ = """Move or rename a file.
626
798
 
627
799
    :Usage:
628
800
        bzr mv OLDNAME NEWNAME
645
817
    takes_args = ['names*']
646
818
    takes_options = [Option("after", help="Move only the bzr identifier"
647
819
        " of the file, because the file has already been moved."),
 
820
        Option('auto', help='Automatically guess renames.'),
 
821
        Option('dry-run', help='Avoid making changes when guessing renames.'),
648
822
        ]
649
823
    aliases = ['move', 'rename']
650
824
    encoding_type = 'replace'
651
825
 
652
 
    def run(self, names_list, after=False):
 
826
    def run(self, names_list, after=False, auto=False, dry_run=False):
 
827
        if auto:
 
828
            return self.run_auto(names_list, after, dry_run)
 
829
        elif dry_run:
 
830
            raise errors.BzrCommandError('--dry-run requires --auto.')
653
831
        if names_list is None:
654
832
            names_list = []
655
 
 
656
833
        if len(names_list) < 2:
657
834
            raise errors.BzrCommandError("missing file argument")
658
 
        tree, rel_names = tree_files(names_list)
659
 
        tree.lock_write()
660
 
        try:
661
 
            self._run(tree, names_list, rel_names, after)
662
 
        finally:
663
 
            tree.unlock()
 
835
        tree, rel_names = tree_files(names_list, canonicalize=False)
 
836
        tree.lock_tree_write()
 
837
        self.add_cleanup(tree.unlock)
 
838
        self._run(tree, names_list, rel_names, after)
 
839
 
 
840
    def run_auto(self, names_list, after, dry_run):
 
841
        if names_list is not None and len(names_list) > 1:
 
842
            raise errors.BzrCommandError('Only one path may be specified to'
 
843
                                         ' --auto.')
 
844
        if after:
 
845
            raise errors.BzrCommandError('--after cannot be specified with'
 
846
                                         ' --auto.')
 
847
        work_tree, file_list = tree_files(names_list, default_branch='.')
 
848
        work_tree.lock_tree_write()
 
849
        self.add_cleanup(work_tree.unlock)
 
850
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
664
851
 
665
852
    def _run(self, tree, names_list, rel_names, after):
666
853
        into_existing = osutils.isdir(names_list[-1])
675
862
                into_existing = False
676
863
            else:
677
864
                inv = tree.inventory
678
 
                from_id = tree.path2id(rel_names[0])
 
865
                # 'fix' the case of a potential 'from'
 
866
                from_id = tree.path2id(
 
867
                            tree.get_canonical_inventory_path(rel_names[0]))
679
868
                if (not osutils.lexists(names_list[0]) and
680
869
                    from_id and inv.get_file_kind(from_id) == "directory"):
681
870
                    into_existing = False
682
871
        # move/rename
683
872
        if into_existing:
684
873
            # move into existing directory
685
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
686
 
                self.outf.write("%s => %s\n" % pair)
 
874
            # All entries reference existing inventory items, so fix them up
 
875
            # for cicp file-systems.
 
876
            rel_names = tree.get_canonical_inventory_paths(rel_names)
 
877
            for src, dest in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
878
                if not is_quiet():
 
879
                    self.outf.write("%s => %s\n" % (src, dest))
687
880
        else:
688
881
            if len(names_list) != 2:
689
882
                raise errors.BzrCommandError('to mv multiple files the'
690
883
                                             ' destination must be a versioned'
691
884
                                             ' directory')
692
 
            tree.rename_one(rel_names[0], rel_names[1], after=after)
693
 
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
885
 
 
886
            # for cicp file-systems: the src references an existing inventory
 
887
            # item:
 
888
            src = tree.get_canonical_inventory_path(rel_names[0])
 
889
            # Find the canonical version of the destination:  In all cases, the
 
890
            # parent of the target must be in the inventory, so we fetch the
 
891
            # canonical version from there (we do not always *use* the
 
892
            # canonicalized tail portion - we may be attempting to rename the
 
893
            # case of the tail)
 
894
            canon_dest = tree.get_canonical_inventory_path(rel_names[1])
 
895
            dest_parent = osutils.dirname(canon_dest)
 
896
            spec_tail = osutils.basename(rel_names[1])
 
897
            # For a CICP file-system, we need to avoid creating 2 inventory
 
898
            # entries that differ only by case.  So regardless of the case
 
899
            # we *want* to use (ie, specified by the user or the file-system),
 
900
            # we must always choose to use the case of any existing inventory
 
901
            # items.  The only exception to this is when we are attempting a
 
902
            # case-only rename (ie, canonical versions of src and dest are
 
903
            # the same)
 
904
            dest_id = tree.path2id(canon_dest)
 
905
            if dest_id is None or tree.path2id(src) == dest_id:
 
906
                # No existing item we care about, so work out what case we
 
907
                # are actually going to use.
 
908
                if after:
 
909
                    # If 'after' is specified, the tail must refer to a file on disk.
 
910
                    if dest_parent:
 
911
                        dest_parent_fq = osutils.pathjoin(tree.basedir, dest_parent)
 
912
                    else:
 
913
                        # pathjoin with an empty tail adds a slash, which breaks
 
914
                        # relpath :(
 
915
                        dest_parent_fq = tree.basedir
 
916
 
 
917
                    dest_tail = osutils.canonical_relpath(
 
918
                                    dest_parent_fq,
 
919
                                    osutils.pathjoin(dest_parent_fq, spec_tail))
 
920
                else:
 
921
                    # not 'after', so case as specified is used
 
922
                    dest_tail = spec_tail
 
923
            else:
 
924
                # Use the existing item so 'mv' fails with AlreadyVersioned.
 
925
                dest_tail = os.path.basename(canon_dest)
 
926
            dest = osutils.pathjoin(dest_parent, dest_tail)
 
927
            mutter("attempting to move %s => %s", src, dest)
 
928
            tree.rename_one(src, dest, after=after)
 
929
            if not is_quiet():
 
930
                self.outf.write("%s => %s\n" % (src, dest))
694
931
 
695
932
 
696
933
class cmd_pull(Command):
697
 
    """Turn this branch into a mirror of another branch.
 
934
    __doc__ = """Turn this branch into a mirror of another branch.
698
935
 
699
 
    This command only works on branches that have not diverged.  Branches are
700
 
    considered diverged if the destination branch's most recent commit is one
701
 
    that has not been merged (directly or indirectly) into the parent.
 
936
    By default, this command only works on branches that have not diverged.
 
937
    Branches are considered diverged if the destination branch's most recent 
 
938
    commit is one that has not been merged (directly or indirectly) into the 
 
939
    parent.
702
940
 
703
941
    If branches have diverged, you can use 'bzr merge' to integrate the changes
704
942
    from one into the other.  Once one branch has merged, the other should
705
943
    be able to pull it again.
706
944
 
707
 
    If you want to forget your local changes and just update your branch to
708
 
    match the remote one, use pull --overwrite.
 
945
    If you want to replace your local changes and just want your branch to
 
946
    match the remote one, use pull --overwrite. This will work even if the two
 
947
    branches have diverged.
709
948
 
710
949
    If there is no default location set, the first pull will set it.  After
711
950
    that, you can omit the location to use the default.  To change the
717
956
    with bzr send.
718
957
    """
719
958
 
720
 
    _see_also = ['push', 'update', 'status-flags']
 
959
    _see_also = ['push', 'update', 'status-flags', 'send']
721
960
    takes_options = ['remember', 'overwrite', 'revision',
722
961
        custom_help('verbose',
723
962
            help='Show logs of pulled revisions.'),
727
966
            short_name='d',
728
967
            type=unicode,
729
968
            ),
 
969
        Option('local',
 
970
            help="Perform a local pull in a bound "
 
971
                 "branch.  Local pulls are not applied to "
 
972
                 "the master branch."
 
973
            ),
730
974
        ]
731
975
    takes_args = ['location?']
732
976
    encoding_type = 'replace'
733
977
 
734
978
    def run(self, location=None, remember=False, overwrite=False,
735
979
            revision=None, verbose=False,
736
 
            directory=None):
 
980
            directory=None, local=False):
737
981
        # FIXME: too much stuff is in the command class
738
982
        revision_id = None
739
983
        mergeable = None
742
986
        try:
743
987
            tree_to = WorkingTree.open_containing(directory)[0]
744
988
            branch_to = tree_to.branch
 
989
            tree_to.lock_write()
 
990
            self.add_cleanup(tree_to.unlock)
745
991
        except errors.NoWorkingTree:
746
992
            tree_to = None
747
993
            branch_to = Branch.open_containing(directory)[0]
 
994
            branch_to.lock_write()
 
995
            self.add_cleanup(branch_to.unlock)
 
996
 
 
997
        if local and not branch_to.get_bound_location():
 
998
            raise errors.LocalRequiresBoundBranch()
748
999
 
749
1000
        possible_transports = []
750
1001
        if location is not None:
766
1017
                    self.outf.write("Using saved parent location: %s\n" % display_url)
767
1018
                location = stored_loc
768
1019
 
 
1020
        revision = _get_one_revision('pull', revision)
769
1021
        if mergeable is not None:
770
1022
            if revision is not None:
771
1023
                raise errors.BzrCommandError(
777
1029
        else:
778
1030
            branch_from = Branch.open(location,
779
1031
                possible_transports=possible_transports)
 
1032
            branch_from.lock_read()
 
1033
            self.add_cleanup(branch_from.unlock)
780
1034
 
781
1035
            if branch_to.get_parent() is None or remember:
782
1036
                branch_to.set_parent(branch_from.base)
783
1037
 
784
1038
        if revision is not None:
785
 
            if len(revision) == 1:
786
 
                revision_id = revision[0].as_revision_id(branch_from)
787
 
            else:
788
 
                raise errors.BzrCommandError(
789
 
                    'bzr pull --revision takes one value.')
790
 
 
791
 
        branch_to.lock_write()
792
 
        try:
793
 
            if tree_to is not None:
794
 
                change_reporter = delta._ChangeReporter(
795
 
                    unversioned_filter=tree_to.is_ignored)
796
 
                result = tree_to.pull(branch_from, overwrite, revision_id,
797
 
                                      change_reporter,
798
 
                                      possible_transports=possible_transports)
799
 
            else:
800
 
                result = branch_to.pull(branch_from, overwrite, revision_id)
801
 
 
802
 
            result.report(self.outf)
803
 
            if verbose and result.old_revid != result.new_revid:
804
 
                old_rh = list(
805
 
                    branch_to.repository.iter_reverse_revision_history(
806
 
                    result.old_revid))
807
 
                old_rh.reverse()
808
 
                new_rh = branch_to.revision_history()
809
 
                log_format = branch_to.get_config().log_format()
810
 
                log.show_changed_revisions(branch_to, old_rh, new_rh,
811
 
                                           to_file=self.outf,
812
 
                                           log_format=log_format)
813
 
        finally:
814
 
            branch_to.unlock()
 
1039
            revision_id = revision.as_revision_id(branch_from)
 
1040
 
 
1041
        if tree_to is not None:
 
1042
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1043
            change_reporter = delta._ChangeReporter(
 
1044
                unversioned_filter=tree_to.is_ignored,
 
1045
                view_info=view_info)
 
1046
            result = tree_to.pull(
 
1047
                branch_from, overwrite, revision_id, change_reporter,
 
1048
                possible_transports=possible_transports, local=local)
 
1049
        else:
 
1050
            result = branch_to.pull(
 
1051
                branch_from, overwrite, revision_id, local=local)
 
1052
 
 
1053
        result.report(self.outf)
 
1054
        if verbose and result.old_revid != result.new_revid:
 
1055
            log.show_branch_change(
 
1056
                branch_to, self.outf, result.old_revno,
 
1057
                result.old_revid)
815
1058
 
816
1059
 
817
1060
class cmd_push(Command):
818
 
    """Update a mirror of this branch.
819
 
    
 
1061
    __doc__ = """Update a mirror of this branch.
 
1062
 
820
1063
    The target branch will not have its working tree populated because this
821
1064
    is both expensive, and is not supported on remote file systems.
822
 
    
 
1065
 
823
1066
    Some smart servers or protocols *may* put the working tree in place in
824
1067
    the future.
825
1068
 
829
1072
 
830
1073
    If branches have diverged, you can use 'bzr push --overwrite' to replace
831
1074
    the other branch completely, discarding its unmerged changes.
832
 
    
 
1075
 
833
1076
    If you want to ensure you have the different changes in the other branch,
834
1077
    do a merge (see bzr help merge) from the other branch, and commit that.
835
1078
    After that you will be able to do a push without '--overwrite'.
864
1107
                'for the commit history. Only the work not present in the '
865
1108
                'referenced branch is included in the branch created.',
866
1109
            type=unicode),
 
1110
        Option('strict',
 
1111
               help='Refuse to push if there are uncommitted changes in'
 
1112
               ' the working tree, --no-strict disables the check.'),
867
1113
        ]
868
1114
    takes_args = ['location?']
869
1115
    encoding_type = 'replace'
871
1117
    def run(self, location=None, remember=False, overwrite=False,
872
1118
        create_prefix=False, verbose=False, revision=None,
873
1119
        use_existing_dir=False, directory=None, stacked_on=None,
874
 
        stacked=False):
 
1120
        stacked=False, strict=None):
875
1121
        from bzrlib.push import _show_push_branch
876
1122
 
877
 
        # Get the source branch and revision_id
878
1123
        if directory is None:
879
1124
            directory = '.'
880
 
        br_from = Branch.open_containing(directory)[0]
 
1125
        # Get the source branch
 
1126
        (tree, br_from,
 
1127
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
 
1128
        # Get the tip's revision_id
 
1129
        revision = _get_one_revision('push', revision)
881
1130
        if revision is not None:
882
 
            if len(revision) == 1:
883
 
                revision_id = revision[0].in_history(br_from).rev_id
884
 
            else:
885
 
                raise errors.BzrCommandError(
886
 
                    'bzr push --revision takes one value.')
 
1131
            revision_id = revision.in_history(br_from).rev_id
887
1132
        else:
888
 
            revision_id = br_from.last_revision()
889
 
 
 
1133
            revision_id = None
 
1134
        if tree is not None and revision_id is None:
 
1135
            tree.check_changed_or_out_of_date(
 
1136
                strict, 'push_strict',
 
1137
                more_error='Use --no-strict to force the push.',
 
1138
                more_warning='Uncommitted changes will not be pushed.')
890
1139
        # Get the stacked_on branch, if any
891
1140
        if stacked_on is not None:
892
1141
            stacked_on = urlutils.normalize_url(stacked_on)
924
1173
 
925
1174
 
926
1175
class cmd_branch(Command):
927
 
    """Create a new copy of a branch.
 
1176
    __doc__ = """Create a new branch that is a copy of an existing branch.
928
1177
 
929
1178
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
930
1179
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
941
1190
    takes_args = ['from_location', 'to_location?']
942
1191
    takes_options = ['revision', Option('hardlink',
943
1192
        help='Hard-link working tree files where possible.'),
 
1193
        Option('no-tree',
 
1194
            help="Create a branch without a working-tree."),
 
1195
        Option('switch',
 
1196
            help="Switch the checkout in the current directory "
 
1197
                 "to the new branch."),
944
1198
        Option('stacked',
945
1199
            help='Create a stacked branch referring to the source branch. '
946
1200
                'The new branch will depend on the availability of the source '
947
1201
                'branch for all operations.'),
948
1202
        Option('standalone',
949
1203
               help='Do not use a shared repository, even if available.'),
 
1204
        Option('use-existing-dir',
 
1205
               help='By default branch will fail if the target'
 
1206
                    ' directory exists, but does not already'
 
1207
                    ' have a control directory.  This flag will'
 
1208
                    ' allow branch to proceed.'),
 
1209
        Option('bind',
 
1210
            help="Bind new branch to from location."),
950
1211
        ]
951
1212
    aliases = ['get', 'clone']
952
1213
 
953
1214
    def run(self, from_location, to_location=None, revision=None,
954
 
            hardlink=False, stacked=False, standalone=False):
 
1215
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1216
            use_existing_dir=False, switch=False, bind=False):
 
1217
        from bzrlib import switch as _mod_switch
955
1218
        from bzrlib.tag import _merge_tags_if_possible
956
 
        if revision is None:
957
 
            revision = [None]
958
 
        elif len(revision) > 1:
959
 
            raise errors.BzrCommandError(
960
 
                'bzr branch --revision takes exactly 1 revision value')
961
 
 
962
1219
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
963
1220
            from_location)
 
1221
        revision = _get_one_revision('branch', revision)
964
1222
        br_from.lock_read()
 
1223
        self.add_cleanup(br_from.unlock)
 
1224
        if revision is not None:
 
1225
            revision_id = revision.as_revision_id(br_from)
 
1226
        else:
 
1227
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1228
            # None or perhaps NULL_REVISION to mean copy nothing
 
1229
            # RBC 20060209
 
1230
            revision_id = br_from.last_revision()
 
1231
        if to_location is None:
 
1232
            to_location = urlutils.derive_to_location(from_location)
 
1233
        to_transport = transport.get_transport(to_location)
965
1234
        try:
966
 
            if len(revision) == 1 and revision[0] is not None:
967
 
                revision_id = revision[0].as_revision_id(br_from)
 
1235
            to_transport.mkdir('.')
 
1236
        except errors.FileExists:
 
1237
            if not use_existing_dir:
 
1238
                raise errors.BzrCommandError('Target directory "%s" '
 
1239
                    'already exists.' % to_location)
968
1240
            else:
969
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
970
 
                # None or perhaps NULL_REVISION to mean copy nothing
971
 
                # RBC 20060209
972
 
                revision_id = br_from.last_revision()
973
 
            if to_location is None:
974
 
                to_location = urlutils.derive_to_location(from_location)
975
 
            to_transport = transport.get_transport(to_location)
976
 
            try:
977
 
                to_transport.mkdir('.')
978
 
            except errors.FileExists:
979
 
                raise errors.BzrCommandError('Target directory "%s" already'
980
 
                                             ' exists.' % to_location)
981
 
            except errors.NoSuchFile:
982
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
983
 
                                             % to_location)
984
 
            try:
985
 
                # preserve whatever source format we have.
986
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
987
 
                                            possible_transports=[to_transport],
988
 
                                            accelerator_tree=accelerator_tree,
989
 
                                            hardlink=hardlink, stacked=stacked,
990
 
                                            force_new_repo=standalone,
991
 
                                            source_branch=br_from)
992
 
                branch = dir.open_branch()
993
 
            except errors.NoSuchRevision:
994
 
                to_transport.delete_tree('.')
995
 
                msg = "The branch %s has no revision %s." % (from_location,
996
 
                    revision[0])
997
 
                raise errors.BzrCommandError(msg)
998
 
            _merge_tags_if_possible(br_from, branch)
999
 
            # If the source branch is stacked, the new branch may
1000
 
            # be stacked whether we asked for that explicitly or not.
1001
 
            # We therefore need a try/except here and not just 'if stacked:'
1002
 
            try:
1003
 
                note('Created new stacked branch referring to %s.' %
1004
 
                    branch.get_stacked_on_url())
1005
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
1006
 
                errors.UnstackableRepositoryFormat), e:
1007
 
                note('Branched %d revision(s).' % branch.revno())
1008
 
        finally:
1009
 
            br_from.unlock()
 
1241
                try:
 
1242
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1243
                except errors.NotBranchError:
 
1244
                    pass
 
1245
                else:
 
1246
                    raise errors.AlreadyBranchError(to_location)
 
1247
        except errors.NoSuchFile:
 
1248
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1249
                                         % to_location)
 
1250
        try:
 
1251
            # preserve whatever source format we have.
 
1252
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1253
                                        possible_transports=[to_transport],
 
1254
                                        accelerator_tree=accelerator_tree,
 
1255
                                        hardlink=hardlink, stacked=stacked,
 
1256
                                        force_new_repo=standalone,
 
1257
                                        create_tree_if_local=not no_tree,
 
1258
                                        source_branch=br_from)
 
1259
            branch = dir.open_branch()
 
1260
        except errors.NoSuchRevision:
 
1261
            to_transport.delete_tree('.')
 
1262
            msg = "The branch %s has no revision %s." % (from_location,
 
1263
                revision)
 
1264
            raise errors.BzrCommandError(msg)
 
1265
        _merge_tags_if_possible(br_from, branch)
 
1266
        # If the source branch is stacked, the new branch may
 
1267
        # be stacked whether we asked for that explicitly or not.
 
1268
        # We therefore need a try/except here and not just 'if stacked:'
 
1269
        try:
 
1270
            note('Created new stacked branch referring to %s.' %
 
1271
                branch.get_stacked_on_url())
 
1272
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1273
            errors.UnstackableRepositoryFormat), e:
 
1274
            note('Branched %d revision(s).' % branch.revno())
 
1275
        if bind:
 
1276
            # Bind to the parent
 
1277
            parent_branch = Branch.open(from_location)
 
1278
            branch.bind(parent_branch)
 
1279
            note('New branch bound to %s' % from_location)
 
1280
        if switch:
 
1281
            # Switch to the new branch
 
1282
            wt, _ = WorkingTree.open_containing('.')
 
1283
            _mod_switch.switch(wt.bzrdir, branch)
 
1284
            note('Switched to branch: %s',
 
1285
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1010
1286
 
1011
1287
 
1012
1288
class cmd_checkout(Command):
1013
 
    """Create a new checkout of an existing branch.
 
1289
    __doc__ = """Create a new checkout of an existing branch.
1014
1290
 
1015
1291
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1016
1292
    the branch found in '.'. This is useful if you have removed the working tree
1017
1293
    or if it was never created - i.e. if you pushed the branch to its current
1018
1294
    location using SFTP.
1019
 
    
 
1295
 
1020
1296
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1021
1297
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1022
1298
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1050
1326
 
1051
1327
    def run(self, branch_location=None, to_location=None, revision=None,
1052
1328
            lightweight=False, files_from=None, hardlink=False):
1053
 
        if revision is None:
1054
 
            revision = [None]
1055
 
        elif len(revision) > 1:
1056
 
            raise errors.BzrCommandError(
1057
 
                'bzr checkout --revision takes exactly 1 revision value')
1058
1329
        if branch_location is None:
1059
1330
            branch_location = osutils.getcwd()
1060
1331
            to_location = branch_location
1061
1332
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1062
1333
            branch_location)
 
1334
        revision = _get_one_revision('checkout', revision)
1063
1335
        if files_from is not None:
1064
1336
            accelerator_tree = WorkingTree.open(files_from)
1065
 
        if len(revision) == 1 and revision[0] is not None:
1066
 
            revision_id = revision[0].as_revision_id(source)
 
1337
        if revision is not None:
 
1338
            revision_id = revision.as_revision_id(source)
1067
1339
        else:
1068
1340
            revision_id = None
1069
1341
        if to_location is None:
1070
1342
            to_location = urlutils.derive_to_location(branch_location)
1071
 
        # if the source and to_location are the same, 
 
1343
        # if the source and to_location are the same,
1072
1344
        # and there is no working tree,
1073
1345
        # then reconstitute a branch
1074
1346
        if (osutils.abspath(to_location) ==
1083
1355
 
1084
1356
 
1085
1357
class cmd_renames(Command):
1086
 
    """Show list of renamed files.
 
1358
    __doc__ = """Show list of renamed files.
1087
1359
    """
1088
1360
    # TODO: Option to show renames between two historical versions.
1089
1361
 
1095
1367
    def run(self, dir=u'.'):
1096
1368
        tree = WorkingTree.open_containing(dir)[0]
1097
1369
        tree.lock_read()
1098
 
        try:
1099
 
            new_inv = tree.inventory
1100
 
            old_tree = tree.basis_tree()
1101
 
            old_tree.lock_read()
1102
 
            try:
1103
 
                old_inv = old_tree.inventory
1104
 
                renames = []
1105
 
                iterator = tree.iter_changes(old_tree, include_unchanged=True)
1106
 
                for f, paths, c, v, p, n, k, e in iterator:
1107
 
                    if paths[0] == paths[1]:
1108
 
                        continue
1109
 
                    if None in (paths):
1110
 
                        continue
1111
 
                    renames.append(paths)
1112
 
                renames.sort()
1113
 
                for old_name, new_name in renames:
1114
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
1115
 
            finally:
1116
 
                old_tree.unlock()
1117
 
        finally:
1118
 
            tree.unlock()
 
1370
        self.add_cleanup(tree.unlock)
 
1371
        new_inv = tree.inventory
 
1372
        old_tree = tree.basis_tree()
 
1373
        old_tree.lock_read()
 
1374
        self.add_cleanup(old_tree.unlock)
 
1375
        old_inv = old_tree.inventory
 
1376
        renames = []
 
1377
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1378
        for f, paths, c, v, p, n, k, e in iterator:
 
1379
            if paths[0] == paths[1]:
 
1380
                continue
 
1381
            if None in (paths):
 
1382
                continue
 
1383
            renames.append(paths)
 
1384
        renames.sort()
 
1385
        for old_name, new_name in renames:
 
1386
            self.outf.write("%s => %s\n" % (old_name, new_name))
1119
1387
 
1120
1388
 
1121
1389
class cmd_update(Command):
1122
 
    """Update a tree to have the latest code committed to its branch.
1123
 
    
 
1390
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1391
 
1124
1392
    This will perform a merge into the working tree, and may generate
1125
 
    conflicts. If you have any local changes, you will still 
 
1393
    conflicts. If you have any local changes, you will still
1126
1394
    need to commit them after the update for the update to be complete.
1127
 
    
1128
 
    If you want to discard your local changes, you can just do a 
 
1395
 
 
1396
    If you want to discard your local changes, you can just do a
1129
1397
    'bzr revert' instead of 'bzr commit' after the update.
 
1398
 
 
1399
    If the tree's branch is bound to a master branch, it will also update
 
1400
    the branch from the master.
1130
1401
    """
1131
1402
 
1132
1403
    _see_also = ['pull', 'working-trees', 'status-flags']
1133
1404
    takes_args = ['dir?']
 
1405
    takes_options = ['revision']
1134
1406
    aliases = ['up']
1135
1407
 
1136
 
    def run(self, dir='.'):
 
1408
    def run(self, dir='.', revision=None):
 
1409
        if revision is not None and len(revision) != 1:
 
1410
            raise errors.BzrCommandError(
 
1411
                        "bzr update --revision takes exactly one revision")
1137
1412
        tree = WorkingTree.open_containing(dir)[0]
 
1413
        branch = tree.branch
1138
1414
        possible_transports = []
1139
 
        master = tree.branch.get_master_branch(
 
1415
        master = branch.get_master_branch(
1140
1416
            possible_transports=possible_transports)
1141
1417
        if master is not None:
1142
1418
            tree.lock_write()
 
1419
            branch_location = master.base
1143
1420
        else:
1144
1421
            tree.lock_tree_write()
 
1422
            branch_location = tree.branch.base
 
1423
        self.add_cleanup(tree.unlock)
 
1424
        # get rid of the final '/' and be ready for display
 
1425
        branch_location = urlutils.unescape_for_display(
 
1426
            branch_location.rstrip('/'),
 
1427
            self.outf.encoding)
 
1428
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1429
        if master is None:
 
1430
            old_tip = None
 
1431
        else:
 
1432
            # may need to fetch data into a heavyweight checkout
 
1433
            # XXX: this may take some time, maybe we should display a
 
1434
            # message
 
1435
            old_tip = branch.update(possible_transports)
 
1436
        if revision is not None:
 
1437
            revision_id = revision[0].as_revision_id(branch)
 
1438
        else:
 
1439
            revision_id = branch.last_revision()
 
1440
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1441
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1442
            note("Tree is up to date at revision %s of branch %s" %
 
1443
                ('.'.join(map(str, revno)), branch_location))
 
1444
            return 0
 
1445
        view_info = _get_view_info_for_change_reporter(tree)
 
1446
        change_reporter = delta._ChangeReporter(
 
1447
            unversioned_filter=tree.is_ignored,
 
1448
            view_info=view_info)
1145
1449
        try:
1146
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1147
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1148
 
            if last_rev == _mod_revision.ensure_null(
1149
 
                tree.branch.last_revision()):
1150
 
                # may be up to date, check master too.
1151
 
                if master is None or last_rev == _mod_revision.ensure_null(
1152
 
                    master.last_revision()):
1153
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1154
 
                    note("Tree is up to date at revision %d." % (revno,))
1155
 
                    return 0
1156
1450
            conflicts = tree.update(
1157
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1158
 
                possible_transports=possible_transports)
1159
 
            revno = tree.branch.revision_id_to_revno(
1160
 
                _mod_revision.ensure_null(tree.last_revision()))
1161
 
            note('Updated to revision %d.' % (revno,))
1162
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1163
 
                note('Your local commits will now show as pending merges with '
1164
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1165
 
            if conflicts != 0:
1166
 
                return 1
1167
 
            else:
1168
 
                return 0
1169
 
        finally:
1170
 
            tree.unlock()
 
1451
                change_reporter,
 
1452
                possible_transports=possible_transports,
 
1453
                revision=revision_id,
 
1454
                old_tip=old_tip)
 
1455
        except errors.NoSuchRevision, e:
 
1456
            raise errors.BzrCommandError(
 
1457
                                  "branch has no revision %s\n"
 
1458
                                  "bzr update --revision only works"
 
1459
                                  " for a revision in the branch history"
 
1460
                                  % (e.revision))
 
1461
        revno = tree.branch.revision_id_to_dotted_revno(
 
1462
            _mod_revision.ensure_null(tree.last_revision()))
 
1463
        note('Updated to revision %s of branch %s' %
 
1464
             ('.'.join(map(str, revno)), branch_location))
 
1465
        parent_ids = tree.get_parent_ids()
 
1466
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1467
            note('Your local commits will now show as pending merges with '
 
1468
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1469
        if conflicts != 0:
 
1470
            return 1
 
1471
        else:
 
1472
            return 0
1171
1473
 
1172
1474
 
1173
1475
class cmd_info(Command):
1174
 
    """Show information about a working tree, branch or repository.
 
1476
    __doc__ = """Show information about a working tree, branch or repository.
1175
1477
 
1176
1478
    This command will show all known locations and formats associated to the
1177
 
    tree, branch or repository.  Statistical information is included with
1178
 
    each report.
 
1479
    tree, branch or repository.
 
1480
 
 
1481
    In verbose mode, statistical information is included with each report.
 
1482
    To see extended statistic information, use a verbosity level of 2 or
 
1483
    higher by specifying the verbose option multiple times, e.g. -vv.
1179
1484
 
1180
1485
    Branches and working trees will also report any missing revisions.
 
1486
 
 
1487
    :Examples:
 
1488
 
 
1489
      Display information on the format and related locations:
 
1490
 
 
1491
        bzr info
 
1492
 
 
1493
      Display the above together with extended format information and
 
1494
      basic statistics (like the number of files in the working tree and
 
1495
      number of revisions in the branch and repository):
 
1496
 
 
1497
        bzr info -v
 
1498
 
 
1499
      Display the above together with number of committers to the branch:
 
1500
 
 
1501
        bzr info -vv
1181
1502
    """
1182
1503
    _see_also = ['revno', 'working-trees', 'repositories']
1183
1504
    takes_args = ['location?']
1187
1508
    @display_command
1188
1509
    def run(self, location=None, verbose=False):
1189
1510
        if verbose:
1190
 
            noise_level = 2
 
1511
            noise_level = get_verbosity_level()
1191
1512
        else:
1192
1513
            noise_level = 0
1193
1514
        from bzrlib.info import show_bzrdir_info
1196
1517
 
1197
1518
 
1198
1519
class cmd_remove(Command):
1199
 
    """Remove files or directories.
 
1520
    __doc__ = """Remove files or directories.
1200
1521
 
1201
1522
    This makes bzr stop tracking changes to the specified files. bzr will delete
1202
1523
    them if they can easily be recovered using revert. If no options or
1211
1532
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1212
1533
            safe='Only delete files if they can be'
1213
1534
                 ' safely recovered (default).',
1214
 
            keep="Don't delete any files.",
 
1535
            keep='Delete from bzr but leave the working copy.',
1215
1536
            force='Delete all the specified files, even if they can not be '
1216
1537
                'recovered and even if they are non-empty directories.')]
1217
1538
    aliases = ['rm', 'del']
1225
1546
            file_list = [f for f in file_list]
1226
1547
 
1227
1548
        tree.lock_write()
1228
 
        try:
1229
 
            # Heuristics should probably all move into tree.remove_smart or
1230
 
            # some such?
1231
 
            if new:
1232
 
                added = tree.changes_from(tree.basis_tree(),
1233
 
                    specific_files=file_list).added
1234
 
                file_list = sorted([f[0] for f in added], reverse=True)
1235
 
                if len(file_list) == 0:
1236
 
                    raise errors.BzrCommandError('No matching files.')
1237
 
            elif file_list is None:
1238
 
                # missing files show up in iter_changes(basis) as
1239
 
                # versioned-with-no-kind.
1240
 
                missing = []
1241
 
                for change in tree.iter_changes(tree.basis_tree()):
1242
 
                    # Find paths in the working tree that have no kind:
1243
 
                    if change[1][1] is not None and change[6][1] is None:
1244
 
                        missing.append(change[1][1])
1245
 
                file_list = sorted(missing, reverse=True)
1246
 
                file_deletion_strategy = 'keep'
1247
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1248
 
                keep_files=file_deletion_strategy=='keep',
1249
 
                force=file_deletion_strategy=='force')
1250
 
        finally:
1251
 
            tree.unlock()
 
1549
        self.add_cleanup(tree.unlock)
 
1550
        # Heuristics should probably all move into tree.remove_smart or
 
1551
        # some such?
 
1552
        if new:
 
1553
            added = tree.changes_from(tree.basis_tree(),
 
1554
                specific_files=file_list).added
 
1555
            file_list = sorted([f[0] for f in added], reverse=True)
 
1556
            if len(file_list) == 0:
 
1557
                raise errors.BzrCommandError('No matching files.')
 
1558
        elif file_list is None:
 
1559
            # missing files show up in iter_changes(basis) as
 
1560
            # versioned-with-no-kind.
 
1561
            missing = []
 
1562
            for change in tree.iter_changes(tree.basis_tree()):
 
1563
                # Find paths in the working tree that have no kind:
 
1564
                if change[1][1] is not None and change[6][1] is None:
 
1565
                    missing.append(change[1][1])
 
1566
            file_list = sorted(missing, reverse=True)
 
1567
            file_deletion_strategy = 'keep'
 
1568
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1569
            keep_files=file_deletion_strategy=='keep',
 
1570
            force=file_deletion_strategy=='force')
1252
1571
 
1253
1572
 
1254
1573
class cmd_file_id(Command):
1255
 
    """Print file_id of a particular file or directory.
 
1574
    __doc__ = """Print file_id of a particular file or directory.
1256
1575
 
1257
1576
    The file_id is assigned when the file is first added and remains the
1258
1577
    same through all revisions where the file exists, even when it is
1274
1593
 
1275
1594
 
1276
1595
class cmd_file_path(Command):
1277
 
    """Print path of file_ids to a file or directory.
 
1596
    __doc__ = """Print path of file_ids to a file or directory.
1278
1597
 
1279
1598
    This prints one line for each directory down to the target,
1280
1599
    starting at the branch root.
1296
1615
 
1297
1616
 
1298
1617
class cmd_reconcile(Command):
1299
 
    """Reconcile bzr metadata in a branch.
 
1618
    __doc__ = """Reconcile bzr metadata in a branch.
1300
1619
 
1301
1620
    This can correct data mismatches that may have been caused by
1302
1621
    previous ghost operations or bzr upgrades. You should only
1303
 
    need to run this command if 'bzr check' or a bzr developer 
 
1622
    need to run this command if 'bzr check' or a bzr developer
1304
1623
    advises you to run it.
1305
1624
 
1306
1625
    If a second branch is provided, cross-branch reconciliation is
1308
1627
    id which was not present in very early bzr versions is represented
1309
1628
    correctly in both branches.
1310
1629
 
1311
 
    At the same time it is run it may recompress data resulting in 
 
1630
    At the same time it is run it may recompress data resulting in
1312
1631
    a potential saving in disk space or performance gain.
1313
1632
 
1314
1633
    The branch *MUST* be on a listable system such as local disk or sftp.
1324
1643
 
1325
1644
 
1326
1645
class cmd_revision_history(Command):
1327
 
    """Display the list of revision ids on a branch."""
 
1646
    __doc__ = """Display the list of revision ids on a branch."""
1328
1647
 
1329
1648
    _see_also = ['log']
1330
1649
    takes_args = ['location?']
1340
1659
 
1341
1660
 
1342
1661
class cmd_ancestry(Command):
1343
 
    """List all revisions merged into this branch."""
 
1662
    __doc__ = """List all revisions merged into this branch."""
1344
1663
 
1345
1664
    _see_also = ['log', 'revision-history']
1346
1665
    takes_args = ['location?']
1365
1684
 
1366
1685
 
1367
1686
class cmd_init(Command):
1368
 
    """Make a directory into a versioned branch.
 
1687
    __doc__ = """Make a directory into a versioned branch.
1369
1688
 
1370
1689
    Use this to create an empty branch, or before importing an
1371
1690
    existing project.
1372
1691
 
1373
 
    If there is a repository in a parent directory of the location, then 
 
1692
    If there is a repository in a parent directory of the location, then
1374
1693
    the history of the branch will be stored in the repository.  Otherwise
1375
1694
    init creates a standalone branch which carries its own history
1376
1695
    in the .bzr directory.
1399
1718
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1400
1719
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1401
1720
                value_switches=True,
1402
 
                title="Branch Format",
 
1721
                title="Branch format",
1403
1722
                ),
1404
1723
         Option('append-revisions-only',
1405
1724
                help='Never change revnos or the existing log.'
1428
1747
                    "\nYou may supply --create-prefix to create all"
1429
1748
                    " leading parent directories."
1430
1749
                    % location)
1431
 
            _create_prefix(to_transport)
 
1750
            to_transport.create_prefix()
1432
1751
 
1433
1752
        try:
1434
1753
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1452
1771
                branch.set_append_revisions_only(True)
1453
1772
            except errors.UpgradeRequired:
1454
1773
                raise errors.BzrCommandError('This branch format cannot be set'
1455
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
1774
                    ' to append-revisions-only.  Try --default.')
1456
1775
        if not is_quiet():
1457
 
            from bzrlib.info import show_bzrdir_info
1458
 
            show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
 
1776
            from bzrlib.info import describe_layout, describe_format
 
1777
            try:
 
1778
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
1779
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
1780
                tree = None
 
1781
            repository = branch.repository
 
1782
            layout = describe_layout(repository, branch, tree).lower()
 
1783
            format = describe_format(a_bzrdir, repository, branch, tree)
 
1784
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
 
1785
            if repository.is_shared():
 
1786
                #XXX: maybe this can be refactored into transport.path_or_url()
 
1787
                url = repository.bzrdir.root_transport.external_url()
 
1788
                try:
 
1789
                    url = urlutils.local_path_from_url(url)
 
1790
                except errors.InvalidURL:
 
1791
                    pass
 
1792
                self.outf.write("Using shared repository: %s\n" % url)
1459
1793
 
1460
1794
 
1461
1795
class cmd_init_repository(Command):
1462
 
    """Create a shared repository to hold branches.
 
1796
    __doc__ = """Create a shared repository for branches to share storage space.
1463
1797
 
1464
1798
    New branches created under the repository directory will store their
1465
 
    revisions in the repository, not in the branch directory.
 
1799
    revisions in the repository, not in the branch directory.  For branches
 
1800
    with shared history, this reduces the amount of storage needed and 
 
1801
    speeds up the creation of new branches.
1466
1802
 
1467
 
    If the --no-trees option is used then the branches in the repository
1468
 
    will not have working trees by default.
 
1803
    If the --no-trees option is given then the branches in the repository
 
1804
    will not have working trees by default.  They will still exist as 
 
1805
    directories on disk, but they will not have separate copies of the 
 
1806
    files at a certain revision.  This can be useful for repositories that
 
1807
    store branches which are interacted with through checkouts or remote
 
1808
    branches, such as on a server.
1469
1809
 
1470
1810
    :Examples:
1471
 
        Create a shared repositories holding just branches::
 
1811
        Create a shared repository holding just branches::
1472
1812
 
1473
1813
            bzr init-repo --no-trees repo
1474
1814
            bzr init repo/trunk
1513
1853
 
1514
1854
 
1515
1855
class cmd_diff(Command):
1516
 
    """Show differences in the working tree, between revisions or branches.
1517
 
    
 
1856
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
1857
 
1518
1858
    If no arguments are given, all changes for the current tree are listed.
1519
1859
    If files are given, only the changes in those files are listed.
1520
1860
    Remote and multiple branches can be compared by using the --old and
1540
1880
 
1541
1881
            bzr diff -r1
1542
1882
 
1543
 
        Difference between revision 2 and revision 1::
1544
 
 
1545
 
            bzr diff -r1..2
1546
 
 
1547
 
        Difference between revision 2 and revision 1 for branch xxx::
1548
 
 
1549
 
            bzr diff -r1..2 xxx
 
1883
        Difference between revision 3 and revision 1::
 
1884
 
 
1885
            bzr diff -r1..3
 
1886
 
 
1887
        Difference between revision 3 and revision 1 for branch xxx::
 
1888
 
 
1889
            bzr diff -r1..3 xxx
 
1890
 
 
1891
        To see the changes introduced in revision X::
 
1892
        
 
1893
            bzr diff -cX
 
1894
 
 
1895
        Note that in the case of a merge, the -c option shows the changes
 
1896
        compared to the left hand parent. To see the changes against
 
1897
        another parent, use::
 
1898
 
 
1899
            bzr diff -r<chosen_parent>..X
 
1900
 
 
1901
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
1902
 
 
1903
            bzr diff -c2
1550
1904
 
1551
1905
        Show just the differences for file NEWS::
1552
1906
 
1591
1945
            help='Use this command to compare files.',
1592
1946
            type=unicode,
1593
1947
            ),
 
1948
        RegistryOption('format',
 
1949
            help='Diff format to use.',
 
1950
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
1951
            value_switches=False, title='Diff format'),
1594
1952
        ]
1595
1953
    aliases = ['di', 'dif']
1596
1954
    encoding_type = 'exact'
1597
1955
 
1598
1956
    @display_command
1599
1957
    def run(self, revision=None, file_list=None, diff_options=None,
1600
 
            prefix=None, old=None, new=None, using=None):
1601
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
1958
            prefix=None, old=None, new=None, using=None, format=None):
 
1959
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
1960
            show_diff_trees)
1602
1961
 
1603
1962
        if (prefix is None) or (prefix == '0'):
1604
1963
            # diff -p0 format
1618
1977
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1619
1978
                                         ' one or two revision specifiers')
1620
1979
 
1621
 
        old_tree, new_tree, specific_files, extra_trees = \
1622
 
                _get_trees_to_diff(file_list, revision, old, new)
1623
 
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
1980
        if using is not None and format is not None:
 
1981
            raise errors.BzrCommandError('--using and --format are mutually '
 
1982
                'exclusive.')
 
1983
 
 
1984
        (old_tree, new_tree,
 
1985
         old_branch, new_branch,
 
1986
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
1987
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
1988
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1624
1989
                               specific_files=specific_files,
1625
1990
                               external_diff_options=diff_options,
1626
1991
                               old_label=old_label, new_label=new_label,
1627
 
                               extra_trees=extra_trees, using=using)
 
1992
                               extra_trees=extra_trees, using=using,
 
1993
                               format_cls=format)
1628
1994
 
1629
1995
 
1630
1996
class cmd_deleted(Command):
1631
 
    """List files deleted in the working tree.
 
1997
    __doc__ = """List files deleted in the working tree.
1632
1998
    """
1633
1999
    # TODO: Show files deleted since a previous revision, or
1634
2000
    # between two revisions.
1643
2009
    def run(self, show_ids=False):
1644
2010
        tree = WorkingTree.open_containing(u'.')[0]
1645
2011
        tree.lock_read()
1646
 
        try:
1647
 
            old = tree.basis_tree()
1648
 
            old.lock_read()
1649
 
            try:
1650
 
                for path, ie in old.inventory.iter_entries():
1651
 
                    if not tree.has_id(ie.file_id):
1652
 
                        self.outf.write(path)
1653
 
                        if show_ids:
1654
 
                            self.outf.write(' ')
1655
 
                            self.outf.write(ie.file_id)
1656
 
                        self.outf.write('\n')
1657
 
            finally:
1658
 
                old.unlock()
1659
 
        finally:
1660
 
            tree.unlock()
 
2012
        self.add_cleanup(tree.unlock)
 
2013
        old = tree.basis_tree()
 
2014
        old.lock_read()
 
2015
        self.add_cleanup(old.unlock)
 
2016
        for path, ie in old.inventory.iter_entries():
 
2017
            if not tree.has_id(ie.file_id):
 
2018
                self.outf.write(path)
 
2019
                if show_ids:
 
2020
                    self.outf.write(' ')
 
2021
                    self.outf.write(ie.file_id)
 
2022
                self.outf.write('\n')
1661
2023
 
1662
2024
 
1663
2025
class cmd_modified(Command):
1664
 
    """List files modified in working tree.
 
2026
    __doc__ = """List files modified in working tree.
1665
2027
    """
1666
2028
 
1667
2029
    hidden = True
1684
2046
 
1685
2047
 
1686
2048
class cmd_added(Command):
1687
 
    """List files added in working tree.
 
2049
    __doc__ = """List files added in working tree.
1688
2050
    """
1689
2051
 
1690
2052
    hidden = True
1699
2061
    def run(self, null=False):
1700
2062
        wt = WorkingTree.open_containing(u'.')[0]
1701
2063
        wt.lock_read()
1702
 
        try:
1703
 
            basis = wt.basis_tree()
1704
 
            basis.lock_read()
1705
 
            try:
1706
 
                basis_inv = basis.inventory
1707
 
                inv = wt.inventory
1708
 
                for file_id in inv:
1709
 
                    if file_id in basis_inv:
1710
 
                        continue
1711
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1712
 
                        continue
1713
 
                    path = inv.id2path(file_id)
1714
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1715
 
                        continue
1716
 
                    if null:
1717
 
                        self.outf.write(path + '\0')
1718
 
                    else:
1719
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1720
 
            finally:
1721
 
                basis.unlock()
1722
 
        finally:
1723
 
            wt.unlock()
 
2064
        self.add_cleanup(wt.unlock)
 
2065
        basis = wt.basis_tree()
 
2066
        basis.lock_read()
 
2067
        self.add_cleanup(basis.unlock)
 
2068
        basis_inv = basis.inventory
 
2069
        inv = wt.inventory
 
2070
        for file_id in inv:
 
2071
            if file_id in basis_inv:
 
2072
                continue
 
2073
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
2074
                continue
 
2075
            path = inv.id2path(file_id)
 
2076
            if not os.access(osutils.abspath(path), os.F_OK):
 
2077
                continue
 
2078
            if null:
 
2079
                self.outf.write(path + '\0')
 
2080
            else:
 
2081
                self.outf.write(osutils.quotefn(path) + '\n')
1724
2082
 
1725
2083
 
1726
2084
class cmd_root(Command):
1727
 
    """Show the tree root directory.
 
2085
    __doc__ = """Show the tree root directory.
1728
2086
 
1729
2087
    The root is the nearest enclosing directory with a .bzr control
1730
2088
    directory."""
1745
2103
        raise errors.BzrCommandError(msg)
1746
2104
 
1747
2105
 
 
2106
def _parse_levels(s):
 
2107
    try:
 
2108
        return int(s)
 
2109
    except ValueError:
 
2110
        msg = "The levels argument must be an integer."
 
2111
        raise errors.BzrCommandError(msg)
 
2112
 
 
2113
 
1748
2114
class cmd_log(Command):
1749
 
    """Show log of a branch, file, or directory.
1750
 
 
1751
 
    By default show the log of the branch containing the working directory.
1752
 
 
1753
 
    To request a range of logs, you can use the command -r begin..end
1754
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
1755
 
    also valid.
1756
 
 
1757
 
    :Examples:
1758
 
        Log the current branch::
1759
 
 
1760
 
            bzr log
1761
 
 
1762
 
        Log a file::
1763
 
 
1764
 
            bzr log foo.c
1765
 
 
1766
 
        Log the last 10 revisions of a branch::
1767
 
 
1768
 
            bzr log -r -10.. http://server/branch
 
2115
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2116
 
 
2117
    log is bzr's default tool for exploring the history of a branch.
 
2118
    The branch to use is taken from the first parameter. If no parameters
 
2119
    are given, the branch containing the working directory is logged.
 
2120
    Here are some simple examples::
 
2121
 
 
2122
      bzr log                       log the current branch
 
2123
      bzr log foo.py                log a file in its branch
 
2124
      bzr log http://server/branch  log a branch on a server
 
2125
 
 
2126
    The filtering, ordering and information shown for each revision can
 
2127
    be controlled as explained below. By default, all revisions are
 
2128
    shown sorted (topologically) so that newer revisions appear before
 
2129
    older ones and descendants always appear before ancestors. If displayed,
 
2130
    merged revisions are shown indented under the revision in which they
 
2131
    were merged.
 
2132
 
 
2133
    :Output control:
 
2134
 
 
2135
      The log format controls how information about each revision is
 
2136
      displayed. The standard log formats are called ``long``, ``short``
 
2137
      and ``line``. The default is long. See ``bzr help log-formats``
 
2138
      for more details on log formats.
 
2139
 
 
2140
      The following options can be used to control what information is
 
2141
      displayed::
 
2142
 
 
2143
        -l N        display a maximum of N revisions
 
2144
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
2145
        -v          display a status summary (delta) for each revision
 
2146
        -p          display a diff (patch) for each revision
 
2147
        --show-ids  display revision-ids (and file-ids), not just revnos
 
2148
 
 
2149
      Note that the default number of levels to display is a function of the
 
2150
      log format. If the -n option is not used, the standard log formats show
 
2151
      just the top level (mainline).
 
2152
 
 
2153
      Status summaries are shown using status flags like A, M, etc. To see
 
2154
      the changes explained using words like ``added`` and ``modified``
 
2155
      instead, use the -vv option.
 
2156
 
 
2157
    :Ordering control:
 
2158
 
 
2159
      To display revisions from oldest to newest, use the --forward option.
 
2160
      In most cases, using this option will have little impact on the total
 
2161
      time taken to produce a log, though --forward does not incrementally
 
2162
      display revisions like --reverse does when it can.
 
2163
 
 
2164
    :Revision filtering:
 
2165
 
 
2166
      The -r option can be used to specify what revision or range of revisions
 
2167
      to filter against. The various forms are shown below::
 
2168
 
 
2169
        -rX      display revision X
 
2170
        -rX..    display revision X and later
 
2171
        -r..Y    display up to and including revision Y
 
2172
        -rX..Y   display from X to Y inclusive
 
2173
 
 
2174
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
2175
      Some common examples are given below::
 
2176
 
 
2177
        -r-1                show just the tip
 
2178
        -r-10..             show the last 10 mainline revisions
 
2179
        -rsubmit:..         show what's new on this branch
 
2180
        -rancestor:path..   show changes since the common ancestor of this
 
2181
                            branch and the one at location path
 
2182
        -rdate:yesterday..  show changes since yesterday
 
2183
 
 
2184
      When logging a range of revisions using -rX..Y, log starts at
 
2185
      revision Y and searches back in history through the primary
 
2186
      ("left-hand") parents until it finds X. When logging just the
 
2187
      top level (using -n1), an error is reported if X is not found
 
2188
      along the way. If multi-level logging is used (-n0), X may be
 
2189
      a nested merge revision and the log will be truncated accordingly.
 
2190
 
 
2191
    :Path filtering:
 
2192
 
 
2193
      If parameters are given and the first one is not a branch, the log
 
2194
      will be filtered to show only those revisions that changed the
 
2195
      nominated files or directories.
 
2196
 
 
2197
      Filenames are interpreted within their historical context. To log a
 
2198
      deleted file, specify a revision range so that the file existed at
 
2199
      the end or start of the range.
 
2200
 
 
2201
      Historical context is also important when interpreting pathnames of
 
2202
      renamed files/directories. Consider the following example:
 
2203
 
 
2204
      * revision 1: add tutorial.txt
 
2205
      * revision 2: modify tutorial.txt
 
2206
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
2207
 
 
2208
      In this case:
 
2209
 
 
2210
      * ``bzr log guide.txt`` will log the file added in revision 1
 
2211
 
 
2212
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
2213
 
 
2214
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
2215
        the original file in revision 2.
 
2216
 
 
2217
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
2218
        was no file called guide.txt in revision 2.
 
2219
 
 
2220
      Renames are always followed by log. By design, there is no need to
 
2221
      explicitly ask for this (and no way to stop logging a file back
 
2222
      until it was last renamed).
 
2223
 
 
2224
    :Other filtering:
 
2225
 
 
2226
      The --message option can be used for finding revisions that match a
 
2227
      regular expression in a commit message.
 
2228
 
 
2229
    :Tips & tricks:
 
2230
 
 
2231
      GUI tools and IDEs are often better at exploring history than command
 
2232
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2233
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2234
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2235
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2236
 
 
2237
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
2238
 
 
2239
        [ALIASES]
 
2240
        tip = log -r-1
 
2241
        top = log -l10 --line
 
2242
        show = log -v -p
 
2243
 
 
2244
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
2245
      will show the last 10 mainline revisions. To see the details of a
 
2246
      particular revision X,  ``bzr show -rX``.
 
2247
 
 
2248
      If you are interested in looking deeper into a particular merge X,
 
2249
      use ``bzr log -n0 -rX``.
 
2250
 
 
2251
      ``bzr log -v`` on a branch with lots of history is currently
 
2252
      very slow. A fix for this issue is currently under development.
 
2253
      With or without that fix, it is recommended that a revision range
 
2254
      be given when using the -v option.
 
2255
 
 
2256
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
2257
      used to find revisions matching user names, commit messages, etc.
 
2258
      Among other features, this plugin can find all revisions containing
 
2259
      a list of words but not others.
 
2260
 
 
2261
      When exploring non-mainline history on large projects with deep
 
2262
      history, the performance of log can be greatly improved by installing
 
2263
      the historycache plugin. This plugin buffers historical information
 
2264
      trading disk space for faster speed.
1769
2265
    """
1770
 
 
1771
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
1772
 
 
1773
 
    takes_args = ['location?']
 
2266
    takes_args = ['file*']
 
2267
    _see_also = ['log-formats', 'revisionspec']
1774
2268
    takes_options = [
1775
2269
            Option('forward',
1776
2270
                   help='Show from oldest to newest.'),
1785
2279
                   help='Show just the specified revision.'
1786
2280
                   ' See also "help revisionspec".'),
1787
2281
            'log-format',
 
2282
            Option('levels',
 
2283
                   short_name='n',
 
2284
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2285
                   argname='N',
 
2286
                   type=_parse_levels),
1788
2287
            Option('message',
1789
2288
                   short_name='m',
1790
2289
                   help='Show revisions whose message matches this '
1795
2294
                   help='Limit the output to the first N revisions.',
1796
2295
                   argname='N',
1797
2296
                   type=_parse_limit),
 
2297
            Option('show-diff',
 
2298
                   short_name='p',
 
2299
                   help='Show changes made in each revision as a patch.'),
 
2300
            Option('include-merges',
 
2301
                   help='Show merged revisions like --levels 0 does.'),
 
2302
            Option('exclude-common-ancestry',
 
2303
                   help='Display only the revisions that are not part'
 
2304
                   ' of both ancestries (require -rX..Y)'
 
2305
                   )
1798
2306
            ]
1799
2307
    encoding_type = 'replace'
1800
2308
 
1801
2309
    @display_command
1802
 
    def run(self, location=None, timezone='original',
 
2310
    def run(self, file_list=None, timezone='original',
1803
2311
            verbose=False,
1804
2312
            show_ids=False,
1805
2313
            forward=False,
1806
2314
            revision=None,
1807
2315
            change=None,
1808
2316
            log_format=None,
 
2317
            levels=None,
1809
2318
            message=None,
1810
 
            limit=None):
1811
 
        from bzrlib.log import show_log
 
2319
            limit=None,
 
2320
            show_diff=False,
 
2321
            include_merges=False,
 
2322
            exclude_common_ancestry=False,
 
2323
            ):
 
2324
        from bzrlib.log import (
 
2325
            Logger,
 
2326
            make_log_request_dict,
 
2327
            _get_info_for_log_files,
 
2328
            )
1812
2329
        direction = (forward and 'forward') or 'reverse'
 
2330
        if (exclude_common_ancestry
 
2331
            and (revision is None or len(revision) != 2)):
 
2332
            raise errors.BzrCommandError(
 
2333
                '--exclude-common-ancestry requires -r with two revisions')
 
2334
        if include_merges:
 
2335
            if levels is None:
 
2336
                levels = 0
 
2337
            else:
 
2338
                raise errors.BzrCommandError(
 
2339
                    '--levels and --include-merges are mutually exclusive')
1813
2340
 
1814
2341
        if change is not None:
1815
2342
            if len(change) > 1:
1820
2347
            else:
1821
2348
                revision = change
1822
2349
 
1823
 
        # log everything
1824
 
        file_id = None
1825
 
        if location:
1826
 
            # find the file id to log:
1827
 
 
1828
 
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1829
 
                location)
1830
 
            if fp != '':
1831
 
                if tree is None:
1832
 
                    tree = b.basis_tree()
1833
 
                file_id = tree.path2id(fp)
 
2350
        file_ids = []
 
2351
        filter_by_dir = False
 
2352
        if file_list:
 
2353
            # find the file ids to log and check for directory filtering
 
2354
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2355
                revision, file_list)
 
2356
            self.add_cleanup(b.unlock)
 
2357
            for relpath, file_id, kind in file_info_list:
1834
2358
                if file_id is None:
1835
2359
                    raise errors.BzrCommandError(
1836
 
                        "Path does not have any revision history: %s" %
1837
 
                        location)
 
2360
                        "Path unknown at end or start of revision range: %s" %
 
2361
                        relpath)
 
2362
                # If the relpath is the top of the tree, we log everything
 
2363
                if relpath == '':
 
2364
                    file_ids = []
 
2365
                    break
 
2366
                else:
 
2367
                    file_ids.append(file_id)
 
2368
                filter_by_dir = filter_by_dir or (
 
2369
                    kind in ['directory', 'tree-reference'])
1838
2370
        else:
1839
 
            # local dir only
1840
 
            # FIXME ? log the current subdir only RBC 20060203 
 
2371
            # log everything
 
2372
            # FIXME ? log the current subdir only RBC 20060203
1841
2373
            if revision is not None \
1842
2374
                    and len(revision) > 0 and revision[0].get_branch():
1843
2375
                location = revision[0].get_branch()
1845
2377
                location = '.'
1846
2378
            dir, relpath = bzrdir.BzrDir.open_containing(location)
1847
2379
            b = dir.open_branch()
1848
 
 
1849
 
        b.lock_read()
1850
 
        try:
1851
 
            if revision is None:
1852
 
                rev1 = None
1853
 
                rev2 = None
1854
 
            elif len(revision) == 1:
1855
 
                rev1 = rev2 = revision[0].in_history(b)
1856
 
            elif len(revision) == 2:
1857
 
                if revision[1].get_branch() != revision[0].get_branch():
1858
 
                    # b is taken from revision[0].get_branch(), and
1859
 
                    # show_log will use its revision_history. Having
1860
 
                    # different branches will lead to weird behaviors.
1861
 
                    raise errors.BzrCommandError(
1862
 
                        "Log doesn't accept two revisions in different"
1863
 
                        " branches.")
1864
 
                rev1 = revision[0].in_history(b)
1865
 
                rev2 = revision[1].in_history(b)
1866
 
            else:
1867
 
                raise errors.BzrCommandError(
1868
 
                    'bzr log --revision takes one or two values.')
1869
 
 
1870
 
            if log_format is None:
1871
 
                log_format = log.log_formatter_registry.get_default(b)
1872
 
 
1873
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
1874
 
                            show_timezone=timezone)
1875
 
 
1876
 
            show_log(b,
1877
 
                     lf,
1878
 
                     file_id,
1879
 
                     verbose=verbose,
1880
 
                     direction=direction,
1881
 
                     start_revision=rev1,
1882
 
                     end_revision=rev2,
1883
 
                     search=message,
1884
 
                     limit=limit)
1885
 
        finally:
1886
 
            b.unlock()
1887
 
 
 
2380
            b.lock_read()
 
2381
            self.add_cleanup(b.unlock)
 
2382
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2383
 
 
2384
        # Decide on the type of delta & diff filtering to use
 
2385
        # TODO: add an --all-files option to make this configurable & consistent
 
2386
        if not verbose:
 
2387
            delta_type = None
 
2388
        else:
 
2389
            delta_type = 'full'
 
2390
        if not show_diff:
 
2391
            diff_type = None
 
2392
        elif file_ids:
 
2393
            diff_type = 'partial'
 
2394
        else:
 
2395
            diff_type = 'full'
 
2396
 
 
2397
        # Build the log formatter
 
2398
        if log_format is None:
 
2399
            log_format = log.log_formatter_registry.get_default(b)
 
2400
        # Make a non-encoding output to include the diffs - bug 328007
 
2401
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2402
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2403
                        to_exact_file=unencoded_output,
 
2404
                        show_timezone=timezone,
 
2405
                        delta_format=get_verbosity_level(),
 
2406
                        levels=levels,
 
2407
                        show_advice=levels is None)
 
2408
 
 
2409
        # Choose the algorithm for doing the logging. It's annoying
 
2410
        # having multiple code paths like this but necessary until
 
2411
        # the underlying repository format is faster at generating
 
2412
        # deltas or can provide everything we need from the indices.
 
2413
        # The default algorithm - match-using-deltas - works for
 
2414
        # multiple files and directories and is faster for small
 
2415
        # amounts of history (200 revisions say). However, it's too
 
2416
        # slow for logging a single file in a repository with deep
 
2417
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2418
        # evil when adding features", we continue to use the
 
2419
        # original algorithm - per-file-graph - for the "single
 
2420
        # file that isn't a directory without showing a delta" case.
 
2421
        partial_history = revision and b.repository._format.supports_chks
 
2422
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2423
            or delta_type or partial_history)
 
2424
 
 
2425
        # Build the LogRequest and execute it
 
2426
        if len(file_ids) == 0:
 
2427
            file_ids = None
 
2428
        rqst = make_log_request_dict(
 
2429
            direction=direction, specific_fileids=file_ids,
 
2430
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2431
            message_search=message, delta_type=delta_type,
 
2432
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2433
            exclude_common_ancestry=exclude_common_ancestry,
 
2434
            )
 
2435
        Logger(b, rqst).show(lf)
 
2436
 
 
2437
 
 
2438
def _get_revision_range(revisionspec_list, branch, command_name):
 
2439
    """Take the input of a revision option and turn it into a revision range.
 
2440
 
 
2441
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2442
    of the desired revisions. It does some user input validations.
 
2443
    """
 
2444
    if revisionspec_list is None:
 
2445
        rev1 = None
 
2446
        rev2 = None
 
2447
    elif len(revisionspec_list) == 1:
 
2448
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2449
    elif len(revisionspec_list) == 2:
 
2450
        start_spec = revisionspec_list[0]
 
2451
        end_spec = revisionspec_list[1]
 
2452
        if end_spec.get_branch() != start_spec.get_branch():
 
2453
            # b is taken from revision[0].get_branch(), and
 
2454
            # show_log will use its revision_history. Having
 
2455
            # different branches will lead to weird behaviors.
 
2456
            raise errors.BzrCommandError(
 
2457
                "bzr %s doesn't accept two revisions in different"
 
2458
                " branches." % command_name)
 
2459
        if start_spec.spec is None:
 
2460
            # Avoid loading all the history.
 
2461
            rev1 = RevisionInfo(branch, None, None)
 
2462
        else:
 
2463
            rev1 = start_spec.in_history(branch)
 
2464
        # Avoid loading all of history when we know a missing
 
2465
        # end of range means the last revision ...
 
2466
        if end_spec.spec is None:
 
2467
            last_revno, last_revision_id = branch.last_revision_info()
 
2468
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2469
        else:
 
2470
            rev2 = end_spec.in_history(branch)
 
2471
    else:
 
2472
        raise errors.BzrCommandError(
 
2473
            'bzr %s --revision takes one or two values.' % command_name)
 
2474
    return rev1, rev2
 
2475
 
 
2476
 
 
2477
def _revision_range_to_revid_range(revision_range):
 
2478
    rev_id1 = None
 
2479
    rev_id2 = None
 
2480
    if revision_range[0] is not None:
 
2481
        rev_id1 = revision_range[0].rev_id
 
2482
    if revision_range[1] is not None:
 
2483
        rev_id2 = revision_range[1].rev_id
 
2484
    return rev_id1, rev_id2
1888
2485
 
1889
2486
def get_log_format(long=False, short=False, line=False, default='long'):
1890
2487
    log_format = default
1898
2495
 
1899
2496
 
1900
2497
class cmd_touching_revisions(Command):
1901
 
    """Return revision-ids which affected a particular file.
 
2498
    __doc__ = """Return revision-ids which affected a particular file.
1902
2499
 
1903
2500
    A more user-friendly interface is "bzr log FILE".
1904
2501
    """
1909
2506
    @display_command
1910
2507
    def run(self, filename):
1911
2508
        tree, relpath = WorkingTree.open_containing(filename)
 
2509
        file_id = tree.path2id(relpath)
1912
2510
        b = tree.branch
1913
 
        file_id = tree.path2id(relpath)
1914
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2511
        b.lock_read()
 
2512
        self.add_cleanup(b.unlock)
 
2513
        touching_revs = log.find_touching_revisions(b, file_id)
 
2514
        for revno, revision_id, what in touching_revs:
1915
2515
            self.outf.write("%6d %s\n" % (revno, what))
1916
2516
 
1917
2517
 
1918
2518
class cmd_ls(Command):
1919
 
    """List files in a tree.
 
2519
    __doc__ = """List files in a tree.
1920
2520
    """
1921
2521
 
1922
2522
    _see_also = ['status', 'cat']
1923
2523
    takes_args = ['path?']
1924
 
    # TODO: Take a revision or remote path and list that tree instead.
1925
2524
    takes_options = [
1926
2525
            'verbose',
1927
2526
            'revision',
1928
 
            Option('non-recursive',
1929
 
                   help='Don\'t recurse into subdirectories.'),
 
2527
            Option('recursive', short_name='R',
 
2528
                   help='Recurse into subdirectories.'),
1930
2529
            Option('from-root',
1931
2530
                   help='Print paths relative to the root of the branch.'),
1932
2531
            Option('unknown', help='Print unknown files.'),
1943
2542
            ]
1944
2543
    @display_command
1945
2544
    def run(self, revision=None, verbose=False,
1946
 
            non_recursive=False, from_root=False,
 
2545
            recursive=False, from_root=False,
1947
2546
            unknown=False, versioned=False, ignored=False,
1948
2547
            null=False, kind=None, show_ids=False, path=None):
1949
2548
 
1958
2557
 
1959
2558
        if path is None:
1960
2559
            fs_path = '.'
1961
 
            prefix = ''
1962
2560
        else:
1963
2561
            if from_root:
1964
2562
                raise errors.BzrCommandError('cannot specify both --from-root'
1965
2563
                                             ' and PATH')
1966
2564
            fs_path = path
1967
 
            prefix = path
1968
2565
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1969
2566
            fs_path)
 
2567
 
 
2568
        # Calculate the prefix to use
 
2569
        prefix = None
1970
2570
        if from_root:
1971
 
            relpath = u''
1972
 
        elif relpath:
1973
 
            relpath += '/'
 
2571
            if relpath:
 
2572
                prefix = relpath + '/'
 
2573
        elif fs_path != '.' and not fs_path.endswith('/'):
 
2574
            prefix = fs_path + '/'
 
2575
 
1974
2576
        if revision is not None or tree is None:
1975
2577
            tree = _get_one_revision_tree('ls', revision, branch=branch)
1976
2578
 
 
2579
        apply_view = False
 
2580
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
2581
            view_files = tree.views.lookup_view()
 
2582
            if view_files:
 
2583
                apply_view = True
 
2584
                view_str = views.view_display_str(view_files)
 
2585
                note("Ignoring files outside view. View is %s" % view_str)
 
2586
 
1977
2587
        tree.lock_read()
1978
 
        try:
1979
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1980
 
                if fp.startswith(relpath):
1981
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
1982
 
                    if non_recursive and '/' in fp:
1983
 
                        continue
1984
 
                    if not all and not selection[fc]:
1985
 
                        continue
1986
 
                    if kind is not None and fkind != kind:
1987
 
                        continue
1988
 
                    kindch = entry.kind_character()
1989
 
                    outstring = fp + kindch
1990
 
                    if verbose:
1991
 
                        outstring = '%-8s %s' % (fc, outstring)
1992
 
                        if show_ids and fid is not None:
1993
 
                            outstring = "%-50s %s" % (outstring, fid)
1994
 
                        self.outf.write(outstring + '\n')
1995
 
                    elif null:
1996
 
                        self.outf.write(fp + '\0')
1997
 
                        if show_ids:
1998
 
                            if fid is not None:
1999
 
                                self.outf.write(fid)
2000
 
                            self.outf.write('\0')
2001
 
                        self.outf.flush()
2002
 
                    else:
2003
 
                        if fid is not None:
2004
 
                            my_id = fid
2005
 
                        else:
2006
 
                            my_id = ''
2007
 
                        if show_ids:
2008
 
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
2009
 
                        else:
2010
 
                            self.outf.write(outstring + '\n')
2011
 
        finally:
2012
 
            tree.unlock()
 
2588
        self.add_cleanup(tree.unlock)
 
2589
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2590
            from_dir=relpath, recursive=recursive):
 
2591
            # Apply additional masking
 
2592
            if not all and not selection[fc]:
 
2593
                continue
 
2594
            if kind is not None and fkind != kind:
 
2595
                continue
 
2596
            if apply_view:
 
2597
                try:
 
2598
                    if relpath:
 
2599
                        fullpath = osutils.pathjoin(relpath, fp)
 
2600
                    else:
 
2601
                        fullpath = fp
 
2602
                    views.check_path_in_view(tree, fullpath)
 
2603
                except errors.FileOutsideView:
 
2604
                    continue
 
2605
 
 
2606
            # Output the entry
 
2607
            if prefix:
 
2608
                fp = osutils.pathjoin(prefix, fp)
 
2609
            kindch = entry.kind_character()
 
2610
            outstring = fp + kindch
 
2611
            ui.ui_factory.clear_term()
 
2612
            if verbose:
 
2613
                outstring = '%-8s %s' % (fc, outstring)
 
2614
                if show_ids and fid is not None:
 
2615
                    outstring = "%-50s %s" % (outstring, fid)
 
2616
                self.outf.write(outstring + '\n')
 
2617
            elif null:
 
2618
                self.outf.write(fp + '\0')
 
2619
                if show_ids:
 
2620
                    if fid is not None:
 
2621
                        self.outf.write(fid)
 
2622
                    self.outf.write('\0')
 
2623
                self.outf.flush()
 
2624
            else:
 
2625
                if show_ids:
 
2626
                    if fid is not None:
 
2627
                        my_id = fid
 
2628
                    else:
 
2629
                        my_id = ''
 
2630
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2631
                else:
 
2632
                    self.outf.write(outstring + '\n')
2013
2633
 
2014
2634
 
2015
2635
class cmd_unknowns(Command):
2016
 
    """List unknown files.
 
2636
    __doc__ = """List unknown files.
2017
2637
    """
2018
2638
 
2019
2639
    hidden = True
2026
2646
 
2027
2647
 
2028
2648
class cmd_ignore(Command):
2029
 
    """Ignore specified files or patterns.
 
2649
    __doc__ = """Ignore specified files or patterns.
2030
2650
 
2031
2651
    See ``bzr help patterns`` for details on the syntax of patterns.
2032
2652
 
 
2653
    If a .bzrignore file does not exist, the ignore command
 
2654
    will create one and add the specified files or patterns to the newly
 
2655
    created file. The ignore command will also automatically add the 
 
2656
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
2657
    the use of the ignore command will require an explicit add command.
 
2658
 
2033
2659
    To remove patterns from the ignore list, edit the .bzrignore file.
2034
2660
    After adding, editing or deleting that file either indirectly by
2035
2661
    using this command or directly by using an editor, be sure to commit
2036
2662
    it.
2037
 
 
2038
 
    Note: ignore patterns containing shell wildcards must be quoted from 
 
2663
    
 
2664
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
2665
    the global ignore file can be found in the application data directory as
 
2666
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
2667
    Global ignores are not touched by this command. The global ignore file
 
2668
    can be edited directly using an editor.
 
2669
 
 
2670
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
2671
    precedence over regular ignores.  Such exceptions are used to specify
 
2672
    files that should be versioned which would otherwise be ignored.
 
2673
    
 
2674
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
2675
    precedence over the '!' exception patterns.
 
2676
 
 
2677
    Note: ignore patterns containing shell wildcards must be quoted from
2039
2678
    the shell on Unix.
2040
2679
 
2041
2680
    :Examples:
2043
2682
 
2044
2683
            bzr ignore ./Makefile
2045
2684
 
2046
 
        Ignore class files in all directories::
 
2685
        Ignore .class files in all directories...::
2047
2686
 
2048
2687
            bzr ignore "*.class"
2049
2688
 
 
2689
        ...but do not ignore "special.class"::
 
2690
 
 
2691
            bzr ignore "!special.class"
 
2692
 
2050
2693
        Ignore .o files under the lib directory::
2051
2694
 
2052
2695
            bzr ignore "lib/**/*.o"
2058
2701
        Ignore everything but the "debian" toplevel directory::
2059
2702
 
2060
2703
            bzr ignore "RE:(?!debian/).*"
 
2704
        
 
2705
        Ignore everything except the "local" toplevel directory,
 
2706
        but always ignore "*~" autosave files, even under local/::
 
2707
        
 
2708
            bzr ignore "*"
 
2709
            bzr ignore "!./local"
 
2710
            bzr ignore "!!*~"
2061
2711
    """
2062
2712
 
2063
2713
    _see_also = ['status', 'ignored', 'patterns']
2064
2714
    takes_args = ['name_pattern*']
2065
2715
    takes_options = [
2066
 
        Option('old-default-rules',
2067
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2716
        Option('default-rules',
 
2717
               help='Display the default ignore rules that bzr uses.')
2068
2718
        ]
2069
 
    
2070
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2719
 
 
2720
    def run(self, name_pattern_list=None, default_rules=None):
2071
2721
        from bzrlib import ignores
2072
 
        if old_default_rules is not None:
2073
 
            # dump the rules and exit
2074
 
            for pattern in ignores.OLD_DEFAULTS:
2075
 
                print pattern
 
2722
        if default_rules is not None:
 
2723
            # dump the default rules and exit
 
2724
            for pattern in ignores.USER_DEFAULTS:
 
2725
                self.outf.write("%s\n" % pattern)
2076
2726
            return
2077
2727
        if not name_pattern_list:
2078
2728
            raise errors.BzrCommandError("ignore requires at least one "
2079
 
                                  "NAME_PATTERN or --old-default-rules")
2080
 
        name_pattern_list = [globbing.normalize_pattern(p) 
 
2729
                "NAME_PATTERN or --default-rules.")
 
2730
        name_pattern_list = [globbing.normalize_pattern(p)
2081
2731
                             for p in name_pattern_list]
2082
2732
        for name_pattern in name_pattern_list:
2083
 
            if (name_pattern[0] == '/' or 
 
2733
            if (name_pattern[0] == '/' or
2084
2734
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2085
2735
                raise errors.BzrCommandError(
2086
2736
                    "NAME_PATTERN should not be an absolute path")
2094
2744
            if id is not None:
2095
2745
                filename = entry[0]
2096
2746
                if ignored.match(filename):
2097
 
                    matches.append(filename.encode('utf-8'))
 
2747
                    matches.append(filename)
2098
2748
        tree.unlock()
2099
2749
        if len(matches) > 0:
2100
 
            print "Warning: the following files are version controlled and" \
2101
 
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
2750
            self.outf.write("Warning: the following files are version controlled and"
 
2751
                  " match your ignore pattern:\n%s"
 
2752
                  "\nThese files will continue to be version controlled"
 
2753
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
2102
2754
 
2103
2755
 
2104
2756
class cmd_ignored(Command):
2105
 
    """List ignored files and the patterns that matched them.
 
2757
    __doc__ = """List ignored files and the patterns that matched them.
2106
2758
 
2107
2759
    List all the ignored files and the ignore pattern that caused the file to
2108
2760
    be ignored.
2119
2771
    def run(self):
2120
2772
        tree = WorkingTree.open_containing(u'.')[0]
2121
2773
        tree.lock_read()
2122
 
        try:
2123
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2124
 
                if file_class != 'I':
2125
 
                    continue
2126
 
                ## XXX: Slightly inefficient since this was already calculated
2127
 
                pat = tree.is_ignored(path)
2128
 
                self.outf.write('%-50s %s\n' % (path, pat))
2129
 
        finally:
2130
 
            tree.unlock()
 
2774
        self.add_cleanup(tree.unlock)
 
2775
        for path, file_class, kind, file_id, entry in tree.list_files():
 
2776
            if file_class != 'I':
 
2777
                continue
 
2778
            ## XXX: Slightly inefficient since this was already calculated
 
2779
            pat = tree.is_ignored(path)
 
2780
            self.outf.write('%-50s %s\n' % (path, pat))
2131
2781
 
2132
2782
 
2133
2783
class cmd_lookup_revision(Command):
2134
 
    """Lookup the revision-id from a revision-number
 
2784
    __doc__ = """Lookup the revision-id from a revision-number
2135
2785
 
2136
2786
    :Examples:
2137
2787
        bzr lookup-revision 33
2138
2788
    """
2139
2789
    hidden = True
2140
2790
    takes_args = ['revno']
2141
 
    
 
2791
 
2142
2792
    @display_command
2143
2793
    def run(self, revno):
2144
2794
        try:
2145
2795
            revno = int(revno)
2146
2796
        except ValueError:
2147
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2148
 
 
2149
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2797
            raise errors.BzrCommandError("not a valid revision-number: %r"
 
2798
                                         % revno)
 
2799
        revid = WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2800
        self.outf.write("%s\n" % revid)
2150
2801
 
2151
2802
 
2152
2803
class cmd_export(Command):
2153
 
    """Export current or past revision to a destination directory or archive.
 
2804
    __doc__ = """Export current or past revision to a destination directory or archive.
2154
2805
 
2155
2806
    If no revision is specified this exports the last committed revision.
2156
2807
 
2183
2834
               help="Type of file to export to.",
2184
2835
               type=unicode),
2185
2836
        'revision',
 
2837
        Option('filters', help='Apply content filters to export the '
 
2838
                'convenient form.'),
2186
2839
        Option('root',
2187
2840
               type=str,
2188
2841
               help="Name of the root directory inside the exported file."),
 
2842
        Option('per-file-timestamps',
 
2843
               help='Set modification time of files to that of the last '
 
2844
                    'revision in which it was changed.'),
2189
2845
        ]
2190
2846
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2191
 
        root=None):
 
2847
        root=None, filters=False, per_file_timestamps=False):
2192
2848
        from bzrlib.export import export
2193
2849
 
2194
2850
        if branch_or_subdir is None:
2201
2857
 
2202
2858
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2203
2859
        try:
2204
 
            export(rev_tree, dest, format, root, subdir)
 
2860
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2861
                   per_file_timestamps=per_file_timestamps)
2205
2862
        except errors.NoSuchExportFormat, e:
2206
2863
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2207
2864
 
2208
2865
 
2209
2866
class cmd_cat(Command):
2210
 
    """Write the contents of a file as of a given revision to standard output.
 
2867
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2211
2868
 
2212
2869
    If no revision is nominated, the last revision is used.
2213
2870
 
2214
2871
    Note: Take care to redirect standard output when using this command on a
2215
 
    binary file. 
 
2872
    binary file.
2216
2873
    """
2217
2874
 
2218
2875
    _see_also = ['ls']
2219
2876
    takes_options = [
2220
2877
        Option('name-from-revision', help='The path name in the old tree.'),
 
2878
        Option('filters', help='Apply content filters to display the '
 
2879
                'convenience form.'),
2221
2880
        'revision',
2222
2881
        ]
2223
2882
    takes_args = ['filename']
2224
2883
    encoding_type = 'exact'
2225
2884
 
2226
2885
    @display_command
2227
 
    def run(self, filename, revision=None, name_from_revision=False):
 
2886
    def run(self, filename, revision=None, name_from_revision=False,
 
2887
            filters=False):
2228
2888
        if revision is not None and len(revision) != 1:
2229
2889
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2230
2890
                                         " one revision specifier")
2231
2891
        tree, branch, relpath = \
2232
2892
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2233
2893
        branch.lock_read()
2234
 
        try:
2235
 
            return self._run(tree, branch, relpath, filename, revision,
2236
 
                             name_from_revision)
2237
 
        finally:
2238
 
            branch.unlock()
 
2894
        self.add_cleanup(branch.unlock)
 
2895
        return self._run(tree, branch, relpath, filename, revision,
 
2896
                         name_from_revision, filters)
2239
2897
 
2240
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
2898
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
2899
        filtered):
2241
2900
        if tree is None:
2242
2901
            tree = b.basis_tree()
2243
2902
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2903
        rev_tree.lock_read()
 
2904
        self.add_cleanup(rev_tree.unlock)
2244
2905
 
2245
 
        cur_file_id = tree.path2id(relpath)
2246
2906
        old_file_id = rev_tree.path2id(relpath)
2247
2907
 
2248
2908
        if name_from_revision:
 
2909
            # Try in revision if requested
2249
2910
            if old_file_id is None:
2250
2911
                raise errors.BzrCommandError(
2251
2912
                    "%r is not present in revision %s" % (
2252
2913
                        filename, rev_tree.get_revision_id()))
2253
2914
            else:
2254
2915
                content = rev_tree.get_file_text(old_file_id)
2255
 
        elif cur_file_id is not None:
2256
 
            content = rev_tree.get_file_text(cur_file_id)
2257
 
        elif old_file_id is not None:
2258
 
            content = rev_tree.get_file_text(old_file_id)
2259
 
        else:
2260
 
            raise errors.BzrCommandError(
2261
 
                "%r is not present in revision %s" % (
2262
 
                    filename, rev_tree.get_revision_id()))
2263
 
        self.outf.write(content)
 
2916
        else:
 
2917
            cur_file_id = tree.path2id(relpath)
 
2918
            found = False
 
2919
            if cur_file_id is not None:
 
2920
                # Then try with the actual file id
 
2921
                try:
 
2922
                    content = rev_tree.get_file_text(cur_file_id)
 
2923
                    found = True
 
2924
                except errors.NoSuchId:
 
2925
                    # The actual file id didn't exist at that time
 
2926
                    pass
 
2927
            if not found and old_file_id is not None:
 
2928
                # Finally try with the old file id
 
2929
                content = rev_tree.get_file_text(old_file_id)
 
2930
                found = True
 
2931
            if not found:
 
2932
                # Can't be found anywhere
 
2933
                raise errors.BzrCommandError(
 
2934
                    "%r is not present in revision %s" % (
 
2935
                        filename, rev_tree.get_revision_id()))
 
2936
        if filtered:
 
2937
            from bzrlib.filters import (
 
2938
                ContentFilterContext,
 
2939
                filtered_output_bytes,
 
2940
                )
 
2941
            filters = rev_tree._content_filter_stack(relpath)
 
2942
            chunks = content.splitlines(True)
 
2943
            content = filtered_output_bytes(chunks, filters,
 
2944
                ContentFilterContext(relpath, rev_tree))
 
2945
            self.cleanup_now()
 
2946
            self.outf.writelines(content)
 
2947
        else:
 
2948
            self.cleanup_now()
 
2949
            self.outf.write(content)
2264
2950
 
2265
2951
 
2266
2952
class cmd_local_time_offset(Command):
2267
 
    """Show the offset in seconds from GMT to local time."""
2268
 
    hidden = True    
 
2953
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2954
    hidden = True
2269
2955
    @display_command
2270
2956
    def run(self):
2271
 
        print osutils.local_time_offset()
 
2957
        self.outf.write("%s\n" % osutils.local_time_offset())
2272
2958
 
2273
2959
 
2274
2960
 
2275
2961
class cmd_commit(Command):
2276
 
    """Commit changes into a new revision.
2277
 
    
2278
 
    If no arguments are given, the entire tree is committed.
2279
 
 
2280
 
    If selected files are specified, only changes to those files are
2281
 
    committed.  If a directory is specified then the directory and everything 
2282
 
    within it is committed.
2283
 
 
2284
 
    When excludes are given, they take precedence over selected files.
2285
 
    For example, too commit only changes within foo, but not changes within
2286
 
    foo/bar::
2287
 
 
2288
 
      bzr commit foo -x foo/bar
2289
 
 
2290
 
    If author of the change is not the same person as the committer, you can
2291
 
    specify the author's name using the --author option. The name should be
2292
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2293
 
 
2294
 
    A selected-file commit may fail in some cases where the committed
2295
 
    tree would be invalid. Consider::
2296
 
 
2297
 
      bzr init foo
2298
 
      mkdir foo/bar
2299
 
      bzr add foo/bar
2300
 
      bzr commit foo -m "committing foo"
2301
 
      bzr mv foo/bar foo/baz
2302
 
      mkdir foo/bar
2303
 
      bzr add foo/bar
2304
 
      bzr commit foo/bar -m "committing bar but not baz"
2305
 
 
2306
 
    In the example above, the last commit will fail by design. This gives
2307
 
    the user the opportunity to decide whether they want to commit the
2308
 
    rename at the same time, separately first, or not at all. (As a general
2309
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2310
 
 
2311
 
    Note: A selected-file commit after a merge is not yet supported.
 
2962
    __doc__ = """Commit changes into a new revision.
 
2963
 
 
2964
    An explanatory message needs to be given for each commit. This is
 
2965
    often done by using the --message option (getting the message from the
 
2966
    command line) or by using the --file option (getting the message from
 
2967
    a file). If neither of these options is given, an editor is opened for
 
2968
    the user to enter the message. To see the changed files in the
 
2969
    boilerplate text loaded into the editor, use the --show-diff option.
 
2970
 
 
2971
    By default, the entire tree is committed and the person doing the
 
2972
    commit is assumed to be the author. These defaults can be overridden
 
2973
    as explained below.
 
2974
 
 
2975
    :Selective commits:
 
2976
 
 
2977
      If selected files are specified, only changes to those files are
 
2978
      committed.  If a directory is specified then the directory and
 
2979
      everything within it is committed.
 
2980
  
 
2981
      When excludes are given, they take precedence over selected files.
 
2982
      For example, to commit only changes within foo, but not changes
 
2983
      within foo/bar::
 
2984
  
 
2985
        bzr commit foo -x foo/bar
 
2986
  
 
2987
      A selective commit after a merge is not yet supported.
 
2988
 
 
2989
    :Custom authors:
 
2990
 
 
2991
      If the author of the change is not the same person as the committer,
 
2992
      you can specify the author's name using the --author option. The
 
2993
      name should be in the same format as a committer-id, e.g.
 
2994
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2995
      the change you can specify the option multiple times, once for each
 
2996
      author.
 
2997
  
 
2998
    :Checks:
 
2999
 
 
3000
      A common mistake is to forget to add a new file or directory before
 
3001
      running the commit command. The --strict option checks for unknown
 
3002
      files and aborts the commit if any are found. More advanced pre-commit
 
3003
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
3004
      for details.
 
3005
 
 
3006
    :Things to note:
 
3007
 
 
3008
      If you accidentially commit the wrong changes or make a spelling
 
3009
      mistake in the commit message say, you can use the uncommit command
 
3010
      to undo it. See ``bzr help uncommit`` for details.
 
3011
 
 
3012
      Hooks can also be configured to run after a commit. This allows you
 
3013
      to trigger updates to external systems like bug trackers. The --fixes
 
3014
      option can be used to record the association between a revision and
 
3015
      one or more bugs. See ``bzr help bugs`` for details.
 
3016
 
 
3017
      A selective commit may fail in some cases where the committed
 
3018
      tree would be invalid. Consider::
 
3019
  
 
3020
        bzr init foo
 
3021
        mkdir foo/bar
 
3022
        bzr add foo/bar
 
3023
        bzr commit foo -m "committing foo"
 
3024
        bzr mv foo/bar foo/baz
 
3025
        mkdir foo/bar
 
3026
        bzr add foo/bar
 
3027
        bzr commit foo/bar -m "committing bar but not baz"
 
3028
  
 
3029
      In the example above, the last commit will fail by design. This gives
 
3030
      the user the opportunity to decide whether they want to commit the
 
3031
      rename at the same time, separately first, or not at all. (As a general
 
3032
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2312
3033
    """
2313
3034
    # TODO: Run hooks on tree to-be-committed, and after commit.
2314
3035
 
2319
3040
 
2320
3041
    # XXX: verbose currently does nothing
2321
3042
 
2322
 
    _see_also = ['bugs', 'uncommit']
 
3043
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2323
3044
    takes_args = ['selected*']
2324
3045
    takes_options = [
2325
3046
            ListOption('exclude', type=str, short_name='x',
2337
3058
             Option('strict',
2338
3059
                    help="Refuse to commit if there are unknown "
2339
3060
                    "files in the working tree."),
 
3061
             Option('commit-time', type=str,
 
3062
                    help="Manually set a commit time using commit date "
 
3063
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
2340
3064
             ListOption('fixes', type=str,
2341
 
                    help="Mark a bug as being fixed by this revision."),
2342
 
             Option('author', type=unicode,
 
3065
                    help="Mark a bug as being fixed by this revision "
 
3066
                         "(see \"bzr help bugs\")."),
 
3067
             ListOption('author', type=unicode,
2343
3068
                    help="Set the author's name, if it's different "
2344
3069
                         "from the committer."),
2345
3070
             Option('local',
2348
3073
                         "the master branch until a normal commit "
2349
3074
                         "is performed."
2350
3075
                    ),
2351
 
              Option('show-diff',
2352
 
                     help='When no message is supplied, show the diff along'
2353
 
                     ' with the status summary in the message editor.'),
 
3076
             Option('show-diff', short_name='p',
 
3077
                    help='When no message is supplied, show the diff along'
 
3078
                    ' with the status summary in the message editor.'),
2354
3079
             ]
2355
3080
    aliases = ['ci', 'checkin']
2356
3081
 
2357
 
    def _get_bug_fix_properties(self, fixes, branch):
2358
 
        properties = []
 
3082
    def _iter_bug_fix_urls(self, fixes, branch):
2359
3083
        # Configure the properties for bug fixing attributes.
2360
3084
        for fixed_bug in fixes:
2361
3085
            tokens = fixed_bug.split(':')
2362
3086
            if len(tokens) != 2:
2363
3087
                raise errors.BzrCommandError(
2364
 
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
2365
 
                    "Commit refused." % fixed_bug)
 
3088
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
3089
                    "See \"bzr help bugs\" for more information on this "
 
3090
                    "feature.\nCommit refused." % fixed_bug)
2366
3091
            tag, bug_id = tokens
2367
3092
            try:
2368
 
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
3093
                yield bugtracker.get_bug_url(tag, branch, bug_id)
2369
3094
            except errors.UnknownBugTrackerAbbreviation:
2370
3095
                raise errors.BzrCommandError(
2371
3096
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
2372
 
            except errors.MalformedBugIdentifier:
 
3097
            except errors.MalformedBugIdentifier, e:
2373
3098
                raise errors.BzrCommandError(
2374
 
                    "Invalid bug identifier for %s. Commit refused."
2375
 
                    % fixed_bug)
2376
 
            properties.append('%s fixed' % bug_url)
2377
 
        return '\n'.join(properties)
 
3099
                    "%s\nCommit refused." % (str(e),))
2378
3100
 
2379
3101
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2380
3102
            unchanged=False, strict=False, local=False, fixes=None,
2381
 
            author=None, show_diff=False, exclude=None):
 
3103
            author=None, show_diff=False, exclude=None, commit_time=None):
2382
3104
        from bzrlib.errors import (
2383
3105
            PointlessCommit,
2384
3106
            ConflictsInTree,
2390
3112
            make_commit_message_template_encoded
2391
3113
        )
2392
3114
 
 
3115
        commit_stamp = offset = None
 
3116
        if commit_time is not None:
 
3117
            try:
 
3118
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3119
            except ValueError, e:
 
3120
                raise errors.BzrCommandError(
 
3121
                    "Could not parse --commit-time: " + str(e))
 
3122
 
2393
3123
        # TODO: Need a blackbox test for invoking the external editor; may be
2394
3124
        # slightly problematic to run this cross-platform.
2395
3125
 
2396
 
        # TODO: do more checks that the commit will succeed before 
 
3126
        # TODO: do more checks that the commit will succeed before
2397
3127
        # spending the user's valuable time typing a commit message.
2398
3128
 
2399
3129
        properties = {}
2407
3137
 
2408
3138
        if fixes is None:
2409
3139
            fixes = []
2410
 
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
3140
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3141
            self._iter_bug_fix_urls(fixes, tree.branch))
2411
3142
        if bug_property:
2412
3143
            properties['bugs'] = bug_property
2413
3144
 
2414
3145
        if local and not tree.branch.get_bound_location():
2415
3146
            raise errors.LocalRequiresBoundBranch()
2416
3147
 
 
3148
        if message is not None:
 
3149
            try:
 
3150
                file_exists = osutils.lexists(message)
 
3151
            except UnicodeError:
 
3152
                # The commit message contains unicode characters that can't be
 
3153
                # represented in the filesystem encoding, so that can't be a
 
3154
                # file.
 
3155
                file_exists = False
 
3156
            if file_exists:
 
3157
                warning_msg = (
 
3158
                    'The commit message is a file name: "%(f)s".\n'
 
3159
                    '(use --file "%(f)s" to take commit message from that file)'
 
3160
                    % { 'f': message })
 
3161
                ui.ui_factory.show_warning(warning_msg)
 
3162
            if '\r' in message:
 
3163
                message = message.replace('\r\n', '\n')
 
3164
                message = message.replace('\r', '\n')
 
3165
            if file:
 
3166
                raise errors.BzrCommandError(
 
3167
                    "please specify either --message or --file")
 
3168
 
2417
3169
        def get_message(commit_obj):
2418
3170
            """Callback to get commit message"""
2419
 
            my_message = message
2420
 
            if my_message is None and not file:
2421
 
                t = make_commit_message_template_encoded(tree,
 
3171
            if file:
 
3172
                my_message = codecs.open(
 
3173
                    file, 'rt', osutils.get_user_encoding()).read()
 
3174
            elif message is not None:
 
3175
                my_message = message
 
3176
            else:
 
3177
                # No message supplied: make one up.
 
3178
                # text is the status of the tree
 
3179
                text = make_commit_message_template_encoded(tree,
2422
3180
                        selected_list, diff=show_diff,
2423
3181
                        output_encoding=osutils.get_user_encoding())
 
3182
                # start_message is the template generated from hooks
 
3183
                # XXX: Warning - looks like hooks return unicode,
 
3184
                # make_commit_message_template_encoded returns user encoding.
 
3185
                # We probably want to be using edit_commit_message instead to
 
3186
                # avoid this.
2424
3187
                start_message = generate_commit_message_template(commit_obj)
2425
 
                my_message = edit_commit_message_encoded(t, 
 
3188
                my_message = edit_commit_message_encoded(text,
2426
3189
                    start_message=start_message)
2427
3190
                if my_message is None:
2428
3191
                    raise errors.BzrCommandError("please specify a commit"
2429
3192
                        " message with either --message or --file")
2430
 
            elif my_message and file:
2431
 
                raise errors.BzrCommandError(
2432
 
                    "please specify either --message or --file")
2433
 
            if file:
2434
 
                my_message = codecs.open(file, 'rt',
2435
 
                                         osutils.get_user_encoding()).read()
2436
3193
            if my_message == "":
2437
3194
                raise errors.BzrCommandError("empty commit message specified")
2438
3195
            return my_message
2439
3196
 
 
3197
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3198
        # but the command line should not do that.
 
3199
        if not selected_list:
 
3200
            selected_list = None
2440
3201
        try:
2441
3202
            tree.commit(message_callback=get_message,
2442
3203
                        specific_files=selected_list,
2443
3204
                        allow_pointless=unchanged, strict=strict, local=local,
2444
3205
                        reporter=None, verbose=verbose, revprops=properties,
2445
 
                        author=author,
 
3206
                        authors=author, timestamp=commit_stamp,
 
3207
                        timezone=offset,
2446
3208
                        exclude=safe_relpath_files(tree, exclude))
2447
3209
        except PointlessCommit:
2448
 
            # FIXME: This should really happen before the file is read in;
2449
 
            # perhaps prepare the commit; get the message; then actually commit
2450
 
            raise errors.BzrCommandError("no changes to commit."
2451
 
                              " use --unchanged to commit anyhow")
 
3210
            raise errors.BzrCommandError("No changes to commit."
 
3211
                              " Use --unchanged to commit anyhow.")
2452
3212
        except ConflictsInTree:
2453
3213
            raise errors.BzrCommandError('Conflicts detected in working '
2454
3214
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2457
3217
            raise errors.BzrCommandError("Commit refused because there are"
2458
3218
                              " unknown files in the working tree.")
2459
3219
        except errors.BoundBranchOutOfDate, e:
2460
 
            raise errors.BzrCommandError(str(e) + "\n"
2461
 
            'To commit to master branch, run update and then commit.\n'
2462
 
            'You can also pass --local to commit to continue working '
2463
 
            'disconnected.')
 
3220
            e.extra_help = ("\n"
 
3221
                'To commit to master branch, run update and then commit.\n'
 
3222
                'You can also pass --local to commit to continue working '
 
3223
                'disconnected.')
 
3224
            raise
2464
3225
 
2465
3226
 
2466
3227
class cmd_check(Command):
2467
 
    """Validate working tree structure, branch consistency and repository history.
 
3228
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2468
3229
 
2469
3230
    This command checks various invariants about branch and repository storage
2470
3231
    to detect data corruption or bzr bugs.
2472
3233
    The working tree and branch checks will only give output if a problem is
2473
3234
    detected. The output fields of the repository check are:
2474
3235
 
2475
 
        revisions: This is just the number of revisions checked.  It doesn't
2476
 
            indicate a problem.
2477
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2478
 
            doesn't indicate a problem.
2479
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2480
 
            are not properly referenced by the revision ancestry.  This is a
2481
 
            subtle problem that Bazaar can work around.
2482
 
        unique file texts: This is the total number of unique file contents
2483
 
            seen in the checked revisions.  It does not indicate a problem.
2484
 
        repeated file texts: This is the total number of repeated texts seen
2485
 
            in the checked revisions.  Texts can be repeated when their file
2486
 
            entries are modified, but the file contents are not.  It does not
2487
 
            indicate a problem.
 
3236
    revisions
 
3237
        This is just the number of revisions checked.  It doesn't
 
3238
        indicate a problem.
 
3239
 
 
3240
    versionedfiles
 
3241
        This is just the number of versionedfiles checked.  It
 
3242
        doesn't indicate a problem.
 
3243
 
 
3244
    unreferenced ancestors
 
3245
        Texts that are ancestors of other texts, but
 
3246
        are not properly referenced by the revision ancestry.  This is a
 
3247
        subtle problem that Bazaar can work around.
 
3248
 
 
3249
    unique file texts
 
3250
        This is the total number of unique file contents
 
3251
        seen in the checked revisions.  It does not indicate a problem.
 
3252
 
 
3253
    repeated file texts
 
3254
        This is the total number of repeated texts seen
 
3255
        in the checked revisions.  Texts can be repeated when their file
 
3256
        entries are modified, but the file contents are not.  It does not
 
3257
        indicate a problem.
2488
3258
 
2489
3259
    If no restrictions are specified, all Bazaar data that is found at the given
2490
3260
    location will be checked.
2525
3295
 
2526
3296
 
2527
3297
class cmd_upgrade(Command):
2528
 
    """Upgrade branch storage to current format.
 
3298
    __doc__ = """Upgrade branch storage to current format.
2529
3299
 
2530
3300
    The check command or bzr developers may sometimes advise you to run
2531
3301
    this command. When the default format has changed you may also be warned
2545
3315
 
2546
3316
    def run(self, url='.', format=None):
2547
3317
        from bzrlib.upgrade import upgrade
2548
 
        if format is None:
2549
 
            format = bzrdir.format_registry.make_bzrdir('default')
2550
3318
        upgrade(url, format)
2551
3319
 
2552
3320
 
2553
3321
class cmd_whoami(Command):
2554
 
    """Show or set bzr user id.
2555
 
    
 
3322
    __doc__ = """Show or set bzr user id.
 
3323
 
2556
3324
    :Examples:
2557
3325
        Show the email of the current user::
2558
3326
 
2570
3338
                    ]
2571
3339
    takes_args = ['name?']
2572
3340
    encoding_type = 'replace'
2573
 
    
 
3341
 
2574
3342
    @display_command
2575
3343
    def run(self, email=False, branch=False, name=None):
2576
3344
        if name is None:
2591
3359
        except errors.NoEmailInUsername, e:
2592
3360
            warning('"%s" does not seem to contain an email address.  '
2593
3361
                    'This is allowed, but not recommended.', name)
2594
 
        
 
3362
 
2595
3363
        # use global config unless --branch given
2596
3364
        if branch:
2597
3365
            c = Branch.open_containing('.')[0].get_config()
2601
3369
 
2602
3370
 
2603
3371
class cmd_nick(Command):
2604
 
    """Print or set the branch nickname.
 
3372
    __doc__ = """Print or set the branch nickname.
2605
3373
 
2606
3374
    If unset, the tree root directory name is used as the nickname.
2607
3375
    To print the current nickname, execute with no argument.
2621
3389
 
2622
3390
    @display_command
2623
3391
    def printme(self, branch):
2624
 
        print branch.nick
 
3392
        self.outf.write('%s\n' % branch.nick)
2625
3393
 
2626
3394
 
2627
3395
class cmd_alias(Command):
2628
 
    """Set/unset and display aliases.
 
3396
    __doc__ = """Set/unset and display aliases.
2629
3397
 
2630
3398
    :Examples:
2631
3399
        Show the current aliases::
2695
3463
 
2696
3464
 
2697
3465
class cmd_selftest(Command):
2698
 
    """Run internal test suite.
2699
 
    
 
3466
    __doc__ = """Run internal test suite.
 
3467
 
2700
3468
    If arguments are given, they are regular expressions that say which tests
2701
3469
    should run.  Tests matching any expression are run, and other tests are
2702
3470
    not run.
2725
3493
    modified by plugins will not be tested, and tests provided by plugins will
2726
3494
    not be run.
2727
3495
 
2728
 
    Tests that need working space on disk use a common temporary directory, 
 
3496
    Tests that need working space on disk use a common temporary directory,
2729
3497
    typically inside $TMPDIR or /tmp.
2730
3498
 
 
3499
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3500
    into a pdb postmortem session.
 
3501
 
2731
3502
    :Examples:
2732
3503
        Run only tests relating to 'ignore'::
2733
3504
 
2742
3513
    def get_transport_type(typestring):
2743
3514
        """Parse and return a transport specifier."""
2744
3515
        if typestring == "sftp":
2745
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
2746
 
            return SFTPAbsoluteServer
 
3516
            from bzrlib.tests import stub_sftp
 
3517
            return stub_sftp.SFTPAbsoluteServer
2747
3518
        if typestring == "memory":
2748
 
            from bzrlib.transport.memory import MemoryServer
2749
 
            return MemoryServer
 
3519
            from bzrlib.tests import test_server
 
3520
            return memory.MemoryServer
2750
3521
        if typestring == "fakenfs":
2751
 
            from bzrlib.transport.fakenfs import FakeNFSServer
2752
 
            return FakeNFSServer
 
3522
            from bzrlib.tests import test_server
 
3523
            return test_server.FakeNFSServer
2753
3524
        msg = "No known transport type %s. Supported types are: sftp\n" %\
2754
3525
            (typestring)
2755
3526
        raise errors.BzrCommandError(msg)
2770
3541
                     Option('lsprof-timed',
2771
3542
                            help='Generate lsprof output for benchmarked'
2772
3543
                                 ' sections of code.'),
 
3544
                     Option('lsprof-tests',
 
3545
                            help='Generate lsprof output for each test.'),
2773
3546
                     Option('cache-dir', type=str,
2774
3547
                            help='Cache intermediate benchmark output in this '
2775
3548
                                 'directory.'),
2779
3552
                            ),
2780
3553
                     Option('list-only',
2781
3554
                            help='List the tests instead of running them.'),
 
3555
                     RegistryOption('parallel',
 
3556
                        help="Run the test suite in parallel.",
 
3557
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3558
                        value_switches=False,
 
3559
                        ),
2782
3560
                     Option('randomize', type=str, argname="SEED",
2783
3561
                            help='Randomize the order of tests using the given'
2784
3562
                                 ' seed or "now" for the current time.'),
2786
3564
                            short_name='x',
2787
3565
                            help='Exclude tests that match this regular'
2788
3566
                                 ' expression.'),
 
3567
                     Option('subunit',
 
3568
                        help='Output test progress via subunit.'),
2789
3569
                     Option('strict', help='Fail on missing dependencies or '
2790
3570
                            'known failures.'),
2791
3571
                     Option('load-list', type=str, argname='TESTLISTFILE',
2799
3579
                     ]
2800
3580
    encoding_type = 'replace'
2801
3581
 
 
3582
    def __init__(self):
 
3583
        Command.__init__(self)
 
3584
        self.additional_selftest_args = {}
 
3585
 
2802
3586
    def run(self, testspecs_list=None, verbose=False, one=False,
2803
3587
            transport=None, benchmark=None,
2804
3588
            lsprof_timed=None, cache_dir=None,
2805
3589
            first=False, list_only=False,
2806
3590
            randomize=None, exclude=None, strict=False,
2807
 
            load_list=None, debugflag=None, starting_with=None):
 
3591
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3592
            parallel=None, lsprof_tests=False):
2808
3593
        from bzrlib.tests import selftest
2809
3594
        import bzrlib.benchmarks as benchmarks
2810
3595
        from bzrlib.benchmarks import tree_creator
2814
3599
 
2815
3600
        if cache_dir is not None:
2816
3601
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2817
 
        if not list_only:
2818
 
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2819
 
            print '   %s (%s python%s)' % (
2820
 
                    bzrlib.__path__[0],
2821
 
                    bzrlib.version_string,
2822
 
                    bzrlib._format_version_tuple(sys.version_info),
2823
 
                    )
2824
 
        print
2825
3602
        if testspecs_list is not None:
2826
3603
            pattern = '|'.join(testspecs_list)
2827
3604
        else:
2828
3605
            pattern = ".*"
 
3606
        if subunit:
 
3607
            try:
 
3608
                from bzrlib.tests import SubUnitBzrRunner
 
3609
            except ImportError:
 
3610
                raise errors.BzrCommandError("subunit not available. subunit "
 
3611
                    "needs to be installed to use --subunit.")
 
3612
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3613
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
3614
            # stdout, which would corrupt the subunit stream. 
 
3615
            if sys.platform == "win32" and sys.stdout.fileno() >= 0:
 
3616
                import msvcrt
 
3617
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
3618
        if parallel:
 
3619
            self.additional_selftest_args.setdefault(
 
3620
                'suite_decorators', []).append(parallel)
2829
3621
        if benchmark:
2830
3622
            test_suite_factory = benchmarks.test_suite
2831
3623
            # Unless user explicitly asks for quiet, be verbose in benchmarks
2832
3624
            verbose = not is_quiet()
2833
3625
            # TODO: should possibly lock the history file...
2834
3626
            benchfile = open(".perf_history", "at", buffering=1)
 
3627
            self.add_cleanup(benchfile.close)
2835
3628
        else:
2836
3629
            test_suite_factory = None
2837
3630
            benchfile = None
2838
 
        try:
2839
 
            result = selftest(verbose=verbose,
2840
 
                              pattern=pattern,
2841
 
                              stop_on_failure=one,
2842
 
                              transport=transport,
2843
 
                              test_suite_factory=test_suite_factory,
2844
 
                              lsprof_timed=lsprof_timed,
2845
 
                              bench_history=benchfile,
2846
 
                              matching_tests_first=first,
2847
 
                              list_only=list_only,
2848
 
                              random_seed=randomize,
2849
 
                              exclude_pattern=exclude,
2850
 
                              strict=strict,
2851
 
                              load_list=load_list,
2852
 
                              debug_flags=debugflag,
2853
 
                              starting_with=starting_with,
2854
 
                              )
2855
 
        finally:
2856
 
            if benchfile is not None:
2857
 
                benchfile.close()
2858
 
        if result:
2859
 
            note('tests passed')
2860
 
        else:
2861
 
            note('tests failed')
 
3631
        selftest_kwargs = {"verbose": verbose,
 
3632
                          "pattern": pattern,
 
3633
                          "stop_on_failure": one,
 
3634
                          "transport": transport,
 
3635
                          "test_suite_factory": test_suite_factory,
 
3636
                          "lsprof_timed": lsprof_timed,
 
3637
                          "lsprof_tests": lsprof_tests,
 
3638
                          "bench_history": benchfile,
 
3639
                          "matching_tests_first": first,
 
3640
                          "list_only": list_only,
 
3641
                          "random_seed": randomize,
 
3642
                          "exclude_pattern": exclude,
 
3643
                          "strict": strict,
 
3644
                          "load_list": load_list,
 
3645
                          "debug_flags": debugflag,
 
3646
                          "starting_with": starting_with
 
3647
                          }
 
3648
        selftest_kwargs.update(self.additional_selftest_args)
 
3649
        result = selftest(**selftest_kwargs)
2862
3650
        return int(not result)
2863
3651
 
2864
3652
 
2865
3653
class cmd_version(Command):
2866
 
    """Show version of bzr."""
 
3654
    __doc__ = """Show version of bzr."""
2867
3655
 
2868
3656
    encoding_type = 'replace'
2869
3657
    takes_options = [
2880
3668
 
2881
3669
 
2882
3670
class cmd_rocks(Command):
2883
 
    """Statement of optimism."""
 
3671
    __doc__ = """Statement of optimism."""
2884
3672
 
2885
3673
    hidden = True
2886
3674
 
2887
3675
    @display_command
2888
3676
    def run(self):
2889
 
        print "It sure does!"
 
3677
        self.outf.write("It sure does!\n")
2890
3678
 
2891
3679
 
2892
3680
class cmd_find_merge_base(Command):
2893
 
    """Find and print a base revision for merging two branches."""
 
3681
    __doc__ = """Find and print a base revision for merging two branches."""
2894
3682
    # TODO: Options to specify revisions on either side, as if
2895
3683
    #       merging only part of the history.
2896
3684
    takes_args = ['branch', 'other']
2897
3685
    hidden = True
2898
 
    
 
3686
 
2899
3687
    @display_command
2900
3688
    def run(self, branch, other):
2901
3689
        from bzrlib.revision import ensure_null
2902
 
        
 
3690
 
2903
3691
        branch1 = Branch.open_containing(branch)[0]
2904
3692
        branch2 = Branch.open_containing(other)[0]
2905
3693
        branch1.lock_read()
2906
 
        try:
2907
 
            branch2.lock_read()
2908
 
            try:
2909
 
                last1 = ensure_null(branch1.last_revision())
2910
 
                last2 = ensure_null(branch2.last_revision())
2911
 
 
2912
 
                graph = branch1.repository.get_graph(branch2.repository)
2913
 
                base_rev_id = graph.find_unique_lca(last1, last2)
2914
 
 
2915
 
                print 'merge base is revision %s' % base_rev_id
2916
 
            finally:
2917
 
                branch2.unlock()
2918
 
        finally:
2919
 
            branch1.unlock()
 
3694
        self.add_cleanup(branch1.unlock)
 
3695
        branch2.lock_read()
 
3696
        self.add_cleanup(branch2.unlock)
 
3697
        last1 = ensure_null(branch1.last_revision())
 
3698
        last2 = ensure_null(branch2.last_revision())
 
3699
 
 
3700
        graph = branch1.repository.get_graph(branch2.repository)
 
3701
        base_rev_id = graph.find_unique_lca(last1, last2)
 
3702
 
 
3703
        self.outf.write('merge base is revision %s\n' % base_rev_id)
2920
3704
 
2921
3705
 
2922
3706
class cmd_merge(Command):
2923
 
    """Perform a three-way merge.
2924
 
    
 
3707
    __doc__ = """Perform a three-way merge.
 
3708
 
2925
3709
    The source of the merge can be specified either in the form of a branch,
2926
3710
    or in the form of a path to a file containing a merge directive generated
2927
3711
    with bzr send. If neither is specified, the default is the upstream branch
2937
3721
    By default, bzr will try to merge in all new work from the other
2938
3722
    branch, automatically determining an appropriate base.  If this
2939
3723
    fails, you may need to give an explicit base.
2940
 
    
 
3724
 
2941
3725
    Merge will do its best to combine the changes in two branches, but there
2942
3726
    are some kinds of problems only a human can fix.  When it encounters those,
2943
3727
    it will mark a conflict.  A conflict means that you need to fix something,
2953
3737
    The results of the merge are placed into the destination working
2954
3738
    directory, where they can be reviewed (with bzr diff), tested, and then
2955
3739
    committed to record the result of the merge.
2956
 
    
 
3740
 
2957
3741
    merge refuses to run if there are any uncommitted changes, unless
2958
 
    --force is given.
 
3742
    --force is given. The --force option can also be used to create a
 
3743
    merge revision which has more than two parents.
 
3744
 
 
3745
    If one would like to merge changes from the working tree of the other
 
3746
    branch without merging any committed revisions, the --uncommitted option
 
3747
    can be given.
 
3748
 
 
3749
    To select only some changes to merge, use "merge -i", which will prompt
 
3750
    you to apply each diff hunk and file change, similar to "shelve".
2959
3751
 
2960
3752
    :Examples:
2961
3753
        To merge the latest revision from bzr.dev::
2970
3762
 
2971
3763
            bzr merge -r 81..82 ../bzr.dev
2972
3764
 
2973
 
        To apply a merge directive contained in in /tmp/merge:
 
3765
        To apply a merge directive contained in /tmp/merge::
2974
3766
 
2975
3767
            bzr merge /tmp/merge
 
3768
 
 
3769
        To create a merge revision with three parents from two branches
 
3770
        feature1a and feature1b:
 
3771
 
 
3772
            bzr merge ../feature1a
 
3773
            bzr merge ../feature1b --force
 
3774
            bzr commit -m 'revision with three parents'
2976
3775
    """
2977
3776
 
2978
3777
    encoding_type = 'exact'
2979
 
    _see_also = ['update', 'remerge', 'status-flags']
 
3778
    _see_also = ['update', 'remerge', 'status-flags', 'send']
2980
3779
    takes_args = ['location?']
2981
3780
    takes_options = [
2982
3781
        'change',
3000
3799
               short_name='d',
3001
3800
               type=unicode,
3002
3801
               ),
3003
 
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3802
        Option('preview', help='Instead of merging, show a diff of the'
 
3803
               ' merge.'),
 
3804
        Option('interactive', help='Select changes interactively.',
 
3805
            short_name='i')
3004
3806
    ]
3005
3807
 
3006
3808
    def run(self, location=None, revision=None, force=False,
3008
3810
            uncommitted=False, pull=False,
3009
3811
            directory=None,
3010
3812
            preview=False,
 
3813
            interactive=False,
3011
3814
            ):
3012
3815
        if merge_type is None:
3013
3816
            merge_type = _mod_merge.Merge3Merger
3018
3821
        allow_pending = True
3019
3822
        verified = 'inapplicable'
3020
3823
        tree = WorkingTree.open_containing(directory)[0]
 
3824
 
 
3825
        try:
 
3826
            basis_tree = tree.revision_tree(tree.last_revision())
 
3827
        except errors.NoSuchRevision:
 
3828
            basis_tree = tree.basis_tree()
 
3829
 
 
3830
        # die as quickly as possible if there are uncommitted changes
 
3831
        if not force:
 
3832
            if tree.has_changes():
 
3833
                raise errors.UncommittedChanges(tree)
 
3834
 
 
3835
        view_info = _get_view_info_for_change_reporter(tree)
3021
3836
        change_reporter = delta._ChangeReporter(
3022
 
            unversioned_filter=tree.is_ignored)
3023
 
        cleanups = []
3024
 
        try:
3025
 
            pb = ui.ui_factory.nested_progress_bar()
3026
 
            cleanups.append(pb.finished)
3027
 
            tree.lock_write()
3028
 
            cleanups.append(tree.unlock)
3029
 
            if location is not None:
3030
 
                try:
3031
 
                    mergeable = bundle.read_mergeable_from_url(location,
3032
 
                        possible_transports=possible_transports)
3033
 
                except errors.NotABundle:
3034
 
                    mergeable = None
3035
 
                else:
3036
 
                    if uncommitted:
3037
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
3038
 
                            ' with bundles or merge directives.')
3039
 
 
3040
 
                    if revision is not None:
3041
 
                        raise errors.BzrCommandError(
3042
 
                            'Cannot use -r with merge directives or bundles')
3043
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
3044
 
                       mergeable, pb)
3045
 
 
3046
 
            if merger is None and uncommitted:
3047
 
                if revision is not None and len(revision) > 0:
3048
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
3049
 
                        ' --revision at the same time.')
3050
 
                location = self._select_branch_location(tree, location)[0]
3051
 
                other_tree, other_path = WorkingTree.open_containing(location)
3052
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
3053
 
                    pb)
3054
 
                allow_pending = False
3055
 
                if other_path != '':
3056
 
                    merger.interesting_files = [other_path]
3057
 
 
3058
 
            if merger is None:
3059
 
                merger, allow_pending = self._get_merger_from_branch(tree,
3060
 
                    location, revision, remember, possible_transports, pb)
3061
 
 
3062
 
            merger.merge_type = merge_type
3063
 
            merger.reprocess = reprocess
3064
 
            merger.show_base = show_base
3065
 
            self.sanity_check_merger(merger)
3066
 
            if (merger.base_rev_id == merger.other_rev_id and
3067
 
                merger.other_rev_id is not None):
3068
 
                note('Nothing to do.')
 
3837
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
3838
        pb = ui.ui_factory.nested_progress_bar()
 
3839
        self.add_cleanup(pb.finished)
 
3840
        tree.lock_write()
 
3841
        self.add_cleanup(tree.unlock)
 
3842
        if location is not None:
 
3843
            try:
 
3844
                mergeable = bundle.read_mergeable_from_url(location,
 
3845
                    possible_transports=possible_transports)
 
3846
            except errors.NotABundle:
 
3847
                mergeable = None
 
3848
            else:
 
3849
                if uncommitted:
 
3850
                    raise errors.BzrCommandError('Cannot use --uncommitted'
 
3851
                        ' with bundles or merge directives.')
 
3852
 
 
3853
                if revision is not None:
 
3854
                    raise errors.BzrCommandError(
 
3855
                        'Cannot use -r with merge directives or bundles')
 
3856
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3857
                   mergeable, None)
 
3858
 
 
3859
        if merger is None and uncommitted:
 
3860
            if revision is not None and len(revision) > 0:
 
3861
                raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3862
                    ' --revision at the same time.')
 
3863
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
3864
            allow_pending = False
 
3865
 
 
3866
        if merger is None:
 
3867
            merger, allow_pending = self._get_merger_from_branch(tree,
 
3868
                location, revision, remember, possible_transports, None)
 
3869
 
 
3870
        merger.merge_type = merge_type
 
3871
        merger.reprocess = reprocess
 
3872
        merger.show_base = show_base
 
3873
        self.sanity_check_merger(merger)
 
3874
        if (merger.base_rev_id == merger.other_rev_id and
 
3875
            merger.other_rev_id is not None):
 
3876
            note('Nothing to do.')
 
3877
            return 0
 
3878
        if pull:
 
3879
            if merger.interesting_files is not None:
 
3880
                raise errors.BzrCommandError('Cannot pull individual files')
 
3881
            if (merger.base_rev_id == tree.last_revision()):
 
3882
                result = tree.pull(merger.other_branch, False,
 
3883
                                   merger.other_rev_id)
 
3884
                result.report(self.outf)
3069
3885
                return 0
3070
 
            if pull:
3071
 
                if merger.interesting_files is not None:
3072
 
                    raise errors.BzrCommandError('Cannot pull individual files')
3073
 
                if (merger.base_rev_id == tree.last_revision()):
3074
 
                    result = tree.pull(merger.other_branch, False,
3075
 
                                       merger.other_rev_id)
3076
 
                    result.report(self.outf)
3077
 
                    return 0
3078
 
            merger.check_basis(not force)
3079
 
            if preview:
3080
 
                return self._do_preview(merger)
3081
 
            else:
3082
 
                return self._do_merge(merger, change_reporter, allow_pending,
3083
 
                                      verified)
3084
 
        finally:
3085
 
            for cleanup in reversed(cleanups):
3086
 
                cleanup()
 
3886
        if merger.this_basis is None:
 
3887
            raise errors.BzrCommandError(
 
3888
                "This branch has no commits."
 
3889
                " (perhaps you would prefer 'bzr pull')")
 
3890
        if preview:
 
3891
            return self._do_preview(merger)
 
3892
        elif interactive:
 
3893
            return self._do_interactive(merger)
 
3894
        else:
 
3895
            return self._do_merge(merger, change_reporter, allow_pending,
 
3896
                                  verified)
 
3897
 
 
3898
    def _get_preview(self, merger):
 
3899
        tree_merger = merger.make_merger()
 
3900
        tt = tree_merger.make_preview_transform()
 
3901
        self.add_cleanup(tt.finalize)
 
3902
        result_tree = tt.get_preview_tree()
 
3903
        return result_tree
3087
3904
 
3088
3905
    def _do_preview(self, merger):
3089
3906
        from bzrlib.diff import show_diff_trees
3090
 
        tree_merger = merger.make_merger()
3091
 
        tt = tree_merger.make_preview_transform()
3092
 
        try:
3093
 
            result_tree = tt.get_preview_tree()
3094
 
            show_diff_trees(merger.this_tree, result_tree, self.outf,
3095
 
                            old_label='', new_label='')
3096
 
        finally:
3097
 
            tt.finalize()
 
3907
        result_tree = self._get_preview(merger)
 
3908
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3909
                        old_label='', new_label='')
3098
3910
 
3099
3911
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3100
3912
        merger.change_reporter = change_reporter
3108
3920
        else:
3109
3921
            return 0
3110
3922
 
 
3923
    def _do_interactive(self, merger):
 
3924
        """Perform an interactive merge.
 
3925
 
 
3926
        This works by generating a preview tree of the merge, then using
 
3927
        Shelver to selectively remove the differences between the working tree
 
3928
        and the preview tree.
 
3929
        """
 
3930
        from bzrlib import shelf_ui
 
3931
        result_tree = self._get_preview(merger)
 
3932
        writer = bzrlib.option.diff_writer_registry.get()
 
3933
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3934
                                   reporter=shelf_ui.ApplyReporter(),
 
3935
                                   diff_writer=writer(sys.stdout))
 
3936
        try:
 
3937
            shelver.run()
 
3938
        finally:
 
3939
            shelver.finalize()
 
3940
 
3111
3941
    def sanity_check_merger(self, merger):
3112
3942
        if (merger.show_base and
3113
3943
            not merger.merge_type is _mod_merge.Merge3Merger):
3148
3978
            base_branch, base_path = Branch.open_containing(base_loc,
3149
3979
                possible_transports)
3150
3980
        # Find the revision ids
3151
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3981
        other_revision_id = None
 
3982
        base_revision_id = None
 
3983
        if revision is not None:
 
3984
            if len(revision) >= 1:
 
3985
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3986
            if len(revision) == 2:
 
3987
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3988
        if other_revision_id is None:
3152
3989
            other_revision_id = _mod_revision.ensure_null(
3153
3990
                other_branch.last_revision())
3154
 
        else:
3155
 
            other_revision_id = revision[-1].as_revision_id(other_branch)
3156
 
        if (revision is not None and len(revision) == 2
3157
 
            and revision[0] is not None):
3158
 
            base_revision_id = revision[0].as_revision_id(base_branch)
3159
 
        else:
3160
 
            base_revision_id = None
3161
3991
        # Remember where we merge from
3162
3992
        if ((remember or tree.branch.get_submit_branch() is None) and
3163
3993
             user_location is not None):
3172
4002
            allow_pending = True
3173
4003
        return merger, allow_pending
3174
4004
 
 
4005
    def get_merger_from_uncommitted(self, tree, location, pb):
 
4006
        """Get a merger for uncommitted changes.
 
4007
 
 
4008
        :param tree: The tree the merger should apply to.
 
4009
        :param location: The location containing uncommitted changes.
 
4010
        :param pb: The progress bar to use for showing progress.
 
4011
        """
 
4012
        location = self._select_branch_location(tree, location)[0]
 
4013
        other_tree, other_path = WorkingTree.open_containing(location)
 
4014
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
4015
        if other_path != '':
 
4016
            merger.interesting_files = [other_path]
 
4017
        return merger
 
4018
 
3175
4019
    def _select_branch_location(self, tree, user_location, revision=None,
3176
4020
                                index=None):
3177
4021
        """Select a branch location, according to possible inputs.
3221
4065
 
3222
4066
 
3223
4067
class cmd_remerge(Command):
3224
 
    """Redo a merge.
 
4068
    __doc__ = """Redo a merge.
3225
4069
 
3226
4070
    Use this if you want to try a different merge technique while resolving
3227
 
    conflicts.  Some merge techniques are better than others, and remerge 
 
4071
    conflicts.  Some merge techniques are better than others, and remerge
3228
4072
    lets you try different ones on different files.
3229
4073
 
3230
4074
    The options for remerge have the same meaning and defaults as the ones for
3234
4078
    :Examples:
3235
4079
        Re-do the merge of all conflicted files, and show the base text in
3236
4080
        conflict regions, in addition to the usual THIS and OTHER texts::
3237
 
      
 
4081
 
3238
4082
            bzr remerge --show-base
3239
4083
 
3240
4084
        Re-do the merge of "foobar", using the weave merge algorithm, with
3241
4085
        additional processing to reduce the size of conflict regions::
3242
 
      
 
4086
 
3243
4087
            bzr remerge --merge-type weave --reprocess foobar
3244
4088
    """
3245
4089
    takes_args = ['file*']
3252
4096
 
3253
4097
    def run(self, file_list=None, merge_type=None, show_base=False,
3254
4098
            reprocess=False):
 
4099
        from bzrlib.conflicts import restore
3255
4100
        if merge_type is None:
3256
4101
            merge_type = _mod_merge.Merge3Merger
3257
4102
        tree, file_list = tree_files(file_list)
3258
4103
        tree.lock_write()
 
4104
        self.add_cleanup(tree.unlock)
 
4105
        parents = tree.get_parent_ids()
 
4106
        if len(parents) != 2:
 
4107
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4108
                                         " merges.  Not cherrypicking or"
 
4109
                                         " multi-merges.")
 
4110
        repository = tree.branch.repository
 
4111
        interesting_ids = None
 
4112
        new_conflicts = []
 
4113
        conflicts = tree.conflicts()
 
4114
        if file_list is not None:
 
4115
            interesting_ids = set()
 
4116
            for filename in file_list:
 
4117
                file_id = tree.path2id(filename)
 
4118
                if file_id is None:
 
4119
                    raise errors.NotVersionedError(filename)
 
4120
                interesting_ids.add(file_id)
 
4121
                if tree.kind(file_id) != "directory":
 
4122
                    continue
 
4123
 
 
4124
                for name, ie in tree.inventory.iter_entries(file_id):
 
4125
                    interesting_ids.add(ie.file_id)
 
4126
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4127
        else:
 
4128
            # Remerge only supports resolving contents conflicts
 
4129
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4130
            restore_files = [c.path for c in conflicts
 
4131
                             if c.typestring in allowed_conflicts]
 
4132
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4133
        tree.set_conflicts(ConflictList(new_conflicts))
 
4134
        if file_list is not None:
 
4135
            restore_files = file_list
 
4136
        for filename in restore_files:
 
4137
            try:
 
4138
                restore(tree.abspath(filename))
 
4139
            except errors.NotConflicted:
 
4140
                pass
 
4141
        # Disable pending merges, because the file texts we are remerging
 
4142
        # have not had those merges performed.  If we use the wrong parents
 
4143
        # list, we imply that the working tree text has seen and rejected
 
4144
        # all the changes from the other tree, when in fact those changes
 
4145
        # have not yet been seen.
 
4146
        tree.set_parent_ids(parents[:1])
3259
4147
        try:
3260
 
            parents = tree.get_parent_ids()
3261
 
            if len(parents) != 2:
3262
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3263
 
                                             " merges.  Not cherrypicking or"
3264
 
                                             " multi-merges.")
3265
 
            repository = tree.branch.repository
3266
 
            interesting_ids = None
3267
 
            new_conflicts = []
3268
 
            conflicts = tree.conflicts()
3269
 
            if file_list is not None:
3270
 
                interesting_ids = set()
3271
 
                for filename in file_list:
3272
 
                    file_id = tree.path2id(filename)
3273
 
                    if file_id is None:
3274
 
                        raise errors.NotVersionedError(filename)
3275
 
                    interesting_ids.add(file_id)
3276
 
                    if tree.kind(file_id) != "directory":
3277
 
                        continue
3278
 
                    
3279
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3280
 
                        interesting_ids.add(ie.file_id)
3281
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3282
 
            else:
3283
 
                # Remerge only supports resolving contents conflicts
3284
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3285
 
                restore_files = [c.path for c in conflicts
3286
 
                                 if c.typestring in allowed_conflicts]
3287
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3288
 
            tree.set_conflicts(ConflictList(new_conflicts))
3289
 
            if file_list is not None:
3290
 
                restore_files = file_list
3291
 
            for filename in restore_files:
3292
 
                try:
3293
 
                    restore(tree.abspath(filename))
3294
 
                except errors.NotConflicted:
3295
 
                    pass
3296
 
            # Disable pending merges, because the file texts we are remerging
3297
 
            # have not had those merges performed.  If we use the wrong parents
3298
 
            # list, we imply that the working tree text has seen and rejected
3299
 
            # all the changes from the other tree, when in fact those changes
3300
 
            # have not yet been seen.
3301
 
            pb = ui.ui_factory.nested_progress_bar()
3302
 
            tree.set_parent_ids(parents[:1])
3303
 
            try:
3304
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3305
 
                                                             tree, parents[1])
3306
 
                merger.interesting_ids = interesting_ids
3307
 
                merger.merge_type = merge_type
3308
 
                merger.show_base = show_base
3309
 
                merger.reprocess = reprocess
3310
 
                conflicts = merger.do_merge()
3311
 
            finally:
3312
 
                tree.set_parent_ids(parents)
3313
 
                pb.finished()
 
4148
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4149
            merger.interesting_ids = interesting_ids
 
4150
            merger.merge_type = merge_type
 
4151
            merger.show_base = show_base
 
4152
            merger.reprocess = reprocess
 
4153
            conflicts = merger.do_merge()
3314
4154
        finally:
3315
 
            tree.unlock()
 
4155
            tree.set_parent_ids(parents)
3316
4156
        if conflicts > 0:
3317
4157
            return 1
3318
4158
        else:
3320
4160
 
3321
4161
 
3322
4162
class cmd_revert(Command):
3323
 
    """Revert files to a previous revision.
 
4163
    __doc__ = """Revert files to a previous revision.
3324
4164
 
3325
4165
    Giving a list of files will revert only those files.  Otherwise, all files
3326
4166
    will be reverted.  If the revision is not specified with '--revision', the
3330
4170
    merge instead.  For example, "merge . --revision -2..-3" will remove the
3331
4171
    changes introduced by -2, without affecting the changes introduced by -1.
3332
4172
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3333
 
    
 
4173
 
3334
4174
    By default, any files that have been manually changed will be backed up
3335
4175
    first.  (Files changed only by merge are not backed up.)  Backup files have
3336
4176
    '.~#~' appended to their name, where # is a number.
3340
4180
    name.  If you name a directory, all the contents of that directory will be
3341
4181
    reverted.
3342
4182
 
3343
 
    Any files that have been newly added since that revision will be deleted,
3344
 
    with a backup kept if appropriate.  Directories containing unknown files
3345
 
    will not be deleted.
 
4183
    If you have newly added files since the target revision, they will be
 
4184
    removed.  If the files to be removed have been changed, backups will be
 
4185
    created as above.  Directories containing unknown files will not be
 
4186
    deleted.
3346
4187
 
3347
 
    The working tree contains a list of pending merged revisions, which will
3348
 
    be included as parents in the next commit.  Normally, revert clears that
3349
 
    list as well as reverting the files.  If any files are specified, revert
3350
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
3351
 
    revert ." in the tree root to revert all files but keep the merge record,
3352
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4188
    The working tree contains a list of revisions that have been merged but
 
4189
    not yet committed. These revisions will be included as additional parents
 
4190
    of the next commit.  Normally, using revert clears that list as well as
 
4191
    reverting the files.  If any files are specified, revert leaves the list
 
4192
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4193
    .`` in the tree root to revert all files but keep the recorded merges,
 
4194
    and ``bzr revert --forget-merges`` to clear the pending merge list without
3353
4195
    reverting any files.
 
4196
 
 
4197
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4198
    changes from a branch in a single revision.  To do this, perform the merge
 
4199
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4200
    the content of the tree as it was, but it will clear the list of pending
 
4201
    merges.  The next commit will then contain all of the changes that are
 
4202
    present in the other branch, but without any other parent revisions.
 
4203
    Because this technique forgets where these changes originated, it may
 
4204
    cause additional conflicts on later merges involving the same source and
 
4205
    target branches.
3354
4206
    """
3355
4207
 
3356
4208
    _see_also = ['cat', 'export']
3365
4217
    def run(self, revision=None, no_backup=False, file_list=None,
3366
4218
            forget_merges=None):
3367
4219
        tree, file_list = tree_files(file_list)
3368
 
        tree.lock_write()
3369
 
        try:
3370
 
            if forget_merges:
3371
 
                tree.set_parent_ids(tree.get_parent_ids()[:1])
3372
 
            else:
3373
 
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3374
 
        finally:
3375
 
            tree.unlock()
 
4220
        tree.lock_tree_write()
 
4221
        self.add_cleanup(tree.unlock)
 
4222
        if forget_merges:
 
4223
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4224
        else:
 
4225
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
3376
4226
 
3377
4227
    @staticmethod
3378
4228
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3379
4229
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
3380
 
        pb = ui.ui_factory.nested_progress_bar()
3381
 
        try:
3382
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
3383
 
                report_changes=True)
3384
 
        finally:
3385
 
            pb.finished()
 
4230
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4231
            report_changes=True)
3386
4232
 
3387
4233
 
3388
4234
class cmd_assert_fail(Command):
3389
 
    """Test reporting of assertion failures"""
 
4235
    __doc__ = """Test reporting of assertion failures"""
3390
4236
    # intended just for use in testing
3391
4237
 
3392
4238
    hidden = True
3396
4242
 
3397
4243
 
3398
4244
class cmd_help(Command):
3399
 
    """Show help on a command or other topic.
 
4245
    __doc__ = """Show help on a command or other topic.
3400
4246
    """
3401
4247
 
3402
4248
    _see_also = ['topics']
3405
4251
            ]
3406
4252
    takes_args = ['topic?']
3407
4253
    aliases = ['?', '--help', '-?', '-h']
3408
 
    
 
4254
 
3409
4255
    @display_command
3410
4256
    def run(self, topic=None, long=False):
3411
4257
        import bzrlib.help
3415
4261
 
3416
4262
 
3417
4263
class cmd_shell_complete(Command):
3418
 
    """Show appropriate completions for context.
 
4264
    __doc__ = """Show appropriate completions for context.
3419
4265
 
3420
4266
    For a list of all available commands, say 'bzr shell-complete'.
3421
4267
    """
3422
4268
    takes_args = ['context?']
3423
4269
    aliases = ['s-c']
3424
4270
    hidden = True
3425
 
    
 
4271
 
3426
4272
    @display_command
3427
4273
    def run(self, context=None):
3428
4274
        import shellcomplete
3430
4276
 
3431
4277
 
3432
4278
class cmd_missing(Command):
3433
 
    """Show unmerged/unpulled revisions between two branches.
3434
 
    
 
4279
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4280
 
3435
4281
    OTHER_BRANCH may be local or remote.
 
4282
 
 
4283
    To filter on a range of revisions, you can use the command -r begin..end
 
4284
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
4285
    also valid.
 
4286
            
 
4287
    :Exit values:
 
4288
        1 - some missing revisions
 
4289
        0 - no missing revisions
 
4290
 
 
4291
    :Examples:
 
4292
 
 
4293
        Determine the missing revisions between this and the branch at the
 
4294
        remembered pull location::
 
4295
 
 
4296
            bzr missing
 
4297
 
 
4298
        Determine the missing revisions between this and another branch::
 
4299
 
 
4300
            bzr missing http://server/branch
 
4301
 
 
4302
        Determine the missing revisions up to a specific revision on the other
 
4303
        branch::
 
4304
 
 
4305
            bzr missing -r ..-10
 
4306
 
 
4307
        Determine the missing revisions up to a specific revision on this
 
4308
        branch::
 
4309
 
 
4310
            bzr missing --my-revision ..-10
3436
4311
    """
3437
4312
 
3438
4313
    _see_also = ['merge', 'pull']
3439
4314
    takes_args = ['other_branch?']
3440
4315
    takes_options = [
3441
 
            Option('reverse', 'Reverse the order of revisions.'),
3442
 
            Option('mine-only',
3443
 
                   'Display changes in the local branch only.'),
3444
 
            Option('this' , 'Same as --mine-only.'),
3445
 
            Option('theirs-only',
3446
 
                   'Display changes in the remote branch only.'),
3447
 
            Option('other', 'Same as --theirs-only.'),
3448
 
            'log-format',
3449
 
            'show-ids',
3450
 
            'verbose',
3451
 
            Option('include-merges', 'Show merged revisions.'),
3452
 
            ]
 
4316
        Option('reverse', 'Reverse the order of revisions.'),
 
4317
        Option('mine-only',
 
4318
               'Display changes in the local branch only.'),
 
4319
        Option('this' , 'Same as --mine-only.'),
 
4320
        Option('theirs-only',
 
4321
               'Display changes in the remote branch only.'),
 
4322
        Option('other', 'Same as --theirs-only.'),
 
4323
        'log-format',
 
4324
        'show-ids',
 
4325
        'verbose',
 
4326
        custom_help('revision',
 
4327
             help='Filter on other branch revisions (inclusive). '
 
4328
                'See "help revisionspec" for details.'),
 
4329
        Option('my-revision',
 
4330
            type=_parse_revision_str,
 
4331
            help='Filter on local branch revisions (inclusive). '
 
4332
                'See "help revisionspec" for details.'),
 
4333
        Option('include-merges',
 
4334
               'Show all revisions in addition to the mainline ones.'),
 
4335
        ]
3453
4336
    encoding_type = 'replace'
3454
4337
 
3455
4338
    @display_command
3457
4340
            theirs_only=False,
3458
4341
            log_format=None, long=False, short=False, line=False,
3459
4342
            show_ids=False, verbose=False, this=False, other=False,
3460
 
            include_merges=False):
 
4343
            include_merges=False, revision=None, my_revision=None):
3461
4344
        from bzrlib.missing import find_unmerged, iter_log_revisions
3462
4345
        def message(s):
3463
4346
            if not is_quiet():
3477
4360
            restrict = 'remote'
3478
4361
 
3479
4362
        local_branch = Branch.open_containing(u".")[0]
 
4363
        local_branch.lock_read()
 
4364
        self.add_cleanup(local_branch.unlock)
 
4365
 
3480
4366
        parent = local_branch.get_parent()
3481
4367
        if other_branch is None:
3482
4368
            other_branch = parent
3491
4377
        remote_branch = Branch.open(other_branch)
3492
4378
        if remote_branch.base == local_branch.base:
3493
4379
            remote_branch = local_branch
3494
 
        local_branch.lock_read()
3495
 
        try:
 
4380
        else:
3496
4381
            remote_branch.lock_read()
3497
 
            try:
3498
 
                local_extra, remote_extra = find_unmerged(
3499
 
                    local_branch, remote_branch, restrict,
3500
 
                    backward=not reverse,
3501
 
                    include_merges=include_merges)
3502
 
 
3503
 
                if log_format is None:
3504
 
                    registry = log.log_formatter_registry
3505
 
                    log_format = registry.get_default(local_branch)
3506
 
                lf = log_format(to_file=self.outf,
3507
 
                                show_ids=show_ids,
3508
 
                                show_timezone='original')
3509
 
 
3510
 
                status_code = 0
3511
 
                if local_extra and not theirs_only:
3512
 
                    message("You have %d extra revision(s):\n" %
3513
 
                        len(local_extra))
3514
 
                    for revision in iter_log_revisions(local_extra,
3515
 
                                        local_branch.repository,
3516
 
                                        verbose):
3517
 
                        lf.log_revision(revision)
3518
 
                    printed_local = True
3519
 
                    status_code = 1
3520
 
                else:
3521
 
                    printed_local = False
3522
 
 
3523
 
                if remote_extra and not mine_only:
3524
 
                    if printed_local is True:
3525
 
                        message("\n\n\n")
3526
 
                    message("You are missing %d revision(s):\n" %
3527
 
                        len(remote_extra))
3528
 
                    for revision in iter_log_revisions(remote_extra,
3529
 
                                        remote_branch.repository,
3530
 
                                        verbose):
3531
 
                        lf.log_revision(revision)
3532
 
                    status_code = 1
3533
 
 
3534
 
                if mine_only and not local_extra:
3535
 
                    # We checked local, and found nothing extra
3536
 
                    message('This branch is up to date.\n')
3537
 
                elif theirs_only and not remote_extra:
3538
 
                    # We checked remote, and found nothing extra
3539
 
                    message('Other branch is up to date.\n')
3540
 
                elif not (mine_only or theirs_only or local_extra or
3541
 
                          remote_extra):
3542
 
                    # We checked both branches, and neither one had extra
3543
 
                    # revisions
3544
 
                    message("Branches are up to date.\n")
3545
 
            finally:
3546
 
                remote_branch.unlock()
3547
 
        finally:
3548
 
            local_branch.unlock()
 
4382
            self.add_cleanup(remote_branch.unlock)
 
4383
 
 
4384
        local_revid_range = _revision_range_to_revid_range(
 
4385
            _get_revision_range(my_revision, local_branch,
 
4386
                self.name()))
 
4387
 
 
4388
        remote_revid_range = _revision_range_to_revid_range(
 
4389
            _get_revision_range(revision,
 
4390
                remote_branch, self.name()))
 
4391
 
 
4392
        local_extra, remote_extra = find_unmerged(
 
4393
            local_branch, remote_branch, restrict,
 
4394
            backward=not reverse,
 
4395
            include_merges=include_merges,
 
4396
            local_revid_range=local_revid_range,
 
4397
            remote_revid_range=remote_revid_range)
 
4398
 
 
4399
        if log_format is None:
 
4400
            registry = log.log_formatter_registry
 
4401
            log_format = registry.get_default(local_branch)
 
4402
        lf = log_format(to_file=self.outf,
 
4403
                        show_ids=show_ids,
 
4404
                        show_timezone='original')
 
4405
 
 
4406
        status_code = 0
 
4407
        if local_extra and not theirs_only:
 
4408
            message("You have %d extra revision(s):\n" %
 
4409
                len(local_extra))
 
4410
            for revision in iter_log_revisions(local_extra,
 
4411
                                local_branch.repository,
 
4412
                                verbose):
 
4413
                lf.log_revision(revision)
 
4414
            printed_local = True
 
4415
            status_code = 1
 
4416
        else:
 
4417
            printed_local = False
 
4418
 
 
4419
        if remote_extra and not mine_only:
 
4420
            if printed_local is True:
 
4421
                message("\n\n\n")
 
4422
            message("You are missing %d revision(s):\n" %
 
4423
                len(remote_extra))
 
4424
            for revision in iter_log_revisions(remote_extra,
 
4425
                                remote_branch.repository,
 
4426
                                verbose):
 
4427
                lf.log_revision(revision)
 
4428
            status_code = 1
 
4429
 
 
4430
        if mine_only and not local_extra:
 
4431
            # We checked local, and found nothing extra
 
4432
            message('This branch is up to date.\n')
 
4433
        elif theirs_only and not remote_extra:
 
4434
            # We checked remote, and found nothing extra
 
4435
            message('Other branch is up to date.\n')
 
4436
        elif not (mine_only or theirs_only or local_extra or
 
4437
                  remote_extra):
 
4438
            # We checked both branches, and neither one had extra
 
4439
            # revisions
 
4440
            message("Branches are up to date.\n")
 
4441
        self.cleanup_now()
3549
4442
        if not status_code and parent is None and other_branch is not None:
3550
4443
            local_branch.lock_write()
3551
 
            try:
3552
 
                # handle race conditions - a parent might be set while we run.
3553
 
                if local_branch.get_parent() is None:
3554
 
                    local_branch.set_parent(remote_branch.base)
3555
 
            finally:
3556
 
                local_branch.unlock()
 
4444
            self.add_cleanup(local_branch.unlock)
 
4445
            # handle race conditions - a parent might be set while we run.
 
4446
            if local_branch.get_parent() is None:
 
4447
                local_branch.set_parent(remote_branch.base)
3557
4448
        return status_code
3558
4449
 
3559
4450
 
3560
4451
class cmd_pack(Command):
3561
 
    """Compress the data within a repository."""
 
4452
    __doc__ = """Compress the data within a repository.
 
4453
 
 
4454
    This operation compresses the data within a bazaar repository. As
 
4455
    bazaar supports automatic packing of repository, this operation is
 
4456
    normally not required to be done manually.
 
4457
 
 
4458
    During the pack operation, bazaar takes a backup of existing repository
 
4459
    data, i.e. pack files. This backup is eventually removed by bazaar
 
4460
    automatically when it is safe to do so. To save disk space by removing
 
4461
    the backed up pack files, the --clean-obsolete-packs option may be
 
4462
    used.
 
4463
 
 
4464
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
4465
    during or immediately after repacking, you may be left with a state
 
4466
    where the deletion has been written to disk but the new packs have not
 
4467
    been. In this case the repository may be unusable.
 
4468
    """
3562
4469
 
3563
4470
    _see_also = ['repositories']
3564
4471
    takes_args = ['branch_or_repo?']
 
4472
    takes_options = [
 
4473
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4474
        ]
3565
4475
 
3566
 
    def run(self, branch_or_repo='.'):
 
4476
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
3567
4477
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3568
4478
        try:
3569
4479
            branch = dir.open_branch()
3570
4480
            repository = branch.repository
3571
4481
        except errors.NotBranchError:
3572
4482
            repository = dir.open_repository()
3573
 
        repository.pack()
 
4483
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
3574
4484
 
3575
4485
 
3576
4486
class cmd_plugins(Command):
3577
 
    """List the installed plugins.
3578
 
    
 
4487
    __doc__ = """List the installed plugins.
 
4488
 
3579
4489
    This command displays the list of installed plugins including
3580
4490
    version of plugin and a short description of each.
3581
4491
 
3587
4497
    adding new commands, providing additional network transports and
3588
4498
    customizing log output.
3589
4499
 
3590
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
3591
 
    information on plugins including where to find them and how to
3592
 
    install them. Instructions are also provided there on how to
3593
 
    write new plugins using the Python programming language.
 
4500
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
4501
    for further information on plugins including where to find them and how to
 
4502
    install them. Instructions are also provided there on how to write new
 
4503
    plugins using the Python programming language.
3594
4504
    """
3595
4505
    takes_options = ['verbose']
3596
4506
 
3611
4521
                doc = '(no description)'
3612
4522
            result.append((name_ver, doc, plugin.path()))
3613
4523
        for name_ver, doc, path in sorted(result):
3614
 
            print name_ver
3615
 
            print '   ', doc
 
4524
            self.outf.write("%s\n" % name_ver)
 
4525
            self.outf.write("   %s\n" % doc)
3616
4526
            if verbose:
3617
 
                print '   ', path
3618
 
            print
 
4527
                self.outf.write("   %s\n" % path)
 
4528
            self.outf.write("\n")
3619
4529
 
3620
4530
 
3621
4531
class cmd_testament(Command):
3622
 
    """Show testament (signing-form) of a revision."""
 
4532
    __doc__ = """Show testament (signing-form) of a revision."""
3623
4533
    takes_options = [
3624
4534
            'revision',
3625
4535
            Option('long', help='Produce long-format testament.'),
3638
4548
        else:
3639
4549
            b = Branch.open(branch)
3640
4550
        b.lock_read()
3641
 
        try:
3642
 
            if revision is None:
3643
 
                rev_id = b.last_revision()
3644
 
            else:
3645
 
                rev_id = revision[0].as_revision_id(b)
3646
 
            t = testament_class.from_revision(b.repository, rev_id)
3647
 
            if long:
3648
 
                sys.stdout.writelines(t.as_text_lines())
3649
 
            else:
3650
 
                sys.stdout.write(t.as_short_text())
3651
 
        finally:
3652
 
            b.unlock()
 
4551
        self.add_cleanup(b.unlock)
 
4552
        if revision is None:
 
4553
            rev_id = b.last_revision()
 
4554
        else:
 
4555
            rev_id = revision[0].as_revision_id(b)
 
4556
        t = testament_class.from_revision(b.repository, rev_id)
 
4557
        if long:
 
4558
            sys.stdout.writelines(t.as_text_lines())
 
4559
        else:
 
4560
            sys.stdout.write(t.as_short_text())
3653
4561
 
3654
4562
 
3655
4563
class cmd_annotate(Command):
3656
 
    """Show the origin of each line in a file.
 
4564
    __doc__ = """Show the origin of each line in a file.
3657
4565
 
3658
4566
    This prints out the given file with an annotation on the left side
3659
4567
    indicating which revision, author and date introduced the change.
3660
4568
 
3661
 
    If the origin is the same for a run of consecutive lines, it is 
 
4569
    If the origin is the same for a run of consecutive lines, it is
3662
4570
    shown only at the top, unless the --all option is given.
3663
4571
    """
3664
4572
    # TODO: annotate directories; showing when each file was last changed
3665
 
    # TODO: if the working copy is modified, show annotations on that 
 
4573
    # TODO: if the working copy is modified, show annotations on that
3666
4574
    #       with new uncommitted lines marked
3667
4575
    aliases = ['ann', 'blame', 'praise']
3668
4576
    takes_args = ['filename']
3681
4589
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
3682
4590
        if wt is not None:
3683
4591
            wt.lock_read()
 
4592
            self.add_cleanup(wt.unlock)
3684
4593
        else:
3685
4594
            branch.lock_read()
3686
 
        try:
3687
 
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
3688
 
            if wt is not None:
3689
 
                file_id = wt.path2id(relpath)
3690
 
            else:
3691
 
                file_id = tree.path2id(relpath)
3692
 
            if file_id is None:
3693
 
                raise errors.NotVersionedError(filename)
3694
 
            file_version = tree.inventory[file_id].revision
3695
 
            if wt is not None and revision is None:
3696
 
                # If there is a tree and we're not annotating historical
3697
 
                # versions, annotate the working tree's content.
3698
 
                annotate_file_tree(wt, file_id, self.outf, long, all,
3699
 
                    show_ids=show_ids)
3700
 
            else:
3701
 
                annotate_file(branch, file_version, file_id, long, all, self.outf,
3702
 
                              show_ids=show_ids)
3703
 
        finally:
3704
 
            if wt is not None:
3705
 
                wt.unlock()
3706
 
            else:
3707
 
                branch.unlock()
 
4595
            self.add_cleanup(branch.unlock)
 
4596
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4597
        tree.lock_read()
 
4598
        self.add_cleanup(tree.unlock)
 
4599
        if wt is not None:
 
4600
            file_id = wt.path2id(relpath)
 
4601
        else:
 
4602
            file_id = tree.path2id(relpath)
 
4603
        if file_id is None:
 
4604
            raise errors.NotVersionedError(filename)
 
4605
        file_version = tree.inventory[file_id].revision
 
4606
        if wt is not None and revision is None:
 
4607
            # If there is a tree and we're not annotating historical
 
4608
            # versions, annotate the working tree's content.
 
4609
            annotate_file_tree(wt, file_id, self.outf, long, all,
 
4610
                show_ids=show_ids)
 
4611
        else:
 
4612
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4613
                          show_ids=show_ids)
3708
4614
 
3709
4615
 
3710
4616
class cmd_re_sign(Command):
3711
 
    """Create a digital signature for an existing revision."""
 
4617
    __doc__ = """Create a digital signature for an existing revision."""
3712
4618
    # TODO be able to replace existing ones.
3713
4619
 
3714
4620
    hidden = True # is this right ?
3715
4621
    takes_args = ['revision_id*']
3716
4622
    takes_options = ['revision']
3717
 
    
 
4623
 
3718
4624
    def run(self, revision_id_list=None, revision=None):
3719
4625
        if revision_id_list is not None and revision is not None:
3720
4626
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3722
4628
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3723
4629
        b = WorkingTree.open_containing(u'.')[0].branch
3724
4630
        b.lock_write()
3725
 
        try:
3726
 
            return self._run(b, revision_id_list, revision)
3727
 
        finally:
3728
 
            b.unlock()
 
4631
        self.add_cleanup(b.unlock)
 
4632
        return self._run(b, revision_id_list, revision)
3729
4633
 
3730
4634
    def _run(self, b, revision_id_list, revision):
3731
4635
        import bzrlib.gpg as gpg
3776
4680
 
3777
4681
 
3778
4682
class cmd_bind(Command):
3779
 
    """Convert the current branch into a checkout of the supplied branch.
 
4683
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
4684
    If no branch is supplied, rebind to the last bound location.
3780
4685
 
3781
4686
    Once converted into a checkout, commits must succeed on the master branch
3782
4687
    before they will be applied to the local branch.
3783
4688
 
3784
4689
    Bound branches use the nickname of its master branch unless it is set
3785
 
    locally, in which case binding will update the the local nickname to be
 
4690
    locally, in which case binding will update the local nickname to be
3786
4691
    that of the master.
3787
4692
    """
3788
4693
 
3800
4705
                    'This format does not remember old locations.')
3801
4706
            else:
3802
4707
                if location is None:
3803
 
                    raise errors.BzrCommandError('No location supplied and no '
3804
 
                        'previous location known')
 
4708
                    if b.get_bound_location() is not None:
 
4709
                        raise errors.BzrCommandError('Branch is already bound')
 
4710
                    else:
 
4711
                        raise errors.BzrCommandError('No location supplied '
 
4712
                            'and no previous location known')
3805
4713
        b_other = Branch.open(location)
3806
4714
        try:
3807
4715
            b.bind(b_other)
3813
4721
 
3814
4722
 
3815
4723
class cmd_unbind(Command):
3816
 
    """Convert the current checkout into a regular branch.
 
4724
    __doc__ = """Convert the current checkout into a regular branch.
3817
4725
 
3818
4726
    After unbinding, the local branch is considered independent and subsequent
3819
4727
    commits will be local only.
3830
4738
 
3831
4739
 
3832
4740
class cmd_uncommit(Command):
3833
 
    """Remove the last committed revision.
 
4741
    __doc__ = """Remove the last committed revision.
3834
4742
 
3835
4743
    --verbose will print out what is being removed.
3836
4744
    --dry-run will go through all the motions, but not actually
3877
4785
 
3878
4786
        if tree is not None:
3879
4787
            tree.lock_write()
 
4788
            self.add_cleanup(tree.unlock)
3880
4789
        else:
3881
4790
            b.lock_write()
3882
 
        try:
3883
 
            return self._run(b, tree, dry_run, verbose, revision, force,
3884
 
                             local=local)
3885
 
        finally:
3886
 
            if tree is not None:
3887
 
                tree.unlock()
3888
 
            else:
3889
 
                b.unlock()
 
4791
            self.add_cleanup(b.unlock)
 
4792
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
3890
4793
 
3891
4794
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
3892
4795
        from bzrlib.log import log_formatter, show_log
3924
4827
                 end_revision=last_revno)
3925
4828
 
3926
4829
        if dry_run:
3927
 
            print 'Dry-run, pretending to remove the above revisions.'
3928
 
            if not force:
3929
 
                val = raw_input('Press <enter> to continue')
 
4830
            self.outf.write('Dry-run, pretending to remove'
 
4831
                            ' the above revisions.\n')
3930
4832
        else:
3931
 
            print 'The above revision(s) will be removed.'
3932
 
            if not force:
3933
 
                val = raw_input('Are you sure [y/N]? ')
3934
 
                if val.lower() not in ('y', 'yes'):
3935
 
                    print 'Canceled'
3936
 
                    return 0
 
4833
            self.outf.write('The above revision(s) will be removed.\n')
 
4834
 
 
4835
        if not force:
 
4836
            if not ui.ui_factory.get_boolean('Are you sure'):
 
4837
                self.outf.write('Canceled')
 
4838
                return 0
3937
4839
 
3938
4840
        mutter('Uncommitting from {%s} to {%s}',
3939
4841
               last_rev_id, rev_id)
3940
4842
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3941
4843
                 revno=revno, local=local)
3942
 
        note('You can restore the old tip by running:\n'
3943
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
4844
        self.outf.write('You can restore the old tip by running:\n'
 
4845
             '  bzr pull . -r revid:%s\n' % last_rev_id)
3944
4846
 
3945
4847
 
3946
4848
class cmd_break_lock(Command):
3947
 
    """Break a dead lock on a repository, branch or working directory.
 
4849
    __doc__ = """Break a dead lock on a repository, branch or working directory.
3948
4850
 
3949
4851
    CAUTION: Locks should only be broken when you are sure that the process
3950
4852
    holding the lock has been stopped.
3951
4853
 
3952
 
    You can get information on what locks are open via the 'bzr info' command.
3953
 
    
 
4854
    You can get information on what locks are open via the 'bzr info
 
4855
    [location]' command.
 
4856
 
3954
4857
    :Examples:
3955
4858
        bzr break-lock
 
4859
        bzr break-lock bzr+ssh://example.com/bzr/foo
3956
4860
    """
3957
4861
    takes_args = ['location?']
3958
4862
 
3964
4868
            control.break_lock()
3965
4869
        except NotImplementedError:
3966
4870
            pass
3967
 
        
 
4871
 
3968
4872
 
3969
4873
class cmd_wait_until_signalled(Command):
3970
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4874
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3971
4875
 
3972
4876
    This just prints a line to signal when it is ready, then blocks on stdin.
3973
4877
    """
3981
4885
 
3982
4886
 
3983
4887
class cmd_serve(Command):
3984
 
    """Run the bzr server."""
 
4888
    __doc__ = """Run the bzr server."""
3985
4889
 
3986
4890
    aliases = ['server']
3987
4891
 
3988
4892
    takes_options = [
3989
4893
        Option('inet',
3990
4894
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4895
        RegistryOption('protocol',
 
4896
               help="Protocol to serve.",
 
4897
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4898
               value_switches=True),
3991
4899
        Option('port',
3992
4900
               help='Listen for connections on nominated port of the form '
3993
4901
                    '[hostname:]portnumber.  Passing 0 as the port number will '
3994
 
                    'result in a dynamically allocated port.  The default port is '
3995
 
                    '4155.',
 
4902
                    'result in a dynamically allocated port.  The default port '
 
4903
                    'depends on the protocol.',
3996
4904
               type=str),
3997
4905
        Option('directory',
3998
4906
               help='Serve contents of this directory.',
4000
4908
        Option('allow-writes',
4001
4909
               help='By default the server is a readonly server.  Supplying '
4002
4910
                    '--allow-writes enables write access to the contents of '
4003
 
                    'the served directory and below.'
 
4911
                    'the served directory and below.  Note that ``bzr serve`` '
 
4912
                    'does not perform authentication, so unless some form of '
 
4913
                    'external authentication is arranged supplying this '
 
4914
                    'option leads to global uncontrolled write access to your '
 
4915
                    'file system.'
4004
4916
                ),
4005
4917
        ]
4006
4918
 
4007
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
4008
 
        from bzrlib import lockdir
4009
 
        from bzrlib.smart import medium, server
4010
 
        from bzrlib.transport import get_transport
4011
 
        from bzrlib.transport.chroot import ChrootServer
 
4919
    def get_host_and_port(self, port):
 
4920
        """Return the host and port to run the smart server on.
 
4921
 
 
4922
        If 'port' is None, None will be returned for the host and port.
 
4923
 
 
4924
        If 'port' has a colon in it, the string before the colon will be
 
4925
        interpreted as the host.
 
4926
 
 
4927
        :param port: A string of the port to run the server on.
 
4928
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4929
            and port is an integer TCP/IP port.
 
4930
        """
 
4931
        host = None
 
4932
        if port is not None:
 
4933
            if ':' in port:
 
4934
                host, port = port.split(':')
 
4935
            port = int(port)
 
4936
        return host, port
 
4937
 
 
4938
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4939
            protocol=None):
 
4940
        from bzrlib.transport import get_transport, transport_server_registry
4012
4941
        if directory is None:
4013
4942
            directory = os.getcwd()
 
4943
        if protocol is None:
 
4944
            protocol = transport_server_registry.get()
 
4945
        host, port = self.get_host_and_port(port)
4014
4946
        url = urlutils.local_path_to_url(directory)
4015
4947
        if not allow_writes:
4016
4948
            url = 'readonly+' + url
4017
 
        chroot_server = ChrootServer(get_transport(url))
4018
 
        chroot_server.setUp()
4019
 
        t = get_transport(chroot_server.get_url())
4020
 
        if inet:
4021
 
            smart_server = medium.SmartServerPipeStreamMedium(
4022
 
                sys.stdin, sys.stdout, t)
4023
 
        else:
4024
 
            host = medium.BZR_DEFAULT_INTERFACE
4025
 
            if port is None:
4026
 
                port = medium.BZR_DEFAULT_PORT
4027
 
            else:
4028
 
                if ':' in port:
4029
 
                    host, port = port.split(':')
4030
 
                port = int(port)
4031
 
            smart_server = server.SmartTCPServer(t, host=host, port=port)
4032
 
            print 'listening on port: ', smart_server.port
4033
 
            sys.stdout.flush()
4034
 
        # for the duration of this server, no UI output is permitted.
4035
 
        # note that this may cause problems with blackbox tests. This should
4036
 
        # be changed with care though, as we dont want to use bandwidth sending
4037
 
        # progress over stderr to smart server clients!
4038
 
        old_factory = ui.ui_factory
4039
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
4040
 
        try:
4041
 
            ui.ui_factory = ui.SilentUIFactory()
4042
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
4043
 
            smart_server.serve()
4044
 
        finally:
4045
 
            ui.ui_factory = old_factory
4046
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4949
        transport = get_transport(url)
 
4950
        protocol(transport, host, port, inet)
4047
4951
 
4048
4952
 
4049
4953
class cmd_join(Command):
4050
 
    """Combine a subtree into its containing tree.
4051
 
    
4052
 
    This command is for experimental use only.  It requires the target tree
4053
 
    to be in dirstate-with-subtree format, which cannot be converted into
4054
 
    earlier formats.
 
4954
    __doc__ = """Combine a tree into its containing tree.
 
4955
 
 
4956
    This command requires the target tree to be in a rich-root format.
4055
4957
 
4056
4958
    The TREE argument should be an independent tree, inside another tree, but
4057
4959
    not part of it.  (Such trees can be produced by "bzr split", but also by
4060
4962
    The result is a combined tree, with the subtree no longer an independant
4061
4963
    part.  This is marked as a merge of the subtree into the containing tree,
4062
4964
    and all history is preserved.
4063
 
 
4064
 
    If --reference is specified, the subtree retains its independence.  It can
4065
 
    be branched by itself, and can be part of multiple projects at the same
4066
 
    time.  But operations performed in the containing tree, such as commit
4067
 
    and merge, will recurse into the subtree.
4068
4965
    """
4069
4966
 
4070
4967
    _see_also = ['split']
4071
4968
    takes_args = ['tree']
4072
4969
    takes_options = [
4073
 
            Option('reference', help='Join by reference.'),
 
4970
            Option('reference', help='Join by reference.', hidden=True),
4074
4971
            ]
4075
 
    hidden = True
4076
4972
 
4077
4973
    def run(self, tree, reference=False):
4078
4974
        sub_tree = WorkingTree.open(tree)
4096
4992
            try:
4097
4993
                containing_tree.subsume(sub_tree)
4098
4994
            except errors.BadSubsumeSource, e:
4099
 
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
4995
                raise errors.BzrCommandError("Cannot join %s.  %s" %
4100
4996
                                             (tree, e.reason))
4101
4997
 
4102
4998
 
4103
4999
class cmd_split(Command):
4104
 
    """Split a subdirectory of a tree into a separate tree.
 
5000
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4105
5001
 
4106
5002
    This command will produce a target tree in a format that supports
4107
5003
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4112
5008
    branch.  Commits in the top-level tree will not apply to the new subtree.
4113
5009
    """
4114
5010
 
4115
 
    # join is not un-hidden yet
4116
 
    #_see_also = ['join']
 
5011
    _see_also = ['join']
4117
5012
    takes_args = ['tree']
4118
5013
 
4119
5014
    def run(self, tree):
4124
5019
        try:
4125
5020
            containing_tree.extract(sub_id)
4126
5021
        except errors.RootNotRich:
4127
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
5022
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
4128
5023
 
4129
5024
 
4130
5025
class cmd_merge_directive(Command):
4131
 
    """Generate a merge directive for auto-merge tools.
 
5026
    __doc__ = """Generate a merge directive for auto-merge tools.
4132
5027
 
4133
5028
    A directive requests a merge to be performed, and also provides all the
4134
5029
    information necessary to do so.  This means it must either include a
4227
5122
 
4228
5123
 
4229
5124
class cmd_send(Command):
4230
 
    """Mail or create a merge-directive for submiting changes.
 
5125
    __doc__ = """Mail or create a merge-directive for submitting changes.
4231
5126
 
4232
5127
    A merge directive provides many things needed for requesting merges:
4233
5128
 
4239
5134
      directly from the merge directive, without retrieving data from a
4240
5135
      branch.
4241
5136
 
4242
 
    If --no-bundle is specified, then public_branch is needed (and must be
4243
 
    up-to-date), so that the receiver can perform the merge using the
4244
 
    public_branch.  The public_branch is always included if known, so that
4245
 
    people can check it later.
4246
 
 
4247
 
    The submit branch defaults to the parent, but can be overridden.  Both
4248
 
    submit branch and public branch will be remembered if supplied.
4249
 
 
4250
 
    If a public_branch is known for the submit_branch, that public submit
4251
 
    branch is used in the merge instructions.  This means that a local mirror
4252
 
    can be used as your actual submit branch, once you have set public_branch
4253
 
    for that mirror.
 
5137
    `bzr send` creates a compact data set that, when applied using bzr
 
5138
    merge, has the same effect as merging from the source branch.  
 
5139
    
 
5140
    By default the merge directive is self-contained and can be applied to any
 
5141
    branch containing submit_branch in its ancestory without needing access to
 
5142
    the source branch.
 
5143
    
 
5144
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
 
5145
    revisions, but only a structured request to merge from the
 
5146
    public_location.  In that case the public_branch is needed and it must be
 
5147
    up-to-date and accessible to the recipient.  The public_branch is always
 
5148
    included if known, so that people can check it later.
 
5149
 
 
5150
    The submit branch defaults to the parent of the source branch, but can be
 
5151
    overridden.  Both submit branch and public branch will be remembered in
 
5152
    branch.conf the first time they are used for a particular branch.  The
 
5153
    source branch defaults to that containing the working directory, but can
 
5154
    be changed using --from.
 
5155
 
 
5156
    In order to calculate those changes, bzr must analyse the submit branch.
 
5157
    Therefore it is most efficient for the submit branch to be a local mirror.
 
5158
    If a public location is known for the submit_branch, that location is used
 
5159
    in the merge directive.
 
5160
 
 
5161
    The default behaviour is to send the merge directive by mail, unless -o is
 
5162
    given, in which case it is sent to a file.
4254
5163
 
4255
5164
    Mail is sent using your preferred mail program.  This should be transparent
4256
5165
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
4257
5166
    If the preferred client can't be found (or used), your editor will be used.
4258
 
    
 
5167
 
4259
5168
    To use a specific mail program, set the mail_client configuration option.
4260
5169
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4261
 
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4262
 
    generic options are "default", "editor", "emacsclient", "mapi", and
4263
 
    "xdg-email".  Plugins may also add supported clients.
 
5170
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
5171
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
5172
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
5173
    supported clients.
4264
5174
 
4265
5175
    If mail is being sent, a to address is required.  This can be supplied
4266
5176
    either on the commandline, by setting the submit_to configuration
4267
 
    option in the branch itself or the child_submit_to configuration option 
 
5177
    option in the branch itself or the child_submit_to configuration option
4268
5178
    in the submit branch.
4269
5179
 
4270
5180
    Two formats are currently supported: "4" uses revision bundle format 4 and
4272
5182
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
4273
5183
    default.  "0.9" uses revision bundle format 0.9 and merge directive
4274
5184
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
4275
 
    
4276
 
    Merge directives are applied using the merge command or the pull command.
 
5185
 
 
5186
    The merge directives created by bzr send may be applied using bzr merge or
 
5187
    bzr pull by specifying a file containing a merge directive as the location.
 
5188
 
 
5189
    bzr send makes extensive use of public locations to map local locations into
 
5190
    URLs that can be used by other people.  See `bzr help configuration` to
 
5191
    set them, and use `bzr info` to display them.
4277
5192
    """
4278
5193
 
4279
5194
    encoding_type = 'exact'
4295
5210
               short_name='f',
4296
5211
               type=unicode),
4297
5212
        Option('output', short_name='o',
4298
 
               help='Write merge directive to this file; '
 
5213
               help='Write merge directive to this file or directory; '
4299
5214
                    'use - for stdout.',
4300
5215
               type=unicode),
 
5216
        Option('strict',
 
5217
               help='Refuse to send if there are uncommitted changes in'
 
5218
               ' the working tree, --no-strict disables the check.'),
4301
5219
        Option('mail-to', help='Mail the request to this address.',
4302
5220
               type=unicode),
4303
5221
        'revision',
4304
5222
        'message',
4305
 
        RegistryOption.from_kwargs('format',
4306
 
        'Use the specified output format.',
4307
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4308
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5223
        Option('body', help='Body for the email.', type=unicode),
 
5224
        RegistryOption('format',
 
5225
                       help='Use the specified output format.',
 
5226
                       lazy_registry=('bzrlib.send', 'format_registry')),
4309
5227
        ]
4310
5228
 
4311
5229
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4312
5230
            no_patch=False, revision=None, remember=False, output=None,
4313
 
            format='4', mail_to=None, message=None, **kwargs):
4314
 
        return self._run(submit_branch, revision, public_branch, remember,
4315
 
                         format, no_bundle, no_patch, output,
4316
 
                         kwargs.get('from', '.'), mail_to, message)
4317
 
 
4318
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
4319
 
             no_bundle, no_patch, output, from_, mail_to, message):
4320
 
        from bzrlib.revision import NULL_REVISION
4321
 
        branch = Branch.open_containing(from_)[0]
4322
 
        if output is None:
4323
 
            outfile = cStringIO.StringIO()
4324
 
        elif output == '-':
4325
 
            outfile = self.outf
4326
 
        else:
4327
 
            outfile = open(output, 'wb')
4328
 
        # we may need to write data into branch's repository to calculate
4329
 
        # the data to send.
4330
 
        branch.lock_write()
4331
 
        try:
4332
 
            if output is None:
4333
 
                config = branch.get_config()
4334
 
                if mail_to is None:
4335
 
                    mail_to = config.get_user_option('submit_to')
4336
 
                mail_client = config.get_mail_client()
4337
 
            if remember and submit_branch is None:
4338
 
                raise errors.BzrCommandError(
4339
 
                    '--remember requires a branch to be specified.')
4340
 
            stored_submit_branch = branch.get_submit_branch()
4341
 
            remembered_submit_branch = None
4342
 
            if submit_branch is None:
4343
 
                submit_branch = stored_submit_branch
4344
 
                remembered_submit_branch = "submit"
4345
 
            else:
4346
 
                if stored_submit_branch is None or remember:
4347
 
                    branch.set_submit_branch(submit_branch)
4348
 
            if submit_branch is None:
4349
 
                submit_branch = branch.get_parent()
4350
 
                remembered_submit_branch = "parent"
4351
 
            if submit_branch is None:
4352
 
                raise errors.BzrCommandError('No submit branch known or'
4353
 
                                             ' specified')
4354
 
            if remembered_submit_branch is not None:
4355
 
                note('Using saved %s location "%s" to determine what '
4356
 
                        'changes to submit.', remembered_submit_branch,
4357
 
                        submit_branch)
4358
 
 
4359
 
            if mail_to is None:
4360
 
                submit_config = Branch.open(submit_branch).get_config()
4361
 
                mail_to = submit_config.get_user_option("child_submit_to")
4362
 
 
4363
 
            stored_public_branch = branch.get_public_branch()
4364
 
            if public_branch is None:
4365
 
                public_branch = stored_public_branch
4366
 
            elif stored_public_branch is None or remember:
4367
 
                branch.set_public_branch(public_branch)
4368
 
            if no_bundle and public_branch is None:
4369
 
                raise errors.BzrCommandError('No public branch specified or'
4370
 
                                             ' known')
4371
 
            base_revision_id = None
4372
 
            revision_id = None
4373
 
            if revision is not None:
4374
 
                if len(revision) > 2:
4375
 
                    raise errors.BzrCommandError('bzr send takes '
4376
 
                        'at most two one revision identifiers')
4377
 
                revision_id = revision[-1].as_revision_id(branch)
4378
 
                if len(revision) == 2:
4379
 
                    base_revision_id = revision[0].as_revision_id(branch)
4380
 
            if revision_id is None:
4381
 
                revision_id = branch.last_revision()
4382
 
            if revision_id == NULL_REVISION:
4383
 
                raise errors.BzrCommandError('No revisions to submit.')
4384
 
            if format == '4':
4385
 
                directive = merge_directive.MergeDirective2.from_objects(
4386
 
                    branch.repository, revision_id, time.time(),
4387
 
                    osutils.local_time_offset(), submit_branch,
4388
 
                    public_branch=public_branch, include_patch=not no_patch,
4389
 
                    include_bundle=not no_bundle, message=message,
4390
 
                    base_revision_id=base_revision_id)
4391
 
            elif format == '0.9':
4392
 
                if not no_bundle:
4393
 
                    if not no_patch:
4394
 
                        patch_type = 'bundle'
4395
 
                    else:
4396
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4397
 
                            ' permit bundle with no patch')
4398
 
                else:
4399
 
                    if not no_patch:
4400
 
                        patch_type = 'diff'
4401
 
                    else:
4402
 
                        patch_type = None
4403
 
                directive = merge_directive.MergeDirective.from_objects(
4404
 
                    branch.repository, revision_id, time.time(),
4405
 
                    osutils.local_time_offset(), submit_branch,
4406
 
                    public_branch=public_branch, patch_type=patch_type,
4407
 
                    message=message)
4408
 
 
4409
 
            outfile.writelines(directive.to_lines())
4410
 
            if output is None:
4411
 
                subject = '[MERGE] '
4412
 
                if message is not None:
4413
 
                    subject += message
4414
 
                else:
4415
 
                    revision = branch.repository.get_revision(revision_id)
4416
 
                    subject += revision.get_summary()
4417
 
                basename = directive.get_disk_name(branch)
4418
 
                mail_client.compose_merge_request(mail_to, subject,
4419
 
                                                  outfile.getvalue(), basename)
4420
 
        finally:
4421
 
            if output != '-':
4422
 
                outfile.close()
4423
 
            branch.unlock()
 
5231
            format=None, mail_to=None, message=None, body=None,
 
5232
            strict=None, **kwargs):
 
5233
        from bzrlib.send import send
 
5234
        return send(submit_branch, revision, public_branch, remember,
 
5235
                    format, no_bundle, no_patch, output,
 
5236
                    kwargs.get('from', '.'), mail_to, message, body,
 
5237
                    self.outf,
 
5238
                    strict=strict)
4424
5239
 
4425
5240
 
4426
5241
class cmd_bundle_revisions(cmd_send):
4427
 
 
4428
 
    """Create a merge-directive for submiting changes.
 
5242
    __doc__ = """Create a merge-directive for submitting changes.
4429
5243
 
4430
5244
    A merge directive provides many things needed for requesting merges:
4431
5245
 
4471
5285
               type=unicode),
4472
5286
        Option('output', short_name='o', help='Write directive to this file.',
4473
5287
               type=unicode),
 
5288
        Option('strict',
 
5289
               help='Refuse to bundle revisions if there are uncommitted'
 
5290
               ' changes in the working tree, --no-strict disables the check.'),
4474
5291
        'revision',
4475
 
        RegistryOption.from_kwargs('format',
4476
 
        'Use the specified output format.',
4477
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4478
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5292
        RegistryOption('format',
 
5293
                       help='Use the specified output format.',
 
5294
                       lazy_registry=('bzrlib.send', 'format_registry')),
4479
5295
        ]
4480
5296
    aliases = ['bundle']
4481
5297
 
4485
5301
 
4486
5302
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4487
5303
            no_patch=False, revision=None, remember=False, output=None,
4488
 
            format='4', **kwargs):
 
5304
            format=None, strict=None, **kwargs):
4489
5305
        if output is None:
4490
5306
            output = '-'
4491
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5307
        from bzrlib.send import send
 
5308
        return send(submit_branch, revision, public_branch, remember,
4492
5309
                         format, no_bundle, no_patch, output,
4493
 
                         kwargs.get('from', '.'), None, None)
 
5310
                         kwargs.get('from', '.'), None, None, None,
 
5311
                         self.outf, strict=strict)
4494
5312
 
4495
5313
 
4496
5314
class cmd_tag(Command):
4497
 
    """Create, remove or modify a tag naming a revision.
4498
 
    
 
5315
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5316
 
4499
5317
    Tags give human-meaningful names to revisions.  Commands that take a -r
4500
5318
    (--revision) option can be given -rtag:X, where X is any previously
4501
5319
    created tag.
4503
5321
    Tags are stored in the branch.  Tags are copied from one branch to another
4504
5322
    along when you branch, push, pull or merge.
4505
5323
 
4506
 
    It is an error to give a tag name that already exists unless you pass 
 
5324
    It is an error to give a tag name that already exists unless you pass
4507
5325
    --force, in which case the tag is moved to point to the new revision.
4508
5326
 
4509
5327
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
4510
5328
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5329
 
 
5330
    If no tag name is specified it will be determined through the 
 
5331
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5332
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5333
    details.
4511
5334
    """
4512
5335
 
4513
5336
    _see_also = ['commit', 'tags']
4514
 
    takes_args = ['tag_name']
 
5337
    takes_args = ['tag_name?']
4515
5338
    takes_options = [
4516
5339
        Option('delete',
4517
5340
            help='Delete this tag rather than placing it.',
4527
5350
        'revision',
4528
5351
        ]
4529
5352
 
4530
 
    def run(self, tag_name,
 
5353
    def run(self, tag_name=None,
4531
5354
            delete=None,
4532
5355
            directory='.',
4533
5356
            force=None,
4535
5358
            ):
4536
5359
        branch, relpath = Branch.open_containing(directory)
4537
5360
        branch.lock_write()
4538
 
        try:
4539
 
            if delete:
4540
 
                branch.tags.delete_tag(tag_name)
4541
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5361
        self.add_cleanup(branch.unlock)
 
5362
        if delete:
 
5363
            if tag_name is None:
 
5364
                raise errors.BzrCommandError("No tag specified to delete.")
 
5365
            branch.tags.delete_tag(tag_name)
 
5366
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5367
        else:
 
5368
            if revision:
 
5369
                if len(revision) != 1:
 
5370
                    raise errors.BzrCommandError(
 
5371
                        "Tags can only be placed on a single revision, "
 
5372
                        "not on a range")
 
5373
                revision_id = revision[0].as_revision_id(branch)
4542
5374
            else:
4543
 
                if revision:
4544
 
                    if len(revision) != 1:
4545
 
                        raise errors.BzrCommandError(
4546
 
                            "Tags can only be placed on a single revision, "
4547
 
                            "not on a range")
4548
 
                    revision_id = revision[0].as_revision_id(branch)
4549
 
                else:
4550
 
                    revision_id = branch.last_revision()
4551
 
                if (not force) and branch.tags.has_tag(tag_name):
4552
 
                    raise errors.TagAlreadyExists(tag_name)
4553
 
                branch.tags.set_tag(tag_name, revision_id)
4554
 
                self.outf.write('Created tag %s.\n' % tag_name)
4555
 
        finally:
4556
 
            branch.unlock()
 
5375
                revision_id = branch.last_revision()
 
5376
            if tag_name is None:
 
5377
                tag_name = branch.automatic_tag_name(revision_id)
 
5378
                if tag_name is None:
 
5379
                    raise errors.BzrCommandError(
 
5380
                        "Please specify a tag name.")
 
5381
            if (not force) and branch.tags.has_tag(tag_name):
 
5382
                raise errors.TagAlreadyExists(tag_name)
 
5383
            branch.tags.set_tag(tag_name, revision_id)
 
5384
            self.outf.write('Created tag %s.\n' % tag_name)
4557
5385
 
4558
5386
 
4559
5387
class cmd_tags(Command):
4560
 
    """List tags.
 
5388
    __doc__ = """List tags.
4561
5389
 
4562
5390
    This command shows a table of tag names and the revisions they reference.
4563
5391
    """
4575
5403
            time='Sort tags chronologically.',
4576
5404
            ),
4577
5405
        'show-ids',
 
5406
        'revision',
4578
5407
    ]
4579
5408
 
4580
5409
    @display_command
4582
5411
            directory='.',
4583
5412
            sort='alpha',
4584
5413
            show_ids=False,
 
5414
            revision=None,
4585
5415
            ):
4586
5416
        branch, relpath = Branch.open_containing(directory)
 
5417
 
4587
5418
        tags = branch.tags.get_tag_dict().items()
4588
5419
        if not tags:
4589
5420
            return
 
5421
 
 
5422
        branch.lock_read()
 
5423
        self.add_cleanup(branch.unlock)
 
5424
        if revision:
 
5425
            graph = branch.repository.get_graph()
 
5426
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5427
            revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5428
            # only show revisions between revid1 and revid2 (inclusive)
 
5429
            tags = [(tag, revid) for tag, revid in tags if
 
5430
                graph.is_between(revid, revid1, revid2)]
4590
5431
        if sort == 'alpha':
4591
5432
            tags.sort()
4592
5433
        elif sort == 'time':
4602
5443
            tags.sort(key=lambda x: timestamps[x[1]])
4603
5444
        if not show_ids:
4604
5445
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4605
 
            revno_map = branch.get_revision_id_to_revno_map()
4606
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4607
 
                        for tag, revid in tags ]
 
5446
            for index, (tag, revid) in enumerate(tags):
 
5447
                try:
 
5448
                    revno = branch.revision_id_to_dotted_revno(revid)
 
5449
                    if isinstance(revno, tuple):
 
5450
                        revno = '.'.join(map(str, revno))
 
5451
                except errors.NoSuchRevision:
 
5452
                    # Bad tag data/merges can lead to tagged revisions
 
5453
                    # which are not in this branch. Fail gracefully ...
 
5454
                    revno = '?'
 
5455
                tags[index] = (tag, revno)
 
5456
        self.cleanup_now()
4608
5457
        for tag, revspec in tags:
4609
5458
            self.outf.write('%-20s %s\n' % (tag, revspec))
4610
5459
 
4611
5460
 
4612
5461
class cmd_reconfigure(Command):
4613
 
    """Reconfigure the type of a bzr directory.
 
5462
    __doc__ = """Reconfigure the type of a bzr directory.
4614
5463
 
4615
5464
    A target configuration must be specified.
4616
5465
 
4625
5474
 
4626
5475
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4627
5476
    takes_args = ['location?']
4628
 
    takes_options = [RegistryOption.from_kwargs('target_type',
4629
 
                     title='Target type',
4630
 
                     help='The type to reconfigure the directory to.',
4631
 
                     value_switches=True, enum_switch=False,
4632
 
                     branch='Reconfigure to be an unbound branch '
4633
 
                        'with no working tree.',
4634
 
                     tree='Reconfigure to be an unbound branch '
4635
 
                        'with a working tree.',
4636
 
                     checkout='Reconfigure to be a bound branch '
4637
 
                        'with a working tree.',
4638
 
                     lightweight_checkout='Reconfigure to be a lightweight'
4639
 
                     ' checkout (with no local history).',
4640
 
                     standalone='Reconfigure to be a standalone branch '
4641
 
                        '(i.e. stop using shared repository).',
4642
 
                     use_shared='Reconfigure to use a shared repository.'),
4643
 
                     Option('bind-to', help='Branch to bind checkout to.',
4644
 
                            type=str),
4645
 
                     Option('force',
4646
 
                        help='Perform reconfiguration even if local changes'
4647
 
                        ' will be lost.')
4648
 
                     ]
 
5477
    takes_options = [
 
5478
        RegistryOption.from_kwargs(
 
5479
            'target_type',
 
5480
            title='Target type',
 
5481
            help='The type to reconfigure the directory to.',
 
5482
            value_switches=True, enum_switch=False,
 
5483
            branch='Reconfigure to be an unbound branch with no working tree.',
 
5484
            tree='Reconfigure to be an unbound branch with a working tree.',
 
5485
            checkout='Reconfigure to be a bound branch with a working tree.',
 
5486
            lightweight_checkout='Reconfigure to be a lightweight'
 
5487
                ' checkout (with no local history).',
 
5488
            standalone='Reconfigure to be a standalone branch '
 
5489
                '(i.e. stop using shared repository).',
 
5490
            use_shared='Reconfigure to use a shared repository.',
 
5491
            with_trees='Reconfigure repository to create '
 
5492
                'working trees on branches by default.',
 
5493
            with_no_trees='Reconfigure repository to not create '
 
5494
                'working trees on branches by default.'
 
5495
            ),
 
5496
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
5497
        Option('force',
 
5498
            help='Perform reconfiguration even if local changes'
 
5499
            ' will be lost.'),
 
5500
        Option('stacked-on',
 
5501
            help='Reconfigure a branch to be stacked on another branch.',
 
5502
            type=unicode,
 
5503
            ),
 
5504
        Option('unstacked',
 
5505
            help='Reconfigure a branch to be unstacked.  This '
 
5506
                'may require copying substantial data into it.',
 
5507
            ),
 
5508
        ]
4649
5509
 
4650
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5510
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5511
            stacked_on=None,
 
5512
            unstacked=None):
4651
5513
        directory = bzrdir.BzrDir.open(location)
 
5514
        if stacked_on and unstacked:
 
5515
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5516
        elif stacked_on is not None:
 
5517
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5518
        elif unstacked:
 
5519
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5520
        # At the moment you can use --stacked-on and a different
 
5521
        # reconfiguration shape at the same time; there seems no good reason
 
5522
        # to ban it.
4652
5523
        if target_type is None:
4653
 
            raise errors.BzrCommandError('No target configuration specified')
 
5524
            if stacked_on or unstacked:
 
5525
                return
 
5526
            else:
 
5527
                raise errors.BzrCommandError('No target configuration '
 
5528
                    'specified')
4654
5529
        elif target_type == 'branch':
4655
5530
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4656
5531
        elif target_type == 'tree':
4657
5532
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4658
5533
        elif target_type == 'checkout':
4659
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4660
 
                                                                  bind_to)
 
5534
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
5535
                directory, bind_to)
4661
5536
        elif target_type == 'lightweight-checkout':
4662
5537
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4663
5538
                directory, bind_to)
4665
5540
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4666
5541
        elif target_type == 'standalone':
4667
5542
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5543
        elif target_type == 'with-trees':
 
5544
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5545
                directory, True)
 
5546
        elif target_type == 'with-no-trees':
 
5547
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5548
                directory, False)
4668
5549
        reconfiguration.apply(force)
4669
5550
 
4670
5551
 
4671
5552
class cmd_switch(Command):
4672
 
    """Set the branch of a checkout and update.
4673
 
    
 
5553
    __doc__ = """Set the branch of a checkout and update.
 
5554
 
4674
5555
    For lightweight checkouts, this changes the branch being referenced.
4675
5556
    For heavyweight checkouts, this checks that there are no local commits
4676
5557
    versus the current bound branch, then it makes the local branch a mirror
4687
5568
    /path/to/newbranch.
4688
5569
 
4689
5570
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case switching will update the the local nickname to be
 
5571
    locally, in which case switching will update the local nickname to be
4691
5572
    that of the master.
4692
5573
    """
4693
5574
 
4694
 
    takes_args = ['to_location']
 
5575
    takes_args = ['to_location?']
4695
5576
    takes_options = [Option('force',
4696
 
                        help='Switch even if local commits will be lost.')
4697
 
                     ]
 
5577
                        help='Switch even if local commits will be lost.'),
 
5578
                     'revision',
 
5579
                     Option('create-branch', short_name='b',
 
5580
                        help='Create the target branch from this one before'
 
5581
                             ' switching to it.'),
 
5582
                    ]
4698
5583
 
4699
 
    def run(self, to_location, force=False):
 
5584
    def run(self, to_location=None, force=False, create_branch=False,
 
5585
            revision=None):
4700
5586
        from bzrlib import switch
4701
5587
        tree_location = '.'
 
5588
        revision = _get_one_revision('switch', revision)
4702
5589
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
4703
 
        branch = control_dir.open_branch()
 
5590
        if to_location is None:
 
5591
            if revision is None:
 
5592
                raise errors.BzrCommandError('You must supply either a'
 
5593
                                             ' revision or a location')
 
5594
            to_location = '.'
4704
5595
        try:
4705
 
            to_branch = Branch.open(to_location)
 
5596
            branch = control_dir.open_branch()
 
5597
            had_explicit_nick = branch.get_config().has_explicit_nickname()
4706
5598
        except errors.NotBranchError:
4707
 
            this_branch = control_dir.open_branch()
4708
 
            # This may be a heavy checkout, where we want the master branch
4709
 
            this_url = this_branch.get_bound_location()
4710
 
            # If not, use a local sibling
4711
 
            if this_url is None:
4712
 
                this_url = this_branch.base
4713
 
            to_branch = Branch.open(
4714
 
                urlutils.join(this_url, '..', to_location))
4715
 
        switch.switch(control_dir, to_branch, force)
4716
 
        if branch.get_config().has_explicit_nickname():
 
5599
            branch = None
 
5600
            had_explicit_nick = False
 
5601
        if create_branch:
 
5602
            if branch is None:
 
5603
                raise errors.BzrCommandError('cannot create branch without'
 
5604
                                             ' source branch')
 
5605
            to_location = directory_service.directories.dereference(
 
5606
                              to_location)
 
5607
            if '/' not in to_location and '\\' not in to_location:
 
5608
                # This path is meant to be relative to the existing branch
 
5609
                this_url = self._get_branch_location(control_dir)
 
5610
                to_location = urlutils.join(this_url, '..', to_location)
 
5611
            to_branch = branch.bzrdir.sprout(to_location,
 
5612
                                 possible_transports=[branch.bzrdir.root_transport],
 
5613
                                 source_branch=branch).open_branch()
 
5614
        else:
 
5615
            try:
 
5616
                to_branch = Branch.open(to_location)
 
5617
            except errors.NotBranchError:
 
5618
                this_url = self._get_branch_location(control_dir)
 
5619
                to_branch = Branch.open(
 
5620
                    urlutils.join(this_url, '..', to_location))
 
5621
        if revision is not None:
 
5622
            revision = revision.as_revision_id(to_branch)
 
5623
        switch.switch(control_dir, to_branch, force, revision_id=revision)
 
5624
        if had_explicit_nick:
4717
5625
            branch = control_dir.open_branch() #get the new branch!
4718
5626
            branch.nick = to_branch.nick
4719
5627
        note('Switched to branch: %s',
4720
5628
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4721
5629
 
 
5630
    def _get_branch_location(self, control_dir):
 
5631
        """Return location of branch for this control dir."""
 
5632
        try:
 
5633
            this_branch = control_dir.open_branch()
 
5634
            # This may be a heavy checkout, where we want the master branch
 
5635
            master_location = this_branch.get_bound_location()
 
5636
            if master_location is not None:
 
5637
                return master_location
 
5638
            # If not, use a local sibling
 
5639
            return this_branch.base
 
5640
        except errors.NotBranchError:
 
5641
            format = control_dir.find_branch_format()
 
5642
            if getattr(format, 'get_reference', None) is not None:
 
5643
                return format.get_reference(control_dir)
 
5644
            else:
 
5645
                return control_dir.root_transport.base
 
5646
 
 
5647
 
 
5648
class cmd_view(Command):
 
5649
    __doc__ = """Manage filtered views.
 
5650
 
 
5651
    Views provide a mask over the tree so that users can focus on
 
5652
    a subset of a tree when doing their work. After creating a view,
 
5653
    commands that support a list of files - status, diff, commit, etc -
 
5654
    effectively have that list of files implicitly given each time.
 
5655
    An explicit list of files can still be given but those files
 
5656
    must be within the current view.
 
5657
 
 
5658
    In most cases, a view has a short life-span: it is created to make
 
5659
    a selected change and is deleted once that change is committed.
 
5660
    At other times, you may wish to create one or more named views
 
5661
    and switch between them.
 
5662
 
 
5663
    To disable the current view without deleting it, you can switch to
 
5664
    the pseudo view called ``off``. This can be useful when you need
 
5665
    to see the whole tree for an operation or two (e.g. merge) but
 
5666
    want to switch back to your view after that.
 
5667
 
 
5668
    :Examples:
 
5669
      To define the current view::
 
5670
 
 
5671
        bzr view file1 dir1 ...
 
5672
 
 
5673
      To list the current view::
 
5674
 
 
5675
        bzr view
 
5676
 
 
5677
      To delete the current view::
 
5678
 
 
5679
        bzr view --delete
 
5680
 
 
5681
      To disable the current view without deleting it::
 
5682
 
 
5683
        bzr view --switch off
 
5684
 
 
5685
      To define a named view and switch to it::
 
5686
 
 
5687
        bzr view --name view-name file1 dir1 ...
 
5688
 
 
5689
      To list a named view::
 
5690
 
 
5691
        bzr view --name view-name
 
5692
 
 
5693
      To delete a named view::
 
5694
 
 
5695
        bzr view --name view-name --delete
 
5696
 
 
5697
      To switch to a named view::
 
5698
 
 
5699
        bzr view --switch view-name
 
5700
 
 
5701
      To list all views defined::
 
5702
 
 
5703
        bzr view --all
 
5704
 
 
5705
      To delete all views::
 
5706
 
 
5707
        bzr view --delete --all
 
5708
    """
 
5709
 
 
5710
    _see_also = []
 
5711
    takes_args = ['file*']
 
5712
    takes_options = [
 
5713
        Option('all',
 
5714
            help='Apply list or delete action to all views.',
 
5715
            ),
 
5716
        Option('delete',
 
5717
            help='Delete the view.',
 
5718
            ),
 
5719
        Option('name',
 
5720
            help='Name of the view to define, list or delete.',
 
5721
            type=unicode,
 
5722
            ),
 
5723
        Option('switch',
 
5724
            help='Name of the view to switch to.',
 
5725
            type=unicode,
 
5726
            ),
 
5727
        ]
 
5728
 
 
5729
    def run(self, file_list,
 
5730
            all=False,
 
5731
            delete=False,
 
5732
            name=None,
 
5733
            switch=None,
 
5734
            ):
 
5735
        tree, file_list = tree_files(file_list, apply_view=False)
 
5736
        current_view, view_dict = tree.views.get_view_info()
 
5737
        if name is None:
 
5738
            name = current_view
 
5739
        if delete:
 
5740
            if file_list:
 
5741
                raise errors.BzrCommandError(
 
5742
                    "Both --delete and a file list specified")
 
5743
            elif switch:
 
5744
                raise errors.BzrCommandError(
 
5745
                    "Both --delete and --switch specified")
 
5746
            elif all:
 
5747
                tree.views.set_view_info(None, {})
 
5748
                self.outf.write("Deleted all views.\n")
 
5749
            elif name is None:
 
5750
                raise errors.BzrCommandError("No current view to delete")
 
5751
            else:
 
5752
                tree.views.delete_view(name)
 
5753
                self.outf.write("Deleted '%s' view.\n" % name)
 
5754
        elif switch:
 
5755
            if file_list:
 
5756
                raise errors.BzrCommandError(
 
5757
                    "Both --switch and a file list specified")
 
5758
            elif all:
 
5759
                raise errors.BzrCommandError(
 
5760
                    "Both --switch and --all specified")
 
5761
            elif switch == 'off':
 
5762
                if current_view is None:
 
5763
                    raise errors.BzrCommandError("No current view to disable")
 
5764
                tree.views.set_view_info(None, view_dict)
 
5765
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
5766
            else:
 
5767
                tree.views.set_view_info(switch, view_dict)
 
5768
                view_str = views.view_display_str(tree.views.lookup_view())
 
5769
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
5770
        elif all:
 
5771
            if view_dict:
 
5772
                self.outf.write('Views defined:\n')
 
5773
                for view in sorted(view_dict):
 
5774
                    if view == current_view:
 
5775
                        active = "=>"
 
5776
                    else:
 
5777
                        active = "  "
 
5778
                    view_str = views.view_display_str(view_dict[view])
 
5779
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
5780
            else:
 
5781
                self.outf.write('No views defined.\n')
 
5782
        elif file_list:
 
5783
            if name is None:
 
5784
                # No name given and no current view set
 
5785
                name = 'my'
 
5786
            elif name == 'off':
 
5787
                raise errors.BzrCommandError(
 
5788
                    "Cannot change the 'off' pseudo view")
 
5789
            tree.views.set_view(name, sorted(file_list))
 
5790
            view_str = views.view_display_str(tree.views.lookup_view())
 
5791
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
5792
        else:
 
5793
            # list the files
 
5794
            if name is None:
 
5795
                # No name given and no current view set
 
5796
                self.outf.write('No current view.\n')
 
5797
            else:
 
5798
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
5799
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
5800
 
4722
5801
 
4723
5802
class cmd_hooks(Command):
4724
 
    """Show a branch's currently registered hooks.
 
5803
    __doc__ = """Show hooks."""
 
5804
 
 
5805
    hidden = True
 
5806
 
 
5807
    def run(self):
 
5808
        for hook_key in sorted(hooks.known_hooks.keys()):
 
5809
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
5810
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
5811
            for hook_name, hook_point in sorted(some_hooks.items()):
 
5812
                self.outf.write("  %s:\n" % (hook_name,))
 
5813
                found_hooks = list(hook_point)
 
5814
                if found_hooks:
 
5815
                    for hook in found_hooks:
 
5816
                        self.outf.write("    %s\n" %
 
5817
                                        (some_hooks.get_hook_name(hook),))
 
5818
                else:
 
5819
                    self.outf.write("    <no hooks installed>\n")
 
5820
 
 
5821
 
 
5822
class cmd_remove_branch(Command):
 
5823
    __doc__ = """Remove a branch.
 
5824
 
 
5825
    This will remove the branch from the specified location but 
 
5826
    will keep any working tree or repository in place.
 
5827
 
 
5828
    :Examples:
 
5829
 
 
5830
      Remove the branch at repo/trunk::
 
5831
 
 
5832
        bzr remove-branch repo/trunk
 
5833
 
4725
5834
    """
4726
5835
 
4727
 
    hidden = True
4728
 
    takes_args = ['path?']
4729
 
 
4730
 
    def run(self, path=None):
4731
 
        if path is None:
4732
 
            path = '.'
4733
 
        branch_hooks = Branch.open(path).hooks
4734
 
        for hook_type in branch_hooks:
4735
 
            hooks = branch_hooks[hook_type]
4736
 
            self.outf.write("%s:\n" % (hook_type,))
4737
 
            if hooks:
4738
 
                for hook in hooks:
4739
 
                    self.outf.write("  %s\n" %
4740
 
                                    (branch_hooks.get_hook_name(hook),))
4741
 
            else:
4742
 
                self.outf.write("  <no hooks installed>\n")
4743
 
 
 
5836
    takes_args = ["location?"]
 
5837
 
 
5838
    aliases = ["rmbranch"]
 
5839
 
 
5840
    def run(self, location=None):
 
5841
        if location is None:
 
5842
            location = "."
 
5843
        branch = Branch.open_containing(location)[0]
 
5844
        branch.bzrdir.destroy_branch()
 
5845
        
4744
5846
 
4745
5847
class cmd_shelve(Command):
4746
 
    """Temporarily set aside some changes from the current tree.
 
5848
    __doc__ = """Temporarily set aside some changes from the current tree.
4747
5849
 
4748
5850
    Shelve allows you to temporarily put changes you've made "on the shelf",
4749
5851
    ie. out of the way, until a later time when you can bring them back from
4750
 
    the shelf with the 'unshelve' command.
 
5852
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
5853
    your working tree, and so they aren't propagated along with your branch nor
 
5854
    will they survive its deletion.
4751
5855
 
4752
5856
    If shelve --list is specified, previously-shelved changes are listed.
4753
5857
 
4776
5880
                       value_switches=True, enum_switch=False),
4777
5881
 
4778
5882
        Option('list', help='List shelved changes.'),
 
5883
        Option('destroy',
 
5884
               help='Destroy removed changes instead of shelving them.'),
4779
5885
    ]
4780
5886
    _see_also = ['unshelve']
4781
5887
 
4782
5888
    def run(self, revision=None, all=False, file_list=None, message=None,
4783
 
            writer=None, list=False):
 
5889
            writer=None, list=False, destroy=False):
4784
5890
        if list:
4785
5891
            return self.run_for_list()
4786
5892
        from bzrlib.shelf_ui import Shelver
4787
5893
        if writer is None:
4788
5894
            writer = bzrlib.option.diff_writer_registry.get()
4789
5895
        try:
4790
 
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
4791
 
                              message).run()
 
5896
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5897
                file_list, message, destroy=destroy)
 
5898
            try:
 
5899
                shelver.run()
 
5900
            finally:
 
5901
                shelver.finalize()
4792
5902
        except errors.UserAbort:
4793
5903
            return 0
4794
5904
 
4795
5905
    def run_for_list(self):
4796
5906
        tree = WorkingTree.open_containing('.')[0]
4797
5907
        tree.lock_read()
4798
 
        try:
4799
 
            manager = tree.get_shelf_manager()
4800
 
            shelves = manager.active_shelves()
4801
 
            if len(shelves) == 0:
4802
 
                note('No shelved changes.')
4803
 
                return 0
4804
 
            for shelf_id in reversed(shelves):
4805
 
                message = manager.get_metadata(shelf_id).get('message')
4806
 
                if message is None:
4807
 
                    message = '<no message>'
4808
 
                self.outf.write('%3d: %s\n' % (shelf_id, message))
4809
 
            return 1
4810
 
        finally:
4811
 
            tree.unlock()
 
5908
        self.add_cleanup(tree.unlock)
 
5909
        manager = tree.get_shelf_manager()
 
5910
        shelves = manager.active_shelves()
 
5911
        if len(shelves) == 0:
 
5912
            note('No shelved changes.')
 
5913
            return 0
 
5914
        for shelf_id in reversed(shelves):
 
5915
            message = manager.get_metadata(shelf_id).get('message')
 
5916
            if message is None:
 
5917
                message = '<no message>'
 
5918
            self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5919
        return 1
4812
5920
 
4813
5921
 
4814
5922
class cmd_unshelve(Command):
4815
 
    """Restore shelved changes.
 
5923
    __doc__ = """Restore shelved changes.
4816
5924
 
4817
5925
    By default, the most recently shelved changes are restored. However if you
4818
 
    specify a patch by name those changes will be restored instead.  This
4819
 
    works best when the changes don't depend on each other.
 
5926
    specify a shelf by id those changes will be restored instead.  This works
 
5927
    best when the changes don't depend on each other.
4820
5928
    """
4821
5929
 
4822
5930
    takes_args = ['shelf_id?']
4826
5934
            enum_switch=False, value_switches=True,
4827
5935
            apply="Apply changes and remove from the shelf.",
4828
5936
            dry_run="Show changes, but do not apply or remove them.",
4829
 
            delete_only="Delete changes without applying them."
 
5937
            preview="Instead of unshelving the changes, show the diff that "
 
5938
                    "would result from unshelving.",
 
5939
            delete_only="Delete changes without applying them.",
 
5940
            keep="Apply changes but don't delete them.",
4830
5941
        )
4831
5942
    ]
4832
5943
    _see_also = ['shelve']
4833
5944
 
4834
5945
    def run(self, shelf_id=None, action='apply'):
4835
5946
        from bzrlib.shelf_ui import Unshelver
4836
 
        Unshelver.from_args(shelf_id, action).run()
4837
 
 
4838
 
 
4839
 
def _create_prefix(cur_transport):
4840
 
    needed = [cur_transport]
4841
 
    # Recurse upwards until we can create a directory successfully
4842
 
    while True:
4843
 
        new_transport = cur_transport.clone('..')
4844
 
        if new_transport.base == cur_transport.base:
4845
 
            raise errors.BzrCommandError(
4846
 
                "Failed to create path prefix for %s."
4847
 
                % cur_transport.base)
 
5947
        unshelver = Unshelver.from_args(shelf_id, action)
4848
5948
        try:
4849
 
            new_transport.mkdir('.')
4850
 
        except errors.NoSuchFile:
4851
 
            needed.append(new_transport)
4852
 
            cur_transport = new_transport
 
5949
            unshelver.run()
 
5950
        finally:
 
5951
            unshelver.tree.unlock()
 
5952
 
 
5953
 
 
5954
class cmd_clean_tree(Command):
 
5955
    __doc__ = """Remove unwanted files from working tree.
 
5956
 
 
5957
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
5958
    files are never deleted.
 
5959
 
 
5960
    Another class is 'detritus', which includes files emitted by bzr during
 
5961
    normal operations and selftests.  (The value of these files decreases with
 
5962
    time.)
 
5963
 
 
5964
    If no options are specified, unknown files are deleted.  Otherwise, option
 
5965
    flags are respected, and may be combined.
 
5966
 
 
5967
    To check what clean-tree will do, use --dry-run.
 
5968
    """
 
5969
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5970
                     Option('detritus', help='Delete conflict files, merge'
 
5971
                            ' backups, and failed selftest dirs.'),
 
5972
                     Option('unknown',
 
5973
                            help='Delete files unknown to bzr (default).'),
 
5974
                     Option('dry-run', help='Show files to delete instead of'
 
5975
                            ' deleting them.'),
 
5976
                     Option('force', help='Do not prompt before deleting.')]
 
5977
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
5978
            force=False):
 
5979
        from bzrlib.clean_tree import clean_tree
 
5980
        if not (unknown or ignored or detritus):
 
5981
            unknown = True
 
5982
        if dry_run:
 
5983
            force = True
 
5984
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5985
                   dry_run=dry_run, no_prompt=force)
 
5986
 
 
5987
 
 
5988
class cmd_reference(Command):
 
5989
    __doc__ = """list, view and set branch locations for nested trees.
 
5990
 
 
5991
    If no arguments are provided, lists the branch locations for nested trees.
 
5992
    If one argument is provided, display the branch location for that tree.
 
5993
    If two arguments are provided, set the branch location for that tree.
 
5994
    """
 
5995
 
 
5996
    hidden = True
 
5997
 
 
5998
    takes_args = ['path?', 'location?']
 
5999
 
 
6000
    def run(self, path=None, location=None):
 
6001
        branchdir = '.'
 
6002
        if path is not None:
 
6003
            branchdir = path
 
6004
        tree, branch, relpath =(
 
6005
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
6006
        if path is not None:
 
6007
            path = relpath
 
6008
        if tree is None:
 
6009
            tree = branch.basis_tree()
 
6010
        if path is None:
 
6011
            info = branch._get_all_reference_info().iteritems()
 
6012
            self._display_reference_info(tree, branch, info)
4853
6013
        else:
4854
 
            break
4855
 
    # Now we only need to create child directories
4856
 
    while needed:
4857
 
        cur_transport = needed.pop()
4858
 
        cur_transport.ensure_base()
4859
 
 
4860
 
 
4861
 
# these get imported and then picked up by the scan for cmd_*
4862
 
# TODO: Some more consistent way to split command definitions across files;
4863
 
# we do need to load at least some information about them to know of 
4864
 
# aliases.  ideally we would avoid loading the implementation until the
4865
 
# details were needed.
4866
 
from bzrlib.cmd_version_info import cmd_version_info
4867
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4868
 
from bzrlib.bundle.commands import (
4869
 
    cmd_bundle_info,
4870
 
    )
4871
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
4872
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
4873
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6014
            file_id = tree.path2id(path)
 
6015
            if file_id is None:
 
6016
                raise errors.NotVersionedError(path)
 
6017
            if location is None:
 
6018
                info = [(file_id, branch.get_reference_info(file_id))]
 
6019
                self._display_reference_info(tree, branch, info)
 
6020
            else:
 
6021
                branch.set_reference_info(file_id, path, location)
 
6022
 
 
6023
    def _display_reference_info(self, tree, branch, info):
 
6024
        ref_list = []
 
6025
        for file_id, (path, location) in info:
 
6026
            try:
 
6027
                path = tree.id2path(file_id)
 
6028
            except errors.NoSuchId:
 
6029
                pass
 
6030
            ref_list.append((path, location))
 
6031
        for path, location in sorted(ref_list):
 
6032
            self.outf.write('%s %s\n' % (path, location))
 
6033
 
 
6034
 
 
6035
def _register_lazy_builtins():
 
6036
    # register lazy builtins from other modules; called at startup and should
 
6037
    # be only called once.
 
6038
    for (name, aliases, module_name) in [
 
6039
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6040
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6041
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6042
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6043
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6044
        ('cmd_sign_my_commits', [], 'bzrlib.sign_my_commits'),
 
6045
        ]:
 
6046
        builtin_command_registry.register_lazy(name, aliases, module_name)