← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2008-10-01 05:40:45 UTC
  • mfrom: (3753 +trunk)
  • mto: This revision was merged to the branch mainline in revision 3756.
  • Revision ID: andrew.bennetts@canonical.com-20081001054045-z50qc0d3p9qsc5im
Merge from bzr.dev; resolve osutils.py conflict by reverting my sha import hackery.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007, 2008 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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
29
29
from bzrlib import (
30
30
    bugtracker,
31
31
    bundle,
32
 
    btree_index,
33
32
    bzrdir,
34
 
    directory_service,
35
33
    delta,
36
34
    config,
37
35
    errors,
38
36
    globbing,
39
 
    hooks,
40
37
    log,
41
38
    merge as _mod_merge,
42
39
    merge_directive,
43
40
    osutils,
44
41
    reconfigure,
45
 
    rename_map,
46
42
    revision as _mod_revision,
47
 
    static_tuple,
48
43
    symbol_versioning,
49
 
    timestamp,
50
44
    transport,
 
45
    tree as _mod_tree,
51
46
    ui,
52
47
    urlutils,
53
 
    views,
54
48
    )
55
49
from bzrlib.branch import Branch
56
50
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
 
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
 
51
from bzrlib.revisionspec import RevisionSpec
59
52
from bzrlib.smtp_connection import SMTPConnection
60
53
from bzrlib.workingtree import WorkingTree
61
54
""")
62
55
 
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):
 
56
from bzrlib.commands import Command, display_command
 
57
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
58
from bzrlib.trace import mutter, note, warning, is_quiet
 
59
 
 
60
 
 
61
def tree_files(file_list, default_branch=u'.'):
80
62
    try:
81
 
        return internal_tree_files(file_list, default_branch, canonicalize,
82
 
            apply_view)
 
63
        return internal_tree_files(file_list, default_branch)
83
64
    except errors.FileInWrongBranch, e:
84
65
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
66
                                     (e.path, file_list[0]))
86
67
 
87
68
 
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
 
 
130
69
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
 
    """
140
70
    if branch is None:
141
71
        branch = tree.branch
142
72
    if revisions is None:
145
75
        else:
146
76
            rev_tree = branch.basis_tree()
147
77
    else:
148
 
        revision = _get_one_revision(command_name, revisions)
149
 
        rev_tree = revision.as_tree(branch)
 
78
        if len(revisions) != 1:
 
79
            raise errors.BzrCommandError(
 
80
                'bzr %s --revision takes exactly one revision identifier' % (
 
81
                    command_name,))
 
82
        rev_tree = revisions[0].as_tree(branch)
150
83
    return rev_tree
151
84
 
152
85
 
153
86
# XXX: Bad function name; should possibly also be a class method of
154
87
# WorkingTree rather than a function.
155
 
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
 
    apply_view=True):
 
88
def internal_tree_files(file_list, default_branch=u'.'):
157
89
    """Convert command-line paths to a WorkingTree and relative paths.
158
90
 
159
91
    This is typically used for command-line processors that take one or
161
93
 
162
94
    The filenames given are not required to exist.
163
95
 
164
 
    :param file_list: Filenames to convert.
 
96
    :param file_list: Filenames to convert.  
165
97
 
166
98
    :param default_branch: Fallback tree path to use if file_list is empty or
167
99
        None.
168
100
 
169
 
    :param apply_view: if True and a view is set, apply it or check that
170
 
        specified files are within it
171
 
 
172
101
    :return: workingtree, [relative_paths]
173
102
    """
174
103
    if file_list is None or len(file_list) == 0:
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
 
104
        return WorkingTree.open_containing(default_branch)[0], file_list
183
105
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
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):
 
106
    return tree, safe_relpath_files(tree, file_list)
 
107
 
 
108
 
 
109
def safe_relpath_files(tree, file_list):
189
110
    """Convert file_list into a list of relpaths in tree.
190
111
 
191
112
    :param tree: A tree to operate on.
192
113
    :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
195
114
    :return: A list of relative paths.
196
115
    :raises errors.PathNotChild: When a provided path is in a different tree
197
116
        than tree.
198
117
    """
199
118
    if file_list is None:
200
119
        return None
201
 
    if tree.supports_views() and apply_view:
202
 
        view_files = tree.views.lookup_view()
203
 
    else:
204
 
        view_files = []
205
120
    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
212
121
    for filename in file_list:
213
122
        try:
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)
 
123
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
218
124
        except errors.PathNotChild:
219
125
            raise errors.FileInWrongBranch(tree.branch, filename)
220
126
    return new_list
221
127
 
222
128
 
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
 
 
235
129
# TODO: Make sure no commands unconditionally use the working directory as a
236
130
# branch.  If a filename argument is used, the first of them should be used to
237
131
# specify the branch.  (Perhaps this can be factored out into some kind of
239
133
# opens the branch?)
240
134
 
241
135
class cmd_status(Command):
242
 
    __doc__ = """Display status summary.
 
136
    """Display status summary.
243
137
 
244
138
    This reports on versioned and unknown files, reporting them
245
139
    grouped by state.  Possible states are:
265
159
    unknown
266
160
        Not versioned and not matching an ignore pattern.
267
161
 
268
 
    Additionally for directories, symlinks and files with an executable
269
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
270
 
    or '*' respectively.
271
 
 
272
162
    To see ignored files use 'bzr ignored'.  For details on the
273
163
    changes to file texts, use 'bzr diff'.
274
 
 
 
164
    
275
165
    Note that --short or -S gives status flags for each item, similar
276
166
    to Subversion's status command. To get output similar to svn -q,
277
167
    use bzr status -SV.
281
171
    files or directories is reported.  If a directory is given, status
282
172
    is reported for everything inside that directory.
283
173
 
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
 
 
289
174
    If a revision argument is given, the status is calculated against
290
175
    that revision, or between two revisions if two are provided.
291
176
    """
292
 
 
 
177
    
293
178
    # TODO: --no-recurse, --recurse options
294
 
 
 
179
    
295
180
    takes_args = ['file*']
296
 
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
181
    takes_options = ['show-ids', 'revision', 'change',
297
182
                     Option('short', help='Use short status indicators.',
298
183
                            short_name='S'),
299
184
                     Option('versioned', help='Only show versioned files.',
305
190
 
306
191
    encoding_type = 'replace'
307
192
    _see_also = ['diff', 'revert', 'status-flags']
308
 
 
 
193
    
309
194
    @display_command
310
195
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
311
 
            versioned=False, no_pending=False, verbose=False):
 
196
            versioned=False, no_pending=False):
312
197
        from bzrlib.status import show_tree_status
313
198
 
314
199
        if revision and len(revision) > 2:
328
213
        show_tree_status(tree, show_ids=show_ids,
329
214
                         specific_files=relfile_list, revision=revision,
330
215
                         to_file=self.outf, short=short, versioned=versioned,
331
 
                         show_pending=(not no_pending), verbose=verbose)
 
216
                         show_pending=(not no_pending))
332
217
 
333
218
 
334
219
class cmd_cat_revision(Command):
335
 
    __doc__ = """Write out metadata for a revision.
336
 
 
 
220
    """Write out metadata for a revision.
 
221
    
337
222
    The revision to print can either be specified by a specific
338
223
    revision identifier, or you can use --revision.
339
224
    """
343
228
    takes_options = ['revision']
344
229
    # cat-revision is more for frontends so should be exact
345
230
    encoding = 'strict'
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
 
 
 
231
    
355
232
    @display_command
356
233
    def run(self, revision_id=None, revision=None):
357
234
        if revision_id is not None and revision is not None:
362
239
                                         ' --revision or a revision_id')
363
240
        b = WorkingTree.open_containing(u'.')[0].branch
364
241
 
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')
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
 
        
391
 
 
392
 
class cmd_dump_btree(Command):
393
 
    __doc__ = """Dump the contents of a btree index file to stdout.
394
 
 
395
 
    PATH is a btree index file, it can be any URL. This includes things like
396
 
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
397
 
 
398
 
    By default, the tuples stored in the index file will be displayed. With
399
 
    --raw, we will uncompress the pages, but otherwise display the raw bytes
400
 
    stored in the index.
401
 
    """
402
 
 
403
 
    # TODO: Do we want to dump the internal nodes as well?
404
 
    # TODO: It would be nice to be able to dump the un-parsed information,
405
 
    #       rather than only going through iter_all_entries. However, this is
406
 
    #       good enough for a start
407
 
    hidden = True
408
 
    encoding_type = 'exact'
409
 
    takes_args = ['path']
410
 
    takes_options = [Option('raw', help='Write the uncompressed bytes out,'
411
 
                                        ' rather than the parsed tuples.'),
412
 
                    ]
413
 
 
414
 
    def run(self, path, raw=False):
415
 
        dirname, basename = osutils.split(path)
416
 
        t = transport.get_transport(dirname)
417
 
        if raw:
418
 
            self._dump_raw_bytes(t, basename)
419
 
        else:
420
 
            self._dump_entries(t, basename)
421
 
 
422
 
    def _get_index_and_bytes(self, trans, basename):
423
 
        """Create a BTreeGraphIndex and raw bytes."""
424
 
        bt = btree_index.BTreeGraphIndex(trans, basename, None)
425
 
        bytes = trans.get_bytes(basename)
426
 
        bt._file = cStringIO.StringIO(bytes)
427
 
        bt._size = len(bytes)
428
 
        return bt, bytes
429
 
 
430
 
    def _dump_raw_bytes(self, trans, basename):
431
 
        import zlib
432
 
 
433
 
        # We need to parse at least the root node.
434
 
        # This is because the first page of every row starts with an
435
 
        # uncompressed header.
436
 
        bt, bytes = self._get_index_and_bytes(trans, basename)
437
 
        for page_idx, page_start in enumerate(xrange(0, len(bytes),
438
 
                                                     btree_index._PAGE_SIZE)):
439
 
            page_end = min(page_start + btree_index._PAGE_SIZE, len(bytes))
440
 
            page_bytes = bytes[page_start:page_end]
441
 
            if page_idx == 0:
442
 
                self.outf.write('Root node:\n')
443
 
                header_end, data = bt._parse_header_from_bytes(page_bytes)
444
 
                self.outf.write(page_bytes[:header_end])
445
 
                page_bytes = data
446
 
            self.outf.write('\nPage %d\n' % (page_idx,))
447
 
            decomp_bytes = zlib.decompress(page_bytes)
448
 
            self.outf.write(decomp_bytes)
449
 
            self.outf.write('\n')
450
 
 
451
 
    def _dump_entries(self, trans, basename):
452
 
        try:
453
 
            st = trans.stat(basename)
454
 
        except errors.TransportNotPossible:
455
 
            # We can't stat, so we'll fake it because we have to do the 'get()'
456
 
            # anyway.
457
 
            bt, _ = self._get_index_and_bytes(trans, basename)
458
 
        else:
459
 
            bt = btree_index.BTreeGraphIndex(trans, basename, st.st_size)
460
 
        for node in bt.iter_all_entries():
461
 
            # Node is made up of:
462
 
            # (index, key, value, [references])
 
242
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
243
        if revision_id is not None:
 
244
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
463
245
            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,))
471
 
 
 
246
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
247
            except errors.NoSuchRevision:
 
248
                msg = "The repository %s contains no revision %s." % (b.repository.base,
 
249
                    revision_id)
 
250
                raise errors.BzrCommandError(msg)
 
251
        elif revision is not None:
 
252
            for rev in revision:
 
253
                if rev is None:
 
254
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
255
                                                 ' revision.')
 
256
                rev_id = rev.as_revision_id(b)
 
257
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
258
    
472
259
 
473
260
class cmd_remove_tree(Command):
474
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
261
    """Remove the working tree from a given branch/checkout.
475
262
 
476
263
    Since a lightweight checkout is little more than a working tree
477
264
    this will refuse to run against one.
479
266
    To re-create the working tree, use "bzr checkout".
480
267
    """
481
268
    _see_also = ['checkout', 'working-trees']
482
 
    takes_args = ['location*']
 
269
    takes_args = ['location?']
483
270
    takes_options = [
484
271
        Option('force',
485
272
               help='Remove the working tree even if it has '
486
273
                    'uncommitted changes.'),
487
274
        ]
488
275
 
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
 
 
 
276
    def run(self, location='.', force=False):
 
277
        d = bzrdir.BzrDir.open(location)
 
278
        
 
279
        try:
 
280
            working = d.open_workingtree()
 
281
        except errors.NoWorkingTree:
 
282
            raise errors.BzrCommandError("No working tree to remove")
 
283
        except errors.NotLocalUrl:
 
284
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
285
                                         "remote path")
 
286
        if not force:
 
287
            changes = working.changes_from(working.basis_tree())
 
288
            if changes.has_changed():
 
289
                raise errors.UncommittedChanges(working)
 
290
 
 
291
        working_path = working.bzrdir.root_transport.base
 
292
        branch_path = working.branch.bzrdir.root_transport.base
 
293
        if working_path != branch_path:
 
294
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
295
                                         "a lightweight checkout")
 
296
        
 
297
        d.destroy_workingtree()
 
298
        
513
299
 
514
300
class cmd_revno(Command):
515
 
    __doc__ = """Show current revision number.
 
301
    """Show current revision number.
516
302
 
517
303
    This is equal to the number of revisions on this branch.
518
304
    """
519
305
 
520
306
    _see_also = ['info']
521
307
    takes_args = ['location?']
522
 
    takes_options = [
523
 
        Option('tree', help='Show revno of working tree'),
524
 
        ]
525
308
 
526
309
    @display_command
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')
 
310
    def run(self, location=u'.'):
 
311
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
312
        self.outf.write('\n')
548
313
 
549
314
 
550
315
class cmd_revision_info(Command):
551
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
316
    """Show revision number and revision id for a given revision identifier.
552
317
    """
553
318
    hidden = True
554
319
    takes_args = ['revision_info*']
555
 
    takes_options = [
556
 
        'revision',
557
 
        Option('directory',
558
 
            help='Branch to examine, '
559
 
                 'rather than the one containing the working directory.',
560
 
            short_name='d',
561
 
            type=unicode,
562
 
            ),
563
 
        Option('tree', help='Show revno of working tree'),
564
 
        ]
 
320
    takes_options = ['revision']
565
321
 
566
322
    @display_command
567
 
    def run(self, revision=None, directory=u'.', tree=False,
568
 
            revision_info_list=[]):
 
323
    def run(self, revision=None, revision_info_list=[]):
569
324
 
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 = []
 
325
        revs = []
581
326
        if revision is not None:
582
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
327
            revs.extend(revision)
583
328
        if revision_info_list is not None:
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:
 
329
            for rev in revision_info_list:
 
330
                revs.append(RevisionSpec.from_string(rev))
 
331
 
 
332
        b = Branch.open_containing(u'.')[0]
 
333
 
 
334
        if len(revs) == 0:
 
335
            revs.append(RevisionSpec.from_string('-1'))
 
336
 
 
337
        for rev in revs:
 
338
            revision_id = rev.as_revision_id(b)
599
339
            try:
600
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
601
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
340
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
602
341
            except errors.NoSuchRevision:
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
 
 
 
342
                dotted_map = b.get_revision_id_to_revno_map()
 
343
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
344
            print '%s %s' % (revno, revision_id)
 
345
 
 
346
    
612
347
class cmd_add(Command):
613
 
    __doc__ = """Add specified files or directories.
 
348
    """Add specified files or directories.
614
349
 
615
350
    In non-recursive mode, all the named items are added, regardless
616
351
    of whether they were previously ignored.  A warning is given if
632
367
    you should never need to explicitly add a directory, they'll just
633
368
    get added when you add a file in the directory.
634
369
 
635
 
    --dry-run will show which files would be added, but not actually
 
370
    --dry-run will show which files would be added, but not actually 
636
371
    add them.
637
372
 
638
373
    --file-ids-from will try to use the file ids from the supplied path.
642
377
    branches that will be merged later (without showing the two different
643
378
    adds as a conflict). It is also useful when merging another project
644
379
    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.
648
380
    """
649
381
    takes_args = ['file*']
650
382
    takes_options = [
658
390
               help='Lookup file ids from this tree.'),
659
391
        ]
660
392
    encoding_type = 'replace'
661
 
    _see_also = ['remove', 'ignore']
 
393
    _see_also = ['remove']
662
394
 
663
395
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
664
396
            file_ids_from=None):
682
414
 
683
415
        if base_tree:
684
416
            base_tree.lock_read()
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()
 
417
        try:
 
418
            file_list = self._maybe_expand_globs(file_list)
 
419
            if file_list:
 
420
                tree = WorkingTree.open_containing(file_list[0])[0]
 
421
            else:
 
422
                tree = WorkingTree.open_containing(u'.')[0]
 
423
            added, ignored = tree.smart_add(file_list, not
 
424
                no_recurse, action=action, save=not dry_run)
 
425
        finally:
 
426
            if base_tree is not None:
 
427
                base_tree.unlock()
690
428
        if len(ignored) > 0:
691
429
            if verbose:
692
430
                for glob in sorted(ignored.keys()):
693
431
                    for path in ignored[glob]:
