/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: Ian Clatworthy
  • Date: 2007-11-14 03:50:56 UTC
  • mto: (3054.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 3055.
  • Revision ID: ian.clatworthy@internode.on.net-20071114035056-72l6odzpby4bcmub
First cut at new look User Guide including chapters 1 and 2

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