/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-10 05:17:09 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070810051709-0rnxlur94samh192
move most existing topics into the User Guide dir for English

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