694
 
                        self.outf.write("ignored %s matching \"%s\"\n"
 
432
                        self.outf.write("ignored %s matching \"%s\"\n" 
695
433
                                        % (path, glob))
 
434
            else:
 
435
                match_len = 0
 
436
                for glob, paths in ignored.items():
 
437
                    match_len += len(paths)
 
438
                self.outf.write("ignored %d file(s).\n" % match_len)
 
439
            self.outf.write("If you wish to add some of these files,"
 
440
                            " please add them by name.\n")
696
441
 
697
442
 
698
443
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
444
    """Create a new versioned directory.
700
445
 
701
446
    This is equivalent to creating the directory and then adding it.
702
447
    """
706
451
 
707
452
    def run(self, dir_list):
708
453
        for d in dir_list:
 
454
            os.mkdir(d)
709
455
            wt, dd = WorkingTree.open_containing(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)
 
456
            wt.add([dd])
 
457
            self.outf.write('added %s\n' % d)
718
458
 
719
459
 
720
460
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
461
    """Show path of a file relative to root"""
722
462
 
723
463
    takes_args = ['filename']
724
464
    hidden = True
725
 
 
 
465
    
726
466
    @display_command
727
467
    def run(self, filename):
728
468
        # TODO: jam 20050106 Can relpath return a munged path if
733
473
 
734
474
 
735
475
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
476
    """Show inventory of the current working copy or a revision.
737
477
 
738
478
    It is possible to limit the output to a particular entry
739
479
    type using the --kind option.  For example: --kind file.
758
498
        if kind and kind not in ['file', 'directory', 'symlink']:
759
499
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
500
 
761
 
        revision = _get_one_revision('inventory', revision)
762
501
        work_tree, file_list = tree_files(file_list)
763
502
        work_tree.lock_read()
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()
 
503
        try:
 
504
            if revision is not None:
 
505
                if len(revision) > 1:
 
506
                    raise errors.BzrCommandError(
 
507
                        'bzr inventory --revision takes exactly one revision'
 
508
                        ' identifier')
 
509
                tree = revision[0].as_tree(work_tree.branch)
 
510
 
 
511
                extra_trees = [work_tree]
 
512
                tree.lock_read()
 
513
            else:
 
514
                tree = work_tree
 
515
                extra_trees = []
 
516
 
 
517
            if file_list is not None:
 
518
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
519
                                          require_versioned=True)
 
520
                # find_ids_across_trees may include some paths that don't
 
521
                # exist in 'tree'.
 
522
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
523
                                 for file_id in file_ids if file_id in tree)
 
524
            else:
 
525
                entries = tree.inventory.entries()
 
526
        finally:
 
527
            tree.unlock()
 
528
            if tree is not work_tree:
 
529
                work_tree.unlock()
 
530
 
786
531
        for path, entry in entries:
787
532
            if kind and kind != entry.kind:
788
533
                continue
794
539
 
795
540
 
796
541
class cmd_mv(Command):
797
 
    __doc__ = """Move or rename a file.
 
542
    """Move or rename a file.
798
543
 
799
544
    :Usage:
800
545
        bzr mv OLDNAME NEWNAME
817
562
    takes_args = ['names*']
818
563
    takes_options = [Option("after", help="Move only the bzr identifier"
819
564
        " 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.'),
822
565
        ]
823
566
    aliases = ['move', 'rename']
824
567
    encoding_type = 'replace'
825
568
 
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.')
 
569
    def run(self, names_list, after=False):
831
570
        if names_list is None:
832
571
            names_list = []
 
572
 
833
573
        if len(names_list) < 2:
834
574
            raise errors.BzrCommandError("missing file argument")
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)
 
575
        tree, rel_names = tree_files(names_list)
 
576
        tree.lock_write()
 
577
        try:
 
578
            self._run(tree, names_list, rel_names, after)
 
579
        finally:
 
580
            tree.unlock()
851
581
 
852
582
    def _run(self, tree, names_list, rel_names, after):
853
583
        into_existing = osutils.isdir(names_list[-1])
862
592
                into_existing = False
863
593
            else:
864
594
                inv = tree.inventory
865
 
                # 'fix' the case of a potential 'from'
866
 
                from_id = tree.path2id(
867
 
                            tree.get_canonical_inventory_path(rel_names[0]))
 
595
                from_id = tree.path2id(rel_names[0])
868
596
                if (not osutils.lexists(names_list[0]) and
869
597
                    from_id and inv.get_file_kind(from_id) == "directory"):
870
598
                    into_existing = False
871
599
        # move/rename
872
600
        if into_existing:
873
601
            # move into existing directory
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))
 
602
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
603
                self.outf.write("%s => %s\n" % pair)
880
604
        else:
881
605
            if len(names_list) != 2:
882
606
                raise errors.BzrCommandError('to mv multiple files the'
883
607
                                             ' destination must be a versioned'
884
608
                                             ' directory')
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))
 
609
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
610
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
931
611
 
932
612
 
933
613
class cmd_pull(Command):
934
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
614
    """Turn this branch into a mirror of another branch.
935
615
 
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.
 
616
    This command only works on branches that have not diverged.  Branches are
 
617
    considered diverged if the destination branch's most recent commit is one
 
618
    that has not been merged (directly or indirectly) into the parent.
940
619
 
941
620
    If branches have diverged, you can use 'bzr merge' to integrate the changes
942
621
    from one into the other.  Once one branch has merged, the other should
943
622
    be able to pull it again.
944
623
 
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.
 
624
    If you want to forget your local changes and just update your branch to
 
625
    match the remote one, use pull --overwrite.
948
626
 
949
627
    If there is no default location set, the first pull will set it.  After
950
628
    that, you can omit the location to use the default.  To change the
956
634
    with bzr send.
957
635
    """
958
636
 
959
 
    _see_also = ['push', 'update', 'status-flags', 'send']
 
637
    _see_also = ['push', 'update', 'status-flags']
960
638
    takes_options = ['remember', 'overwrite', 'revision',
961
639
        custom_help('verbose',
962
640
            help='Show logs of pulled revisions.'),
966
644
            short_name='d',
967
645
            type=unicode,
968
646
            ),
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
 
            ),
974
647
        ]
975
648
    takes_args = ['location?']
976
649
    encoding_type = 'replace'
977
650
 
978
651
    def run(self, location=None, remember=False, overwrite=False,
979
652
            revision=None, verbose=False,
980
 
            directory=None, local=False):
 
653
            directory=None):
981
654
        # FIXME: too much stuff is in the command class
982
655
        revision_id = None
983
656
        mergeable = None
986
659
        try:
987
660
            tree_to = WorkingTree.open_containing(directory)[0]
988
661
            branch_to = tree_to.branch
989
 
            tree_to.lock_write()
990
 
            self.add_cleanup(tree_to.unlock)
991
662
        except errors.NoWorkingTree:
992
663
            tree_to = None
993
664
            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()
999
665
 
1000
666
        possible_transports = []
1001
667
        if location is not None:
1017
683
                    self.outf.write("Using saved parent location: %s\n" % display_url)
1018
684
                location = stored_loc
1019
685
 
1020
 
        revision = _get_one_revision('pull', revision)
1021
686
        if mergeable is not None:
1022
687
            if revision is not None:
1023
688
                raise errors.BzrCommandError(
1029
694
        else:
1030
695
            branch_from = Branch.open(location,
1031
696
                possible_transports=possible_transports)
1032
 
            branch_from.lock_read()
1033
 
            self.add_cleanup(branch_from.unlock)
1034
697
 
1035
698
            if branch_to.get_parent() is None or remember:
1036
699
                branch_to.set_parent(branch_from.base)
1037
700
 
1038
701
        if revision is not None:
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)
 
702
            if len(revision) == 1:
 
703
                revision_id = revision[0].as_revision_id(branch_from)
 
704
            else:
 
705
                raise errors.BzrCommandError(
 
706
                    'bzr pull --revision takes one value.')
 
707
 
 
708
        branch_to.lock_write()
 
709
        try:
 
710
            if tree_to is not None:
 
711
                change_reporter = delta._ChangeReporter(
 
712
                    unversioned_filter=tree_to.is_ignored)
 
713
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
714
                                      change_reporter,
 
715
                                      possible_transports=possible_transports)
 
716
            else:
 
717
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
718
 
 
719
            result.report(self.outf)
 
720
            if verbose and result.old_revid != result.new_revid:
 
721
                old_rh = list(
 
722
                    branch_to.repository.iter_reverse_revision_history(
 
723
                    result.old_revid))
 
724
                old_rh.reverse()
 
725
                new_rh = branch_to.revision_history()
 
726
                log.show_changed_revisions(branch_to, old_rh, new_rh,
 
727
                                           to_file=self.outf)
 
728
        finally:
 
729
            branch_to.unlock()
1058
730
 
1059
731
 
1060
732
class cmd_push(Command):
1061
 
    __doc__ = """Update a mirror of this branch.
1062
 
 
 
733
    """Update a mirror of this branch.
 
734
    
1063
735
    The target branch will not have its working tree populated because this
1064
736
    is both expensive, and is not supported on remote file systems.
1065
 
 
 
737
    
1066
738
    Some smart servers or protocols *may* put the working tree in place in
1067
739
    the future.
1068
740
 
1072
744
 
1073
745
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1074
746
    the other branch completely, discarding its unmerged changes.
1075
 
 
 
747
    
1076
748
    If you want to ensure you have the different changes in the other branch,
1077
749
    do a merge (see bzr help merge) from the other branch, and commit that.
1078
750
    After that you will be able to do a push without '--overwrite'.
1107
779
                'for the commit history. Only the work not present in the '
1108
780
                'referenced branch is included in the branch created.',
1109
781
            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.'),
1113
782
        ]
1114
783
    takes_args = ['location?']
1115
784
    encoding_type = 'replace'
1117
786
    def run(self, location=None, remember=False, overwrite=False,
1118
787
        create_prefix=False, verbose=False, revision=None,
1119
788
        use_existing_dir=False, directory=None, stacked_on=None,
1120
 
        stacked=False, strict=None):
 
789
        stacked=False):
1121
790
        from bzrlib.push import _show_push_branch
1122
791
 
 
792
        # Get the source branch and revision_id
1123
793
        if directory is None:
1124
794
            directory = '.'
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)
 
795
        br_from = Branch.open_containing(directory)[0]
1130
796
        if revision is not None:
1131
 
            revision_id = revision.in_history(br_from).rev_id
 
797
            if len(revision) == 1:
 
798
                revision_id = revision[0].in_history(br_from).rev_id
 
799
            else:
 
800
                raise errors.BzrCommandError(
 
801
                    'bzr push --revision takes one value.')
1132
802
        else:
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.')
 
803
            revision_id = br_from.last_revision()
 
804
 
1139
805
        # Get the stacked_on branch, if any
1140
806
        if stacked_on is not None:
1141
807
            stacked_on = urlutils.normalize_url(stacked_on)
1173
839
 
1174
840
 
1175
841
class cmd_branch(Command):
1176
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
842
    """Create a new copy of a branch.
1177
843
 
1178
844
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1179
845
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1190
856
    takes_args = ['from_location', 'to_location?']
1191
857
    takes_options = ['revision', Option('hardlink',
1192
858
        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."),
1198
859
        Option('stacked',
1199
860
            help='Create a stacked branch referring to the source branch. '
1200
861
                'The new branch will depend on the availability of the source '
1201
862
                'branch for all operations.'),
1202
863
        Option('standalone',
1203
864
               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."),
1211
865
        ]
1212
866
    aliases = ['get', 'clone']
1213
867
 
1214
868
    def run(self, from_location, to_location=None, revision=None,
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
 
869
            hardlink=False, stacked=False, standalone=False):
1218
870
        from bzrlib.tag import _merge_tags_if_possible
 
871
        if revision is None:
 
872
            revision = [None]
 
873
        elif len(revision) > 1:
 
874
            raise errors.BzrCommandError(
 
875
                'bzr branch --revision takes exactly 1 revision value')
 
876
 
1219
877
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1220
878
            from_location)
1221
 
        revision = _get_one_revision('branch', revision)
1222
879
        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)
1234
880
        try:
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)
 
881
            if len(revision) == 1 and revision[0] is not None:
 
882
                revision_id = revision[0].as_revision_id(br_from)
1240
883
            else:
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'))
 
884
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
885
                # None or perhaps NULL_REVISION to mean copy nothing
 
886
                # RBC 20060209
 
887
                revision_id = br_from.last_revision()
 
888
            if to_location is None:
 
889
                to_location = urlutils.derive_to_location(from_location)
 
890
            to_transport = transport.get_transport(to_location)
 
891
            try:
 
892
                to_transport.mkdir('.')
 
893
            except errors.FileExists:
 
894
                raise errors.BzrCommandError('Target directory "%s" already'
 
895
                                             ' exists.' % to_location)
 
896
            except errors.NoSuchFile:
 
897
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
898
                                             % to_location)
 
899
            try:
 
900
                # preserve whatever source format we have.
 
901
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
902
                                            possible_transports=[to_transport],
 
903
                                            accelerator_tree=accelerator_tree,
 
904
                                            hardlink=hardlink, stacked=stacked,
 
905
                                            force_new_repo=standalone)
 
906
                branch = dir.open_branch()
 
907
            except errors.NoSuchRevision:
 
908
                to_transport.delete_tree('.')
 
909
                msg = "The branch %s has no revision %s." % (from_location,
 
910
                    revision[0])
 
911
                raise errors.BzrCommandError(msg)
 
912
            _merge_tags_if_possible(br_from, branch)
 
913
            # If the source branch is stacked, the new branch may
 
914
            # be stacked whether we asked for that explicitly or not.
 
915
            # We therefore need a try/except here and not just 'if stacked:'
 
916
            try:
 
917
                note('Created new stacked branch referring to %s.' %
 
918
                    branch.get_stacked_on_url())
 
919
            except (errors.NotStacked, errors.UnstackableBranchFormat,
 
920
                errors.UnstackableRepositoryFormat), e:
 
921
                note('Branched %d revision(s).' % branch.revno())
 
922
        finally:
 
923
            br_from.unlock()
1286
924
 
1287
925
 
1288
926
class cmd_checkout(Command):
1289
 
    __doc__ = """Create a new checkout of an existing branch.
 
927
    """Create a new checkout of an existing branch.
1290
928
 
1291
929
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1292
930
    the branch found in '.'. This is useful if you have removed the working tree
1293
931
    or if it was never created - i.e. if you pushed the branch to its current
1294
932
    location using SFTP.
1295
 
 
 
933
    
1296
934
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1297
935
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1298
936
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1326
964
 
1327
965
    def run(self, branch_location=None, to_location=None, revision=None,
1328
966
            lightweight=False, files_from=None, hardlink=False):
 
967
        if revision is None:
 
968
            revision = [None]
 
969
        elif len(revision) > 1:
 
970
            raise errors.BzrCommandError(
 
971
                'bzr checkout --revision takes exactly 1 revision value')
1329
972
        if branch_location is None:
1330
973
            branch_location = osutils.getcwd()
1331
974
            to_location = branch_location
1332
975
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1333
976
            branch_location)
1334
 
        revision = _get_one_revision('checkout', revision)
1335
977
        if files_from is not None:
1336
978
            accelerator_tree = WorkingTree.open(files_from)
1337
 
        if revision is not None:
1338
 
            revision_id = revision.as_revision_id(source)
 
979
        if len(revision) == 1 and revision[0] is not None:
 
980
            revision_id = revision[0].as_revision_id(source)
1339
981
        else:
1340
982
            revision_id = None
1341
983
        if to_location is None:
1342
984
            to_location = urlutils.derive_to_location(branch_location)
1343
 
        # if the source and to_location are the same,
 
985
        # if the source and to_location are the same, 
1344
986
        # and there is no working tree,
1345
987
        # then reconstitute a branch
