/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2007-10-26 08:56:09 UTC
  • mfrom: (2592.3.247 mbp-writegroups)
  • Revision ID: pqm@pqm.ubuntu.com-20071026085609-c3r8skfrmjj21j0m
Unlock while in a write group now aborts the write group, unlocks, and errors.  Also includes the knit extraction one-liner tweak.

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