/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-26 05:14:51 UTC
  • mfrom: (3737.1.3 trivial_python_compat)
  • Revision ID: pqm@pqm.ubuntu.com-20080926051451-dvc1qg5inn7msjvr
(jam) Some win32 tweaks for the faster iter_changes code.

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