1346
988
        if (osutils.abspath(to_location) ==
1355
997
 
1356
998
 
1357
999
class cmd_renames(Command):
1358
 
    __doc__ = """Show list of renamed files.
 
1000
    """Show list of renamed files.
1359
1001
    """
1360
1002
    # TODO: Option to show renames between two historical versions.
1361
1003
 
1367
1009
    def run(self, dir=u'.'):
1368
1010
        tree = WorkingTree.open_containing(dir)[0]
1369
1011
        tree.lock_read()
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))
 
1012
        try:
 
1013
            new_inv = tree.inventory
 
1014
            old_tree = tree.basis_tree()
 
1015
            old_tree.lock_read()
 
1016
            try:
 
1017
                old_inv = old_tree.inventory
 
1018
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
1019
                renames.sort()
 
1020
                for old_name, new_name in renames:
 
1021
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1022
            finally:
 
1023
                old_tree.unlock()
 
1024
        finally:
 
1025
            tree.unlock()
1387
1026
 
1388
1027
 
1389
1028
class cmd_update(Command):
1390
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
1391
 
 
 
1029
    """Update a tree to have the latest code committed to its branch.
 
1030
    
1392
1031
    This will perform a merge into the working tree, and may generate
1393
 
    conflicts. If you have any local changes, you will still
 
1032
    conflicts. If you have any local changes, you will still 
1394
1033
    need to commit them after the update for the update to be complete.
1395
 
 
1396
 
    If you want to discard your local changes, you can just do a
 
1034
    
 
1035
    If you want to discard your local changes, you can just do a 
1397
1036
    '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.
1401
1037
    """
1402
1038
 
1403
1039
    _see_also = ['pull', 'working-trees', 'status-flags']
1404
1040
    takes_args = ['dir?']
1405
 
    takes_options = ['revision']
1406
1041
    aliases = ['up']
1407
1042
 
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")
 
1043
    def run(self, dir='.'):
1412
1044
        tree = WorkingTree.open_containing(dir)[0]
1413
 
        branch = tree.branch
1414
1045
        possible_transports = []
1415
 
        master = branch.get_master_branch(
 
1046
        master = tree.branch.get_master_branch(
1416
1047
            possible_transports=possible_transports)
1417
1048
        if master is not None:
1418
1049
            tree.lock_write()
1419
 
            branch_location = master.base
1420
1050
        else:
1421
1051
            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)
1449
1052
        try:
 
1053
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1054
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1055
            if last_rev == _mod_revision.ensure_null(
 
1056
                tree.branch.last_revision()):
 
1057
                # may be up to date, check master too.
 
1058
                if master is None or last_rev == _mod_revision.ensure_null(
 
1059
                    master.last_revision()):
 
1060
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1061
                    note("Tree is up to date at revision %d." % (revno,))
 
1062
                    return 0
1450
1063
            conflicts = tree.update(
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
 
1064
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1065
                possible_transports=possible_transports)
 
1066
            revno = tree.branch.revision_id_to_revno(
 
1067
                _mod_revision.ensure_null(tree.last_revision()))
 
1068
            note('Updated to revision %d.' % (revno,))
 
1069
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1070
                note('Your local commits will now show as pending merges with '
 
1071
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1072
            if conflicts != 0:
 
1073
                return 1
 
1074
            else:
 
1075
                return 0
 
1076
        finally:
 
1077
            tree.unlock()
1473
1078
 
1474
1079
 
1475
1080
class cmd_info(Command):
1476
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1081
    """Show information about a working tree, branch or repository.
1477
1082
 
1478
1083
    This command will show all known locations and formats associated to the
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.
 
1084
    tree, branch or repository.  Statistical information is included with
 
1085
    each report.
1484
1086
 
1485
1087
    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
1502
1088
    """
1503
1089
    _see_also = ['revno', 'working-trees', 'repositories']
1504
1090
    takes_args = ['location?']
1508
1094
    @display_command
1509
1095
    def run(self, location=None, verbose=False):
1510
1096
        if verbose:
1511
 
            noise_level = get_verbosity_level()
 
1097
            noise_level = 2
1512
1098
        else:
1513
1099
            noise_level = 0
1514
1100
        from bzrlib.info import show_bzrdir_info
1517
1103
 
1518
1104
 
1519
1105
class cmd_remove(Command):
1520
 
    __doc__ = """Remove files or directories.
 
1106
    """Remove files or directories.
1521
1107
 
1522
1108
    This makes bzr stop tracking changes to the specified files. bzr will delete
1523
1109
    them if they can easily be recovered using revert. If no options or
1532
1118
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1533
1119
            safe='Only delete files if they can be'
1534
1120
                 ' safely recovered (default).',
1535
 
            keep='Delete from bzr but leave the working copy.',
 
1121
            keep="Don't delete any files.",
1536
1122
            force='Delete all the specified files, even if they can not be '
1537
1123
                'recovered and even if they are non-empty directories.')]
1538
1124
    aliases = ['rm', 'del']
1546
1132
            file_list = [f for f in file_list]
1547
1133
 
1548
1134
        tree.lock_write()
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')
 
1135
        try:
 
1136
            # Heuristics should probably all move into tree.remove_smart or
 
1137
            # some such?
 
1138
            if new:
 
1139
                added = tree.changes_from(tree.basis_tree(),
 
1140
                    specific_files=file_list).added
 
1141
                file_list = sorted([f[0] for f in added], reverse=True)
 
1142
                if len(file_list) == 0:
 
1143
                    raise errors.BzrCommandError('No matching files.')
 
1144
            elif file_list is None:
 
1145
                # missing files show up in iter_changes(basis) as
 
1146
                # versioned-with-no-kind.
 
1147
                missing = []
 
1148
                for change in tree.iter_changes(tree.basis_tree()):
 
1149
                    # Find paths in the working tree that have no kind:
 
1150
                    if change[1][1] is not None and change[6][1] is None:
 
1151
                        missing.append(change[1][1])
 
1152
                file_list = sorted(missing, reverse=True)
 
1153
                file_deletion_strategy = 'keep'
 
1154
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1155
                keep_files=file_deletion_strategy=='keep',
 
1156
                force=file_deletion_strategy=='force')
 
1157
        finally:
 
1158
            tree.unlock()
1571
1159
 
1572
1160
 
1573
1161
class cmd_file_id(Command):
1574
 
    __doc__ = """Print file_id of a particular file or directory.
 
1162
    """Print file_id of a particular file or directory.
1575
1163
 
1576
1164
    The file_id is assigned when the file is first added and remains the
1577
1165
    same through all revisions where the file exists, even when it is
1593
1181
 
1594
1182
 
1595
1183
class cmd_file_path(Command):
1596
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1184
    """Print path of file_ids to a file or directory.
1597
1185
 
1598
1186
    This prints one line for each directory down to the target,
1599
1187
    starting at the branch root.
1615
1203
 
1616
1204
 
1617
1205
class cmd_reconcile(Command):
1618
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1206
    """Reconcile bzr metadata in a branch.
1619
1207
 
1620
1208
    This can correct data mismatches that may have been caused by
1621
1209
    previous ghost operations or bzr upgrades. You should only
1622
 
    need to run this command if 'bzr check' or a bzr developer
 
1210
    need to run this command if 'bzr check' or a bzr developer 
1623
1211
    advises you to run it.
1624
1212
 
1625
1213
    If a second branch is provided, cross-branch reconciliation is
1627
1215
    id which was not present in very early bzr versions is represented
1628
1216
    correctly in both branches.
1629
1217
 
1630
 
    At the same time it is run it may recompress data resulting in
 
1218
    At the same time it is run it may recompress data resulting in 
1631
1219
    a potential saving in disk space or performance gain.
1632
1220
 
1633
1221
    The branch *MUST* be on a listable system such as local disk or sftp.
1643
1231
 
1644
1232
 
1645
1233
class cmd_revision_history(Command):
1646
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1234
    """Display the list of revision ids on a branch."""
1647
1235
 
1648
1236
    _see_also = ['log']
1649
1237
    takes_args = ['location?']
1659
1247
 
1660
1248
 
1661
1249
class cmd_ancestry(Command):
1662
 
    __doc__ = """List all revisions merged into this branch."""
 
1250
    """List all revisions merged into this branch."""
1663
1251
 
1664
1252
    _see_also = ['log', 'revision-history']
1665
1253
    takes_args = ['location?']
1684
1272
 
1685
1273
 
1686
1274
class cmd_init(Command):
1687
 
    __doc__ = """Make a directory into a versioned branch.
 
1275
    """Make a directory into a versioned branch.
1688
1276
 
1689
1277
    Use this to create an empty branch, or before importing an
1690
1278
    existing project.
1691
1279
 
1692
 
    If there is a repository in a parent directory of the location, then
 
1280
    If there is a repository in a parent directory of the location, then 
1693
1281
    the history of the branch will be stored in the repository.  Otherwise
1694
1282
    init creates a standalone branch which carries its own history
1695
1283
    in the .bzr directory.
1718
1306
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1719
1307
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1720
1308
                value_switches=True,
1721
 
                title="Branch format",
 
1309
                title="Branch Format",
1722
1310
                ),
1723
1311
         Option('append-revisions-only',
1724
1312
                help='Never change revnos or the existing log.'
1747
1335
                    "\nYou may supply --create-prefix to create all"
1748
1336
                    " leading parent directories."
1749
1337
                    % location)
1750
 
            to_transport.create_prefix()
 
1338
            _create_prefix(to_transport)
1751
1339
 
1752
1340
        try:
1753
1341
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1771
1359
                branch.set_append_revisions_only(True)
1772
1360
            except errors.UpgradeRequired:
1773
1361
                raise errors.BzrCommandError('This branch format cannot be set'
1774
 
                    ' to append-revisions-only.  Try --default.')
 
1362
                    ' to append-revisions-only.  Try --experimental-branch6')
1775
1363
        if not is_quiet():
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)
 
1364
            from bzrlib.info import show_bzrdir_info
 
1365
            show_bzrdir_info(a_bzrdir, verbose=0, outfile=self.outf)
1793
1366
 
1794
1367
 
1795
1368
class cmd_init_repository(Command):
1796
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1369
    """Create a shared repository to hold branches.
1797
1370
 
1798
1371
    New branches created under the repository directory will store their
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.
 
1372
    revisions in the repository, not in the branch directory.
1802
1373
 
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.
 
1374
    If the --no-trees option is used then the branches in the repository
 
1375
    will not have working trees by default.
1809
1376
 
1810
1377
    :Examples:
1811
 
        Create a shared repository holding just branches::
 
1378
        Create a shared repositories holding just branches::
1812
1379
 
1813
1380
            bzr init-repo --no-trees repo
1814
1381
            bzr init repo/trunk
1853
1420
 
1854
1421
 
1855
1422
class cmd_diff(Command):
1856
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
1857
 
 
 
1423
    """Show differences in the working tree, between revisions or branches.
 
1424
    
1858
1425
    If no arguments are given, all changes for the current tree are listed.
1859
1426
    If files are given, only the changes in those files are listed.
1860
1427
    Remote and multiple branches can be compared by using the --old and
1880
1447
 
1881
1448
            bzr diff -r1
1882
1449
 
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
 
1450
        Difference between revision 2 and revision 1::
 
1451
 
 
1452
            bzr diff -r1..2
 
1453
 
 
1454
        Difference between revision 2 and revision 1 for branch xxx::
 
1455
 
 
1456
            bzr diff -r1..2 xxx
1904
1457
 
1905
1458
        Show just the differences for file NEWS::
1906
1459
 
1945
1498
            help='Use this command to compare files.',
1946
1499
            type=unicode,
1947
1500
            ),
1948
 
        RegistryOption('format',
1949
 
            help='Diff format to use.',
1950
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1951
 
            value_switches=False, title='Diff format'),
1952
1501
        ]
1953
1502
    aliases = ['di', 'dif']
1954
1503
    encoding_type = 'exact'
1955
1504
 
1956
1505
    @display_command
1957
1506
    def run(self, revision=None, file_list=None, diff_options=None,
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)
 
1507
            prefix=None, old=None, new=None, using=None):
 
1508
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1961
1509
 
1962
1510
        if (prefix is None) or (prefix == '0'):
1963
1511
            # diff -p0 format
1977
1525
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1978
1526
                                         ' one or two revision specifiers')
1979
1527
 
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,
 
1528
        old_tree, new_tree, specific_files, extra_trees = \
 
1529
                _get_trees_to_diff(file_list, revision, old, new)
 
1530
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
1989
1531
                               specific_files=specific_files,
1990
1532
                               external_diff_options=diff_options,
1991
1533
                               old_label=old_label, new_label=new_label,
1992
 
                               extra_trees=extra_trees, using=using,
1993
 
                               format_cls=format)
 
1534
                               extra_trees=extra_trees, using=using)
1994
1535
 
1995
1536
 
1996
1537
class cmd_deleted(Command):
1997
 
    __doc__ = """List files deleted in the working tree.
 
1538
    """List files deleted in the working tree.
1998
1539
    """
1999
1540
    # TODO: Show files deleted since a previous revision, or
2000
1541
    # between two revisions.
2009
1550
    def run(self, show_ids=False):
2010
1551
        tree = WorkingTree.open_containing(u'.')[0]
2011
1552
        tree.lock_read()
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')
 
1553
        try:
 
1554
            old = tree.basis_tree()
 
1555
            old.lock_read()
 
1556
            try:
 
1557
                for path, ie in old.inventory.iter_entries():
 
1558
                    if not tree.has_id(ie.file_id):
 
1559
                        self.outf.write(path)
 
1560
                        if show_ids:
 
1561
                            self.outf.write(' ')
 
1562
                            self.outf.write(ie.file_id)
 
1563
                        self.outf.write('\n')
 
1564
            finally:
 
1565
                old.unlock()
 
1566
        finally:
 
1567
            tree.unlock()
2023
1568
 
2024
1569
 
2025
1570
class cmd_modified(Command):
2026
 
    __doc__ = """List files modified in working tree.
 
1571
    """List files modified in working tree.
2027
1572
    """
2028
1573
 
2029
1574
    hidden = True
2046
1591
 
2047
1592
 
2048
1593
class cmd_added(Command):
2049
 
    __doc__ = """List files added in working tree.
 
1594
    """List files added in working tree.
2050
1595
    """
2051
1596
 
2052
1597
    hidden = True
2061
1606
    def run(self, null=False):
2062
1607
        wt = WorkingTree.open_containing(u'.')[0]
2063
1608
        wt.lock_read()
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')
 
1609
        try:
 
1610
            basis = wt.basis_tree()
 
1611
            basis.lock_read()
 
1612
            try:
 
1613
                basis_inv = basis.inventory
 
1614
                inv = wt.inventory
 
1615
                for file_id in inv:
 
1616
                    if file_id in basis_inv:
 
1617
                        continue
 
1618
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1619
                        continue
 
1620
                    path = inv.id2path(file_id)
 
1621
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1622
                        continue
 
1623
                    if null:
 
1624
                        self.outf.write(path + '\0')
 
1625
                    else:
 
1626
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1627
            finally:
 
1628
                basis.unlock()
 
1629
        finally:
 
1630
            wt.unlock()
2082
1631
 
2083
1632
 
2084
1633
class cmd_root(Command):
2085
 
    __doc__ = """Show the tree root directory.
 
1634
    """Show the tree root directory.
2086
1635
 
2087
1636
    The root is the nearest enclosing directory with a .bzr control
2088
1637
    directory."""
2103
1652
        raise errors.BzrCommandError(msg)
2104
1653
 
2105
1654
 
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
 
 
2114
1655
class cmd_log(Command):
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.
 
1656
    """Show log of a branch, file, or directory.
 
1657
 
 
1658
    By default show the log of the branch containing the working directory.
 
1659
 
 
1660
    To request a range of logs, you can use the command -r begin..end
 
1661
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1662
    also valid.
 
1663
 
 
1664
    :Examples:
 
1665
        Log the current branch::
 
1666
 
 
1667
            bzr log
 
1668
 
 
1669
        Log a file::
 
1670
 
 
1671
            bzr log foo.c
 
1672
 
 
1673
        Log the last 10 revisions of a branch::
 
1674
 
 
1675
            bzr log -r -10.. http://server/branch
2265
1676
    """
2266
 
    takes_args = ['file*']
2267
 
    _see_also = ['log-formats', 'revisionspec']
 
1677
 
 
1678
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1679
 
 
1680
    takes_args = ['location?']
2268
1681
    takes_options = [
2269
1682
            Option('forward',
2270
1683
                   help='Show from oldest to newest.'),
2271
 
            'timezone',
 
1684
            Option('timezone',
 
1685
                   type=str,
 
1686
                   help='Display timezone as local, original, or utc.'),
2272
1687
            custom_help('verbose',
2273
1688
                   help='Show files changed in each revision.'),
2274
1689
            'show-ids',
2279
1694
                   help='Show just the specified revision.'
2280
1695
                   ' See also "help revisionspec".'),
2281
1696
            '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),
2287
1697
            Option('message',
2288
1698
                   short_name='m',
2289
1699
                   help='Show revisions whose message matches this '
2294
1704
                   help='Limit the output to the first N revisions.',
2295
1705
                   argname='N',
2296
1706
                   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
 
                   )
2306
1707
            ]
2307
1708
    encoding_type = 'replace'
2308
1709
 
2309
1710
    @display_command
2310
 
    def run(self, file_list=None, timezone='original',
 
1711
    def run(self, location=None, timezone='original',
2311
1712
            verbose=False,
2312
1713
            show_ids=False,
2313
1714
            forward=False,
2314
1715
            revision=None,
2315
1716
            change=None,
2316
1717
            log_format=None,
2317
 
            levels=None,
2318
1718
            message=None,
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
 
            )
 
1719
            limit=None):
 
1720
        from bzrlib.log import show_log
2329
1721
        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')
2340
1722
 
2341
1723
        if change is not None:
2342
1724
            if len(change) > 1:
2347
1729
            else:
2348
1730
                revision = change
2349
1731
 
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:
 
1732
        # log everything
 
1733
        file_id = None
 
1734
        if location:
 
1735
            # find the file id to log:
 
1736
 
 
1737
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1738
                location)
 
1739
            if fp != '':
 
1740
                if tree is None:
 
1741
                    tree = b.basis_tree()
 
1742
                file_id = tree.path2id(fp)
2358
1743
                if file_id is None:
2359
1744
                    raise errors.BzrCommandError(
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'])
 
1745
                        "Path does not have any revision history: %s" %
 
1746
                        location)
2370
1747
        else:
2371
 
            # log everything
2372
 
            # FIXME ? log the current subdir only RBC 20060203
 
1748
            # local dir only
 
1749
            # FIXME ? log the current subdir only RBC 20060203 
2373
1750
            if revision is not None \
2374
1751
                    and len(revision) > 0 and revision[0].get_branch():
2375
1752
                location = revision[0].get_branch()
2377
1754
                location = '.'
2378
1755
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2379
1756
            b = dir.open_branch()
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
 
1757
 
 
1758
        b.lock_read()
 
1759
        try:
 
1760
            if revision is None:
 
1761
                rev1 = None
 
1762
                rev2 = None
 
1763
            elif len(revision) == 1:
 
1764
                rev1 = rev2 = revision[0].in_history(b)
 
1765
            elif len(revision) == 2:
 
1766
                if revision[1].get_branch() != revision[0].get_branch():
 
1767
                    # b is taken from revision[0].get_branch(), and
 
1768
                    # show_log will use its revision_history. Having
 
1769
                    # different branches will lead to weird behaviors.
 
1770
                    raise errors.BzrCommandError(
 
1771
                        "Log doesn't accept two revisions in different"
 
1772
                        " branches.")
 
1773
                rev1 = revision[0].in_history(b)
 
1774
                rev2 = revision[1].in_history(b)
 
1775
            else:
 
1776
                raise errors.BzrCommandError(
 
1777
                    'bzr log --revision takes one or two values.')
 
1778
 
 
1779
            if log_format is None:
 
1780
                log_format = log.log_formatter_registry.get_default(b)
 
1781
 
 
1782
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1783
                            show_timezone=timezone)
 
1784
 
 
1785
            show_log(b,
 
1786
                     lf,
 
1787
                     file_id,
 
1788
                     verbose=verbose,
 
1789
                     direction=direction,
 
1790
                     start_revision=rev1,
 
1791
                     end_revision=rev2,
 
1792
                     search=message,
 
1793
                     limit=limit)
 
1794
        finally:
 
1795
            b.unlock()
 
1796
 
2485
1797
 
2486
1798
def get_log_format(long=False, short=False, line=False, default='long'):
2487
1799
    log_format = default
2495
1807
 
2496
1808
 
2497
1809
class cmd_touching_revisions(Command):
2498
 
    __doc__ = """Return revision-ids which affected a particular file.
 
1810
    """Return revision-ids which affected a particular file.
2499
1811
 
2500
1812
    A more user-friendly interface is "bzr log FILE".
2501
1813
    """
2506
1818
    @display_command
2507
1819
    def run(self, filename):
2508
1820
        tree, relpath = WorkingTree.open_containing(filename)
 
1821
        b = tree.branch
2509
1822
        file_id = tree.path2id(relpath)
2510
 
        b = tree.branch
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:
 
1823
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2515
1824
            self.outf.write("%6d %s\n" % (revno, what))
2516
1825
 
2517
1826
 
2518
1827
class cmd_ls(Command):
2519
 
    __doc__ = """List files in a tree.
 
1828
    """List files in a tree.
2520
1829
    """
2521
1830
 
2522
1831
    _see_also = ['status', 'cat']
2523
1832
    takes_args = ['path?']
 
1833
    # TODO: Take a revision or remote path and list that tree instead.
2524
1834
    takes_options = [
2525
1835
            'verbose',
2526
1836
            'revision',
2527
 
            Option('recursive', short_name='R',
2528
 
                   help='Recurse into subdirectories.'),
 
1837
            Option('non-recursive',
 
1838
                   help='Don\'t recurse into subdirectories.'),
2529
1839
            Option('from-root',
2530
1840
                   help='Print paths relative to the root of the branch.'),
2531
1841
            Option('unknown', help='Print unknown files.'),
2542
1852
            ]
2543
1853
    @display_command
2544
1854
    def run(self, revision=None, verbose=False,
2545
 
            recursive=False, from_root=False,
 
1855
            non_recursive=False, from_root=False,
2546
1856
            unknown=False, versioned=False, ignored=False,
2547
1857
            null=False, kind=None, show_ids=False, path=None):
2548
1858
 
2557
1867
 
2558
1868
        if path is None:
2559
1869
            fs_path = '.'
 
1870
            prefix = ''
2560
1871
        else:
2561
1872
            if from_root:
2562
1873
                raise errors.BzrCommandError('cannot specify both --from-root'
2563
1874
                                             ' and PATH')
2564
1875
            fs_path = path
 
1876
            prefix = path
2565
1877
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2566
1878
            fs_path)
2567
 
 
2568
 
        # Calculate the prefix to use
2569
 
        prefix = None
2570
1879
        if from_root:
2571
 
            if relpath:
2572
 
                prefix = relpath + '/'
2573
 
        elif fs_path != '.' and not fs_path.endswith('/'):
2574
 
            prefix = fs_path + '/'
2575
 
 
 
1880
            relpath = u''
 
1881
        elif relpath:
 
1882
            relpath += '/'
2576
1883
        if revision is not None or tree is None:
2577
1884
            tree = _get_one_revision_tree('ls', revision, branch=branch)
2578
1885
 
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
 
 
2587
1886
        tree.lock_read()
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')
 
1887
        try:
 
1888
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1889
                if fp.startswith(relpath):
 
1890
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1891
                    if non_recursive and '/' in fp:
 
1892
                        continue
 
1893
                    if not all and not selection[fc]:
 
1894
                        continue
 
1895
                    if kind is not None and fkind != kind:
 
1896
                        continue
 
1897
                    if verbose:
 
1898
                        kindch = entry.kind_character()
 
1899
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1900
                        if show_ids and fid is not None:
 
1901
                            outstring = "%-50s %s" % (outstring, fid)
 
1902
                        self.outf.write(outstring + '\n')
 
1903
                    elif null:
 
1904
                        self.outf.write(fp + '\0')
 
1905
                        if show_ids:
 
1906
                            if fid is not None:
 
1907
                                self.outf.write(fid)
 
1908
                            self.outf.write('\0')
 
1909
                        self.outf.flush()
 
1910
                    else:
 
1911
                        if fid is not None:
 
1912
                            my_id = fid
 
1913
                        else:
 
1914
                            my_id = ''
 
1915
                        if show_ids:
 
1916
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1917
                        else:
 
1918
                            self.outf.write(fp + '\n')
 
1919
        finally:
 
1920
            tree.unlock()
2633
1921
 
2634
1922
 
2635
1923
class cmd_unknowns(Command):
2636
 
    __doc__ = """List unknown files.
 
1924
    """List unknown files.
2637
1925
    """
2638
1926
 
2639
1927
    hidden = True
2646
1934
 
2647
1935
 
2648
1936
class cmd_ignore(Command):
2649
 
    __doc__ = """Ignore specified files or patterns.
 
1937
    """Ignore specified files or patterns.
2650
1938
 
2651
1939
    See ``bzr help patterns`` for details on the syntax of patterns.
2652
1940
 
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
 
 
2659
1941
    To remove patterns from the ignore list, edit the .bzrignore file.
2660
1942
    After adding, editing or deleting that file either indirectly by
2661
1943
    using this command or directly by using an editor, be sure to commit
2662
1944
    it.
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
 
1945
 
 
1946
    Note: ignore patterns containing shell wildcards must be quoted from 
2678
1947
    the shell on Unix.
2679
1948
 
2680
1949
    :Examples:
2682
1951
 
2683
1952
            bzr ignore ./Makefile
2684
1953
 
2685
 
        Ignore .class files in all directories...::
 
1954
        Ignore class files in all directories::
2686
1955
 
2687
1956
            bzr ignore "*.class"
2688
1957
 
2689
 
        ...but do not ignore "special.class"::
2690
 
 
2691
 
            bzr ignore "!special.class"
2692
 
 
2693
1958
        Ignore .o files under the lib directory::
2694
1959
 
2695
1960
            bzr ignore "lib/**/*.o"
2701
1966
        Ignore everything but the "debian" toplevel directory::
2702
1967
 
2703
1968
            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 "!!*~"
2711
1969
    """
2712
1970
 
2713
1971
    _see_also = ['status', 'ignored', 'patterns']
2714
1972
    takes_args = ['name_pattern*']
2715
1973
    takes_options = [
2716
 
        Option('default-rules',
2717
 
               help='Display the default ignore rules that bzr uses.')
 
1974
        Option('old-default-rules',
 
1975
               help='Write out the ignore rules bzr < 0.9 always used.')
2718
1976
        ]
2719
 
 
2720
 
    def run(self, name_pattern_list=None, default_rules=None):
 
1977
    
 
1978
    def run(self, name_pattern_list=None, old_default_rules=None):
2721
1979
        from bzrlib import ignores
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)
 
1980
        if old_default_rules is not None:
 
1981
            # dump the rules and exit
 
1982
            for pattern in ignores.OLD_DEFAULTS:
 
1983
                print pattern
2726
1984
            return
2727
1985
        if not name_pattern_list:
2728
1986
            raise errors.BzrCommandError("ignore requires at least one "
2729
 
                "NAME_PATTERN or --default-rules.")
2730
 
        name_pattern_list = [globbing.normalize_pattern(p)
 
1987
                                  "NAME_PATTERN or --old-default-rules")
 
1988
        name_pattern_list = [globbing.normalize_pattern(p) 
2731
1989
                             for p in name_pattern_list]
2732
1990
        for name_pattern in name_pattern_list:
2733
 
            if (name_pattern[0] == '/' or
 
1991
            if (name_pattern[0] == '/' or 
2734
1992
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2735
1993
                raise errors.BzrCommandError(
2736
1994
                    "NAME_PATTERN should not be an absolute path")
2744
2002
            if id is not None:
2745
2003
                filename = entry[0]
2746
2004
                if ignored.match(filename):
2747
 
                    matches.append(filename)
 
2005
                    matches.append(filename.encode('utf-8'))
2748
2006
        tree.unlock()
2749
2007
        if len(matches) > 0:
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),))
 
2008
            print "Warning: the following files are version controlled and" \
 
2009
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
2754
2010
 
2755
2011
 
2756
2012
class cmd_ignored(Command):
2757
 
    __doc__ = """List ignored files and the patterns that matched them.
 
2013
    """List ignored files and the patterns that matched them.
2758
2014
 
2759
2015
    List all the ignored files and the ignore pattern that caused the file to
2760
2016
    be ignored.
2771
2027
    def run(self):
2772
2028
        tree = WorkingTree.open_containing(u'.')[0]
2773
2029
        tree.lock_read()
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))
 
2030
        try:
 
2031
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2032
                if file_class != 'I':
 
2033
                    continue
 
2034
                ## XXX: Slightly inefficient since this was already calculated
 
2035
                pat = tree.is_ignored(path)
 
2036
                self.outf.write('%-50s %s\n' % (path, pat))
 
2037
        finally:
 
2038
            tree.unlock()
2781
2039
 
2782
2040
 
2783
2041
class cmd_lookup_revision(Command):
2784
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2042
    """Lookup the revision-id from a revision-number
2785
2043
 
2786
2044
    :Examples:
2787
2045
        bzr lookup-revision 33
2788
2046
    """
2789
2047
    hidden = True
2790
2048
    takes_args = ['revno']
2791
 
 
 
2049
    
2792
2050
    @display_command
2793
2051
    def run(self, revno):
2794
2052
        try:
2795
2053
            revno = int(revno)
2796
2054
        except ValueError:
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)
 
2055
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2056
 
 
2057
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2801
2058
 
2802
2059
 
2803
2060
class cmd_export(Command):
2804
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2061
    """Export current or past revision to a destination directory or archive.
2805
2062
 
2806
2063
    If no revision is specified this exports the last committed revision.
2807
2064
 
2834
2091
               help="Type of file to export to.",
2835
2092
               type=unicode),
