← 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-20 03:20:20 UTC
  • mfrom: (2592 +trunk)
  • mto: This revision was merged to the branch mainline in revision 2635.
  • Revision ID: robertc@robertcollins.net-20070720032020-xiftpb5gqeebo861
(robertc) Reinstate the accidentally backed out external_url patch.

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