← 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: 2007-07-13 16:35:54 UTC
  • mto: (2592.3.3 repository)
  • mto: This revision was merged to the branch mainline in revision 2624.
  • Revision ID: robertc@robertcollins.net-20070713163554-ok2qtnzv6rcbpt3z
Change the missing key interface in index operations to not raise, allowing callers to set policy.

Show diffs side-by-side

added added

removed removed

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