2836
2093
        'revision',
2837
 
        Option('filters', help='Apply content filters to export the '
2838
 
                'convenient form.'),
2839
2094
        Option('root',
2840
2095
               type=str,
2841
2096
               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.'),
2845
2097
        ]
2846
2098
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2847
 
        root=None, filters=False, per_file_timestamps=False):
 
2099
        root=None):
2848
2100
        from bzrlib.export import export
2849
2101
 
2850
2102
        if branch_or_subdir is None:
2857
2109
 
2858
2110
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2859
2111
        try:
2860
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2861
 
                   per_file_timestamps=per_file_timestamps)
 
2112
            export(rev_tree, dest, format, root, subdir)
2862
2113
        except errors.NoSuchExportFormat, e:
2863
2114
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2864
2115
 
2865
2116
 
2866
2117
class cmd_cat(Command):
2867
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2118
    """Write the contents of a file as of a given revision to standard output.
2868
2119
 
2869
2120
    If no revision is nominated, the last revision is used.
2870
2121
 
2871
2122
    Note: Take care to redirect standard output when using this command on a
2872
 
    binary file.
 
2123
    binary file. 
2873
2124
    """
2874
2125
 
2875
2126
    _see_also = ['ls']
2876
2127
    takes_options = [
2877
2128
        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.'),
2880
2129
        'revision',
2881
2130
        ]
2882
2131
    takes_args = ['filename']
2883
2132
    encoding_type = 'exact'
2884
2133
 
2885
2134
    @display_command
2886
 
    def run(self, filename, revision=None, name_from_revision=False,
2887
 
            filters=False):
 
2135
    def run(self, filename, revision=None, name_from_revision=False):
2888
2136
        if revision is not None and len(revision) != 1:
2889
2137
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2890
2138
                                         " one revision specifier")
2891
2139
        tree, branch, relpath = \
2892
2140
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2893
2141
        branch.lock_read()
2894
 
        self.add_cleanup(branch.unlock)
2895
 
        return self._run(tree, branch, relpath, filename, revision,
2896
 
                         name_from_revision, filters)
 
2142
        try:
 
2143
            return self._run(tree, branch, relpath, filename, revision,
 
2144
                             name_from_revision)
 
2145
        finally:
 
2146
            branch.unlock()
2897
2147
 
2898
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2899
 
        filtered):
 
2148
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2900
2149
        if tree is None:
2901
2150
            tree = b.basis_tree()
2902
2151
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2903
 
        rev_tree.lock_read()
2904
 
        self.add_cleanup(rev_tree.unlock)
2905
2152
 
 
2153
        cur_file_id = tree.path2id(relpath)
2906
2154
        old_file_id = rev_tree.path2id(relpath)
2907
2155
 
2908
2156
        if name_from_revision:
2909
 
            # Try in revision if requested
2910
2157
            if old_file_id is None:
2911
2158
                raise errors.BzrCommandError(
2912
2159
                    "%r is not present in revision %s" % (
2913
2160
                        filename, rev_tree.get_revision_id()))
2914
2161
            else:
2915
2162
                content = rev_tree.get_file_text(old_file_id)
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)
 
2163
        elif cur_file_id is not None:
 
2164
            content = rev_tree.get_file_text(cur_file_id)
 
2165
        elif old_file_id is not None:
 
2166
            content = rev_tree.get_file_text(old_file_id)
 
2167
        else:
 
2168
            raise errors.BzrCommandError(
 
2169
                "%r is not present in revision %s" % (
 
2170
                    filename, rev_tree.get_revision_id()))
 
2171
        self.outf.write(content)
2950
2172
 
2951
2173
 
2952
2174
class cmd_local_time_offset(Command):
2953
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
2954
 
    hidden = True
 
2175
    """Show the offset in seconds from GMT to local time."""
 
2176
    hidden = True    
2955
2177
    @display_command
2956
2178
    def run(self):
2957
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2179
        print osutils.local_time_offset()
2958
2180
 
2959
2181
 
2960
2182
 
2961
2183
class cmd_commit(Command):
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.)
 
2184
    """Commit changes into a new revision.
 
2185
    
 
2186
    If no arguments are given, the entire tree is committed.
 
2187
 
 
2188
    If selected files are specified, only changes to those files are
 
2189
    committed.  If a directory is specified then the directory and everything 
 
2190
    within it is committed.
 
2191
 
 
2192
    When excludes are given, they take precedence over selected files.
 
2193
    For example, too commit only changes within foo, but not changes within
 
2194
    foo/bar::
 
2195
 
 
2196
      bzr commit foo -x foo/bar
 
2197
 
 
2198
    If author of the change is not the same person as the committer, you can
 
2199
    specify the author's name using the --author option. The name should be
 
2200
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2201
 
 
2202
    A selected-file commit may fail in some cases where the committed
 
2203
    tree would be invalid. Consider::
 
2204
 
 
2205
      bzr init foo
 
2206
      mkdir foo/bar
 
2207
      bzr add foo/bar
 
2208
      bzr commit foo -m "committing foo"
 
2209
      bzr mv foo/bar foo/baz
 
2210
      mkdir foo/bar
 
2211
      bzr add foo/bar
 
2212
      bzr commit foo/bar -m "committing bar but not baz"
 
2213
 
 
2214
    In the example above, the last commit will fail by design. This gives
 
2215
    the user the opportunity to decide whether they want to commit the
 
2216
    rename at the same time, separately first, or not at all. (As a general
 
2217
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2218
 
 
2219
    Note: A selected-file commit after a merge is not yet supported.
3033
2220
    """
3034
2221
    # TODO: Run hooks on tree to-be-committed, and after commit.
3035
2222
 
3040
2227
 
3041
2228
    # XXX: verbose currently does nothing
3042
2229
 
3043
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2230
    _see_also = ['bugs', 'uncommit']
3044
2231
    takes_args = ['selected*']
3045
2232
    takes_options = [
3046
2233
            ListOption('exclude', type=str, short_name='x',
3058
2245
             Option('strict',
3059
2246
                    help="Refuse to commit if there are unknown "
3060
2247
                    "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'."),
3064
2248
             ListOption('fixes', type=str,
3065
 
                    help="Mark a bug as being fixed by this revision "
3066
 
                         "(see \"bzr help bugs\")."),
3067
 
             ListOption('author', type=unicode,
 
2249
                    help="Mark a bug as being fixed by this revision."),
 
2250
             Option('author', type=unicode,
3068
2251
                    help="Set the author's name, if it's different "
3069
2252
                         "from the committer."),
3070
2253
             Option('local',
3073
2256
                         "the master branch until a normal commit "
3074
2257
                         "is performed."
3075
2258
                    ),
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.'),
 
2259
              Option('show-diff',
 
2260
                     help='When no message is supplied, show the diff along'
 
2261
                     ' with the status summary in the message editor.'),
3079
2262
             ]
3080
2263
    aliases = ['ci', 'checkin']
3081
2264
 
3082
 
    def _iter_bug_fix_urls(self, fixes, branch):
 
2265
    def _get_bug_fix_properties(self, fixes, branch):
 
2266
        properties = []
3083
2267
        # Configure the properties for bug fixing attributes.
3084
2268
        for fixed_bug in fixes:
3085
2269
            tokens = fixed_bug.split(':')
3086
2270
            if len(tokens) != 2:
3087
2271
                raise errors.BzrCommandError(
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)
 
2272
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2273
                    "Commit refused." % fixed_bug)
3091
2274
            tag, bug_id = tokens
3092
2275
            try:
3093
 
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2276
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
3094
2277
            except errors.UnknownBugTrackerAbbreviation:
3095
2278
                raise errors.BzrCommandError(
3096
2279
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3097
 
            except errors.MalformedBugIdentifier, e:
 
2280
            except errors.MalformedBugIdentifier:
3098
2281
                raise errors.BzrCommandError(
3099
 
                    "%s\nCommit refused." % (str(e),))
 
2282
                    "Invalid bug identifier for %s. Commit refused."
 
2283
                    % fixed_bug)
 
2284
            properties.append('%s fixed' % bug_url)
 
2285
        return '\n'.join(properties)
3100
2286
 
3101
2287
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3102
2288
            unchanged=False, strict=False, local=False, fixes=None,
3103
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2289
            author=None, show_diff=False, exclude=None):
3104
2290
        from bzrlib.errors import (
3105
2291
            PointlessCommit,
3106
2292
            ConflictsInTree,
3108
2294
        )
3109
2295
        from bzrlib.msgeditor import (
3110
2296
            edit_commit_message_encoded,
3111
 
            generate_commit_message_template,
3112
2297
            make_commit_message_template_encoded
3113
2298
        )
3114
2299
 
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
 
 
3123
2300
        # TODO: Need a blackbox test for invoking the external editor; may be
3124
2301
        # slightly problematic to run this cross-platform.
3125
2302
 
3126
 
        # TODO: do more checks that the commit will succeed before
 
2303
        # TODO: do more checks that the commit will succeed before 
3127
2304
        # spending the user's valuable time typing a commit message.
3128
2305
 
3129
2306
        properties = {}
3137
2314
 
3138
2315
        if fixes is None:
3139
2316
            fixes = []
