← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

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