3140
 
        bug_property = bugtracker.encode_fixes_bug_urls(
3141
 
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2317
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
3142
2318
        if bug_property:
3143
2319
            properties['bugs'] = bug_property
3144
2320
 
3145
2321
        if local and not tree.branch.get_bound_location():
3146
2322
            raise errors.LocalRequiresBoundBranch()
3147
2323
 
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
 
 
3169
2324
        def get_message(commit_obj):
3170
2325
            """Callback to get commit message"""
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,
 
2326
            my_message = message
 
2327
            if my_message is None and not file:
 
2328
                t = make_commit_message_template_encoded(tree,
3180
2329
                        selected_list, diff=show_diff,
3181
2330
                        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.
3187
 
                start_message = generate_commit_message_template(commit_obj)
3188
 
                my_message = edit_commit_message_encoded(text,
3189
 
                    start_message=start_message)
 
2331
                my_message = edit_commit_message_encoded(t)
3190
2332
                if my_message is None:
3191
2333
                    raise errors.BzrCommandError("please specify a commit"
3192
2334
                        " message with either --message or --file")
 
2335
            elif my_message and file:
 
2336
                raise errors.BzrCommandError(
 
2337
                    "please specify either --message or --file")
 
2338
            if file:
 
2339
                my_message = codecs.open(file, 'rt',
 
2340
                                         osutils.get_user_encoding()).read()
3193
2341
            if my_message == "":
3194
2342
                raise errors.BzrCommandError("empty commit message specified")
3195
2343
            return my_message
3196
2344
 
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
3201
2345
        try:
3202
2346
            tree.commit(message_callback=get_message,
3203
2347
                        specific_files=selected_list,
3204
2348
                        allow_pointless=unchanged, strict=strict, local=local,
3205
2349
                        reporter=None, verbose=verbose, revprops=properties,
3206
 
                        authors=author, timestamp=commit_stamp,
3207
 
                        timezone=offset,
 
2350
                        author=author,
3208
2351
                        exclude=safe_relpath_files(tree, exclude))
3209
2352
        except PointlessCommit:
3210
 
            raise errors.BzrCommandError("No changes to commit."
3211
 
                              " Use --unchanged to commit anyhow.")
 
2353
            # FIXME: This should really happen before the file is read in;
 
2354
            # perhaps prepare the commit; get the message; then actually commit
 
2355
            raise errors.BzrCommandError("no changes to commit."
 
2356
                              " use --unchanged to commit anyhow")
3212
2357
        except ConflictsInTree:
3213
2358
            raise errors.BzrCommandError('Conflicts detected in working '
3214
2359
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3217
2362
            raise errors.BzrCommandError("Commit refused because there are"
3218
2363
                              " unknown files in the working tree.")
3219
2364
        except errors.BoundBranchOutOfDate, e:
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
 
2365
            raise errors.BzrCommandError(str(e) + "\n"
 
2366
            'To commit to master branch, run update and then commit.\n'
 
2367
            'You can also pass --local to commit to continue working '
 
2368
            'disconnected.')
3225
2369
 
3226
2370
 
3227
2371
class cmd_check(Command):
3228
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2372
    """Validate working tree structure, branch consistency and repository history.
3229
2373
 
3230
2374
    This command checks various invariants about branch and repository storage
3231
2375
    to detect data corruption or bzr bugs.
3233
2377
    The working tree and branch checks will only give output if a problem is
3234
2378
    detected. The output fields of the repository check are:
3235
2379
 
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.
 
2380
        revisions: This is just the number of revisions checked.  It doesn't
 
2381
            indicate a problem.
 
2382
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2383
            doesn't indicate a problem.
 
2384
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2385
            are not properly referenced by the revision ancestry.  This is a
 
2386
            subtle problem that Bazaar can work around.
 
2387
        unique file texts: This is the total number of unique file contents
 
2388
            seen in the checked revisions.  It does not indicate a problem.
 
2389
        repeated file texts: This is the total number of repeated texts seen
 
2390
            in the checked revisions.  Texts can be repeated when their file
 
2391
            entries are modified, but the file contents are not.  It does not
 
2392
            indicate a problem.
3258
2393
 
3259
2394
    If no restrictions are specified, all Bazaar data that is found at the given
3260
2395
    location will be checked.
3295
2430
 
3296
2431
 
3297
2432
class cmd_upgrade(Command):
3298
 
    __doc__ = """Upgrade branch storage to current format.
 
2433
    """Upgrade branch storage to current format.
3299
2434
 
3300
2435
    The check command or bzr developers may sometimes advise you to run
3301
2436
    this command. When the default format has changed you may also be warned
3315
2450
 
3316
2451
    def run(self, url='.', format=None):
3317
2452
        from bzrlib.upgrade import upgrade
 
2453
        if format is None:
 
2454
            format = bzrdir.format_registry.make_bzrdir('default')
3318
2455
        upgrade(url, format)
3319
2456
 
3320
2457
 
3321
2458
class cmd_whoami(Command):
3322
 
    __doc__ = """Show or set bzr user id.
3323
 
 
 
2459
    """Show or set bzr user id.
 
2460
    
3324
2461
    :Examples:
3325
2462
        Show the email of the current user::
3326
2463
 
3338
2475
                    ]
3339
2476
    takes_args = ['name?']
3340
2477
    encoding_type = 'replace'
3341
 
 
 
2478
    
3342
2479
    @display_command
3343
2480
    def run(self, email=False, branch=False, name=None):
3344
2481
        if name is None:
3359
2496
        except errors.NoEmailInUsername, e:
3360
2497
            warning('"%s" does not seem to contain an email address.  '
3361
2498
                    'This is allowed, but not recommended.', name)
3362
 
 
 
2499
        
3363
2500
        # use global config unless --branch given
3364
2501
        if branch:
3365
2502
            c = Branch.open_containing('.')[0].get_config()
3369
2506
 
3370
2507
 
3371
2508
class cmd_nick(Command):
3372
 
    __doc__ = """Print or set the branch nickname.
3373
 
 
3374
 
    If unset, the tree root directory name is used as the nickname.
3375
 
    To print the current nickname, execute with no argument.
3376
 
 
3377
 
    Bound branches use the nickname of its master branch unless it is set
3378
 
    locally.
 
2509
    """Print or set the branch nickname.  
 
2510
 
 
2511
    If unset, the tree root directory name is used as the nickname
 
2512
    To print the current nickname, execute with no argument.  
3379
2513
    """
3380
2514
 
3381
2515
    _see_also = ['info']
3389
2523
 
3390
2524
    @display_command
3391
2525
    def printme(self, branch):
3392
 
        self.outf.write('%s\n' % branch.nick)
 
2526
        print branch.nick
3393
2527
 
3394
2528
 
3395
2529
class cmd_alias(Command):
3396
 
    __doc__ = """Set/unset and display aliases.
 
2530
    """Set/unset and display aliases.
3397
2531
 
3398
2532
    :Examples:
3399
2533
        Show the current aliases::
3463
2597
 
3464
2598
 
3465
2599
class cmd_selftest(Command):
3466
 
    __doc__ = """Run internal test suite.
3467
 
 
 
2600
    """Run internal test suite.
 
2601
    
3468
2602
    If arguments are given, they are regular expressions that say which tests
3469
2603
    should run.  Tests matching any expression are run, and other tests are
3470
2604
    not run.
3493
2627
    modified by plugins will not be tested, and tests provided by plugins will
3494
2628
    not be run.
3495
2629
 
3496
 
    Tests that need working space on disk use a common temporary directory,
 
2630
    Tests that need working space on disk use a common temporary directory, 
3497
2631
    typically inside $TMPDIR or /tmp.
3498
2632
 
3499
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3500
 
    into a pdb postmortem session.
3501
 
 
3502
2633
    :Examples:
3503
2634
        Run only tests relating to 'ignore'::
3504
2635
 
3513
2644
    def get_transport_type(typestring):
3514
2645
        """Parse and return a transport specifier."""
3515
2646
        if typestring == "sftp":
3516
 
            from bzrlib.tests import stub_sftp
3517
 
            return stub_sftp.SFTPAbsoluteServer
 
2647
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2648
            return SFTPAbsoluteServer
3518
2649
        if typestring == "memory":
3519
 
            from bzrlib.tests import test_server
3520
 
            return memory.MemoryServer
 
2650
            from bzrlib.transport.memory import MemoryServer
 
2651
            return MemoryServer
3521
2652
        if typestring == "fakenfs":
3522
 
            from bzrlib.tests import test_server
3523
 
            return test_server.FakeNFSServer
 
2653
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2654
            return FakeNFSServer
3524
2655
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3525
2656
            (typestring)
3526
2657
        raise errors.BzrCommandError(msg)
3541
2672
                     Option('lsprof-timed',
3542
2673
                            help='Generate lsprof output for benchmarked'
3543
2674
                                 ' sections of code.'),
3544
 
                     Option('lsprof-tests',
3545
 
                            help='Generate lsprof output for each test.'),
3546
2675
                     Option('cache-dir', type=str,
3547
2676
                            help='Cache intermediate benchmark output in this '
3548
2677
                                 'directory.'),
3552
2681
                            ),
3553
2682
                     Option('list-only',
3554
2683
                            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
 
                        ),
3560
2684
                     Option('randomize', type=str, argname="SEED",
3561
2685
                            help='Randomize the order of tests using the given'
3562
2686
                                 ' seed or "now" for the current time.'),
3564
2688
                            short_name='x',
3565
2689
                            help='Exclude tests that match this regular'
3566
2690
                                 ' expression.'),
3567
 
                     Option('subunit',
3568
 
                        help='Output test progress via subunit.'),
3569
2691
                     Option('strict', help='Fail on missing dependencies or '
3570
2692
                            'known failures.'),
3571
2693
                     Option('load-list', type=str, argname='TESTLISTFILE',
3579
2701
                     ]
3580
2702
    encoding_type = 'replace'
3581
2703
 
3582
 
    def __init__(self):
3583
 
        Command.__init__(self)
3584
 
        self.additional_selftest_args = {}
3585
 
 
3586
2704
    def run(self, testspecs_list=None, verbose=False, one=False,
3587
2705
            transport=None, benchmark=None,
3588
2706
            lsprof_timed=None, cache_dir=None,
3589
2707
            first=False, list_only=False,
3590
2708
            randomize=None, exclude=None, strict=False,
3591
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3592
 
            parallel=None, lsprof_tests=False):
 
2709
            load_list=None, debugflag=None, starting_with=None):
3593
2710
        from bzrlib.tests import selftest
3594
2711
        import bzrlib.benchmarks as benchmarks
3595
2712
        from bzrlib.benchmarks import tree_creator
3599
2716
 
3600
2717
        if cache_dir is not None:
3601
2718
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2719
        if not list_only:
 
2720
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2721
            print '   %s (%s python%s)' % (
 
2722
                    bzrlib.__path__[0],
 
2723
                    bzrlib.version_string,
 
2724
                    bzrlib._format_version_tuple(sys.version_info),
 
2725
                    )
 
2726
        print
3602
2727
        if testspecs_list is not None:
3603
2728
            pattern = '|'.join(testspecs_list)
3604
2729
        else:
3605
2730
            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)
3621
2731
        if benchmark:
3622
2732
            test_suite_factory = benchmarks.test_suite
3623
2733
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3624
2734
            verbose = not is_quiet()
3625
2735
            # TODO: should possibly lock the history file...
3626
2736
            benchfile = open(".perf_history", "at", buffering=1)
3627
 
            self.add_cleanup(benchfile.close)
3628
2737
        else:
3629
2738
            test_suite_factory = None
3630
2739
            benchfile = None
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)
 
2740
        try:
 
2741
            result = selftest(verbose=verbose,
 
2742
                              pattern=pattern,
 
2743
                              stop_on_failure=one,
 
2744
                              transport=transport,
 
2745
                              test_suite_factory=test_suite_factory,
 
2746
                              lsprof_timed=lsprof_timed,
 
2747
                              bench_history=benchfile,
 
2748
                              matching_tests_first=first,
 
2749
                              list_only=list_only,
 
2750
                              random_seed=randomize,
 
2751
                              exclude_pattern=exclude,
 
2752
                              strict=strict,
 
2753
                              load_list=load_list,
 
2754
                              debug_flags=debugflag,
 
2755
                              starting_with=starting_with,
 
2756
                              )
 
2757
        finally:
 
2758
            if benchfile is not None:
 
2759
                benchfile.close()
 
2760
        if result:
 
2761
            note('tests passed')
 
2762
        else:
 
2763
            note('tests failed')
3650
2764
        return int(not result)
3651
2765
 
3652
2766
 
3653
2767
class cmd_version(Command):
3654
 
    __doc__ = """Show version of bzr."""
 
2768
    """Show version of bzr."""
3655
2769
 
3656
2770
    encoding_type = 'replace'
3657
2771
    takes_options = [
3668
2782
 
3669
2783
 
3670
2784
class cmd_rocks(Command):
3671
 
    __doc__ = """Statement of optimism."""
 
2785
    """Statement of optimism."""
3672
2786
 
3673
2787
    hidden = True
3674
2788
 
3675
2789
    @display_command
3676
2790
    def run(self):
3677
 
        self.outf.write("It sure does!\n")
 
2791
        print "It sure does!"
3678
2792
 
3679
2793
 
3680
2794
class cmd_find_merge_base(Command):
3681
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
2795
    """Find and print a base revision for merging two branches."""
3682
2796
    # TODO: Options to specify revisions on either side, as if
3683
2797
    #       merging only part of the history.
3684
2798
    takes_args = ['branch', 'other']
3685
2799
    hidden = True
3686
 
 
 
2800
    
3687
2801
    @display_command
3688
2802
    def run(self, branch, other):
3689
2803
        from bzrlib.revision import ensure_null
3690
 
 
 
2804
        
3691
2805
        branch1 = Branch.open_containing(branch)[0]
3692
2806
        branch2 = Branch.open_containing(other)[0]
3693
2807
        branch1.lock_read()
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)
 
2808
        try:
 
2809
            branch2.lock_read()
 
2810
            try:
 
2811
                last1 = ensure_null(branch1.last_revision())
 
2812
                last2 = ensure_null(branch2.last_revision())
 
2813
 
 
2814
                graph = branch1.repository.get_graph(branch2.repository)
 
2815
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2816
 
 
2817
                print 'merge base is revision %s' % base_rev_id
 
2818
            finally:
 
2819
                branch2.unlock()
 
2820
        finally:
 
2821
            branch1.unlock()
3704
2822
 
3705
2823
 
3706
2824
class cmd_merge(Command):
3707
 
    __doc__ = """Perform a three-way merge.
3708
 
 
 
2825
    """Perform a three-way merge.
 
2826
    
3709
2827
    The source of the merge can be specified either in the form of a branch,
3710
2828
    or in the form of a path to a file containing a merge directive generated
3711
2829
    with bzr send. If neither is specified, the default is the upstream branch
3721
2839
    By default, bzr will try to merge in all new work from the other
3722
2840
    branch, automatically determining an appropriate base.  If this
3723
2841
    fails, you may need to give an explicit base.
3724
 
 
 
2842
    
3725
2843
    Merge will do its best to combine the changes in two branches, but there
3726
2844
    are some kinds of problems only a human can fix.  When it encounters those,
3727
2845
    it will mark a conflict.  A conflict means that you need to fix something,
3737
2855
    The results of the merge are placed into the destination working
3738
2856
    directory, where they can be reviewed (with bzr diff), tested, and then
3739
2857
    committed to record the result of the merge.
3740
 
 
 
2858
    
3741
2859
    merge refuses to run if there are any uncommitted changes, unless
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".
 
2860
    --force is given.
3751
2861
 
3752
2862
    :Examples:
3753
2863
        To merge the latest revision from bzr.dev::
3762
2872
 
3763
2873
            bzr merge -r 81..82 ../bzr.dev
3764
2874
 
3765
 
        To apply a merge directive contained in /tmp/merge::
 
2875
        To apply a merge directive contained in in /tmp/merge:
3766
2876
 
3767
2877
            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'
3775
2878
    """
3776
2879
 
3777
2880
    encoding_type = 'exact'
3778
 
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
2881
    _see_also = ['update', 'remerge', 'status-flags']
3779
2882
    takes_args = ['location?']
3780
2883
    takes_options = [
3781
2884
        'change',
3799
2902
               short_name='d',
3800
2903
               type=unicode,
3801
2904
               ),
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')
 
2905
        Option('preview', help='Instead of merging, show a diff of the merge.')
3806
2906
    ]
3807
2907
 
3808
2908
    def run(self, location=None, revision=None, force=False,
3809
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
2909
            merge_type=None, show_base=False, reprocess=False, remember=False,
3810
2910
            uncommitted=False, pull=False,
3811
2911
            directory=None,
3812
2912
            preview=False,
3813
 
            interactive=False,
3814
2913
            ):
3815
2914
        if merge_type is None:
3816
2915
            merge_type = _mod_merge.Merge3Merger
3821
2920
        allow_pending = True
3822
2921
        verified = 'inapplicable'
3823
2922
        tree = WorkingTree.open_containing(directory)[0]
3824
 
 
 
2923
        change_reporter = delta._ChangeReporter(
 
2924
            unversioned_filter=tree.is_ignored)
 
2925
        cleanups = []
3825
2926
        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)
3836
 
        change_reporter = delta._ChangeReporter(
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
 
2927
            pb = ui.ui_factory.nested_progress_bar()
 
2928
            cleanups.append(pb.finished)
 
2929
            tree.lock_write()
 
2930
            cleanups.append(tree.unlock)
 
2931
            if location is not None:
 
2932
                try:
 
2933
                    mergeable = bundle.read_mergeable_from_url(location,
 
2934
                        possible_transports=possible_transports)
 
2935
                except errors.NotABundle:
 
2936
                    mergeable = None
 
2937
                else:
 
2938
                    if uncommitted:
 
2939
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2940
                            ' with bundles or merge directives.')
 
2941
 
 
2942
                    if revision is not None:
 
2943
                        raise errors.BzrCommandError(
 
2944
                            'Cannot use -r with merge directives or bundles')
 
2945
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2946
                       mergeable, pb)
 
2947
 
 
2948
            if merger is None and uncommitted:
 
2949
                if revision is not None and len(revision) > 0:
 
2950
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2951
                        ' --revision at the same time.')
 
2952
                location = self._select_branch_location(tree, location)[0]
 
2953
                other_tree, other_path = WorkingTree.open_containing(location)
 
2954
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2955
                    pb)
 
2956
                allow_pending = False
 
2957
                if other_path != '':
 
2958
                    merger.interesting_files = [other_path]
 
2959
 
 
2960
            if merger is None:
 
2961
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2962
                    location, revision, remember, possible_transports, pb)
 
2963
 
 
2964
            merger.merge_type = merge_type
 
2965
            merger.reprocess = reprocess
 
2966
            merger.show_base = show_base
 
2967
            self.sanity_check_merger(merger)
 
2968
            if (merger.base_rev_id == merger.other_rev_id and
 
2969
                merger.other_rev_id is not None):
 
2970
                note('Nothing to do.')
 
2971
                return 0
 
2972
            if pull:
 
2973
                if merger.interesting_files is not None:
 
2974
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2975
                if (merger.base_rev_id == tree.last_revision()):
 
2976
                    result = tree.pull(merger.other_branch, False,
 
2977
                                       merger.other_rev_id)
 
2978
                    result.report(self.outf)
 
2979
                    return 0
 
2980
            merger.check_basis(not force)
 
2981
            if preview:
 
2982
                return self._do_preview(merger)
3848
2983
            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)
3885
 
                return 0
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):
 
2984
                return self._do_merge(merger, change_reporter, allow_pending,
 
2985
                                      verified)
 
2986
        finally:
 
2987
            for cleanup in reversed(cleanups):
 
2988
                cleanup()
 
2989
 
 
2990
    def _do_preview(self, merger):
 
2991
        from bzrlib.diff import show_diff_trees
3899
2992
        tree_merger = merger.make_merger()
3900
2993
        tt = tree_merger.make_preview_transform()
3901
 
        self.add_cleanup(tt.finalize)
3902
 
        result_tree = tt.get_preview_tree()
3903
 
        return result_tree
3904
 
 
3905
 
    def _do_preview(self, merger):
3906
 
        from bzrlib.diff import show_diff_trees
3907
 
        result_tree = self._get_preview(merger)
3908
 
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3909
 
                        old_label='', new_label='')
 
2994
        try:
 
2995
            result_tree = tt.get_preview_tree()
 
2996
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2997
                            old_label='', new_label='')
 
2998
        finally:
 
2999
            tt.finalize()
3910
3000
 
3911
3001
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3912
3002
        merger.change_reporter = change_reporter
3920
3010
        else:
3921
3011
            return 0
3922
3012
 
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
 
 
3941
3013
    def sanity_check_merger(self, merger):
3942
3014
        if (merger.show_base and
3943
3015
            not merger.merge_type is _mod_merge.Merge3Merger):
3944
3016
            raise errors.BzrCommandError("Show-base is not supported for this"
3945
3017
                                         " merge type. %s" % merger.merge_type)
3946
 
        if merger.reprocess is None:
3947
 
            if merger.show_base:
3948
 
                merger.reprocess = False
3949
 
            else:
3950
 
                # Use reprocess if the merger supports it
3951
 
                merger.reprocess = merger.merge_type.supports_reprocess
3952
3018
        if merger.reprocess and not merger.merge_type.supports_reprocess:
3953
3019
            raise errors.BzrCommandError("Conflict reduction is not supported"
3954
3020
                                         " for merge type %s." %
3978
3044
            base_branch, base_path = Branch.open_containing(base_loc,
3979
3045
                possible_transports)
3980
3046
        # Find the revision ids
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:
 
3047
        if revision is None or len(revision) < 1 or revision[-1] is None:
3989
3048
            other_revision_id = _mod_revision.ensure_null(
3990
3049
                other_branch.last_revision())
 
3050
        else:
 
3051
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3052
        if (revision is not None and len(revision) == 2
 
3053
            and revision[0] is not None):
 
3054
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3055
        else:
 
3056
            base_revision_id = None
3991
3057
        # Remember where we merge from
3992
3058
        if ((remember or tree.branch.get_submit_branch() is None) and
3993
3059
             user_location is not None):
4002
3068
            allow_pending = True
4003
3069
        return merger, allow_pending
4004
3070
 
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
 
 
4019
3071
    def _select_branch_location(self, tree, user_location, revision=None,
4020
3072
                                index=None):
4021
3073
        """Select a branch location, according to possible inputs.
4065
3117
 
4066
3118
 
4067
3119
class cmd_remerge(Command):
4068
 
    __doc__ = """Redo a merge.
 
3120
    """Redo a merge.
4069
3121
 
4070
3122
    Use this if you want to try a different merge technique while resolving
4071
 
    conflicts.  Some merge techniques are better than others, and remerge
 
3123
    conflicts.  Some merge techniques are better than others, and remerge 
4072
3124
    lets you try different ones on different files.
4073
3125
 
4074
3126
    The options for remerge have the same meaning and defaults as the ones for
4078
3130
    :Examples:
4079
3131
        Re-do the merge of all conflicted files, and show the base text in
4080
3132
        conflict regions, in addition to the usual THIS and OTHER texts::
4081
 
 
 
3133
      
4082
3134
            bzr remerge --show-base
4083
3135
 
4084
3136
        Re-do the merge of "foobar", using the weave merge algorithm, with
4085
3137
        additional processing to reduce the size of conflict regions::
4086
 
 
 
3138
      
4087
3139
            bzr remerge --merge-type weave --reprocess foobar
4088
3140
    """
4089
3141
    takes_args = ['file*']
4096
3148
 
4097
3149
    def run(self, file_list=None, merge_type=None, show_base=False,
4098
3150
            reprocess=False):
4099
 
        from bzrlib.conflicts import restore
4100
3151
        if merge_type is None:
4101
3152
            merge_type = _mod_merge.Merge3Merger
4102
3153
        tree, file_list = tree_files(file_list)
4103
3154
        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:
 
3155
        try:
 
3156
            parents = tree.get_parent_ids()
 
3157
            if len(parents) != 2:
 
3158
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3159
                                             " merges.  Not cherrypicking or"
 
3160
                                             " multi-merges.")
 
3161
            repository = tree.branch.repository
 
3162
            interesting_ids = None
 
3163
            new_conflicts = []
 
3164
            conflicts = tree.conflicts()
 
3165
            if file_list is not None:
 
3166
                interesting_ids = set()
 
3167
                for filename in file_list:
 
3168
                    file_id = tree.path2id(filename)
 
3169
                    if file_id is None:
 
3170
                        raise errors.NotVersionedError(filename)
 
3171
                    interesting_ids.add(file_id)
 
3172
                    if tree.kind(file_id) != "directory":
 
3173
                        continue
 
3174
                    
 
3175
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3176
                        interesting_ids.add(ie.file_id)
 
3177
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3178
            else:
 
3179
                # Remerge only supports resolving contents conflicts
 
3180
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3181
                restore_files = [c.path for c in conflicts
 
3182
                                 if c.typestring in allowed_conflicts]
 
3183
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3184
            tree.set_conflicts(ConflictList(new_conflicts))
 
3185
            if file_list is not None:
 
3186
                restore_files = file_list
 
3187
            for filename in restore_files:
 
3188
                try:
 
3189
                    restore(tree.abspath(filename))
 
3190
                except errors.NotConflicted:
 
3191
                    pass
 
3192
            # Disable pending merges, because the file texts we are remerging
 
3193
            # have not had those merges performed.  If we use the wrong parents
 
3194
            # list, we imply that the working tree text has seen and rejected
 
3195
            # all the changes from the other tree, when in fact those changes
 
3196
            # have not yet been seen.
 
3197
            pb = ui.ui_factory.nested_progress_bar()
 
3198
            tree.set_parent_ids(parents[:1])
4137
3199
            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])
4147
 
        try:
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()
 
3200
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3201
                                                             tree, parents[1])
 
3202
                merger.interesting_ids = interesting_ids
 
3203
                merger.merge_type = merge_type
 
3204
                merger.show_base = show_base
 
3205
                merger.reprocess = reprocess
 
3206
                conflicts = merger.do_merge()
 
3207
            finally:
 
3208
                tree.set_parent_ids(parents)
 
3209
                pb.finished()
4154
3210
        finally:
4155
 
            tree.set_parent_ids(parents)
 
3211
            tree.unlock()
4156
3212
        if conflicts > 0:
4157
3213
            return 1
4158
3214
        else:
4160
3216
 
4161
3217
 
4162
3218
class cmd_revert(Command):
4163
 
    __doc__ = """Revert files to a previous revision.
 
3219
    """Revert files to a previous revision.
4164
3220
 
4165
3221
    Giving a list of files will revert only those files.  Otherwise, all files
4166
3222
    will be reverted.  If the revision is not specified with '--revision', the
4170
3226
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4171
3227
    changes introduced by -2, without affecting the changes introduced by -1.
4172
3228
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4173
 
 
 
3229
    
4174
3230
    By default, any files that have been manually changed will be backed up
4175
3231
    first.  (Files changed only by merge are not backed up.)  Backup files have
4176
3232
    '.~#~' appended to their name, where # is a number.
4180
3236
    name.  If you name a directory, all the contents of that directory will be
4181
3237
    reverted.
4182
3238
 
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.
 
3239
    Any files that have been newly added since that revision will be deleted,
 
3240
    with a backup kept if appropriate.  Directories containing unknown files
 
3241
    will not be deleted.
4187
3242
 
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
 
3243
    The working tree contains a list of pending merged revisions, which will
 
3244
    be included as parents in the next commit.  Normally, revert clears that
 
3245
    list as well as reverting the files.  If any files are specified, revert
 
3246
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3247
    revert ." in the tree root to revert all files but keep the merge record,
 
3248
    and "bzr revert --forget-merges" to clear the pending merge list without
4195
3249
    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.
4206
3250
    """
4207
3251
 
4208
3252
    _see_also = ['cat', 'export']
4217
3261
    def run(self, revision=None, no_backup=False, file_list=None,
4218
3262
            forget_merges=None):
4219
3263
        tree, file_list = tree_files(file_list)
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)
 
3264
        tree.lock_write()
 
3265
        try:
 
3266
            if forget_merges:
 
3267
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3268
            else:
 
3269
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3270
        finally:
 
3271
            tree.unlock()
4226
3272
 
4227
3273
    @staticmethod
4228
3274
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4229
3275
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4230
 
        tree.revert(file_list, rev_tree, not no_backup, None,
4231
 
            report_changes=True)
 
3276
        pb = ui.ui_factory.nested_progress_bar()
 
3277
        try:
 
3278
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3279
                report_changes=True)
 
3280
        finally:
 
3281
            pb.finished()
4232
3282
 
4233
3283
 
4234
3284
class cmd_assert_fail(Command):
4235
 
    __doc__ = """Test reporting of assertion failures"""
 
3285
    """Test reporting of assertion failures"""
4236
3286
    # intended just for use in testing
4237
3287
 
4238
3288
    hidden = True
4242
3292
 
4243
3293
 
4244
3294
class cmd_help(Command):
4245
 
    __doc__ = """Show help on a command or other topic.
 
3295
    """Show help on a command or other topic.
4246
3296
    """
4247
3297
 
4248
3298
    _see_also = ['topics']
4251
3301
            ]
4252
3302
    takes_args = ['topic?']
4253
3303
    aliases = ['?', '--help', '-?', '-h']
4254
 
 
 
3304
    
4255
3305
    @display_command
4256
3306
    def run(self, topic=None, long=False):
4257
3307
        import bzrlib.help
4261
3311
 
4262
3312
 
4263
3313
class cmd_shell_complete(Command):
4264
 
    __doc__ = """Show appropriate completions for context.
 
3314
    """Show appropriate completions for context.
4265
3315
 
4266
3316
    For a list of all available commands, say 'bzr shell-complete'.
4267
3317
    """
4268
3318
    takes_args = ['context?']
4269
3319
    aliases = ['s-c']
4270
3320
    hidden = True
4271
 
 
 
3321
    
4272
3322
    @display_command
4273
3323
    def run(self, context=None):
4274
3324
        import shellcomplete
4276
3326
 
4277
3327
 
4278
3328
class cmd_missing(Command):
4279
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4280
 
 
 
3329
    """Show unmerged/unpulled revisions between two branches.
 
3330
    
4281
3331
    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
4311
3332
    """
4312
3333
 
4313
3334
    _see_also = ['merge', 'pull']
4314
3335
    takes_args = ['other_branch?']
4315
3336
    takes_options = [
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
 
        ]
 
3337
            Option('reverse', 'Reverse the order of revisions.'),
 
3338
            Option('mine-only',
 
3339
                   'Display changes in the local branch only.'),
 
3340
            Option('this' , 'Same as --mine-only.'),
 
3341
            Option('theirs-only',
 
3342
                   'Display changes in the remote branch only.'),
 
3343
            Option('other', 'Same as --theirs-only.'),
 
3344
            'log-format',
 
3345
            'show-ids',
 
3346
            'verbose',
 
3347
            Option('include-merges', 'Show merged revisions.'),
 
3348
            ]
4336
3349
    encoding_type = 'replace'
4337
3350
 
4338
3351
    @display_command
4340
3353
            theirs_only=False,
4341
3354
            log_format=None, long=False, short=False, line=False,
4342
3355
            show_ids=False, verbose=False, this=False, other=False,
4343
 
            include_merges=False, revision=None, my_revision=None):
 
3356
            include_merges=False):
4344
3357
        from bzrlib.missing import find_unmerged, iter_log_revisions
4345
 
        def message(s):
4346
 
            if not is_quiet():
4347
 
                self.outf.write(s)
4348
3358
 
4349
3359
        if this:
4350
3360
            mine_only = this
4360
3370
            restrict = 'remote'
4361
3371
 
4362
3372
        local_branch = Branch.open_containing(u".")[0]
4363
 
        local_branch.lock_read()
4364
 
        self.add_cleanup(local_branch.unlock)
4365
 
 
4366
3373
        parent = local_branch.get_parent()
4367
3374
        if other_branch is None:
4368
3375
            other_branch = parent
4371
3378
                                             " or specified.")
4372
3379
            display_url = urlutils.unescape_for_display(parent,
4373
3380
                                                        self.outf.encoding)
4374
 
            message("Using saved parent location: "
 
3381
            self.outf.write("Using saved parent location: "
4375
3382
                    + display_url + "\n")
4376
3383
 
4377
3384
        remote_branch = Branch.open(other_branch)
4378
3385
        if remote_branch.base == local_branch.base:
4379
3386
            remote_branch = local_branch
4380
 
        else:
 
3387
        local_branch.lock_read()
 
3388
        try:
4381
3389
            remote_branch.lock_read()
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()
 
3390
            try:
 
3391
                local_extra, remote_extra = find_unmerged(
 
3392
                    local_branch, remote_branch, restrict,
 
3393
                    backward=not reverse,
 
3394
                    include_merges=include_merges)
 
3395
 
 
3396
                if log_format is None:
 
3397
                    registry = log.log_formatter_registry
 
3398
                    log_format = registry.get_default(local_branch)
 
3399
                lf = log_format(to_file=self.outf,
 
3400
                                show_ids=show_ids,
 
3401
                                show_timezone='original')
 
3402
 
 
3403
                status_code = 0
 
3404
                if local_extra and not theirs_only:
 
3405
                    self.outf.write("You have %d extra revision(s):\n" %
 
3406
                                    len(local_extra))
 
3407
                    for revision in iter_log_revisions(local_extra,
 
3408
                                        local_branch.repository,
 
3409
                                        verbose):
 
3410
                        lf.log_revision(revision)
 
3411
                    printed_local = True
 
3412
                    status_code = 1
 
3413
                else:
 
3414
                    printed_local = False
 
3415
 
 
3416
                if remote_extra and not mine_only:
 
3417
                    if printed_local is True:
 
3418
                        self.outf.write("\n\n\n")
 
3419
                    self.outf.write("You are missing %d revision(s):\n" %
 
3420
                                    len(remote_extra))
 
3421
                    for revision in iter_log_revisions(remote_extra,
 
3422
                                        remote_branch.repository,
 
3423
                                        verbose):
 
3424
                        lf.log_revision(revision)
 
3425
                    status_code = 1
 
3426
 
 
3427
                if mine_only and not local_extra:
 
3428
                    # We checked local, and found nothing extra
 
3429
                    self.outf.write('This branch is up to date.\n')
 
3430
                elif theirs_only and not remote_extra:
 
3431
                    # We checked remote, and found nothing extra
 
3432
                    self.outf.write('Other branch is up to date.\n')
 
3433
                elif not (mine_only or theirs_only or local_extra or
 
3434
                          remote_extra):
 
3435
                    # We checked both branches, and neither one had extra
 
3436
                    # revisions
 
3437
                    self.outf.write("Branches are up to date.\n")
 
3438
            finally:
 
3439
                remote_branch.unlock()
 
3440
        finally:
 
3441
            local_branch.unlock()
4442
3442
        if not status_code and parent is None and other_branch is not None:
4443
3443
            local_branch.lock_write()
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)
 
3444
            try:
 
3445
                # handle race conditions - a parent might be set while we run.
 
3446
                if local_branch.get_parent() is None:
 
3447
                    local_branch.set_parent(remote_branch.base)
 
3448
            finally:
 
3449
                local_branch.unlock()
4448
3450
        return status_code
4449
3451
 
4450
3452
 
4451
3453
class cmd_pack(Command):
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
 
    """
 
3454
    """Compress the data within a repository."""
4469
3455
 
4470
3456
    _see_also = ['repositories']
4471
3457
    takes_args = ['branch_or_repo?']
4472
 
    takes_options = [
4473
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4474
 
        ]
4475
3458
 
4476
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
3459
    def run(self, branch_or_repo='.'):
4477
3460
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4478
3461
        try:
4479
3462
            branch = dir.open_branch()
4480
3463
            repository = branch.repository
4481
3464
        except errors.NotBranchError:
4482
3465
            repository = dir.open_repository()
4483
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
3466
        repository.pack()
4484
3467
 
4485
3468
 
4486
3469
class cmd_plugins(Command):
4487
 
    __doc__ = """List the installed plugins.
4488
 
 
 
3470
    """List the installed plugins.
 
3471
    
4489
3472
    This command displays the list of installed plugins including
4490
3473
    version of plugin and a short description of each.
4491
3474
 
4497
3480
    adding new commands, providing additional network transports and
4498
3481
    customizing log output.
4499
3482
 
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.
 
3483
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3484
    information on plugins including where to find them and how to
 
3485
    install them. Instructions are also provided there on how to
 
3486
    write new plugins using the Python programming language.
4504
3487
    """
4505
3488
    takes_options = ['verbose']
4506
3489
 
4521
3504
                doc = '(no description)'
4522
3505
            result.append((name_ver, doc, plugin.path()))
4523
3506
        for name_ver, doc, path in sorted(result):
4524
 
            self.outf.write("%s\n" % name_ver)
4525
 
            self.outf.write("   %s\n" % doc)
 
3507
            print name_ver
 
3508
            print '   ', doc
4526
3509
            if verbose:
4527
 
                self.outf.write("   %s\n" % path)
4528
 
            self.outf.write("\n")
 
3510
                print '   ', path
 
3511
            print
4529
3512
 
4530
3513
 
4531
3514
class cmd_testament(Command):
4532
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
3515
    """Show testament (signing-form) of a revision."""
4533
3516
    takes_options = [
4534
3517
            'revision',
4535
3518
            Option('long', help='Produce long-format testament.'),
4548
3531
        else:
4549
3532
            b = Branch.open(branch)
4550
3533
        b.lock_read()
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())
 
3534
        try:
 
3535
            if revision is None:
 
3536
                rev_id = b.last_revision()
 
3537
            else:
 
3538
                rev_id = revision[0].as_revision_id(b)
 
3539
            t = testament_class.from_revision(b.repository, rev_id)
 
3540
            if long:
 
3541
                sys.stdout.writelines(t.as_text_lines())
 
3542
            else:
 
3543
                sys.stdout.write(t.as_short_text())
 
3544
        finally:
 
3545
            b.unlock()
4561
3546
 
4562
3547
 
4563
3548
class cmd_annotate(Command):
4564
 
    __doc__ = """Show the origin of each line in a file.
 
3549
    """Show the origin of each line in a file.
4565
3550
 
4566
3551
    This prints out the given file with an annotation on the left side
4567
3552
    indicating which revision, author and date introduced the change.
4568
3553
 
4569
 
    If the origin is the same for a run of consecutive lines, it is
 
3554
    If the origin is the same for a run of consecutive lines, it is 
4570
3555
    shown only at the top, unless the --all option is given.
4571
3556
    """
4572
3557
    # TODO: annotate directories; showing when each file was last changed
4573
 
    # TODO: if the working copy is modified, show annotations on that
 
3558
    # TODO: if the working copy is modified, show annotations on that 
4574
3559
    #       with new uncommitted lines marked
4575
3560
    aliases = ['ann', 'blame', 'praise']
4576
3561
    takes_args = ['filename']
4589
3574
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4590
3575
        if wt is not None:
4591
3576
            wt.lock_read()
4592
 
            self.add_cleanup(wt.unlock)
4593
3577
        else:
4594
3578
            branch.lock_read()
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)
 
3579
        try:
 
3580
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
3581
            if wt is not None:
 
3582
                file_id = wt.path2id(relpath)
 
3583
            else:
 
3584
                file_id = tree.path2id(relpath)
 
3585
            if file_id is None:
 
3586
                raise errors.NotVersionedError(filename)
 
3587
            file_version = tree.inventory[file_id].revision
 
3588
            if wt is not None and revision is None:
 
3589
                # If there is a tree and we're not annotating historical
 
3590
                # versions, annotate the working tree's content.
 
3591
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
3592
                    show_ids=show_ids)
 
3593
            else:
 
3594
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3595
                              show_ids=show_ids)
 
3596
        finally:
 
3597
            if wt is not None:
 
3598
                wt.unlock()
 
3599
            else:
 
3600
                branch.unlock()
4614
3601
 
4615
3602
 
4616
3603
class cmd_re_sign(Command):
4617
 
    __doc__ = """Create a digital signature for an existing revision."""
 
3604
    """Create a digital signature for an existing revision."""
4618
3605
    # TODO be able to replace existing ones.
4619
3606
 
4620
3607
    hidden = True # is this right ?
4621
3608
    takes_args = ['revision_id*']
4622
3609
    takes_options = ['revision']
4623
 
 
 
3610
    
4624
3611
    def run(self, revision_id_list=None, revision=None):
4625
3612
        if revision_id_list is not None and revision is not None:
4626
3613
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4628
3615
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4629
3616
        b = WorkingTree.open_containing(u'.')[0].branch
4630
3617
        b.lock_write()
4631
 
        self.add_cleanup(b.unlock)
4632
 
        return self._run(b, revision_id_list, revision)
 
3618
        try:
 
3619
            return self._run(b, revision_id_list, revision)
 
3620
        finally:
 
3621
            b.unlock()
4633
3622
 
4634
3623
    def _run(self, b, revision_id_list, revision):
4635
3624
        import bzrlib.gpg as gpg
4680
3669
 
4681
3670
 
4682
3671
class cmd_bind(Command):
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.
 
3672
    """Convert the current branch into a checkout of the supplied branch.
4685
3673
 
4686
3674
    Once converted into a checkout, commits must succeed on the master branch
4687
3675
    before they will be applied to the local branch.
4688
 
 
4689
 
    Bound branches use the nickname of its master branch unless it is set
4690
 
    locally, in which case binding will update the local nickname to be
4691
 
    that of the master.
4692
3676
    """
4693
3677
 
4694
3678
    _see_also = ['checkouts', 'unbind']
4705
3689
                    'This format does not remember old locations.')
4706
3690
            else:
4707
3691
                if location is None:
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')
 
3692
                    raise errors.BzrCommandError('No location supplied and no '
 
3693
                        'previous location known')
4713
3694
        b_other = Branch.open(location)
4714
3695
        try:
4715
3696
            b.bind(b_other)
4716
3697
        except errors.DivergedBranches:
4717
3698
            raise errors.BzrCommandError('These branches have diverged.'
4718
3699
                                         ' Try merging, and then bind again.')
4719
 
        if b.get_config().has_explicit_nickname():
4720
 
            b.nick = b_other.nick
4721
3700
 
4722
3701
 
4723
3702
class cmd_unbind(Command):
4724
 
    __doc__ = """Convert the current checkout into a regular branch.
 
3703
    """Convert the current checkout into a regular branch.
4725
3704
 
4726
3705
    After unbinding, the local branch is considered independent and subsequent
4727
3706
    commits will be local only.
4738
3717
 
4739
3718
 
4740
3719
class cmd_uncommit(Command):
4741
 
    __doc__ = """Remove the last committed revision.
 
3720
    """Remove the last committed revision.
4742
3721
 
4743
3722
    --verbose will print out what is being removed.
4744
3723
    --dry-run will go through all the motions, but not actually
4785
3764
 
4786
3765
        if tree is not None:
4787
3766
            tree.lock_write()
4788
 
            self.add_cleanup(tree.unlock)
4789
3767
        else:
4790
3768
            b.lock_write()
4791
 
            self.add_cleanup(b.unlock)
4792
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
3769
        try:
 
3770
            return self._run(b, tree, dry_run, verbose, revision, force,
 
3771
                             local=local)
 
3772
        finally:
 
3773
            if tree is not None:
 
3774
                tree.unlock()
 
3775
            else:
 
3776
                b.unlock()
4793
3777
 
4794
3778
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4795
3779
        from bzrlib.log import log_formatter, show_log
4827
3811
                 end_revision=last_revno)
4828
3812
 
4829
3813
        if dry_run:
4830
 
            self.outf.write('Dry-run, pretending to remove'
4831
 
                            ' the above revisions.\n')
 
3814
            print 'Dry-run, pretending to remove the above revisions.'
 
3815
            if not force:
 
3816
                val = raw_input('Press <enter> to continue')
4832
3817
        else:
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
 
3818
            print 'The above revision(s) will be removed.'
 
3819
            if not force:
 
3820
                val = raw_input('Are you sure [y/N]? ')
 
3821
                if val.lower() not in ('y', 'yes'):
 
3822
                    print 'Canceled'
 
3823
                    return 0
4839
3824
 
4840
3825
        mutter('Uncommitting from {%s} to {%s}',
4841
3826
               last_rev_id, rev_id)
4842
3827
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4843
3828
                 revno=revno, local=local)
4844
 
        self.outf.write('You can restore the old tip by running:\n'
4845
 
             '  bzr pull . -r revid:%s\n' % last_rev_id)
 
3829
        note('You can restore the old tip by running:\n'
 
3830
             '  bzr pull . -r revid:%s', last_rev_id)
4846
3831
 
4847
3832
 
4848
3833
class cmd_break_lock(Command):
4849
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
3834
    """Break a dead lock on a repository, branch or working directory.
4850
3835
 
4851
3836
    CAUTION: Locks should only be broken when you are sure that the process
4852
3837
    holding the lock has been stopped.
4853
3838
 
4854
 
    You can get information on what locks are open via the 'bzr info
4855
 
    [location]' command.
4856
 
 
 
3839
    You can get information on what locks are open via the 'bzr info' command.
 
3840
    
4857
3841
    :Examples:
4858
3842
        bzr break-lock
4859
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4860
3843
    """
4861
3844
    takes_args = ['location?']
4862
3845
 
4868
3851
            control.break_lock()
4869
3852
        except NotImplementedError:
4870
3853
            pass
4871
 
 
 
3854
        
4872
3855
 
4873
3856
class cmd_wait_until_signalled(Command):
4874
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3857
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4875
3858
 
4876
3859
    This just prints a line to signal when it is ready, then blocks on stdin.
4877
3860
    """
4885
3868
 
4886
3869
 
4887
3870
class cmd_serve(Command):
4888
 
    __doc__ = """Run the bzr server."""
 
3871
    """Run the bzr server."""
4889
3872
 
4890
3873
    aliases = ['server']
4891
3874
 
4892
3875
    takes_options = [
4893
3876
        Option('inet',
4894
3877
               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),
4899
3878
        Option('port',
4900
3879
               help='Listen for connections on nominated port of the form '
4901
3880
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4902
 
                    'result in a dynamically allocated port.  The default port '
4903
 
                    'depends on the protocol.',
 
3881
                    'result in a dynamically allocated port.  The default port is '
 
3882
                    '4155.',
4904
3883
               type=str),
4905
3884
        Option('directory',
4906
3885
               help='Serve contents of this directory.',
4908
3887
        Option('allow-writes',
4909
3888
               help='By default the server is a readonly server.  Supplying '
4910
3889
                    '--allow-writes enables write access to the contents of '
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.'
 
3890
                    'the served directory and below.'
4916
3891
                ),
4917
3892
        ]
4918
3893
 
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
 
3894
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3895
        from bzrlib import lockdir
 
3896
        from bzrlib.smart import medium, server
 
3897
        from bzrlib.transport import get_transport
 
3898
        from bzrlib.transport.chroot import ChrootServer
4941
3899
        if directory is None:
4942
3900
            directory = os.getcwd()
4943
 
        if protocol is None:
4944
 
            protocol = transport_server_registry.get()
4945
 
        host, port = self.get_host_and_port(port)
4946
3901
        url = urlutils.local_path_to_url(directory)
4947
3902
        if not allow_writes:
4948
3903
            url = 'readonly+' + url
4949
 
        transport = get_transport(url)
4950
 
        protocol(transport, host, port, inet)
 
3904
        chroot_server = ChrootServer(get_transport(url))
 
3905
        chroot_server.setUp()
 
3906
        t = get_transport(chroot_server.get_url())
 
3907
        if inet:
 
3908
            smart_server = medium.SmartServerPipeStreamMedium(
 
3909
                sys.stdin, sys.stdout, t)
 
3910
        else:
 
3911
            host = medium.BZR_DEFAULT_INTERFACE
 
3912
            if port is None:
 
3913
                port = medium.BZR_DEFAULT_PORT
 
3914
            else:
 
3915
                if ':' in port:
 
3916
                    host, port = port.split(':')
 
3917
                port = int(port)
 
3918
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3919
            print 'listening on port: ', smart_server.port
 
3920
            sys.stdout.flush()
 
3921
        # for the duration of this server, no UI output is permitted.
 
3922
        # note that this may cause problems with blackbox tests. This should
 
3923
        # be changed with care though, as we dont want to use bandwidth sending
 
3924
        # progress over stderr to smart server clients!
 
3925
        old_factory = ui.ui_factory
 
3926
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3927
        try:
 
3928
            ui.ui_factory = ui.SilentUIFactory()
 
3929
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3930
            smart_server.serve()
 
3931
        finally:
 
3932
            ui.ui_factory = old_factory
 
3933
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4951
3934
 
4952
3935
 
4953
3936
class cmd_join(Command):
4954
 
    __doc__ = """Combine a tree into its containing tree.
4955
 
 
4956
 
    This command requires the target tree to be in a rich-root format.
 
3937
    """Combine a subtree into its containing tree.
 
3938
    
 
3939
    This command is for experimental use only.  It requires the target tree
 
3940
    to be in dirstate-with-subtree format, which cannot be converted into
 
3941
    earlier formats.
4957
3942
 
4958
3943
    The TREE argument should be an independent tree, inside another tree, but
4959
3944
    not part of it.  (Such trees can be produced by "bzr split", but also by
4962
3947
    The result is a combined tree, with the subtree no longer an independant
4963
3948
    part.  This is marked as a merge of the subtree into the containing tree,
4964
3949
    and all history is preserved.
 
3950
 
 
3951
    If --reference is specified, the subtree retains its independence.  It can
 
3952
    be branched by itself, and can be part of multiple projects at the same
 
3953
    time.  But operations performed in the containing tree, such as commit
 
3954
    and merge, will recurse into the subtree.
4965
3955
    """
4966
3956
 
4967
3957
    _see_also = ['split']
4968
3958
    takes_args = ['tree']
4969
3959
    takes_options = [
4970
 
            Option('reference', help='Join by reference.', hidden=True),
 
3960
            Option('reference', help='Join by reference.'),
4971
3961
            ]
 
3962
    hidden = True
4972
3963
 
4973
3964
    def run(self, tree, reference=False):
4974
3965
        sub_tree = WorkingTree.open(tree)
4992
3983
            try:
4993
3984
                containing_tree.subsume(sub_tree)
4994
3985
            except errors.BadSubsumeSource, e:
4995
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3986
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
4996
3987
                                             (tree, e.reason))
4997
3988
 
4998
3989
 
4999
3990
class cmd_split(Command):
5000
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
3991
    """Split a subdirectory of a tree into a separate tree.
5001
3992
 
5002
3993
    This command will produce a target tree in a format that supports
5003
3994
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5008
3999
    branch.  Commits in the top-level tree will not apply to the new subtree.
5009
4000
    """
5010
4001
 
5011
 
    _see_also = ['join']
 
4002
    # join is not un-hidden yet
 
4003
    #_see_also = ['join']
5012
4004
    takes_args = ['tree']
5013
4005
 
5014
4006
    def run(self, tree):
5019
4011
        try:
5020
4012
            containing_tree.extract(sub_id)
5021
4013
        except errors.RootNotRich:
5022
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4014
            raise errors.UpgradeRequired(containing_tree.branch.base)
5023
4015
 
5024
4016
 
5025
4017
class cmd_merge_directive(Command):
5026
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4018
    """Generate a merge directive for auto-merge tools.
5027
4019
 
5028
4020
    A directive requests a merge to be performed, and also provides all the
5029
4021
    information necessary to do so.  This means it must either include a
5122
4114
 
5123
4115
 
5124
4116
class cmd_send(Command):
5125
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4117
    """Mail or create a merge-directive for submiting changes.
5126
4118
 
5127
4119
    A merge directive provides many things needed for requesting merges:
5128
4120
 
5134
4126
      directly from the merge directive, without retrieving data from a
5135
4127
      branch.
5136
4128
 
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.
 
4129
    If --no-bundle is specified, then public_branch is needed (and must be
 
4130
    up-to-date), so that the receiver can perform the merge using the
 
4131
    public_branch.  The public_branch is always included if known, so that
 
4132
    people can check it later.
 
4133
 
 
4134
    The submit branch defaults to the parent, but can be overridden.  Both
 
4135
    submit branch and public branch will be remembered if supplied.
 
4136
 
 
4137
    If a public_branch is known for the submit_branch, that public submit
 
4138
    branch is used in the merge instructions.  This means that a local mirror
 
4139
    can be used as your actual submit branch, once you have set public_branch
 
4140
    for that mirror.
5163
4141
 
5164
4142
    Mail is sent using your preferred mail program.  This should be transparent
5165
4143
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5166
4144
    If the preferred client can't be found (or used), your editor will be used.
5167
 
 
 
4145
    
5168
4146
    To use a specific mail program, set the mail_client configuration option.
5169
4147
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
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.
 
4148
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4149
    generic options are "default", "editor", "emacsclient", "mapi", and
 
4150
    "xdg-email".  Plugins may also add supported clients.
5174
4151
 
5175
4152
    If mail is being sent, a to address is required.  This can be supplied
5176
4153
    either on the commandline, by setting the submit_to configuration
5177
 
    option in the branch itself or the child_submit_to configuration option
 
4154
    option in the branch itself or the child_submit_to configuration option 
5178
4155
    in the submit branch.
5179
4156
 
5180
4157
    Two formats are currently supported: "4" uses revision bundle format 4 and
5182
4159
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5183
4160
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5184
4161
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
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.
 
4162
    
 
4163
    Merge directives are applied using the merge command or the pull command.
5192
4164
    """
5193
4165
 
5194
4166
    encoding_type = 'exact'
5210
4182
               short_name='f',
5211
4183
               type=unicode),
5212
4184
        Option('output', short_name='o',
5213
 
               help='Write merge directive to this file or directory; '
 
4185
               help='Write merge directive to this file; '
5214
4186
                    'use - for stdout.',
5215
4187
               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.'),
5219
4188
        Option('mail-to', help='Mail the request to this address.',
5220
4189
               type=unicode),
5221
4190
        'revision',
5222
4191
        'message',
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')),
 
4192
        RegistryOption.from_kwargs('format',
 
4193
        'Use the specified output format.',
 
4194
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4195
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5227
4196
        ]
5228
4197
 
5229
4198
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5230
4199
            no_patch=False, revision=None, remember=False, output=None,
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)
 
4200
            format='4', mail_to=None, message=None, **kwargs):
 
4201
        return self._run(submit_branch, revision, public_branch, remember,
 
4202
                         format, no_bundle, no_patch, output,
 
4203
                         kwargs.get('from', '.'), mail_to, message)
 
4204
 
 
4205
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4206
             no_bundle, no_patch, output, from_, mail_to, message):
 
4207
        from bzrlib.revision import NULL_REVISION
 
4208
        branch = Branch.open_containing(from_)[0]
 
4209
        if output is None:
 
4210
            outfile = cStringIO.StringIO()
 
4211
        elif output == '-':
 
4212
            outfile = self.outf
 
4213
        else:
 
4214
            outfile = open(output, 'wb')
 
4215
        # we may need to write data into branch's repository to calculate
 
4216
        # the data to send.
 
4217
        branch.lock_write()
 
4218
        try:
 
4219
            if output is None:
 
4220
                config = branch.get_config()
 
4221
                if mail_to is None:
 
4222
                    mail_to = config.get_user_option('submit_to')
 
4223
                mail_client = config.get_mail_client()
 
4224
            if remember and submit_branch is None:
 
4225
                raise errors.BzrCommandError(
 
4226
                    '--remember requires a branch to be specified.')
 
4227
            stored_submit_branch = branch.get_submit_branch()
 
4228
            remembered_submit_branch = None
 
4229
            if submit_branch is None:
 
4230
                submit_branch = stored_submit_branch
 
4231
                remembered_submit_branch = "submit"
 
4232
            else:
 
4233
                if stored_submit_branch is None or remember:
 
4234
                    branch.set_submit_branch(submit_branch)
 
4235
            if submit_branch is None:
 
4236
                submit_branch = branch.get_parent()
 
4237
                remembered_submit_branch = "parent"
 
4238
            if submit_branch is None:
 
4239
                raise errors.BzrCommandError('No submit branch known or'
 
4240
                                             ' specified')
 
4241
            if remembered_submit_branch is not None:
 
4242
                note('Using saved %s location "%s" to determine what '
 
4243
                        'changes to submit.', remembered_submit_branch,
 
4244
                        submit_branch)
 
4245
 
 
4246
            if mail_to is None:
 
4247
                submit_config = Branch.open(submit_branch).get_config()
 
4248
                mail_to = submit_config.get_user_option("child_submit_to")
 
4249
 
 
4250
            stored_public_branch = branch.get_public_branch()
 
4251
            if public_branch is None:
 
4252
                public_branch = stored_public_branch
 
4253
            elif stored_public_branch is None or remember:
 
4254
                branch.set_public_branch(public_branch)
 
4255
            if no_bundle and public_branch is None:
 
4256
                raise errors.BzrCommandError('No public branch specified or'
 
4257
                                             ' known')
 
4258
            base_revision_id = None
 
4259
            revision_id = None
 
4260
            if revision is not None:
 
4261
                if len(revision) > 2:
 
4262
                    raise errors.BzrCommandError('bzr send takes '
 
4263
                        'at most two one revision identifiers')
 
4264
                revision_id = revision[-1].as_revision_id(branch)
 
4265
                if len(revision) == 2:
 
4266
                    base_revision_id = revision[0].as_revision_id(branch)
 
4267
            if revision_id is None:
 
4268
                revision_id = branch.last_revision()
 
4269
            if revision_id == NULL_REVISION:
 
4270
                raise errors.BzrCommandError('No revisions to submit.')
 
4271
            if format == '4':
 
4272
                directive = merge_directive.MergeDirective2.from_objects(
 
4273
                    branch.repository, revision_id, time.time(),
 
4274
                    osutils.local_time_offset(), submit_branch,
 
4275
                    public_branch=public_branch, include_patch=not no_patch,
 
4276
                    include_bundle=not no_bundle, message=message,
 
4277
                    base_revision_id=base_revision_id)
 
4278
            elif format == '0.9':
 
4279
                if not no_bundle:
 
4280
                    if not no_patch:
 
4281
                        patch_type = 'bundle'
 
4282
                    else:
 
4283
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4284
                            ' permit bundle with no patch')
 
4285
                else:
 
4286
                    if not no_patch:
 
4287
                        patch_type = 'diff'
 
4288
                    else:
 
4289
                        patch_type = None
 
4290
                directive = merge_directive.MergeDirective.from_objects(
 
4291
                    branch.repository, revision_id, time.time(),
 
4292
                    osutils.local_time_offset(), submit_branch,
 
4293
                    public_branch=public_branch, patch_type=patch_type,
 
4294
                    message=message)
 
4295
 
 
4296
            outfile.writelines(directive.to_lines())
 
4297
            if output is None:
 
4298
                subject = '[MERGE] '
 
4299
                if message is not None:
 
4300
                    subject += message
 
4301
                else:
 
4302
                    revision = branch.repository.get_revision(revision_id)
 
4303
                    subject += revision.get_summary()
 
4304
                basename = directive.get_disk_name(branch)
 
4305
                mail_client.compose_merge_request(mail_to, subject,
 
4306
                                                  outfile.getvalue(), basename)
 
4307
        finally:
 
4308
            if output != '-':
 
4309
                outfile.close()
 
4310
            branch.unlock()
5239
4311
 
5240
4312
 
5241
4313
class cmd_bundle_revisions(cmd_send):
5242
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4314
 
 
4315
    """Create a merge-directive for submiting changes.
5243
4316
 
5244
4317
    A merge directive provides many things needed for requesting merges:
5245
4318
 
5285
4358
               type=unicode),
5286
4359
        Option('output', short_name='o', help='Write directive to this file.',
5287
4360
               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.'),
5291
4361
        'revision',
5292
 
        RegistryOption('format',
5293
 
                       help='Use the specified output format.',
5294
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4362
        RegistryOption.from_kwargs('format',
 
4363
        'Use the specified output format.',
 
4364
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4365
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5295
4366
        ]
5296
4367
    aliases = ['bundle']
5297
4368
 
5301
4372
 
5302
4373
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5303
4374
            no_patch=False, revision=None, remember=False, output=None,
5304
 
            format=None, strict=None, **kwargs):
 
4375
            format='4', **kwargs):
5305
4376
        if output is None:
5306
4377
            output = '-'
5307
 
        from bzrlib.send import send
5308
 
        return send(submit_branch, revision, public_branch, remember,
 
4378
        return self._run(submit_branch, revision, public_branch, remember,
5309
4379
                         format, no_bundle, no_patch, output,
5310
 
                         kwargs.get('from', '.'), None, None, None,
5311
 
                         self.outf, strict=strict)
 
4380
                         kwargs.get('from', '.'), None, None)
5312
4381
 
5313
4382
 
5314
4383
class cmd_tag(Command):
5315
 
    __doc__ = """Create, remove or modify a tag naming a revision.
5316
 
 
 
4384
    """Create, remove or modify a tag naming a revision.
 
4385
    
5317
4386
    Tags give human-meaningful names to revisions.  Commands that take a -r
5318
4387
    (--revision) option can be given -rtag:X, where X is any previously
5319
4388
    created tag.
5321
4390
    Tags are stored in the branch.  Tags are copied from one branch to another
5322
4391
    along when you branch, push, pull or merge.
5323
4392
 
5324
 
    It is an error to give a tag name that already exists unless you pass
 
4393
    It is an error to give a tag name that already exists unless you pass 
5325
4394
    --force, in which case the tag is moved to point to the new revision.
5326
4395
 
5327
4396
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5328
4397
    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.
5334
4398
    """
5335
4399
 
5336
4400
    _see_also = ['commit', 'tags']
5337
 
    takes_args = ['tag_name?']
 
4401
    takes_args = ['tag_name']
5338
4402
    takes_options = [
5339
4403
        Option('delete',
5340
4404
            help='Delete this tag rather than placing it.',
5350
4414
        'revision',
5351
4415
        ]
5352
4416
 
5353
 
    def run(self, tag_name=None,
 
4417
    def run(self, tag_name,
5354
4418
            delete=None,
5355
4419
            directory='.',
5356
4420
            force=None,
5358
4422
            ):
5359
4423
        branch, relpath = Branch.open_containing(directory)
5360
4424
        branch.lock_write()
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)
 
4425
        try:
 
4426
            if delete:
 
4427
                branch.tags.delete_tag(tag_name)
 
4428
                self.outf.write('Deleted tag %s.\n' % tag_name)
5374
4429
            else:
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)
 
4430
                if revision:
 
4431
                    if len(revision) != 1:
 
4432
                        raise errors.BzrCommandError(
 
4433
                            "Tags can only be placed on a single revision, "
 
4434
                            "not on a range")
 
4435
                    revision_id = revision[0].as_revision_id(branch)
 
4436
                else:
 
4437
                    revision_id = branch.last_revision()
 
4438
                if (not force) and branch.tags.has_tag(tag_name):
 
4439
                    raise errors.TagAlreadyExists(tag_name)
 
4440
                branch.tags.set_tag(tag_name, revision_id)
 
4441
                self.outf.write('Created tag %s.\n' % tag_name)
 
4442
        finally:
 
4443
            branch.unlock()
5385
4444
 
5386
4445
 
5387
4446
class cmd_tags(Command):
5388
 
    __doc__ = """List tags.
 
4447
    """List tags.
5389
4448
 
5390
4449
    This command shows a table of tag names and the revisions they reference.
5391
4450
    """
5403
4462
            time='Sort tags chronologically.',
5404
4463
            ),
5405
4464
        'show-ids',
5406
 
        'revision',
5407
4465
    ]
5408
4466
 
5409
4467
    @display_command
5411
4469
            directory='.',
5412
4470
            sort='alpha',
5413
4471
            show_ids=False,
5414
 
            revision=None,
5415
4472
            ):
5416
4473
        branch, relpath = Branch.open_containing(directory)
5417
 
 
5418
4474
        tags = branch.tags.get_tag_dict().items()
5419
4475
        if not tags:
5420
4476
            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)]
5431
4477
        if sort == 'alpha':
5432
4478
            tags.sort()
5433
4479
        elif sort == 'time':
5443
4489
            tags.sort(key=lambda x: timestamps[x[1]])
5444
4490
        if not show_ids:
5445
4491
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
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()
 
4492
            revno_map = branch.get_revision_id_to_revno_map()
 
4493
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4494
                        for tag, revid in tags ]
5457
4495
        for tag, revspec in tags:
5458
4496
            self.outf.write('%-20s %s\n' % (tag, revspec))
5459
4497
 
5460
4498
 
5461
4499
class cmd_reconfigure(Command):
5462
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
4500
    """Reconfigure the type of a bzr directory.
5463
4501
 
5464
4502
    A target configuration must be specified.
5465
4503
 
5474
4512
 
5475
4513
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5476
4514
    takes_args = ['location?']
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
 
        ]
 
4515
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4516
                     title='Target type',
 
4517
                     help='The type to reconfigure the directory to.',
 
4518
                     value_switches=True, enum_switch=False,
 
4519
                     branch='Reconfigure to be an unbound branch '
 
4520
                        'with no working tree.',
 
4521
                     tree='Reconfigure to be an unbound branch '
 
4522
                        'with a working tree.',
 
4523
                     checkout='Reconfigure to be a bound branch '
 
4524
                        'with a working tree.',
 
4525
                     lightweight_checkout='Reconfigure to be a lightweight'
 
4526
                     ' checkout (with no local history).',
 
4527
                     standalone='Reconfigure to be a standalone branch '
 
4528
                        '(i.e. stop using shared repository).',
 
4529
                     use_shared='Reconfigure to use a shared repository.'),
 
4530
                     Option('bind-to', help='Branch to bind checkout to.',
 
4531
                            type=str),
 
4532
                     Option('force',
 
4533
                        help='Perform reconfiguration even if local changes'
 
4534
                        ' will be lost.')
 
4535
                     ]
5509
4536
 
5510
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5511
 
            stacked_on=None,
5512
 
            unstacked=None):
 
4537
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5513
4538
        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.
5523
4539
        if target_type is None:
5524
 
            if stacked_on or unstacked:
5525
 
                return
5526
 
            else:
5527
 
                raise errors.BzrCommandError('No target configuration '
5528
 
                    'specified')
 
4540
            raise errors.BzrCommandError('No target configuration specified')
5529
4541
        elif target_type == 'branch':
5530
4542
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5531
4543
        elif target_type == 'tree':
5532
4544
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5533
4545
        elif target_type == 'checkout':
5534
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5535
 
                directory, bind_to)
 
4546
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4547
                                                                  bind_to)
5536
4548
        elif target_type == 'lightweight-checkout':
5537
4549
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5538
4550
                directory, bind_to)
5540
4552
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5541
4553
        elif target_type == 'standalone':
5542
4554
            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)
5549
4555
        reconfiguration.apply(force)
5550
4556
 
5551
4557
 
5552
4558
class cmd_switch(Command):
5553
 
    __doc__ = """Set the branch of a checkout and update.
5554
 
 
 
4559
    """Set the branch of a checkout and update.
 
4560
    
5555
4561
    For lightweight checkouts, this changes the branch being referenced.
5556
4562
    For heavyweight checkouts, this checks that there are no local commits
5557
4563
    versus the current bound branch, then it makes the local branch a mirror
5558
4564
    of the new location and binds to it.
5559
 
 
 
4565
    
5560
4566
    In both cases, the working tree is updated and uncommitted changes
5561
4567
    are merged. The user can commit or revert these as they desire.
5562
4568
 
5566
4572
    directory of the current branch. For example, if you are currently in a
5567
4573
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5568
4574
    /path/to/newbranch.
5569
 
 
5570
 
    Bound branches use the nickname of its master branch unless it is set
5571
 
    locally, in which case switching will update the local nickname to be
5572
 
    that of the master.
5573
4575
    """
5574
4576
 
5575
 
    takes_args = ['to_location?']
 
4577
    takes_args = ['to_location']
5576
4578
    takes_options = [Option('force',
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
 
                    ]
 
4579
                        help='Switch even if local commits will be lost.')
 
4580
                     ]
5583
4581
 
5584
 
    def run(self, to_location=None, force=False, create_branch=False,
5585
 
            revision=None):
 
4582
    def run(self, to_location, force=False):
5586
4583
        from bzrlib import switch
5587
4584
        tree_location = '.'
5588
 
        revision = _get_one_revision('switch', revision)
5589
4585
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
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 = '.'
5595
4586
        try:
5596
 
            branch = control_dir.open_branch()
5597
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
4587
            to_branch = Branch.open(to_location)
5598
4588
        except errors.NotBranchError:
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:
5625
 
            branch = control_dir.open_branch() #get the new branch!
5626
 
            branch.nick = to_branch.nick
5627
 
        note('Switched to branch: %s',
5628
 
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5629
 
 
5630
 
    def _get_branch_location(self, control_dir):
5631
 
        """Return location of branch for this control dir."""
5632
 
        try:
5633
4589
            this_branch = control_dir.open_branch()
5634
4590
            # 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
 
4591
            this_url = this_branch.get_bound_location()
5638
4592
            # 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))
 
4593
            if this_url is None:
 
4594
                this_url = this_branch.base
 
4595
            to_branch = Branch.open(
 
4596
                urlutils.join(this_url, '..', to_location))
 
4597
        switch.switch(control_dir, to_branch, force)
 
4598
        note('Switched to branch: %s',
 
4599
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5800
4600
 
5801
4601
 
5802
4602
class cmd_hooks(Command):
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
 
 
5834
 
    """
5835
 
 
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
 
        
5846
 
 
5847
 
class cmd_shelve(Command):
5848
 
    __doc__ = """Temporarily set aside some changes from the current tree.
5849
 
 
5850
 
    Shelve allows you to temporarily put changes you've made "on the shelf",
5851
 
    ie. out of the way, until a later time when you can bring them back from
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.
5855
 
 
5856
 
    If shelve --list is specified, previously-shelved changes are listed.
5857
 
 
5858
 
    Shelve is intended to help separate several sets of changes that have
5859
 
    been inappropriately mingled.  If you just want to get rid of all changes
5860
 
    and you don't need to restore them later, use revert.  If you want to
5861
 
    shelve all text changes at once, use shelve --all.
5862
 
 
5863
 
    If filenames are specified, only the changes to those files will be
5864
 
    shelved. Other files will be left untouched.
5865
 
 
5866
 
    If a revision is specified, changes since that revision will be shelved.
5867
 
 
5868
 
    You can put multiple items on the shelf, and by default, 'unshelve' will
5869
 
    restore the most recently shelved changes.
5870
 
    """
5871
 
 
5872
 
    takes_args = ['file*']
5873
 
 
5874
 
    takes_options = [
5875
 
        'revision',
5876
 
        Option('all', help='Shelve all changes.'),
5877
 
        'message',
5878
 
        RegistryOption('writer', 'Method to use for writing diffs.',
5879
 
                       bzrlib.option.diff_writer_registry,
5880
 
                       value_switches=True, enum_switch=False),
5881
 
 
5882
 
        Option('list', help='List shelved changes.'),
5883
 
        Option('destroy',
5884
 
               help='Destroy removed changes instead of shelving them.'),
5885
 
    ]
5886
 
    _see_also = ['unshelve']
5887
 
 
5888
 
    def run(self, revision=None, all=False, file_list=None, message=None,
5889
 
            writer=None, list=False, destroy=False):
5890
 
        if list:
5891
 
            return self.run_for_list()
5892
 
        from bzrlib.shelf_ui import Shelver
5893
 
        if writer is None:
5894
 
            writer = bzrlib.option.diff_writer_registry.get()
5895
 
        try:
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()
5902
 
        except errors.UserAbort:
5903
 
            return 0
5904
 
 
5905
 
    def run_for_list(self):
5906
 
        tree = WorkingTree.open_containing('.')[0]
5907
 
        tree.lock_read()
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
5920
 
 
5921
 
 
5922
 
class cmd_unshelve(Command):
5923
 
    __doc__ = """Restore shelved changes.
5924
 
 
5925
 
    By default, the most recently shelved changes are restored. However if you
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.
5928
 
    """
5929
 
 
5930
 
    takes_args = ['shelf_id?']
5931
 
    takes_options = [
5932
 
        RegistryOption.from_kwargs(
5933
 
            'action', help="The action to perform.",
5934
 
            enum_switch=False, value_switches=True,
5935
 
            apply="Apply changes and remove from the shelf.",
5936
 
            dry_run="Show changes, but do not apply or remove 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.",
5941
 
        )
5942
 
    ]
5943
 
    _see_also = ['shelve']
5944
 
 
5945
 
    def run(self, shelf_id=None, action='apply'):
5946
 
        from bzrlib.shelf_ui import Unshelver
5947
 
        unshelver = Unshelver.from_args(shelf_id, action)
5948
 
        try:
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()
 
4603
    """Show a branch's currently registered hooks.
 
4604
    """
 
4605
 
 
4606
    hidden = True
 
4607
    takes_args = ['path?']
 
4608
 
 
4609
    def run(self, path=None):
6010
4610
        if path is None:
6011
 
            info = branch._get_all_reference_info().iteritems()
6012
 
            self._display_reference_info(tree, branch, info)
 
4611
            path = '.'
 
4612
        branch_hooks = Branch.open(path).hooks
 
4613
        for hook_type in branch_hooks:
 
4614
            hooks = branch_hooks[hook_type]
 
4615
            self.outf.write("%s:\n" % (hook_type,))
 
4616
            if hooks:
 
4617
                for hook in hooks:
 
4618
                    self.outf.write("  %s\n" %
 
4619
                                    (branch_hooks.get_hook_name(hook),))
 
4620
            else:
 
4621
                self.outf.write("  <no hooks installed>\n")
 
4622
 
 
4623
 
 
4624
def _create_prefix(cur_transport):
 
4625
    needed = [cur_transport]
 
4626
    # Recurse upwards until we can create a directory successfully
 
4627
    while True:
 
4628
        new_transport = cur_transport.clone('..')
 
4629
        if new_transport.base == cur_transport.base:
 
4630
            raise errors.BzrCommandError(
 
4631
                "Failed to create path prefix for %s."
 
4632
                % cur_transport.base)
 
4633
        try:
 
4634
            new_transport.mkdir('.')
 
4635
        except errors.NoSuchFile:
 
4636
            needed.append(new_transport)
 
4637
            cur_transport = new_transport
6013
4638
        else:
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)
 
4639
            break
 
4640
    # Now we only need to create child directories
 
4641
    while needed:
 
4642
        cur_transport = needed.pop()
 
4643
        cur_transport.ensure_base()
 
4644
 
 
4645
 
 
4646
# these get imported and then picked up by the scan for cmd_*
 
4647
# TODO: Some more consistent way to split command definitions across files;
 
4648
# we do need to load at least some information about them to know of 
 
4649
# aliases.  ideally we would avoid loading the implementation until the
 
4650
# details were needed.
 
4651
from bzrlib.cmd_version_info import cmd_version_info
 
4652
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4653
from bzrlib.bundle.commands import (
 
4654
    cmd_bundle_info,
 
4655
    )
 
4656
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4657
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
4658
        cmd_weave_plan_merge, cmd_weave_merge_text