/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: Robert Collins
  • Date: 2010-05-11 08:44:59 UTC
  • mfrom: (5221 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511084459-pb0uinna9zs3wu59
Merge trunk - resolve conflicts.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
 
1
# Copyright (C) 2005-2010 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
19
19
import os
20
 
from StringIO import StringIO
21
20
 
22
21
from bzrlib.lazy_import import lazy_import
23
22
lazy_import(globals(), """
24
23
import codecs
 
24
import cStringIO
25
25
import sys
26
26
import time
27
27
 
29
29
from bzrlib import (
30
30
    bugtracker,
31
31
    bundle,
 
32
    btree_index,
32
33
    bzrdir,
 
34
    directory_service,
33
35
    delta,
34
36
    config,
35
37
    errors,
36
38
    globbing,
37
 
    ignores,
 
39
    hooks,
38
40
    log,
39
41
    merge as _mod_merge,
40
42
    merge_directive,
41
43
    osutils,
42
44
    reconfigure,
 
45
    rename_map,
43
46
    revision as _mod_revision,
 
47
    static_tuple,
44
48
    symbol_versioning,
 
49
    timestamp,
45
50
    transport,
46
 
    tree as _mod_tree,
47
51
    ui,
48
52
    urlutils,
 
53
    views,
49
54
    )
50
55
from bzrlib.branch import Branch
51
56
from bzrlib.conflicts import ConflictList
52
 
from bzrlib.revisionspec import RevisionSpec
 
57
from bzrlib.transport import memory
 
58
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
53
59
from bzrlib.smtp_connection import SMTPConnection
54
60
from bzrlib.workingtree import WorkingTree
55
61
""")
56
62
 
57
 
from bzrlib.commands import Command, display_command
58
 
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
59
 
from bzrlib.trace import mutter, note, warning, is_quiet, info
60
 
 
61
 
 
62
 
def tree_files(file_list, default_branch=u'.'):
 
63
from bzrlib.commands import (
 
64
    Command,
 
65
    builtin_command_registry,
 
66
    display_command,
 
67
    )
 
68
from bzrlib.option import (
 
69
    ListOption,
 
70
    Option,
 
71
    RegistryOption,
 
72
    custom_help,
 
73
    _parse_revision_str,
 
74
    )
 
75
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
 
76
 
 
77
 
 
78
def tree_files(file_list, default_branch=u'.', canonicalize=True,
 
79
    apply_view=True):
63
80
    try:
64
 
        return internal_tree_files(file_list, default_branch)
 
81
        return internal_tree_files(file_list, default_branch, canonicalize,
 
82
            apply_view)
65
83
    except errors.FileInWrongBranch, e:
66
84
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
67
85
                                     (e.path, file_list[0]))
68
86
 
69
87
 
 
88
def tree_files_for_add(file_list):
 
89
    """
 
90
    Return a tree and list of absolute paths from a file list.
 
91
 
 
92
    Similar to tree_files, but add handles files a bit differently, so it a
 
93
    custom implementation.  In particular, MutableTreeTree.smart_add expects
 
94
    absolute paths, which it immediately converts to relative paths.
 
95
    """
 
96
    # FIXME Would be nice to just return the relative paths like
 
97
    # internal_tree_files does, but there are a large number of unit tests
 
98
    # that assume the current interface to mutabletree.smart_add
 
99
    if file_list:
 
100
        tree, relpath = WorkingTree.open_containing(file_list[0])
 
101
        if tree.supports_views():
 
102
            view_files = tree.views.lookup_view()
 
103
            if view_files:
 
104
                for filename in file_list:
 
105
                    if not osutils.is_inside_any(view_files, filename):
 
106
                        raise errors.FileOutsideView(filename, view_files)
 
107
        file_list = file_list[:]
 
108
        file_list[0] = tree.abspath(relpath)
 
109
    else:
 
110
        tree = WorkingTree.open_containing(u'.')[0]
 
111
        if tree.supports_views():
 
112
            view_files = tree.views.lookup_view()
 
113
            if view_files:
 
114
                file_list = view_files
 
115
                view_str = views.view_display_str(view_files)
 
116
                note("Ignoring files outside view. View is %s" % view_str)
 
117
    return tree, file_list
 
118
 
 
119
 
 
120
def _get_one_revision(command_name, revisions):
 
121
    if revisions is None:
 
122
        return None
 
123
    if len(revisions) != 1:
 
124
        raise errors.BzrCommandError(
 
125
            'bzr %s --revision takes exactly one revision identifier' % (
 
126
                command_name,))
 
127
    return revisions[0]
 
128
 
 
129
 
 
130
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
 
131
    """Get a revision tree. Not suitable for commands that change the tree.
 
132
    
 
133
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
 
134
    and doing a commit/uncommit/pull will at best fail due to changing the
 
135
    basis revision data.
 
136
 
 
137
    If tree is passed in, it should be already locked, for lifetime management
 
138
    of the trees internal cached state.
 
139
    """
 
140
    if branch is None:
 
141
        branch = tree.branch
 
142
    if revisions is None:
 
143
        if tree is not None:
 
144
            rev_tree = tree.basis_tree()
 
145
        else:
 
146
            rev_tree = branch.basis_tree()
 
147
    else:
 
148
        revision = _get_one_revision(command_name, revisions)
 
149
        rev_tree = revision.as_tree(branch)
 
150
    return rev_tree
 
151
 
 
152
 
70
153
# XXX: Bad function name; should possibly also be a class method of
71
154
# WorkingTree rather than a function.
72
 
def internal_tree_files(file_list, default_branch=u'.'):
 
155
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
 
156
    apply_view=True):
73
157
    """Convert command-line paths to a WorkingTree and relative paths.
74
158
 
75
159
    This is typically used for command-line processors that take one or
77
161
 
78
162
    The filenames given are not required to exist.
79
163
 
80
 
    :param file_list: Filenames to convert.  
 
164
    :param file_list: Filenames to convert.
81
165
 
82
166
    :param default_branch: Fallback tree path to use if file_list is empty or
83
167
        None.
84
168
 
 
169
    :param apply_view: if True and a view is set, apply it or check that
 
170
        specified files are within it
 
171
 
85
172
    :return: workingtree, [relative_paths]
86
173
    """
87
174
    if file_list is None or len(file_list) == 0:
88
 
        return WorkingTree.open_containing(default_branch)[0], file_list
 
175
        tree = WorkingTree.open_containing(default_branch)[0]
 
176
        if tree.supports_views() and apply_view:
 
177
            view_files = tree.views.lookup_view()
 
178
            if view_files:
 
179
                file_list = view_files
 
180
                view_str = views.view_display_str(view_files)
 
181
                note("Ignoring files outside view. View is %s" % view_str)
 
182
        return tree, file_list
89
183
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
184
    return tree, safe_relpath_files(tree, file_list, canonicalize,
 
185
        apply_view=apply_view)
 
186
 
 
187
 
 
188
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
 
189
    """Convert file_list into a list of relpaths in tree.
 
190
 
 
191
    :param tree: A tree to operate on.
 
192
    :param file_list: A list of user provided paths or None.
 
193
    :param apply_view: if True and a view is set, apply it or check that
 
194
        specified files are within it
 
195
    :return: A list of relative paths.
 
196
    :raises errors.PathNotChild: When a provided path is in a different tree
 
197
        than tree.
 
198
    """
 
199
    if file_list is None:
 
200
        return None
 
201
    if tree.supports_views() and apply_view:
 
202
        view_files = tree.views.lookup_view()
 
203
    else:
 
204
        view_files = []
90
205
    new_list = []
 
206
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
 
207
    # doesn't - fix that up here before we enter the loop.
 
208
    if canonicalize:
 
209
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
 
210
    else:
 
211
        fixer = tree.relpath
91
212
    for filename in file_list:
92
213
        try:
93
 
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
214
            relpath = fixer(osutils.dereference_path(filename))
 
215
            if  view_files and not osutils.is_inside_any(view_files, relpath):
 
216
                raise errors.FileOutsideView(filename, view_files)
 
217
            new_list.append(relpath)
94
218
        except errors.PathNotChild:
95
219
            raise errors.FileInWrongBranch(tree.branch, filename)
96
 
    return tree, new_list
97
 
 
98
 
 
99
 
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
100
 
def get_format_type(typestring):
101
 
    """Parse and return a format specifier."""
102
 
    # Have to use BzrDirMetaFormat1 directly, so that
103
 
    # RepositoryFormat.set_default_format works
104
 
    if typestring == "default":
105
 
        return bzrdir.BzrDirMetaFormat1()
 
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
106
226
    try:
107
 
        return bzrdir.format_registry.make_bzrdir(typestring)
108
 
    except KeyError:
109
 
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
110
 
        raise errors.BzrCommandError(msg)
 
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)
111
241
 
112
242
 
113
243
# TODO: Make sure no commands unconditionally use the working directory as a
117
247
# opens the branch?)
118
248
 
119
249
class cmd_status(Command):
120
 
    """Display status summary.
 
250
    __doc__ = """Display status summary.
121
251
 
122
252
    This reports on versioned and unknown files, reporting them
123
253
    grouped by state.  Possible states are:
143
273
    unknown
144
274
        Not versioned and not matching an ignore pattern.
145
275
 
 
276
    Additionally for directories, symlinks and files with an executable
 
277
    bit, Bazaar indicates their type using a trailing character: '/', '@'
 
278
    or '*' respectively.
 
279
 
146
280
    To see ignored files use 'bzr ignored'.  For details on the
147
281
    changes to file texts, use 'bzr diff'.
148
 
    
 
282
 
149
283
    Note that --short or -S gives status flags for each item, similar
150
284
    to Subversion's status command. To get output similar to svn -q,
151
 
    use bzr -SV.
 
285
    use bzr status -SV.
152
286
 
153
287
    If no arguments are specified, the status of the entire working
154
288
    directory is shown.  Otherwise, only the status of the specified
155
289
    files or directories is reported.  If a directory is given, status
156
290
    is reported for everything inside that directory.
157
291
 
 
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
 
158
297
    If a revision argument is given, the status is calculated against
159
298
    that revision, or between two revisions if two are provided.
160
299
    """
161
 
    
 
300
 
162
301
    # TODO: --no-recurse, --recurse options
163
 
    
 
302
 
164
303
    takes_args = ['file*']
165
 
    takes_options = ['show-ids', 'revision', 'change',
 
304
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
166
305
                     Option('short', help='Use short status indicators.',
167
306
                            short_name='S'),
168
307
                     Option('versioned', help='Only show versioned files.',
169
 
                            short_name='V')
 
308
                            short_name='V'),
 
309
                     Option('no-pending', help='Don\'t show pending merges.',
 
310
                           ),
170
311
                     ]
171
312
    aliases = ['st', 'stat']
172
313
 
173
314
    encoding_type = 'replace'
174
315
    _see_also = ['diff', 'revert', 'status-flags']
175
 
    
 
316
 
176
317
    @display_command
177
318
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
178
 
            versioned=False):
 
319
            versioned=False, no_pending=False, verbose=False):
179
320
        from bzrlib.status import show_tree_status
180
321
 
181
322
        if revision and len(revision) > 2:
182
323
            raise errors.BzrCommandError('bzr status --revision takes exactly'
183
324
                                         ' one or two revision specifiers')
184
325
 
185
 
        tree, file_list = tree_files(file_list)
186
 
            
 
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
187
336
        show_tree_status(tree, show_ids=show_ids,
188
 
                         specific_files=file_list, revision=revision,
189
 
                         to_file=self.outf, short=short, versioned=versioned)
 
337
                         specific_files=relfile_list, revision=revision,
 
338
                         to_file=self.outf, short=short, versioned=versioned,
 
339
                         show_pending=(not no_pending), verbose=verbose)
190
340
 
191
341
 
192
342
class cmd_cat_revision(Command):
193
 
    """Write out metadata for a revision.
194
 
    
 
343
    __doc__ = """Write out metadata for a revision.
 
344
 
195
345
    The revision to print can either be specified by a specific
196
346
    revision identifier, or you can use --revision.
197
347
    """
198
348
 
199
349
    hidden = True
200
350
    takes_args = ['revision_id?']
201
 
    takes_options = ['revision']
 
351
    takes_options = ['directory', 'revision']
202
352
    # cat-revision is more for frontends so should be exact
203
353
    encoding = 'strict'
204
 
    
 
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
 
205
363
    @display_command
206
 
    def run(self, revision_id=None, revision=None):
 
364
    def run(self, revision_id=None, revision=None, directory=u'.'):
207
365
        if revision_id is not None and revision is not None:
208
366
            raise errors.BzrCommandError('You can only supply one of'
209
367
                                         ' revision_id or --revision')
210
368
        if revision_id is None and revision is None:
211
369
            raise errors.BzrCommandError('You must supply either'
212
370
                                         ' --revision or a revision_id')
213
 
        b = WorkingTree.open_containing(u'.')[0].branch
214
 
 
215
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
216
 
        if revision_id is not None:
217
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
218
 
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
219
 
        elif revision is not None:
220
 
            for rev in revision:
221
 
                if rev is None:
222
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
223
 
                                                 ' revision.')
224
 
                revno, rev_id = rev.in_history(b)
225
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
226
 
    
 
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
 
227
480
 
228
481
class cmd_remove_tree(Command):
229
 
    """Remove the working tree from a given branch/checkout.
 
482
    __doc__ = """Remove the working tree from a given branch/checkout.
230
483
 
231
484
    Since a lightweight checkout is little more than a working tree
232
485
    this will refuse to run against one.
234
487
    To re-create the working tree, use "bzr checkout".
235
488
    """
236
489
    _see_also = ['checkout', 'working-trees']
237
 
 
238
 
    takes_args = ['location?']
239
 
 
240
 
    def run(self, location='.'):
241
 
        d = bzrdir.BzrDir.open(location)
242
 
        
243
 
        try:
244
 
            working = d.open_workingtree()
245
 
        except errors.NoWorkingTree:
246
 
            raise errors.BzrCommandError("No working tree to remove")
247
 
        except errors.NotLocalUrl:
248
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
249
 
                                         "remote path")
250
 
        
251
 
        working_path = working.bzrdir.root_transport.base
252
 
        branch_path = working.branch.bzrdir.root_transport.base
253
 
        if working_path != branch_path:
254
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
255
 
                                         "a lightweight checkout")
256
 
        
257
 
        d.destroy_workingtree()
258
 
        
 
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
 
259
521
 
260
522
class cmd_revno(Command):
261
 
    """Show current revision number.
 
523
    __doc__ = """Show current revision number.
262
524
 
263
525
    This is equal to the number of revisions on this branch.
264
526
    """
265
527
 
266
528
    _see_also = ['info']
267
529
    takes_args = ['location?']
 
530
    takes_options = [
 
531
        Option('tree', help='Show revno of working tree'),
 
532
        ]
268
533
 
269
534
    @display_command
270
 
    def run(self, location=u'.'):
271
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
272
 
        self.outf.write('\n')
 
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')
273
554
 
274
555
 
275
556
class cmd_revision_info(Command):
276
 
    """Show revision number and revision id for a given revision identifier.
 
557
    __doc__ = """Show revision number and revision id for a given revision identifier.
277
558
    """
278
559
    hidden = True
279
560
    takes_args = ['revision_info*']
280
 
    takes_options = ['revision']
 
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
        ]
281
568
 
282
569
    @display_command
283
 
    def run(self, revision=None, revision_info_list=[]):
 
570
    def run(self, revision=None, directory=u'.', tree=False,
 
571
            revision_info_list=[]):
284
572
 
285
 
        revs = []
 
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 = []
286
582
        if revision is not None:
287
 
            revs.extend(revision)
 
583
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
288
584
        if revision_info_list is not None:
289
 
            for rev in revision_info_list:
290
 
                revs.append(RevisionSpec.from_string(rev))
291
 
 
292
 
        b = Branch.open_containing(u'.')[0]
293
 
 
294
 
        if len(revs) == 0:
295
 
            revs.append(RevisionSpec.from_string('-1'))
296
 
 
297
 
        for rev in revs:
298
 
            revinfo = rev.in_history(b)
299
 
            if revinfo.revno is None:
300
 
                dotted_map = b.get_revision_id_to_revno_map()
301
 
                revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
302
 
                print '%s %s' % (revno, revinfo.rev_id)
 
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())
303
594
            else:
304
 
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
305
 
 
306
 
    
 
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
 
307
613
class cmd_add(Command):
308
 
    """Add specified files or directories.
 
614
    __doc__ = """Add specified files or directories.
309
615
 
310
616
    In non-recursive mode, all the named items are added, regardless
311
617
    of whether they were previously ignored.  A warning is given if
327
633
    you should never need to explicitly add a directory, they'll just
328
634
    get added when you add a file in the directory.
329
635
 
330
 
    --dry-run will show which files would be added, but not actually 
 
636
    --dry-run will show which files would be added, but not actually
331
637
    add them.
332
638
 
333
639
    --file-ids-from will try to use the file ids from the supplied path.
337
643
    branches that will be merged later (without showing the two different
338
644
    adds as a conflict). It is also useful when merging another project
339
645
    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.
340
649
    """
341
650
    takes_args = ['file*']
342
651
    takes_options = [
350
659
               help='Lookup file ids from this tree.'),
351
660
        ]
352
661
    encoding_type = 'replace'
353
 
    _see_also = ['remove']
 
662
    _see_also = ['remove', 'ignore']
354
663
 
355
664
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
356
665
            file_ids_from=None):
373
682
                should_print=(not is_quiet()))
374
683
 
375
684
        if base_tree:
376
 
            base_tree.lock_read()
377
 
        try:
378
 
            file_list = self._maybe_expand_globs(file_list)
379
 
            if file_list:
380
 
                tree = WorkingTree.open_containing(file_list[0])[0]
381
 
            else:
382
 
                tree = WorkingTree.open_containing(u'.')[0]
383
 
            added, ignored = tree.smart_add(file_list, not
384
 
                no_recurse, action=action, save=not dry_run)
385
 
        finally:
386
 
            if base_tree is not None:
387
 
                base_tree.unlock()
 
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()
388
690
        if len(ignored) > 0:
389
691
            if verbose:
390
692
                for glob in sorted(ignored.keys()):
391
693
                    for path in ignored[glob]:
392
 
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
694
                        self.outf.write("ignored %s matching \"%s\"\n"
393
695
                                        % (path, glob))
394
 
            else:
395
 
                match_len = 0
396
 
                for glob, paths in ignored.items():
397
 
                    match_len += len(paths)
398
 
                self.outf.write("ignored %d file(s).\n" % match_len)
399
 
            self.outf.write("If you wish to add some of these files,"
400
 
                            " please add them by name.\n")
401
696
 
402
697
 
403
698
class cmd_mkdir(Command):
404
 
    """Create a new versioned directory.
 
699
    __doc__ = """Create a new versioned directory.
405
700
 
406
701
    This is equivalent to creating the directory and then adding it.
407
702
    """
411
706
 
412
707
    def run(self, dir_list):
413
708
        for d in dir_list:
414
 
            os.mkdir(d)
415
709
            wt, dd = WorkingTree.open_containing(d)
416
 
            wt.add([dd])
417
 
            self.outf.write('added %s\n' % 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)
418
718
 
419
719
 
420
720
class cmd_relpath(Command):
421
 
    """Show path of a file relative to root"""
 
721
    __doc__ = """Show path of a file relative to root"""
422
722
 
423
723
    takes_args = ['filename']
424
724
    hidden = True
425
 
    
 
725
 
426
726
    @display_command
427
727
    def run(self, filename):
428
728
        # TODO: jam 20050106 Can relpath return a munged path if
433
733
 
434
734
 
435
735
class cmd_inventory(Command):
436
 
    """Show inventory of the current working copy or a revision.
 
736
    __doc__ = """Show inventory of the current working copy or a revision.
437
737
 
438
738
    It is possible to limit the output to a particular entry
439
739
    type using the --kind option.  For example: --kind file.
458
758
        if kind and kind not in ['file', 'directory', 'symlink']:
459
759
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
460
760
 
 
761
        revision = _get_one_revision('inventory', revision)
461
762
        work_tree, file_list = tree_files(file_list)
462
 
        work_tree.lock_read()
463
 
        try:
464
 
            if revision is not None:
465
 
                if len(revision) > 1:
466
 
                    raise errors.BzrCommandError(
467
 
                        'bzr inventory --revision takes exactly one revision'
468
 
                        ' identifier')
469
 
                revision_id = revision[0].in_history(work_tree.branch).rev_id
470
 
                tree = work_tree.branch.repository.revision_tree(revision_id)
471
 
 
472
 
                extra_trees = [work_tree]
473
 
                tree.lock_read()
474
 
            else:
475
 
                tree = work_tree
476
 
                extra_trees = []
477
 
 
478
 
            if file_list is not None:
479
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
480
 
                                          require_versioned=True)
481
 
                # find_ids_across_trees may include some paths that don't
482
 
                # exist in 'tree'.
483
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
484
 
                                 for file_id in file_ids if file_id in tree)
485
 
            else:
486
 
                entries = tree.inventory.entries()
487
 
        finally:
488
 
            tree.unlock()
489
 
            if tree is not work_tree:
490
 
                work_tree.unlock()
491
 
 
 
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()
492
784
        for path, entry in entries:
493
785
            if kind and kind != entry.kind:
494
786
                continue
500
792
 
501
793
 
502
794
class cmd_mv(Command):
503
 
    """Move or rename a file.
 
795
    __doc__ = """Move or rename a file.
504
796
 
505
797
    :Usage:
506
798
        bzr mv OLDNAME NEWNAME
523
815
    takes_args = ['names*']
524
816
    takes_options = [Option("after", help="Move only the bzr identifier"
525
817
        " 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.'),
526
820
        ]
527
821
    aliases = ['move', 'rename']
528
822
    encoding_type = 'replace'
529
823
 
530
 
    def run(self, names_list, after=False):
 
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.')
531
829
        if names_list is None:
532
830
            names_list = []
533
 
 
534
831
        if len(names_list) < 2:
535
832
            raise errors.BzrCommandError("missing file argument")
536
 
        tree, rel_names = tree_files(names_list)
537
 
        
538
 
        if os.path.isdir(names_list[-1]):
 
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:
539
869
            # move into existing directory
540
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
541
 
                self.outf.write("%s => %s\n" % pair)
 
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))
542
876
        else:
543
877
            if len(names_list) != 2:
544
878
                raise errors.BzrCommandError('to mv multiple files the'
545
879
                                             ' destination must be a versioned'
546
880
                                             ' directory')
547
 
            tree.rename_one(rel_names[0], rel_names[1], after=after)
548
 
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
549
 
            
550
 
    
 
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
 
551
929
class cmd_pull(Command):
552
 
    """Turn this branch into a mirror of another branch.
 
930
    __doc__ = """Turn this branch into a mirror of another branch.
553
931
 
554
 
    This command only works on branches that have not diverged.  Branches are
555
 
    considered diverged if the destination branch's most recent commit is one
556
 
    that has not been merged (directly or indirectly) into the parent.
 
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.
557
936
 
558
937
    If branches have diverged, you can use 'bzr merge' to integrate the changes
559
938
    from one into the other.  Once one branch has merged, the other should
560
939
    be able to pull it again.
561
940
 
562
 
    If you want to forget your local changes and just update your branch to
563
 
    match the remote one, use pull --overwrite.
 
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.
564
944
 
565
945
    If there is no default location set, the first pull will set it.  After
566
946
    that, you can omit the location to use the default.  To change the
567
947
    default, use --remember. The value will only be saved if the remote
568
948
    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.
569
953
    """
570
954
 
571
 
    _see_also = ['push', 'update', 'status-flags']
 
955
    _see_also = ['push', 'update', 'status-flags', 'send']
572
956
    takes_options = ['remember', 'overwrite', 'revision',
573
957
        custom_help('verbose',
574
958
            help='Show logs of pulled revisions.'),
575
 
        Option('directory',
 
959
        custom_help('directory',
576
960
            help='Branch to pull into, '
577
 
                 'rather than the one containing the working directory.',
578
 
            short_name='d',
579
 
            type=unicode,
 
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."
580
966
            ),
581
967
        ]
582
968
    takes_args = ['location?']
584
970
 
585
971
    def run(self, location=None, remember=False, overwrite=False,
586
972
            revision=None, verbose=False,
587
 
            directory=None):
 
973
            directory=None, local=False):
588
974
        # FIXME: too much stuff is in the command class
589
975
        revision_id = None
590
976
        mergeable = None
593
979
        try:
594
980
            tree_to = WorkingTree.open_containing(directory)[0]
595
981
            branch_to = tree_to.branch
 
982
            self.add_cleanup(tree_to.lock_write().unlock)
596
983
        except errors.NoWorkingTree:
597
984
            tree_to = None
598
985
            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()
599
990
 
600
991
        possible_transports = []
601
992
        if location is not None:
602
 
            mergeable, location_transport = _get_mergeable_helper(location)
603
 
            possible_transports.append(location_transport)
 
993
            try:
 
994
                mergeable = bundle.read_mergeable_from_url(location,
 
995
                    possible_transports=possible_transports)
 
996
            except errors.NotABundle:
 
997
                mergeable = None
604
998
 
605
999
        stored_loc = branch_to.get_parent()
606
1000
        if location is None:
610
1004
            else:
611
1005
                display_url = urlutils.unescape_for_display(stored_loc,
612
1006
                        self.outf.encoding)
613
 
                self.outf.write("Using saved location: %s\n" % display_url)
 
1007
                if not is_quiet():
 
1008
                    self.outf.write("Using saved parent location: %s\n" % display_url)
614
1009
                location = stored_loc
615
 
                location_transport = transport.get_transport(
616
 
                    location, possible_transports=possible_transports)
617
1010
 
 
1011
        revision = _get_one_revision('pull', revision)
618
1012
        if mergeable is not None:
619
1013
            if revision is not None:
620
1014
                raise errors.BzrCommandError(
624
1018
                mergeable.get_merge_request(branch_to.repository)
625
1019
            branch_from = branch_to
626
1020
        else:
627
 
            branch_from = Branch.open_from_transport(location_transport)
 
1021
            branch_from = Branch.open(location,
 
1022
                possible_transports=possible_transports)
 
1023
            self.add_cleanup(branch_from.lock_read().unlock)
628
1024
 
629
1025
            if branch_to.get_parent() is None or remember:
630
1026
                branch_to.set_parent(branch_from.base)
631
1027
 
632
1028
        if revision is not None:
633
 
            if len(revision) == 1:
634
 
                revision_id = revision[0].in_history(branch_from).rev_id
635
 
            else:
636
 
                raise errors.BzrCommandError(
637
 
                    'bzr pull --revision takes one value.')
 
1029
            revision_id = revision.as_revision_id(branch_from)
638
1030
 
639
 
        if verbose:
640
 
            old_rh = branch_to.revision_history()
641
1031
        if tree_to is not None:
 
1032
            view_info = _get_view_info_for_change_reporter(tree_to)
642
1033
            change_reporter = delta._ChangeReporter(
643
 
                unversioned_filter=tree_to.is_ignored)
644
 
            result = tree_to.pull(branch_from, overwrite, revision_id,
645
 
                                  change_reporter,
646
 
                                  possible_transports=possible_transports)
 
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)
647
1039
        else:
648
 
            result = branch_to.pull(branch_from, overwrite, revision_id)
 
1040
            result = branch_to.pull(
 
1041
                branch_from, overwrite, revision_id, local=local)
649
1042
 
650
1043
        result.report(self.outf)
651
 
        if verbose:
652
 
            new_rh = branch_to.revision_history()
653
 
            log.show_changed_revisions(branch_to, old_rh, new_rh,
654
 
                                       to_file=self.outf)
 
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)
655
1048
 
656
1049
 
657
1050
class cmd_push(Command):
658
 
    """Update a mirror of this branch.
659
 
    
 
1051
    __doc__ = """Update a mirror of this branch.
 
1052
 
660
1053
    The target branch will not have its working tree populated because this
661
1054
    is both expensive, and is not supported on remote file systems.
662
 
    
 
1055
 
663
1056
    Some smart servers or protocols *may* put the working tree in place in
664
1057
    the future.
665
1058
 
669
1062
 
670
1063
    If branches have diverged, you can use 'bzr push --overwrite' to replace
671
1064
    the other branch completely, discarding its unmerged changes.
672
 
    
 
1065
 
673
1066
    If you want to ensure you have the different changes in the other branch,
674
1067
    do a merge (see bzr help merge) from the other branch, and commit that.
675
1068
    After that you will be able to do a push without '--overwrite'.
681
1074
    """
682
1075
 
683
1076
    _see_also = ['pull', 'update', 'working-trees']
684
 
    takes_options = ['remember', 'overwrite', 'verbose',
 
1077
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
685
1078
        Option('create-prefix',
686
1079
               help='Create the path leading up to the branch '
687
1080
                    'if it does not already exist.'),
688
 
        Option('directory',
 
1081
        custom_help('directory',
689
1082
            help='Branch to push from, '
690
 
                 'rather than the one containing the working directory.',
691
 
            short_name='d',
692
 
            type=unicode,
693
 
            ),
 
1083
                 'rather than the one containing the working directory.'),
694
1084
        Option('use-existing-dir',
695
1085
               help='By default push will fail if the target'
696
1086
                    ' directory exists, but does not already'
697
1087
                    ' have a control directory.  This flag will'
698
1088
                    ' 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.'),
699
1100
        ]
700
1101
    takes_args = ['location?']
701
1102
    encoding_type = 'replace'
702
1103
 
703
1104
    def run(self, location=None, remember=False, overwrite=False,
704
 
            create_prefix=False, verbose=False,
705
 
            use_existing_dir=False,
706
 
            directory=None):
707
 
        # FIXME: Way too big!  Put this into a function called from the
708
 
        # command.
 
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
 
709
1110
        if directory is None:
710
1111
            directory = '.'
711
 
        br_from = Branch.open_containing(directory)[0]
712
 
        stored_loc = br_from.get_push_location()
 
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
713
1145
        if location is None:
 
1146
            stored_loc = br_from.get_push_location()
714
1147
            if stored_loc is None:
715
 
                raise errors.BzrCommandError("No push location known or specified.")
 
1148
                raise errors.BzrCommandError(
 
1149
                    "No push location known or specified.")
716
1150
            else:
717
1151
                display_url = urlutils.unescape_for_display(stored_loc,
718
1152
                        self.outf.encoding)
719
 
                self.outf.write("Using saved location: %s\n" % display_url)
 
1153
                self.outf.write("Using saved push location: %s\n" % display_url)
720
1154
                location = stored_loc
721
1155
 
722
 
        to_transport = transport.get_transport(location)
723
 
 
724
 
        br_to = repository_to = dir_to = None
725
 
        try:
726
 
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
727
 
        except errors.NotBranchError:
728
 
            pass # Didn't find anything
729
 
        else:
730
 
            # If we can open a branch, use its direct repository, otherwise see
731
 
            # if there is a repository without a branch.
732
 
            try:
733
 
                br_to = dir_to.open_branch()
734
 
            except errors.NotBranchError:
735
 
                # Didn't find a branch, can we find a repository?
736
 
                try:
737
 
                    repository_to = dir_to.find_repository()
738
 
                except errors.NoRepositoryPresent:
739
 
                    pass
740
 
            else:
741
 
                # Found a branch, so we must have found a repository
742
 
                repository_to = br_to.repository
743
 
        push_result = None
744
 
        if verbose:
745
 
            old_rh = []
746
 
        if dir_to is None:
747
 
            # The destination doesn't exist; create it.
748
 
            # XXX: Refactor the create_prefix/no_create_prefix code into a
749
 
            #      common helper function
750
 
            try:
751
 
                to_transport.mkdir('.')
752
 
            except errors.FileExists:
753
 
                if not use_existing_dir:
754
 
                    raise errors.BzrCommandError("Target directory %s"
755
 
                         " already exists, but does not have a valid .bzr"
756
 
                         " directory. Supply --use-existing-dir to push"
757
 
                         " there anyway." % location)
758
 
            except errors.NoSuchFile:
759
 
                if not create_prefix:
760
 
                    raise errors.BzrCommandError("Parent directory of %s"
761
 
                        " does not exist."
762
 
                        "\nYou may supply --create-prefix to create all"
763
 
                        " leading parent directories."
764
 
                        % location)
765
 
                _create_prefix(to_transport)
766
 
 
767
 
            # Now the target directory exists, but doesn't have a .bzr
768
 
            # directory. So we need to create it, along with any work to create
769
 
            # all of the dependent branches, etc.
770
 
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
771
 
                revision_id=br_from.last_revision())
772
 
            br_to = dir_to.open_branch()
773
 
            # TODO: Some more useful message about what was copied
774
 
            note('Created new branch.')
775
 
            # We successfully created the target, remember it
776
 
            if br_from.get_push_location() is None or remember:
777
 
                br_from.set_push_location(br_to.base)
778
 
        elif repository_to is None:
779
 
            # we have a bzrdir but no branch or repository
780
 
            # XXX: Figure out what to do other than complain.
781
 
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
782
 
                " directory, but not a branch or repository. This is an"
783
 
                " unsupported configuration. Please move the target directory"
784
 
                " out of the way and try again."
785
 
                % location)
786
 
        elif br_to is None:
787
 
            # We have a repository but no branch, copy the revisions, and then
788
 
            # create a branch.
789
 
            last_revision_id = br_from.last_revision()
790
 
            repository_to.fetch(br_from.repository,
791
 
                                revision_id=last_revision_id)
792
 
            br_to = br_from.clone(dir_to, revision_id=last_revision_id)
793
 
            note('Created new branch.')
794
 
            if br_from.get_push_location() is None or remember:
795
 
                br_from.set_push_location(br_to.base)
796
 
        else: # We have a valid to branch
797
 
            # We were able to connect to the remote location, so remember it
798
 
            # we don't need to successfully push because of possible divergence.
799
 
            if br_from.get_push_location() is None or remember:
800
 
                br_from.set_push_location(br_to.base)
801
 
            if verbose:
802
 
                old_rh = br_to.revision_history()
803
 
            try:
804
 
                try:
805
 
                    tree_to = dir_to.open_workingtree()
806
 
                except errors.NotLocalUrl:
807
 
                    warning("This transport does not update the working " 
808
 
                            "tree of: %s. See 'bzr help working-trees' for "
809
 
                            "more information." % br_to.base)
810
 
                    push_result = br_from.push(br_to, overwrite)
811
 
                except errors.NoWorkingTree:
812
 
                    push_result = br_from.push(br_to, overwrite)
813
 
                else:
814
 
                    tree_to.lock_write()
815
 
                    try:
816
 
                        push_result = br_from.push(tree_to.branch, overwrite)
817
 
                        tree_to.update()
818
 
                    finally:
819
 
                        tree_to.unlock()
820
 
            except errors.DivergedBranches:
821
 
                raise errors.BzrCommandError('These branches have diverged.'
822
 
                                        '  Try using "merge" and then "push".')
823
 
        if push_result is not None:
824
 
            push_result.report(self.outf)
825
 
        elif verbose:
826
 
            new_rh = br_to.revision_history()
827
 
            if old_rh != new_rh:
828
 
                # Something changed
829
 
                from bzrlib.log import show_changed_revisions
830
 
                show_changed_revisions(br_to, old_rh, new_rh,
831
 
                                       to_file=self.outf)
832
 
        else:
833
 
            # we probably did a clone rather than a push, so a message was
834
 
            # emitted above
835
 
            pass
 
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)
836
1160
 
837
1161
 
838
1162
class cmd_branch(Command):
839
 
    """Create a new copy of a branch.
 
1163
    __doc__ = """Create a new branch that is a copy of an existing branch.
840
1164
 
841
1165
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
842
1166
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
851
1175
 
852
1176
    _see_also = ['checkout']
853
1177
    takes_args = ['from_location', 'to_location?']
854
 
    takes_options = ['revision']
 
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
        ]
855
1199
    aliases = ['get', 'clone']
856
1200
 
857
 
    def run(self, from_location, to_location=None, revision=None):
 
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
858
1205
        from bzrlib.tag import _merge_tags_if_possible
859
 
        if revision is None:
860
 
            revision = [None]
861
 
        elif len(revision) > 1:
862
 
            raise errors.BzrCommandError(
863
 
                'bzr branch --revision takes exactly 1 revision value')
864
 
 
865
 
        br_from = Branch.open(from_location)
866
 
        br_from.lock_read()
867
 
        try:
868
 
            if len(revision) == 1 and revision[0] is not None:
869
 
                revision_id = revision[0].in_history(br_from)[1]
870
 
            else:
871
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
872
 
                # None or perhaps NULL_REVISION to mean copy nothing
873
 
                # RBC 20060209
874
 
                revision_id = br_from.last_revision()
875
 
            if to_location is None:
876
 
                to_location = urlutils.derive_to_location(from_location)
877
 
                name = None
878
 
            else:
879
 
                name = os.path.basename(to_location) + '\n'
880
 
 
881
 
            to_transport = transport.get_transport(to_location)
882
 
            try:
883
 
                to_transport.mkdir('.')
884
 
            except errors.FileExists:
885
 
                raise errors.BzrCommandError('Target directory "%s" already'
886
 
                                             ' exists.' % to_location)
887
 
            except errors.NoSuchFile:
888
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
889
 
                                             % to_location)
890
 
            try:
891
 
                # preserve whatever source format we have.
892
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
893
 
                                            possible_transports=[to_transport])
894
 
                branch = dir.open_branch()
895
 
            except errors.NoSuchRevision:
896
 
                to_transport.delete_tree('.')
897
 
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
898
 
                raise errors.BzrCommandError(msg)
899
 
            if name:
900
 
                branch.control_files.put_utf8('branch-name', name)
901
 
            _merge_tags_if_possible(br_from, branch)
 
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:
902
1260
            note('Branched %d revision(s).' % branch.revno())
903
 
        finally:
904
 
            br_from.unlock()
 
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'))
905
1272
 
906
1273
 
907
1274
class cmd_checkout(Command):
908
 
    """Create a new checkout of an existing branch.
 
1275
    __doc__ = """Create a new checkout of an existing branch.
909
1276
 
910
1277
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
911
1278
    the branch found in '.'. This is useful if you have removed the working tree
912
1279
    or if it was never created - i.e. if you pushed the branch to its current
913
1280
    location using SFTP.
914
 
    
 
1281
 
915
1282
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
916
1283
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
917
1284
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
935
1302
                                 "common operations like diff and status without "
936
1303
                                 "such access, and also support local commits."
937
1304
                            ),
 
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
                            ),
938
1310
                     ]
939
1311
    aliases = ['co']
940
1312
 
941
1313
    def run(self, branch_location=None, to_location=None, revision=None,
942
 
            lightweight=False):
943
 
        if revision is None:
944
 
            revision = [None]
945
 
        elif len(revision) > 1:
946
 
            raise errors.BzrCommandError(
947
 
                'bzr checkout --revision takes exactly 1 revision value')
 
1314
            lightweight=False, files_from=None, hardlink=False):
948
1315
        if branch_location is None:
949
1316
            branch_location = osutils.getcwd()
950
1317
            to_location = branch_location
951
 
        source = Branch.open(branch_location)
952
 
        if len(revision) == 1 and revision[0] is not None:
953
 
            revision_id = _mod_revision.ensure_null(
954
 
                revision[0].in_history(source)[1])
 
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)
955
1325
        else:
956
1326
            revision_id = None
957
1327
        if to_location is None:
958
1328
            to_location = urlutils.derive_to_location(branch_location)
959
 
        # if the source and to_location are the same, 
 
1329
        # if the source and to_location are the same,
960
1330
        # and there is no working tree,
961
1331
        # then reconstitute a branch
962
1332
        if (osutils.abspath(to_location) ==
966
1336
            except errors.NoWorkingTree:
967
1337
                source.bzrdir.create_workingtree(revision_id)
968
1338
                return
969
 
        source.create_checkout(to_location, revision_id, lightweight)
 
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)
970
1346
 
971
1347
 
972
1348
class cmd_renames(Command):
973
 
    """Show list of renamed files.
 
1349
    __doc__ = """Show list of renamed files.
974
1350
    """
975
1351
    # TODO: Option to show renames between two historical versions.
976
1352
 
981
1357
    @display_command
982
1358
    def run(self, dir=u'.'):
983
1359
        tree = WorkingTree.open_containing(dir)[0]
984
 
        tree.lock_read()
985
 
        try:
986
 
            new_inv = tree.inventory
987
 
            old_tree = tree.basis_tree()
988
 
            old_tree.lock_read()
989
 
            try:
990
 
                old_inv = old_tree.inventory
991
 
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
992
 
                renames.sort()
993
 
                for old_name, new_name in renames:
994
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
995
 
            finally:
996
 
                old_tree.unlock()
997
 
        finally:
998
 
            tree.unlock()
 
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))
999
1376
 
1000
1377
 
1001
1378
class cmd_update(Command):
1002
 
    """Update a tree to have the latest code committed to its branch.
1003
 
    
 
1379
    __doc__ = """Update a tree to have the latest code committed to its branch.
 
1380
 
1004
1381
    This will perform a merge into the working tree, and may generate
1005
 
    conflicts. If you have any local changes, you will still 
 
1382
    conflicts. If you have any local changes, you will still
1006
1383
    need to commit them after the update for the update to be complete.
1007
 
    
1008
 
    If you want to discard your local changes, you can just do a 
 
1384
 
 
1385
    If you want to discard your local changes, you can just do a
1009
1386
    '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.
1010
1390
    """
1011
1391
 
1012
1392
    _see_also = ['pull', 'working-trees', 'status-flags']
1013
1393
    takes_args = ['dir?']
 
1394
    takes_options = ['revision']
1014
1395
    aliases = ['up']
1015
1396
 
1016
 
    def run(self, dir='.'):
 
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")
1017
1401
        tree = WorkingTree.open_containing(dir)[0]
 
1402
        branch = tree.branch
1018
1403
        possible_transports = []
1019
 
        master = tree.branch.get_master_branch(
 
1404
        master = branch.get_master_branch(
1020
1405
            possible_transports=possible_transports)
1021
1406
        if master is not None:
 
1407
            branch_location = master.base
1022
1408
            tree.lock_write()
1023
1409
        else:
 
1410
            branch_location = tree.branch.base
1024
1411
            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)
1025
1438
        try:
1026
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1027
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1028
 
            if last_rev == _mod_revision.ensure_null(
1029
 
                tree.branch.last_revision()):
1030
 
                # may be up to date, check master too.
1031
 
                if master is None or last_rev == _mod_revision.ensure_null(
1032
 
                    master.last_revision()):
1033
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1034
 
                    note("Tree is up to date at revision %d." % (revno,))
1035
 
                    return 0
1036
1439
            conflicts = tree.update(
1037
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1038
 
                possible_transports=possible_transports)
1039
 
            revno = tree.branch.revision_id_to_revno(
1040
 
                _mod_revision.ensure_null(tree.last_revision()))
1041
 
            note('Updated to revision %d.' % (revno,))
1042
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1043
 
                note('Your local commits will now show as pending merges with '
1044
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1045
 
            if conflicts != 0:
1046
 
                return 1
1047
 
            else:
1048
 
                return 0
1049
 
        finally:
1050
 
            tree.unlock()
 
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
1051
1462
 
1052
1463
 
1053
1464
class cmd_info(Command):
1054
 
    """Show information about a working tree, branch or repository.
 
1465
    __doc__ = """Show information about a working tree, branch or repository.
1055
1466
 
1056
1467
    This command will show all known locations and formats associated to the
1057
 
    tree, branch or repository.  Statistical information is included with
1058
 
    each report.
 
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.
1059
1473
 
1060
1474
    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
1061
1491
    """
1062
1492
    _see_also = ['revno', 'working-trees', 'repositories']
1063
1493
    takes_args = ['location?']
1067
1497
    @display_command
1068
1498
    def run(self, location=None, verbose=False):
1069
1499
        if verbose:
1070
 
            noise_level = 2
 
1500
            noise_level = get_verbosity_level()
1071
1501
        else:
1072
1502
            noise_level = 0
1073
1503
        from bzrlib.info import show_bzrdir_info
1076
1506
 
1077
1507
 
1078
1508
class cmd_remove(Command):
1079
 
    """Remove files or directories.
1080
 
 
1081
 
    This makes bzr stop tracking changes to the specified files and
1082
 
    delete them if they can easily be recovered using revert.
1083
 
 
1084
 
    You can specify one or more files, and/or --new.  If you specify --new,
1085
 
    only 'added' files will be removed.  If you specify both, then new files
1086
 
    in the specified directories will be removed.  If the directories are
1087
 
    also new, they will also be removed.
 
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.
1088
1515
    """
1089
1516
    takes_args = ['file*']
1090
1517
    takes_options = ['verbose',
1091
 
        Option('new', help='Remove newly-added files.'),
 
1518
        Option('new', help='Only remove files that have never been committed.'),
1092
1519
        RegistryOption.from_kwargs('file-deletion-strategy',
1093
1520
            'The file deletion mode to be used.',
1094
1521
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1095
1522
            safe='Only delete files if they can be'
1096
1523
                 ' safely recovered (default).',
1097
 
            keep="Don't delete any files.",
 
1524
            keep='Delete from bzr but leave the working copy.',
1098
1525
            force='Delete all the specified files, even if they can not be '
1099
1526
                'recovered and even if they are non-empty directories.')]
1100
 
    aliases = ['rm']
 
1527
    aliases = ['rm', 'del']
1101
1528
    encoding_type = 'replace'
1102
1529
 
1103
1530
    def run(self, file_list, verbose=False, new=False,
1106
1533
 
1107
1534
        if file_list is not None:
1108
1535
            file_list = [f for f in file_list]
1109
 
        elif not new:
1110
 
            raise errors.BzrCommandError('Specify one or more files to'
1111
 
            ' remove, or use --new.')
1112
1536
 
 
1537
        self.add_cleanup(tree.lock_write().unlock)
 
1538
        # Heuristics should probably all move into tree.remove_smart or
 
1539
        # some such?
1113
1540
        if new:
1114
1541
            added = tree.changes_from(tree.basis_tree(),
1115
1542
                specific_files=file_list).added
1116
1543
            file_list = sorted([f[0] for f in added], reverse=True)
1117
1544
            if len(file_list) == 0:
1118
1545
                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'
1119
1556
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1120
1557
            keep_files=file_deletion_strategy=='keep',
1121
1558
            force=file_deletion_strategy=='force')
1122
1559
 
1123
1560
 
1124
1561
class cmd_file_id(Command):
1125
 
    """Print file_id of a particular file or directory.
 
1562
    __doc__ = """Print file_id of a particular file or directory.
1126
1563
 
1127
1564
    The file_id is assigned when the file is first added and remains the
1128
1565
    same through all revisions where the file exists, even when it is
1144
1581
 
1145
1582
 
1146
1583
class cmd_file_path(Command):
1147
 
    """Print path of file_ids to a file or directory.
 
1584
    __doc__ = """Print path of file_ids to a file or directory.
1148
1585
 
1149
1586
    This prints one line for each directory down to the target,
1150
1587
    starting at the branch root.
1166
1603
 
1167
1604
 
1168
1605
class cmd_reconcile(Command):
1169
 
    """Reconcile bzr metadata in a branch.
 
1606
    __doc__ = """Reconcile bzr metadata in a branch.
1170
1607
 
1171
1608
    This can correct data mismatches that may have been caused by
1172
1609
    previous ghost operations or bzr upgrades. You should only
1173
 
    need to run this command if 'bzr check' or a bzr developer 
 
1610
    need to run this command if 'bzr check' or a bzr developer
1174
1611
    advises you to run it.
1175
1612
 
1176
1613
    If a second branch is provided, cross-branch reconciliation is
1178
1615
    id which was not present in very early bzr versions is represented
1179
1616
    correctly in both branches.
1180
1617
 
1181
 
    At the same time it is run it may recompress data resulting in 
 
1618
    At the same time it is run it may recompress data resulting in
1182
1619
    a potential saving in disk space or performance gain.
1183
1620
 
1184
1621
    The branch *MUST* be on a listable system such as local disk or sftp.
1194
1631
 
1195
1632
 
1196
1633
class cmd_revision_history(Command):
1197
 
    """Display the list of revision ids on a branch."""
 
1634
    __doc__ = """Display the list of revision ids on a branch."""
1198
1635
 
1199
1636
    _see_also = ['log']
1200
1637
    takes_args = ['location?']
1210
1647
 
1211
1648
 
1212
1649
class cmd_ancestry(Command):
1213
 
    """List all revisions merged into this branch."""
 
1650
    __doc__ = """List all revisions merged into this branch."""
1214
1651
 
1215
1652
    _see_also = ['log', 'revision-history']
1216
1653
    takes_args = ['location?']
1229
1666
            last_revision = wt.last_revision()
1230
1667
 
1231
1668
        revision_ids = b.repository.get_ancestry(last_revision)
1232
 
        assert revision_ids[0] is None
1233
1669
        revision_ids.pop(0)
1234
1670
        for revision_id in revision_ids:
1235
1671
            self.outf.write(revision_id + '\n')
1236
1672
 
1237
1673
 
1238
1674
class cmd_init(Command):
1239
 
    """Make a directory into a versioned branch.
 
1675
    __doc__ = """Make a directory into a versioned branch.
1240
1676
 
1241
1677
    Use this to create an empty branch, or before importing an
1242
1678
    existing project.
1243
1679
 
1244
 
    If there is a repository in a parent directory of the location, then 
 
1680
    If there is a repository in a parent directory of the location, then
1245
1681
    the history of the branch will be stored in the repository.  Otherwise
1246
1682
    init creates a standalone branch which carries its own history
1247
1683
    in the .bzr directory.
1255
1691
        bzr init
1256
1692
        bzr add .
1257
1693
        bzr status
1258
 
        bzr commit -m 'imported project'
 
1694
        bzr commit -m "imported project"
1259
1695
    """
1260
1696
 
1261
1697
    _see_also = ['init-repository', 'branch', 'checkout']
1267
1703
         RegistryOption('format',
1268
1704
                help='Specify a format for this branch. '
1269
1705
                'See "help formats".',
1270
 
                registry=bzrdir.format_registry,
1271
 
                converter=bzrdir.format_registry.make_bzrdir,
 
1706
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1707
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1272
1708
                value_switches=True,
1273
 
                title="Branch Format",
 
1709
                title="Branch format",
1274
1710
                ),
1275
1711
         Option('append-revisions-only',
1276
1712
                help='Never change revnos or the existing log.'
1299
1735
                    "\nYou may supply --create-prefix to create all"
1300
1736
                    " leading parent directories."
1301
1737
                    % location)
1302
 
            _create_prefix(to_transport)
 
1738
            to_transport.create_prefix()
1303
1739
 
1304
1740
        try:
1305
 
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1741
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1306
1742
        except errors.NotBranchError:
1307
1743
            # really a NotBzrDir error...
1308
1744
            create_branch = bzrdir.BzrDir.create_branch_convenience
1309
1745
            branch = create_branch(to_transport.base, format=format,
1310
1746
                                   possible_transports=[to_transport])
 
1747
            a_bzrdir = branch.bzrdir
1311
1748
        else:
1312
1749
            from bzrlib.transport.local import LocalTransport
1313
 
            if existing_bzrdir.has_branch():
 
1750
            if a_bzrdir.has_branch():
1314
1751
                if (isinstance(to_transport, LocalTransport)
1315
 
                    and not existing_bzrdir.has_workingtree()):
 
1752
                    and not a_bzrdir.has_workingtree()):
1316
1753
                        raise errors.BranchExistsWithoutWorkingTree(location)
1317
1754
                raise errors.AlreadyBranchError(location)
1318
 
            else:
1319
 
                branch = existing_bzrdir.create_branch()
1320
 
                existing_bzrdir.create_workingtree()
 
1755
            branch = a_bzrdir.create_branch()
 
1756
            a_bzrdir.create_workingtree()
1321
1757
        if append_revisions_only:
1322
1758
            try:
1323
1759
                branch.set_append_revisions_only(True)
1324
1760
            except errors.UpgradeRequired:
1325
1761
                raise errors.BzrCommandError('This branch format cannot be set'
1326
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
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)
1327
1781
 
1328
1782
 
1329
1783
class cmd_init_repository(Command):
1330
 
    """Create a shared repository to hold branches.
 
1784
    __doc__ = """Create a shared repository for branches to share storage space.
1331
1785
 
1332
1786
    New branches created under the repository directory will store their
1333
 
    revisions in the repository, not in the branch directory.
 
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.
1334
1790
 
1335
 
    If the --no-trees option is used then the branches in the repository
1336
 
    will not have working trees by default.
 
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.
1337
1797
 
1338
1798
    :Examples:
1339
 
        Create a shared repositories holding just branches::
 
1799
        Create a shared repository holding just branches::
1340
1800
 
1341
1801
            bzr init-repo --no-trees repo
1342
1802
            bzr init repo/trunk
1353
1813
    takes_options = [RegistryOption('format',
1354
1814
                            help='Specify a format for this repository. See'
1355
1815
                                 ' "bzr help formats" for details.',
1356
 
                            registry=bzrdir.format_registry,
1357
 
                            converter=bzrdir.format_registry.make_bzrdir,
 
1816
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
1817
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
1358
1818
                            value_switches=True, title='Repository format'),
1359
1819
                     Option('no-trees',
1360
1820
                             help='Branches in the repository will default to'
1375
1835
        newdir = format.initialize_on_transport(to_transport)
1376
1836
        repo = newdir.create_repository(shared=True)
1377
1837
        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)
1378
1841
 
1379
1842
 
1380
1843
class cmd_diff(Command):
1381
 
    """Show differences in the working tree or between revisions.
1382
 
    
1383
 
    If files are listed, only the changes in those files are listed.
1384
 
    Otherwise, all changes for the tree are listed.
 
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.
1385
1852
 
1386
1853
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1387
1854
    produces patches suitable for "patch -p1".
1401
1868
 
1402
1869
            bzr diff -r1
1403
1870
 
1404
 
        Difference between revision 2 and revision 1::
1405
 
 
1406
 
            bzr diff -r1..2
 
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
1407
1908
 
1408
1909
        Same as 'bzr diff' but prefix paths with old/ and new/::
1409
1910
 
1410
1911
            bzr diff --prefix old/:new/
1411
 
 
1412
 
        Show the differences between the two working trees::
1413
 
 
1414
 
            bzr diff bzr.mine bzr.dev
1415
 
 
1416
 
        Show just the differences for 'foo.c'::
1417
 
 
1418
 
            bzr diff foo.c
1419
1912
    """
1420
 
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
1421
 
    #       or a graphical diff.
1422
 
 
1423
 
    # TODO: Python difflib is not exactly the same as unidiff; should
1424
 
    #       either fix it up or prefer to use an external diff.
1425
 
 
1426
 
    # TODO: Selected-file diff is inefficient and doesn't show you
1427
 
    #       deleted files.
1428
 
 
1429
 
    # TODO: This probably handles non-Unix newlines poorly.
1430
 
 
1431
1913
    _see_also = ['status']
1432
1914
    takes_args = ['file*']
1433
1915
    takes_options = [
1437
1919
               short_name='p',
1438
1920
               help='Set prefixes added to old and new filenames, as '
1439
1921
                    '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
            ),
1440
1930
        'revision',
1441
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'),
1442
1940
        ]
1443
1941
    aliases = ['di', 'dif']
1444
1942
    encoding_type = 'exact'
1445
1943
 
1446
1944
    @display_command
1447
1945
    def run(self, revision=None, file_list=None, diff_options=None,
1448
 
            prefix=None):
1449
 
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
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)
1450
1949
 
1451
1950
        if (prefix is None) or (prefix == '0'):
1452
1951
            # diff -p0 format
1466
1965
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1467
1966
                                         ' one or two revision specifiers')
1468
1967
 
1469
 
        try:
1470
 
            tree1, file_list = internal_tree_files(file_list)
1471
 
            tree2 = None
1472
 
            b = None
1473
 
            b2 = None
1474
 
        except errors.FileInWrongBranch:
1475
 
            if len(file_list) != 2:
1476
 
                raise errors.BzrCommandError("Files are in different branches")
1477
 
 
1478
 
            tree1, file1 = WorkingTree.open_containing(file_list[0])
1479
 
            tree2, file2 = WorkingTree.open_containing(file_list[1])
1480
 
            if file1 != "" or file2 != "":
1481
 
                # FIXME diff those two files. rbc 20051123
1482
 
                raise errors.BzrCommandError("Files are in different branches")
1483
 
            file_list = None
1484
 
        except errors.NotBranchError:
1485
 
            if (revision is not None and len(revision) == 2
1486
 
                and not revision[0].needs_branch()
1487
 
                and not revision[1].needs_branch()):
1488
 
                # If both revision specs include a branch, we can
1489
 
                # diff them without needing a local working tree
1490
 
                tree1, tree2 = None, None
1491
 
            else:
1492
 
                raise
1493
 
 
1494
 
        if tree2 is not None:
1495
 
            if revision is not None:
1496
 
                # FIXME: but there should be a clean way to diff between
1497
 
                # non-default versions of two trees, it's not hard to do
1498
 
                # internally...
1499
 
                raise errors.BzrCommandError(
1500
 
                        "Sorry, diffing arbitrary revisions across branches "
1501
 
                        "is not implemented yet")
1502
 
            return show_diff_trees(tree1, tree2, sys.stdout, 
1503
 
                                   specific_files=file_list,
1504
 
                                   external_diff_options=diff_options,
1505
 
                                   old_label=old_label, new_label=new_label)
1506
 
 
1507
 
        return diff_cmd_helper(tree1, file_list, diff_options,
1508
 
                               revision_specs=revision,
1509
 
                               old_label=old_label, new_label=new_label)
 
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)
1510
1982
 
1511
1983
 
1512
1984
class cmd_deleted(Command):
1513
 
    """List files deleted in the working tree.
 
1985
    __doc__ = """List files deleted in the working tree.
1514
1986
    """
1515
1987
    # TODO: Show files deleted since a previous revision, or
1516
1988
    # between two revisions.
1519
1991
    # level of effort but possibly much less IO.  (Or possibly not,
1520
1992
    # if the directories are very large...)
1521
1993
    _see_also = ['status', 'ls']
1522
 
    takes_options = ['show-ids']
 
1994
    takes_options = ['directory', 'show-ids']
1523
1995
 
1524
1996
    @display_command
1525
 
    def run(self, show_ids=False):
1526
 
        tree = WorkingTree.open_containing(u'.')[0]
1527
 
        tree.lock_read()
1528
 
        try:
1529
 
            old = tree.basis_tree()
1530
 
            old.lock_read()
1531
 
            try:
1532
 
                for path, ie in old.inventory.iter_entries():
1533
 
                    if not tree.has_id(ie.file_id):
1534
 
                        self.outf.write(path)
1535
 
                        if show_ids:
1536
 
                            self.outf.write(' ')
1537
 
                            self.outf.write(ie.file_id)
1538
 
                        self.outf.write('\n')
1539
 
            finally:
1540
 
                old.unlock()
1541
 
        finally:
1542
 
            tree.unlock()
 
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')
1543
2009
 
1544
2010
 
1545
2011
class cmd_modified(Command):
1546
 
    """List files modified in working tree.
 
2012
    __doc__ = """List files modified in working tree.
1547
2013
    """
1548
2014
 
1549
2015
    hidden = True
1550
2016
    _see_also = ['status', 'ls']
 
2017
    takes_options = ['directory', 'null']
1551
2018
 
1552
2019
    @display_command
1553
 
    def run(self):
1554
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2020
    def run(self, null=False, directory=u'.'):
 
2021
        tree = WorkingTree.open_containing(directory)[0]
1555
2022
        td = tree.changes_from(tree.basis_tree())
1556
2023
        for path, id, kind, text_modified, meta_modified in td.modified:
1557
 
            self.outf.write(path + '\n')
 
2024
            if null:
 
2025
                self.outf.write(path + '\0')
 
2026
            else:
 
2027
                self.outf.write(osutils.quotefn(path) + '\n')
1558
2028
 
1559
2029
 
1560
2030
class cmd_added(Command):
1561
 
    """List files added in working tree.
 
2031
    __doc__ = """List files added in working tree.
1562
2032
    """
1563
2033
 
1564
2034
    hidden = True
1565
2035
    _see_also = ['status', 'ls']
 
2036
    takes_options = ['directory', 'null']
1566
2037
 
1567
2038
    @display_command
1568
 
    def run(self):
1569
 
        wt = WorkingTree.open_containing(u'.')[0]
1570
 
        wt.lock_read()
1571
 
        try:
1572
 
            basis = wt.basis_tree()
1573
 
            basis.lock_read()
1574
 
            try:
1575
 
                basis_inv = basis.inventory
1576
 
                inv = wt.inventory
1577
 
                for file_id in inv:
1578
 
                    if file_id in basis_inv:
1579
 
                        continue
1580
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1581
 
                        continue
1582
 
                    path = inv.id2path(file_id)
1583
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1584
 
                        continue
1585
 
                    self.outf.write(path + '\n')
1586
 
            finally:
1587
 
                basis.unlock()
1588
 
        finally:
1589
 
            wt.unlock()
 
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')
1590
2058
 
1591
2059
 
1592
2060
class cmd_root(Command):
1593
 
    """Show the tree root directory.
 
2061
    __doc__ = """Show the tree root directory.
1594
2062
 
1595
2063
    The root is the nearest enclosing directory with a .bzr control
1596
2064
    directory."""
1611
2079
        raise errors.BzrCommandError(msg)
1612
2080
 
1613
2081
 
 
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
 
1614
2090
class cmd_log(Command):
1615
 
    """Show log of a branch, file, or directory.
1616
 
 
1617
 
    By default show the log of the branch containing the working directory.
1618
 
 
1619
 
    To request a range of logs, you can use the command -r begin..end
1620
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
1621
 
    also valid.
1622
 
 
1623
 
    :Examples:
1624
 
        Log the current branch::
1625
 
 
1626
 
            bzr log
1627
 
 
1628
 
        Log a file::
1629
 
 
1630
 
            bzr log foo.c
1631
 
 
1632
 
        Log the last 10 revisions of a branch::
1633
 
 
1634
 
            bzr log -r -10.. http://server/branch
 
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.
1635
2241
    """
1636
 
 
1637
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
1638
 
 
1639
 
    takes_args = ['location?']
 
2242
    takes_args = ['file*']
 
2243
    _see_also = ['log-formats', 'revisionspec']
1640
2244
    takes_options = [
1641
2245
            Option('forward',
1642
2246
                   help='Show from oldest to newest.'),
1643
 
            Option('timezone',
1644
 
                   type=str,
1645
 
                   help='Display timezone as local, original, or utc.'),
 
2247
            'timezone',
1646
2248
            custom_help('verbose',
1647
2249
                   help='Show files changed in each revision.'),
1648
2250
            'show-ids',
1649
2251
            '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".'),
1650
2257
            '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),
1651
2268
            Option('message',
1652
2269
                   short_name='m',
1653
2270
                   help='Show revisions whose message matches this '
1654
2271
                        'regular expression.',
1655
2272
                   type=str),
1656
2273
            Option('limit',
 
2274
                   short_name='l',
1657
2275
                   help='Limit the output to the first N revisions.',
1658
2276
                   argname='N',
1659
2277
                   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
                   )
1660
2287
            ]
1661
2288
    encoding_type = 'replace'
1662
2289
 
1663
2290
    @display_command
1664
 
    def run(self, location=None, timezone='original',
 
2291
    def run(self, file_list=None, timezone='original',
1665
2292
            verbose=False,
1666
2293
            show_ids=False,
1667
2294
            forward=False,
1668
2295
            revision=None,
 
2296
            change=None,
1669
2297
            log_format=None,
 
2298
            levels=None,
1670
2299
            message=None,
1671
 
            limit=None):
1672
 
        from bzrlib.log import show_log
1673
 
        assert message is None or isinstance(message, basestring), \
1674
 
            "invalid message argument %r" % message
 
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
            )
1675
2311
        direction = (forward and 'forward') or 'reverse'
1676
 
        
1677
 
        # log everything
1678
 
        file_id = None
1679
 
        if location:
1680
 
            # find the file id to log:
1681
 
 
1682
 
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1683
 
                location)
1684
 
            if fp != '':
1685
 
                if tree is None:
1686
 
                    tree = b.basis_tree()
1687
 
                file_id = tree.path2id(fp)
 
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:
1688
2339
                if file_id is None:
1689
2340
                    raise errors.BzrCommandError(
1690
 
                        "Path does not have any revision history: %s" %
1691
 
                        location)
 
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'])
1692
2351
        else:
1693
 
            # local dir only
1694
 
            # FIXME ? log the current subdir only RBC 20060203 
 
2352
            # log everything
 
2353
            # FIXME ? log the current subdir only RBC 20060203
1695
2354
            if revision is not None \
1696
2355
                    and len(revision) > 0 and revision[0].get_branch():
1697
2356
                location = revision[0].get_branch()
1699
2358
                location = '.'
1700
2359
            dir, relpath = bzrdir.BzrDir.open_containing(location)
1701
2360
            b = dir.open_branch()
1702
 
 
1703
 
        b.lock_read()
1704
 
        try:
1705
 
            if revision is None:
1706
 
                rev1 = None
1707
 
                rev2 = None
1708
 
            elif len(revision) == 1:
1709
 
                rev1 = rev2 = revision[0].in_history(b)
1710
 
            elif len(revision) == 2:
1711
 
                if revision[1].get_branch() != revision[0].get_branch():
1712
 
                    # b is taken from revision[0].get_branch(), and
1713
 
                    # show_log will use its revision_history. Having
1714
 
                    # different branches will lead to weird behaviors.
1715
 
                    raise errors.BzrCommandError(
1716
 
                        "Log doesn't accept two revisions in different"
1717
 
                        " branches.")
1718
 
                rev1 = revision[0].in_history(b)
1719
 
                rev2 = revision[1].in_history(b)
1720
 
            else:
1721
 
                raise errors.BzrCommandError(
1722
 
                    'bzr log --revision takes one or two values.')
1723
 
 
1724
 
            if log_format is None:
1725
 
                log_format = log.log_formatter_registry.get_default(b)
1726
 
 
1727
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
1728
 
                            show_timezone=timezone)
1729
 
 
1730
 
            show_log(b,
1731
 
                     lf,
1732
 
                     file_id,
1733
 
                     verbose=verbose,
1734
 
                     direction=direction,
1735
 
                     start_revision=rev1,
1736
 
                     end_revision=rev2,
1737
 
                     search=message,
1738
 
                     limit=limit)
1739
 
        finally:
1740
 
            b.unlock()
1741
 
 
 
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
1742
2466
 
1743
2467
def get_log_format(long=False, short=False, line=False, default='long'):
1744
2468
    log_format = default
1752
2476
 
1753
2477
 
1754
2478
class cmd_touching_revisions(Command):
1755
 
    """Return revision-ids which affected a particular file.
 
2479
    __doc__ = """Return revision-ids which affected a particular file.
1756
2480
 
1757
2481
    A more user-friendly interface is "bzr log FILE".
1758
2482
    """
1763
2487
    @display_command
1764
2488
    def run(self, filename):
1765
2489
        tree, relpath = WorkingTree.open_containing(filename)
 
2490
        file_id = tree.path2id(relpath)
1766
2491
        b = tree.branch
1767
 
        file_id = tree.path2id(relpath)
1768
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
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:
1769
2495
            self.outf.write("%6d %s\n" % (revno, what))
1770
2496
 
1771
2497
 
1772
2498
class cmd_ls(Command):
1773
 
    """List files in a tree.
 
2499
    __doc__ = """List files in a tree.
1774
2500
    """
1775
2501
 
1776
2502
    _see_also = ['status', 'cat']
1777
2503
    takes_args = ['path?']
1778
 
    # TODO: Take a revision or remote path and list that tree instead.
1779
2504
    takes_options = [
1780
2505
            'verbose',
1781
2506
            'revision',
1782
 
            Option('non-recursive',
1783
 
                   help='Don\'t recurse into subdirectories.'),
 
2507
            Option('recursive', short_name='R',
 
2508
                   help='Recurse into subdirectories.'),
1784
2509
            Option('from-root',
1785
2510
                   help='Print paths relative to the root of the branch.'),
1786
 
            Option('unknown', help='Print unknown files.'),
1787
 
            Option('versioned', help='Print versioned files.'),
1788
 
            Option('ignored', help='Print ignored files.'),
1789
 
            Option('null',
1790
 
                   help='Write an ascii NUL (\\0) separator '
1791
 
                   'between files rather than a newline.'),
1792
 
            Option('kind',
 
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',
1793
2518
                   help='List entries of a particular kind: file, directory, symlink.',
1794
2519
                   type=unicode),
 
2520
            'null',
1795
2521
            'show-ids',
 
2522
            'directory',
1796
2523
            ]
1797
2524
    @display_command
1798
2525
    def run(self, revision=None, verbose=False,
1799
 
            non_recursive=False, from_root=False,
 
2526
            recursive=False, from_root=False,
1800
2527
            unknown=False, versioned=False, ignored=False,
1801
 
            null=False, kind=None, show_ids=False, path=None):
 
2528
            null=False, kind=None, show_ids=False, path=None, directory=None):
1802
2529
 
1803
2530
        if kind and kind not in ('file', 'directory', 'symlink'):
1804
2531
            raise errors.BzrCommandError('invalid kind specified')
1811
2538
 
1812
2539
        if path is None:
1813
2540
            fs_path = '.'
1814
 
            prefix = ''
1815
2541
        else:
1816
2542
            if from_root:
1817
2543
                raise errors.BzrCommandError('cannot specify both --from-root'
1818
2544
                                             ' and PATH')
1819
2545
            fs_path = path
1820
 
            prefix = path
1821
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1822
 
            fs_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
1823
2551
        if from_root:
1824
 
            relpath = u''
1825
 
        elif relpath:
1826
 
            relpath += '/'
1827
 
        if revision is not None:
1828
 
            tree = branch.repository.revision_tree(
1829
 
                revision[0].in_history(branch).rev_id)
1830
 
        elif tree is None:
1831
 
            tree = branch.basis_tree()
1832
 
 
1833
 
        tree.lock_read()
1834
 
        try:
1835
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1836
 
                if fp.startswith(relpath):
1837
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
1838
 
                    if non_recursive and '/' in fp:
1839
 
                        continue
1840
 
                    if not all and not selection[fc]:
1841
 
                        continue
1842
 
                    if kind is not None and fkind != kind:
1843
 
                        continue
1844
 
                    if verbose:
1845
 
                        kindch = entry.kind_character()
1846
 
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
1847
 
                        if show_ids and fid is not None:
1848
 
                            outstring = "%-50s %s" % (outstring, fid)
1849
 
                        self.outf.write(outstring + '\n')
1850
 
                    elif null:
1851
 
                        self.outf.write(fp + '\0')
1852
 
                        if show_ids:
1853
 
                            if fid is not None:
1854
 
                                self.outf.write(fid)
1855
 
                            self.outf.write('\0')
1856
 
                        self.outf.flush()
1857
 
                    else:
1858
 
                        if fid is not None:
1859
 
                            my_id = fid
1860
 
                        else:
1861
 
                            my_id = ''
1862
 
                        if show_ids:
1863
 
                            self.outf.write('%-50s %s\n' % (fp, my_id))
1864
 
                        else:
1865
 
                            self.outf.write(fp + '\n')
1866
 
        finally:
1867
 
            tree.unlock()
 
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')
1868
2613
 
1869
2614
 
1870
2615
class cmd_unknowns(Command):
1871
 
    """List unknown files.
 
2616
    __doc__ = """List unknown files.
1872
2617
    """
1873
2618
 
1874
2619
    hidden = True
1875
2620
    _see_also = ['ls']
 
2621
    takes_options = ['directory']
1876
2622
 
1877
2623
    @display_command
1878
 
    def run(self):
1879
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2624
    def run(self, directory=u'.'):
 
2625
        for f in WorkingTree.open_containing(directory)[0].unknowns():
1880
2626
            self.outf.write(osutils.quotefn(f) + '\n')
1881
2627
 
1882
2628
 
1883
2629
class cmd_ignore(Command):
1884
 
    """Ignore specified files or patterns.
 
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.
1885
2639
 
1886
2640
    To remove patterns from the ignore list, edit the .bzrignore file.
1887
 
 
1888
 
    Trailing slashes on patterns are ignored. 
1889
 
    If the pattern contains a slash or is a regular expression, it is compared 
1890
 
    to the whole path from the branch root.  Otherwise, it is compared to only
1891
 
    the last component of the path.  To match a file only in the root 
1892
 
    directory, prepend './'.
1893
 
 
1894
 
    Ignore patterns specifying absolute paths are not allowed.
1895
 
 
1896
 
    Ignore patterns may include globbing wildcards such as::
1897
 
 
1898
 
      ? - Matches any single character except '/'
1899
 
      * - Matches 0 or more characters except '/'
1900
 
      /**/ - Matches 0 or more directories in a path
1901
 
      [a-z] - Matches a single character from within a group of characters
1902
 
 
1903
 
    Ignore patterns may also be Python regular expressions.  
1904
 
    Regular expression ignore patterns are identified by a 'RE:' prefix 
1905
 
    followed by the regular expression.  Regular expression ignore patterns
1906
 
    may not include named or numbered groups.
1907
 
 
1908
 
    Note: ignore patterns containing shell wildcards must be quoted from 
 
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
1909
2659
    the shell on Unix.
1910
2660
 
1911
2661
    :Examples:
1913
2663
 
1914
2664
            bzr ignore ./Makefile
1915
2665
 
1916
 
        Ignore class files in all directories::
1917
 
 
1918
 
            bzr ignore '*.class'
1919
 
 
1920
 
        Ignore .o files under the lib directory::
1921
 
 
1922
 
            bzr ignore 'lib/**/*.o'
1923
 
 
1924
 
        Ignore .o files under the lib directory::
1925
 
 
1926
 
            bzr ignore 'RE:lib/.*\.o'
 
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 "!!*~"
1927
2692
    """
1928
2693
 
1929
 
    _see_also = ['status', 'ignored']
 
2694
    _see_also = ['status', 'ignored', 'patterns']
1930
2695
    takes_args = ['name_pattern*']
1931
 
    takes_options = [
1932
 
        Option('old-default-rules',
1933
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2696
    takes_options = ['directory',
 
2697
        Option('default-rules',
 
2698
               help='Display the default ignore rules that bzr uses.')
1934
2699
        ]
1935
 
    
1936
 
    def run(self, name_pattern_list=None, old_default_rules=None):
1937
 
        from bzrlib.atomicfile import AtomicFile
1938
 
        if old_default_rules is not None:
1939
 
            # dump the rules and exit
1940
 
            for pattern in ignores.OLD_DEFAULTS:
1941
 
                print pattern
 
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)
1942
2708
            return
1943
2709
        if not name_pattern_list:
1944
2710
            raise errors.BzrCommandError("ignore requires at least one "
1945
 
                                  "NAME_PATTERN or --old-default-rules")
1946
 
        name_pattern_list = [globbing.normalize_pattern(p) 
 
2711
                "NAME_PATTERN or --default-rules.")
 
2712
        name_pattern_list = [globbing.normalize_pattern(p)
1947
2713
                             for p in name_pattern_list]
1948
2714
        for name_pattern in name_pattern_list:
1949
 
            if (name_pattern[0] == '/' or 
 
2715
            if (name_pattern[0] == '/' or
1950
2716
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
1951
2717
                raise errors.BzrCommandError(
1952
2718
                    "NAME_PATTERN should not be an absolute path")
1953
 
        tree, relpath = WorkingTree.open_containing(u'.')
1954
 
        ifn = tree.abspath('.bzrignore')
1955
 
        if os.path.exists(ifn):
1956
 
            f = open(ifn, 'rt')
1957
 
            try:
1958
 
                igns = f.read().decode('utf-8')
1959
 
            finally:
1960
 
                f.close()
1961
 
        else:
1962
 
            igns = ''
1963
 
 
1964
 
        # TODO: If the file already uses crlf-style termination, maybe
1965
 
        # we should use that for the newly added lines?
1966
 
 
1967
 
        if igns and igns[-1] != '\n':
1968
 
            igns += '\n'
1969
 
        for name_pattern in name_pattern_list:
1970
 
            igns += name_pattern + '\n'
1971
 
 
1972
 
        f = AtomicFile(ifn, 'wb')
1973
 
        try:
1974
 
            f.write(igns.encode('utf-8'))
1975
 
            f.commit()
1976
 
        finally:
1977
 
            f.close()
1978
 
 
1979
 
        if not tree.path2id('.bzrignore'):
1980
 
            tree.add(['.bzrignore'])
1981
 
 
 
2719
        tree, relpath = WorkingTree.open_containing(directory)
 
2720
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1982
2721
        ignored = globbing.Globster(name_pattern_list)
1983
2722
        matches = []
1984
2723
        tree.lock_read()
1987
2726
            if id is not None:
1988
2727
                filename = entry[0]
1989
2728
                if ignored.match(filename):
1990
 
                    matches.append(filename.encode('utf-8'))
 
2729
                    matches.append(filename)
1991
2730
        tree.unlock()
1992
2731
        if len(matches) > 0:
1993
 
            print "Warning: the following files are version controlled and" \
1994
 
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
2732
            self.outf.write("Warning: the following files are version controlled and"
 
2733
                  " match your ignore pattern:\n%s"
 
2734
                  "\nThese files will continue to be version controlled"
 
2735
                  " unless you 'bzr remove' them.\n" % ("\n".join(matches),))
 
2736
 
1995
2737
 
1996
2738
class cmd_ignored(Command):
1997
 
    """List ignored files and the patterns that matched them.
 
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
1998
2747
    """
1999
2748
 
2000
 
    _see_also = ['ignore']
 
2749
    encoding_type = 'replace'
 
2750
    _see_also = ['ignore', 'ls']
 
2751
    takes_options = ['directory']
 
2752
 
2001
2753
    @display_command
2002
 
    def run(self):
2003
 
        tree = WorkingTree.open_containing(u'.')[0]
2004
 
        tree.lock_read()
2005
 
        try:
2006
 
            for path, file_class, kind, file_id, entry in tree.list_files():
2007
 
                if file_class != 'I':
2008
 
                    continue
2009
 
                ## XXX: Slightly inefficient since this was already calculated
2010
 
                pat = tree.is_ignored(path)
2011
 
                print '%-50s %s' % (path, pat)
2012
 
        finally:
2013
 
            tree.unlock()
 
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))
2014
2763
 
2015
2764
 
2016
2765
class cmd_lookup_revision(Command):
2017
 
    """Lookup the revision-id from a revision-number
 
2766
    __doc__ = """Lookup the revision-id from a revision-number
2018
2767
 
2019
2768
    :Examples:
2020
2769
        bzr lookup-revision 33
2021
2770
    """
2022
2771
    hidden = True
2023
2772
    takes_args = ['revno']
2024
 
    
 
2773
    takes_options = ['directory']
 
2774
 
2025
2775
    @display_command
2026
 
    def run(self, revno):
 
2776
    def run(self, revno, directory=u'.'):
2027
2777
        try:
2028
2778
            revno = int(revno)
2029
2779
        except ValueError:
2030
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2031
 
 
2032
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
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)
2033
2784
 
2034
2785
 
2035
2786
class cmd_export(Command):
2036
 
    """Export current or past revision to a destination directory or archive.
 
2787
    __doc__ = """Export current or past revision to a destination directory or archive.
2037
2788
 
2038
2789
    If no revision is specified this exports the last committed revision.
2039
2790
 
2060
2811
         zip                          .zip
2061
2812
      =================       =========================
2062
2813
    """
2063
 
    takes_args = ['dest', 'branch?']
2064
 
    takes_options = [
 
2814
    takes_args = ['dest', 'branch_or_subdir?']
 
2815
    takes_options = ['directory',
2065
2816
        Option('format',
2066
2817
               help="Type of file to export to.",
2067
2818
               type=unicode),
2068
2819
        'revision',
 
2820
        Option('filters', help='Apply content filters to export the '
 
2821
                'convenient form.'),
2069
2822
        Option('root',
2070
2823
               type=str,
2071
2824
               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.'),
2072
2828
        ]
2073
 
    def run(self, dest, branch=None, revision=None, format=None, root=None):
 
2829
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2830
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
2074
2831
        from bzrlib.export import export
2075
2832
 
2076
 
        if branch is None:
2077
 
            tree = WorkingTree.open_containing(u'.')[0]
 
2833
        if branch_or_subdir is None:
 
2834
            tree = WorkingTree.open_containing(directory)[0]
2078
2835
            b = tree.branch
2079
 
        else:
2080
 
            b = Branch.open(branch)
2081
 
            
2082
 
        if revision is None:
2083
 
            # should be tree.last_revision  FIXME
2084
 
            rev_id = b.last_revision()
2085
 
        else:
2086
 
            if len(revision) != 1:
2087
 
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2088
 
            rev_id = revision[0].in_history(b).rev_id
2089
 
        t = b.repository.revision_tree(rev_id)
 
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)
2090
2842
        try:
2091
 
            export(t, dest, format, root)
 
2843
            export(rev_tree, dest, format, root, subdir, filtered=filters,
 
2844
                   per_file_timestamps=per_file_timestamps)
2092
2845
        except errors.NoSuchExportFormat, e:
2093
2846
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2094
2847
 
2095
2848
 
2096
2849
class cmd_cat(Command):
2097
 
    """Write the contents of a file as of a given revision to standard output.
 
2850
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2098
2851
 
2099
2852
    If no revision is nominated, the last revision is used.
2100
2853
 
2101
2854
    Note: Take care to redirect standard output when using this command on a
2102
 
    binary file. 
 
2855
    binary file.
2103
2856
    """
2104
2857
 
2105
2858
    _see_also = ['ls']
2106
 
    takes_options = [
 
2859
    takes_options = ['directory',
2107
2860
        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.'),
2108
2863
        'revision',
2109
2864
        ]
2110
2865
    takes_args = ['filename']
2111
2866
    encoding_type = 'exact'
2112
2867
 
2113
2868
    @display_command
2114
 
    def run(self, filename, revision=None, name_from_revision=False):
 
2869
    def run(self, filename, revision=None, name_from_revision=False,
 
2870
            filters=False, directory=None):
2115
2871
        if revision is not None and len(revision) != 1:
2116
2872
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2117
 
                                        " one number")
2118
 
 
2119
 
        tree = None
2120
 
        try:
2121
 
            tree, b, relpath = \
2122
 
                    bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2123
 
        except errors.NotBranchError:
2124
 
            pass
2125
 
 
2126
 
        if revision is not None and revision[0].get_branch() is not None:
2127
 
            b = Branch.open(revision[0].get_branch())
 
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):
2128
2882
        if tree is None:
2129
2883
            tree = b.basis_tree()
2130
 
        if revision is None:
2131
 
            revision_id = b.last_revision()
2132
 
        else:
2133
 
            revision_id = revision[0].in_history(b).rev_id
 
2884
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2885
        self.add_cleanup(rev_tree.lock_read().unlock)
2134
2886
 
2135
 
        cur_file_id = tree.path2id(relpath)
2136
 
        rev_tree = b.repository.revision_tree(revision_id)
2137
2887
        old_file_id = rev_tree.path2id(relpath)
2138
 
        
 
2888
 
2139
2889
        if name_from_revision:
 
2890
            # Try in revision if requested
2140
2891
            if old_file_id is None:
2141
 
                raise errors.BzrCommandError("%r is not present in revision %s"
2142
 
                                                % (filename, revision_id))
 
2892
                raise errors.BzrCommandError(
 
2893
                    "%r is not present in revision %s" % (
 
2894
                        filename, rev_tree.get_revision_id()))
2143
2895
            else:
2144
 
                rev_tree.print_file(old_file_id)
2145
 
        elif cur_file_id is not None:
2146
 
            rev_tree.print_file(cur_file_id)
2147
 
        elif old_file_id is not None:
2148
 
            rev_tree.print_file(old_file_id)
2149
 
        else:
2150
 
            raise errors.BzrCommandError("%r is not present in revision %s" %
2151
 
                                         (filename, revision_id))
 
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)
2152
2931
 
2153
2932
 
2154
2933
class cmd_local_time_offset(Command):
2155
 
    """Show the offset in seconds from GMT to local time."""
2156
 
    hidden = True    
 
2934
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
2935
    hidden = True
2157
2936
    @display_command
2158
2937
    def run(self):
2159
 
        print osutils.local_time_offset()
 
2938
        self.outf.write("%s\n" % osutils.local_time_offset())
2160
2939
 
2161
2940
 
2162
2941
 
2163
2942
class cmd_commit(Command):
2164
 
    """Commit changes into a new revision.
2165
 
    
2166
 
    If no arguments are given, the entire tree is committed.
2167
 
 
2168
 
    If selected files are specified, only changes to those files are
2169
 
    committed.  If a directory is specified then the directory and everything 
2170
 
    within it is committed.
2171
 
 
2172
 
    If author of the change is not the same person as the committer, you can
2173
 
    specify the author's name using the --author option. The name should be
2174
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2175
 
 
2176
 
    A selected-file commit may fail in some cases where the committed
2177
 
    tree would be invalid. Consider::
2178
 
 
2179
 
      bzr init foo
2180
 
      mkdir foo/bar
2181
 
      bzr add foo/bar
2182
 
      bzr commit foo -m "committing foo"
2183
 
      bzr mv foo/bar foo/baz
2184
 
      mkdir foo/bar
2185
 
      bzr add foo/bar
2186
 
      bzr commit foo/bar -m "committing bar but not baz"
2187
 
 
2188
 
    In the example above, the last commit will fail by design. This gives
2189
 
    the user the opportunity to decide whether they want to commit the
2190
 
    rename at the same time, separately first, or not at all. (As a general
2191
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2192
 
 
2193
 
    Note: A selected-file commit after a merge is not yet supported.
 
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.)
2194
3014
    """
2195
3015
    # TODO: Run hooks on tree to-be-committed, and after commit.
2196
3016
 
2201
3021
 
2202
3022
    # XXX: verbose currently does nothing
2203
3023
 
2204
 
    _see_also = ['bugs', 'uncommit']
 
3024
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2205
3025
    takes_args = ['selected*']
2206
3026
    takes_options = [
 
3027
            ListOption('exclude', type=str, short_name='x',
 
3028
                help="Do not consider changes made to a given path."),
2207
3029
            Option('message', type=unicode,
2208
3030
                   short_name='m',
2209
3031
                   help="Description of the new revision."),
2217
3039
             Option('strict',
2218
3040
                    help="Refuse to commit if there are unknown "
2219
3041
                    "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'."),
2220
3045
             ListOption('fixes', type=str,
2221
 
                    help="Mark a bug as being fixed by this revision."),
2222
 
             Option('author', type=str,
 
3046
                    help="Mark a bug as being fixed by this revision "
 
3047
                         "(see \"bzr help bugs\")."),
 
3048
             ListOption('author', type=unicode,
2223
3049
                    help="Set the author's name, if it's different "
2224
3050
                         "from the committer."),
2225
3051
             Option('local',
2228
3054
                         "the master branch until a normal commit "
2229
3055
                         "is performed."
2230
3056
                    ),
2231
 
              Option('show-diff',
2232
 
                     help='When no message is supplied, show the diff along'
2233
 
                     ' with the status summary in the message editor.'),
 
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.'),
2234
3060
             ]
2235
3061
    aliases = ['ci', 'checkin']
2236
3062
 
2237
 
    def _get_bug_fix_properties(self, fixes, branch):
2238
 
        properties = []
 
3063
    def _iter_bug_fix_urls(self, fixes, branch):
2239
3064
        # Configure the properties for bug fixing attributes.
2240
3065
        for fixed_bug in fixes:
2241
3066
            tokens = fixed_bug.split(':')
2242
3067
            if len(tokens) != 2:
2243
3068
                raise errors.BzrCommandError(
2244
 
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
2245
 
                    "Commit refused." % fixed_bug)
 
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)
2246
3072
            tag, bug_id = tokens
2247
3073
            try:
2248
 
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
3074
                yield bugtracker.get_bug_url(tag, branch, bug_id)
2249
3075
            except errors.UnknownBugTrackerAbbreviation:
2250
3076
                raise errors.BzrCommandError(
2251
3077
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
2252
 
            except errors.MalformedBugIdentifier:
 
3078
            except errors.MalformedBugIdentifier, e:
2253
3079
                raise errors.BzrCommandError(
2254
 
                    "Invalid bug identifier for %s. Commit refused."
2255
 
                    % fixed_bug)
2256
 
            properties.append('%s fixed' % bug_url)
2257
 
        return '\n'.join(properties)
 
3080
                    "%s\nCommit refused." % (str(e),))
2258
3081
 
2259
3082
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2260
3083
            unchanged=False, strict=False, local=False, fixes=None,
2261
 
            author=None, show_diff=False):
 
3084
            author=None, show_diff=False, exclude=None, commit_time=None):
2262
3085
        from bzrlib.errors import (
2263
3086
            PointlessCommit,
2264
3087
            ConflictsInTree,
2266
3089
        )
2267
3090
        from bzrlib.msgeditor import (
2268
3091
            edit_commit_message_encoded,
 
3092
            generate_commit_message_template,
2269
3093
            make_commit_message_template_encoded
2270
3094
        )
2271
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))
 
3103
 
2272
3104
        # TODO: Need a blackbox test for invoking the external editor; may be
2273
3105
        # slightly problematic to run this cross-platform.
2274
3106
 
2275
 
        # TODO: do more checks that the commit will succeed before 
 
3107
        # TODO: do more checks that the commit will succeed before
2276
3108
        # spending the user's valuable time typing a commit message.
2277
3109
 
2278
3110
        properties = {}
2286
3118
 
2287
3119
        if fixes is None:
2288
3120
            fixes = []
2289
 
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
3121
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3122
            self._iter_bug_fix_urls(fixes, tree.branch))
2290
3123
        if bug_property:
2291
3124
            properties['bugs'] = bug_property
2292
3125
 
2293
3126
        if local and not tree.branch.get_bound_location():
2294
3127
            raise errors.LocalRequiresBoundBranch()
2295
3128
 
 
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
 
2296
3150
        def get_message(commit_obj):
2297
3151
            """Callback to get commit message"""
2298
 
            my_message = message
2299
 
            if my_message is None and not file:
2300
 
                t = make_commit_message_template_encoded(tree,
 
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,
2301
3161
                        selected_list, diff=show_diff,
2302
 
                        output_encoding=bzrlib.user_encoding)
2303
 
                my_message = edit_commit_message_encoded(t)
 
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)
2304
3171
                if my_message is None:
2305
3172
                    raise errors.BzrCommandError("please specify a commit"
2306
3173
                        " message with either --message or --file")
2307
 
            elif my_message and file:
2308
 
                raise errors.BzrCommandError(
2309
 
                    "please specify either --message or --file")
2310
 
            if file:
2311
 
                my_message = codecs.open(file, 'rt', 
2312
 
                                         bzrlib.user_encoding).read()
2313
3174
            if my_message == "":
2314
3175
                raise errors.BzrCommandError("empty commit message specified")
2315
3176
            return my_message
2316
3177
 
 
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
2317
3182
        try:
2318
3183
            tree.commit(message_callback=get_message,
2319
3184
                        specific_files=selected_list,
2320
3185
                        allow_pointless=unchanged, strict=strict, local=local,
2321
3186
                        reporter=None, verbose=verbose, revprops=properties,
2322
 
                        author=author)
 
3187
                        authors=author, timestamp=commit_stamp,
 
3188
                        timezone=offset,
 
3189
                        exclude=safe_relpath_files(tree, exclude))
2323
3190
        except PointlessCommit:
2324
 
            # FIXME: This should really happen before the file is read in;
2325
 
            # perhaps prepare the commit; get the message; then actually commit
2326
 
            raise errors.BzrCommandError("no changes to commit."
2327
 
                              " use --unchanged to commit anyhow")
 
3191
            raise errors.BzrCommandError("No changes to commit."
 
3192
                              " Use --unchanged to commit anyhow.")
2328
3193
        except ConflictsInTree:
2329
3194
            raise errors.BzrCommandError('Conflicts detected in working '
2330
3195
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2333
3198
            raise errors.BzrCommandError("Commit refused because there are"
2334
3199
                              " unknown files in the working tree.")
2335
3200
        except errors.BoundBranchOutOfDate, e:
2336
 
            raise errors.BzrCommandError(str(e) + "\n"
2337
 
            'To commit to master branch, run update and then commit.\n'
2338
 
            'You can also pass --local to commit to continue working '
2339
 
            'disconnected.')
 
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
2340
3206
 
2341
3207
 
2342
3208
class cmd_check(Command):
2343
 
    """Validate consistency of branch history.
2344
 
 
2345
 
    This command checks various invariants about the branch storage to
2346
 
    detect data corruption or bzr bugs.
2347
 
 
2348
 
    Output fields:
2349
 
 
2350
 
        revisions: This is just the number of revisions checked.  It doesn't
2351
 
            indicate a problem.
2352
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2353
 
            doesn't indicate a problem.
2354
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2355
 
            are not properly referenced by the revision ancestry.  This is a
2356
 
            subtle problem that Bazaar can work around.
2357
 
        unique file texts: This is the total number of unique file contents
2358
 
            seen in the checked revisions.  It does not indicate a problem.
2359
 
        repeated file texts: This is the total number of repeated texts seen
2360
 
            in the checked revisions.  Texts can be repeated when their file
2361
 
            entries are modified, but the file contents are not.  It does not
2362
 
            indicate a problem.
 
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
2363
3256
    """
2364
3257
 
2365
3258
    _see_also = ['reconcile']
2366
 
    takes_args = ['branch?']
2367
 
    takes_options = ['verbose']
 
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.")]
2368
3267
 
2369
 
    def run(self, branch=None, verbose=False):
2370
 
        from bzrlib.check import check
2371
 
        if branch is None:
2372
 
            branch_obj = Branch.open_containing('.')[0]
2373
 
        else:
2374
 
            branch_obj = Branch.open(branch)
2375
 
        check(branch_obj, verbose)
2376
 
        # bit hacky, check the tree parent is accurate
2377
 
        try:
2378
 
            if branch is None:
2379
 
                tree = WorkingTree.open_containing('.')[0]
2380
 
            else:
2381
 
                tree = WorkingTree.open(branch)
2382
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
2383
 
            pass
2384
 
        else:
2385
 
            # This is a primitive 'check' for tree state. Currently this is not
2386
 
            # integrated into the main check logic as yet.
2387
 
            tree.lock_read()
2388
 
            try:
2389
 
                tree_basis = tree.basis_tree()
2390
 
                tree_basis.lock_read()
2391
 
                try:
2392
 
                    repo_basis = tree.branch.repository.revision_tree(
2393
 
                        tree.last_revision())
2394
 
                    if len(list(repo_basis._iter_changes(tree_basis))):
2395
 
                        raise errors.BzrCheckError(
2396
 
                            "Mismatched basis inventory content.")
2397
 
                    tree._validate()
2398
 
                finally:
2399
 
                    tree_basis.unlock()
2400
 
            finally:
2401
 
                tree.unlock()
 
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)
2402
3276
 
2403
3277
 
2404
3278
class cmd_upgrade(Command):
2405
 
    """Upgrade branch storage to current format.
 
3279
    __doc__ = """Upgrade branch storage to current format.
2406
3280
 
2407
3281
    The check command or bzr developers may sometimes advise you to run
2408
3282
    this command. When the default format has changed you may also be warned
2415
3289
                    RegistryOption('format',
2416
3290
                        help='Upgrade to a specific format.  See "bzr help'
2417
3291
                             ' formats" for details.',
2418
 
                        registry=bzrdir.format_registry,
2419
 
                        converter=bzrdir.format_registry.make_bzrdir,
 
3292
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3293
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
2420
3294
                        value_switches=True, title='Branch format'),
2421
3295
                    ]
2422
3296
 
2423
3297
    def run(self, url='.', format=None):
2424
3298
        from bzrlib.upgrade import upgrade
2425
 
        if format is None:
2426
 
            format = bzrdir.format_registry.make_bzrdir('default')
2427
3299
        upgrade(url, format)
2428
3300
 
2429
3301
 
2430
3302
class cmd_whoami(Command):
2431
 
    """Show or set bzr user id.
2432
 
    
 
3303
    __doc__ = """Show or set bzr user id.
 
3304
 
2433
3305
    :Examples:
2434
3306
        Show the email of the current user::
2435
3307
 
2437
3309
 
2438
3310
        Set the current user::
2439
3311
 
2440
 
            bzr whoami 'Frank Chu <fchu@example.com>'
 
3312
            bzr whoami "Frank Chu <fchu@example.com>"
2441
3313
    """
2442
3314
    takes_options = [ Option('email',
2443
3315
                             help='Display email address only.'),
2447
3319
                    ]
2448
3320
    takes_args = ['name?']
2449
3321
    encoding_type = 'replace'
2450
 
    
 
3322
 
2451
3323
    @display_command
2452
3324
    def run(self, email=False, branch=False, name=None):
2453
3325
        if name is None:
2468
3340
        except errors.NoEmailInUsername, e:
2469
3341
            warning('"%s" does not seem to contain an email address.  '
2470
3342
                    'This is allowed, but not recommended.', name)
2471
 
        
 
3343
 
2472
3344
        # use global config unless --branch given
2473
3345
        if branch:
2474
3346
            c = Branch.open_containing('.')[0].get_config()
2478
3350
 
2479
3351
 
2480
3352
class cmd_nick(Command):
2481
 
    """Print or set the branch nickname.  
2482
 
 
2483
 
    If unset, the tree root directory name is used as the nickname
2484
 
    To print the current nickname, execute with no argument.  
 
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.
2485
3360
    """
2486
3361
 
2487
3362
    _see_also = ['info']
2488
3363
    takes_args = ['nickname?']
2489
 
    def run(self, nickname=None):
2490
 
        branch = Branch.open_containing(u'.')[0]
 
3364
    takes_options = ['directory']
 
3365
    def run(self, nickname=None, directory=u'.'):
 
3366
        branch = Branch.open_containing(directory)[0]
2491
3367
        if nickname is None:
2492
3368
            self.printme(branch)
2493
3369
        else:
2495
3371
 
2496
3372
    @display_command
2497
3373
    def printme(self, branch):
2498
 
        print branch.nick
 
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)
2499
3445
 
2500
3446
 
2501
3447
class cmd_selftest(Command):
2502
 
    """Run internal test suite.
2503
 
    
 
3448
    __doc__ = """Run internal test suite.
 
3449
 
2504
3450
    If arguments are given, they are regular expressions that say which tests
2505
3451
    should run.  Tests matching any expression are run, and other tests are
2506
3452
    not run.
2529
3475
    modified by plugins will not be tested, and tests provided by plugins will
2530
3476
    not be run.
2531
3477
 
2532
 
    Tests that need working space on disk use a common temporary directory, 
 
3478
    Tests that need working space on disk use a common temporary directory,
2533
3479
    typically inside $TMPDIR or /tmp.
2534
3480
 
 
3481
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3482
    into a pdb postmortem session.
 
3483
 
2535
3484
    :Examples:
2536
3485
        Run only tests relating to 'ignore'::
2537
3486
 
2546
3495
    def get_transport_type(typestring):
2547
3496
        """Parse and return a transport specifier."""
2548
3497
        if typestring == "sftp":
2549
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
2550
 
            return SFTPAbsoluteServer
 
3498
            from bzrlib.tests import stub_sftp
 
3499
            return stub_sftp.SFTPAbsoluteServer
2551
3500
        if typestring == "memory":
2552
 
            from bzrlib.transport.memory import MemoryServer
2553
 
            return MemoryServer
 
3501
            from bzrlib.tests import test_server
 
3502
            return memory.MemoryServer
2554
3503
        if typestring == "fakenfs":
2555
 
            from bzrlib.transport.fakenfs import FakeNFSServer
2556
 
            return FakeNFSServer
 
3504
            from bzrlib.tests import test_server
 
3505
            return test_server.FakeNFSServer
2557
3506
        msg = "No known transport type %s. Supported types are: sftp\n" %\
2558
3507
            (typestring)
2559
3508
        raise errors.BzrCommandError(msg)
2574
3523
                     Option('lsprof-timed',
2575
3524
                            help='Generate lsprof output for benchmarked'
2576
3525
                                 ' sections of code.'),
 
3526
                     Option('lsprof-tests',
 
3527
                            help='Generate lsprof output for each test.'),
2577
3528
                     Option('cache-dir', type=str,
2578
3529
                            help='Cache intermediate benchmark output in this '
2579
3530
                                 'directory.'),
2583
3534
                            ),
2584
3535
                     Option('list-only',
2585
3536
                            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
                        ),
2586
3542
                     Option('randomize', type=str, argname="SEED",
2587
3543
                            help='Randomize the order of tests using the given'
2588
3544
                                 ' seed or "now" for the current time.'),
2590
3546
                            short_name='x',
2591
3547
                            help='Exclude tests that match this regular'
2592
3548
                                 ' expression.'),
 
3549
                     Option('subunit',
 
3550
                        help='Output test progress via subunit.'),
2593
3551
                     Option('strict', help='Fail on missing dependencies or '
2594
3552
                            '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.'),
2595
3561
                     ]
2596
3562
    encoding_type = 'replace'
2597
3563
 
 
3564
    def __init__(self):
 
3565
        Command.__init__(self)
 
3566
        self.additional_selftest_args = {}
 
3567
 
2598
3568
    def run(self, testspecs_list=None, verbose=False, one=False,
2599
3569
            transport=None, benchmark=None,
2600
3570
            lsprof_timed=None, cache_dir=None,
2601
3571
            first=False, list_only=False,
2602
 
            randomize=None, exclude=None, strict=False):
2603
 
        import bzrlib.ui
 
3572
            randomize=None, exclude=None, strict=False,
 
3573
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3574
            parallel=None, lsprof_tests=False):
2604
3575
        from bzrlib.tests import selftest
2605
3576
        import bzrlib.benchmarks as benchmarks
2606
3577
        from bzrlib.benchmarks import tree_creator
2607
3578
 
 
3579
        # Make deprecation warnings visible, unless -Werror is set
 
3580
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3581
 
2608
3582
        if cache_dir is not None:
2609
3583
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2610
 
        if not list_only:
2611
 
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2612
 
            print '   %s (%s python%s)' % (
2613
 
                    bzrlib.__path__[0],
2614
 
                    bzrlib.version_string,
2615
 
                    '.'.join(map(str, sys.version_info)),
2616
 
                    )
2617
 
        print
2618
3584
        if testspecs_list is not None:
2619
3585
            pattern = '|'.join(testspecs_list)
2620
3586
        else:
2621
3587
            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)
2622
3603
        if benchmark:
2623
3604
            test_suite_factory = benchmarks.test_suite
2624
3605
            # Unless user explicitly asks for quiet, be verbose in benchmarks
2625
3606
            verbose = not is_quiet()
2626
3607
            # TODO: should possibly lock the history file...
2627
3608
            benchfile = open(".perf_history", "at", buffering=1)
 
3609
            self.add_cleanup(benchfile.close)
2628
3610
        else:
2629
3611
            test_suite_factory = None
2630
3612
            benchfile = None
2631
 
        try:
2632
 
            result = selftest(verbose=verbose,
2633
 
                              pattern=pattern,
2634
 
                              stop_on_failure=one,
2635
 
                              transport=transport,
2636
 
                              test_suite_factory=test_suite_factory,
2637
 
                              lsprof_timed=lsprof_timed,
2638
 
                              bench_history=benchfile,
2639
 
                              matching_tests_first=first,
2640
 
                              list_only=list_only,
2641
 
                              random_seed=randomize,
2642
 
                              exclude_pattern=exclude,
2643
 
                              strict=strict,
2644
 
                              )
2645
 
        finally:
2646
 
            if benchfile is not None:
2647
 
                benchfile.close()
2648
 
        if result:
2649
 
            info('tests passed')
2650
 
        else:
2651
 
            info('tests failed')
 
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)
2652
3632
        return int(not result)
2653
3633
 
2654
3634
 
2655
3635
class cmd_version(Command):
2656
 
    """Show version of bzr."""
 
3636
    __doc__ = """Show version of bzr."""
2657
3637
 
2658
3638
    encoding_type = 'replace'
 
3639
    takes_options = [
 
3640
        Option("short", help="Print just the version number."),
 
3641
        ]
2659
3642
 
2660
3643
    @display_command
2661
 
    def run(self):
 
3644
    def run(self, short=False):
2662
3645
        from bzrlib.version import show_version
2663
 
        show_version(to_file=self.outf)
 
3646
        if short:
 
3647
            self.outf.write(bzrlib.version_string + '\n')
 
3648
        else:
 
3649
            show_version(to_file=self.outf)
2664
3650
 
2665
3651
 
2666
3652
class cmd_rocks(Command):
2667
 
    """Statement of optimism."""
 
3653
    __doc__ = """Statement of optimism."""
2668
3654
 
2669
3655
    hidden = True
2670
3656
 
2671
3657
    @display_command
2672
3658
    def run(self):
2673
 
        print "It sure does!"
 
3659
        self.outf.write("It sure does!\n")
2674
3660
 
2675
3661
 
2676
3662
class cmd_find_merge_base(Command):
2677
 
    """Find and print a base revision for merging two branches."""
 
3663
    __doc__ = """Find and print a base revision for merging two branches."""
2678
3664
    # TODO: Options to specify revisions on either side, as if
2679
3665
    #       merging only part of the history.
2680
3666
    takes_args = ['branch', 'other']
2681
3667
    hidden = True
2682
 
    
 
3668
 
2683
3669
    @display_command
2684
3670
    def run(self, branch, other):
2685
3671
        from bzrlib.revision import ensure_null
2686
 
        
 
3672
 
2687
3673
        branch1 = Branch.open_containing(branch)[0]
2688
3674
        branch2 = Branch.open_containing(other)[0]
2689
 
 
 
3675
        self.add_cleanup(branch1.lock_read().unlock)
 
3676
        self.add_cleanup(branch2.lock_read().unlock)
2690
3677
        last1 = ensure_null(branch1.last_revision())
2691
3678
        last2 = ensure_null(branch2.last_revision())
2692
3679
 
2693
3680
        graph = branch1.repository.get_graph(branch2.repository)
2694
3681
        base_rev_id = graph.find_unique_lca(last1, last2)
2695
3682
 
2696
 
        print 'merge base is revision %s' % base_rev_id
 
3683
        self.outf.write('merge base is revision %s\n' % base_rev_id)
2697
3684
 
2698
3685
 
2699
3686
class cmd_merge(Command):
2700
 
    """Perform a three-way merge.
2701
 
    
2702
 
    The branch is the branch you will merge from.  By default, it will merge
2703
 
    the latest revision.  If you specify a revision, that revision will be
2704
 
    merged.  If you specify two revisions, the first will be used as a BASE,
2705
 
    and the second one as OTHER.  Revision numbers are always relative to the
2706
 
    specified branch.
 
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.
2707
3700
 
2708
3701
    By default, bzr will try to merge in all new work from the other
2709
3702
    branch, automatically determining an appropriate base.  If this
2710
3703
    fails, you may need to give an explicit base.
2711
 
    
 
3704
 
2712
3705
    Merge will do its best to combine the changes in two branches, but there
2713
3706
    are some kinds of problems only a human can fix.  When it encounters those,
2714
3707
    it will mark a conflict.  A conflict means that you need to fix something,
2724
3717
    The results of the merge are placed into the destination working
2725
3718
    directory, where they can be reviewed (with bzr diff), tested, and then
2726
3719
    committed to record the result of the merge.
2727
 
    
 
3720
 
2728
3721
    merge refuses to run if there are any uncommitted changes, unless
2729
 
    --force is given.
 
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".
2730
3731
 
2731
3732
    :Examples:
2732
3733
        To merge the latest revision from bzr.dev::
2740
3741
        To merge the changes introduced by 82, without previous changes::
2741
3742
 
2742
3743
            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'
2743
3755
    """
2744
3756
 
2745
 
    _see_also = ['update', 'remerge', 'status-flags']
2746
 
    takes_args = ['branch?']
 
3757
    encoding_type = 'exact'
 
3758
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3759
    takes_args = ['location?']
2747
3760
    takes_options = [
2748
3761
        'change',
2749
3762
        'revision',
2760
3773
                ' completely merged into the source, pull from the'
2761
3774
                ' source rather than merging.  When this happens,'
2762
3775
                ' you do not need to commit the result.'),
2763
 
        Option('directory',
 
3776
        custom_help('directory',
2764
3777
               help='Branch to merge into, '
2765
 
                    'rather than the one containing the working directory.',
2766
 
               short_name='d',
2767
 
               type=unicode,
2768
 
               ),
 
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')
2769
3783
    ]
2770
3784
 
2771
 
    def run(self, branch=None, revision=None, force=False, merge_type=None,
2772
 
            show_base=False, reprocess=False, remember=False,
 
3785
    def run(self, location=None, revision=None, force=False,
 
3786
            merge_type=None, show_base=False, reprocess=None, remember=False,
2773
3787
            uncommitted=False, pull=False,
2774
3788
            directory=None,
 
3789
            preview=False,
 
3790
            interactive=False,
2775
3791
            ):
2776
 
        # This is actually a branch (or merge-directive) *location*.
2777
 
        location = branch
2778
 
        del branch
2779
 
 
2780
3792
        if merge_type is None:
2781
3793
            merge_type = _mod_merge.Merge3Merger
2782
3794
 
2786
3798
        allow_pending = True
2787
3799
        verified = 'inapplicable'
2788
3800
        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)
2789
3813
        change_reporter = delta._ChangeReporter(
2790
 
            unversioned_filter=tree.is_ignored)
2791
 
        cleanups = []
2792
 
        try:
2793
 
            pb = ui.ui_factory.nested_progress_bar()
2794
 
            cleanups.append(pb.finished)
2795
 
            tree.lock_write()
2796
 
            cleanups.append(tree.unlock)
2797
 
            if location is not None:
2798
 
                mergeable, other_transport = _get_mergeable_helper(location)
2799
 
                if mergeable:
2800
 
                    if uncommitted:
2801
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
2802
 
                            ' with bundles or merge directives.')
2803
 
 
2804
 
                    if revision is not None:
2805
 
                        raise errors.BzrCommandError(
2806
 
                            'Cannot use -r with merge directives or bundles')
2807
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
2808
 
                       mergeable, pb)
2809
 
                possible_transports.append(other_transport)
2810
 
 
2811
 
            if merger is None and uncommitted:
2812
 
                if revision is not None and len(revision) > 0:
2813
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
2814
 
                        ' --revision at the same time.')
2815
 
                location = self._select_branch_location(tree, location)[0]
2816
 
                other_tree, other_path = WorkingTree.open_containing(location)
2817
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2818
 
                    pb)
2819
 
                allow_pending = False
2820
 
 
2821
 
            if merger is None:
2822
 
                merger, allow_pending = self._get_merger_from_branch(tree,
2823
 
                    location, revision, remember, possible_transports, pb)
2824
 
 
2825
 
            merger.merge_type = merge_type
2826
 
            merger.reprocess = reprocess
2827
 
            merger.show_base = show_base
2828
 
            merger.change_reporter = change_reporter
2829
 
            self.sanity_check_merger(merger)
2830
 
            if (merger.base_rev_id == merger.other_rev_id and
2831
 
                merger.other_rev_id != None):
2832
 
                note('Nothing to do.')
2833
 
                return 0
2834
 
            if pull:
2835
 
                if merger.interesting_files is not None:
2836
 
                    raise errors.BzrCommandError('Cannot pull individual files')
2837
 
                if (merger.base_rev_id == tree.last_revision()):
2838
 
                    result = tree.pull(merger.other_branch, False,
2839
 
                                       merger.other_rev_id)
2840
 
                    result.report(self.outf)
2841
 
                    return 0
2842
 
            merger.check_basis(not force)
2843
 
            conflict_count = merger.do_merge()
2844
 
            if allow_pending:
2845
 
                merger.set_pending()
2846
 
            if verified == 'failed':
2847
 
                warning('Preview patch does not match changes')
2848
 
            if conflict_count != 0:
2849
 
                return 1
 
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
2850
3824
            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)
2851
3861
                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()
2852
3914
        finally:
2853
 
            for cleanup in reversed(cleanups):
2854
 
                cleanup()
 
3915
            shelver.finalize()
2855
3916
 
2856
3917
    def sanity_check_merger(self, merger):
2857
3918
        if (merger.show_base and
2858
3919
            not merger.merge_type is _mod_merge.Merge3Merger):
2859
3920
            raise errors.BzrCommandError("Show-base is not supported for this"
2860
3921
                                         " 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
2861
3928
        if merger.reprocess and not merger.merge_type.supports_reprocess:
2862
3929
            raise errors.BzrCommandError("Conflict reduction is not supported"
2863
3930
                                         " for merge type %s." %
2870
3937
                                possible_transports, pb):
2871
3938
        """Produce a merger from a location, assuming it refers to a branch."""
2872
3939
        from bzrlib.tag import _merge_tags_if_possible
2873
 
        assert revision is None or len(revision) < 3
2874
3940
        # find the branch locations
2875
 
        other_loc, location = self._select_branch_location(tree, location,
 
3941
        other_loc, user_location = self._select_branch_location(tree, location,
2876
3942
            revision, -1)
2877
3943
        if revision is not None and len(revision) == 2:
2878
 
            base_loc, location = self._select_branch_location(tree, location,
2879
 
                                                              revision, 0)
 
3944
            base_loc, _unused = self._select_branch_location(tree,
 
3945
                location, revision, 0)
2880
3946
        else:
2881
3947
            base_loc = other_loc
2882
3948
        # Open the branches
2888
3954
            base_branch, base_path = Branch.open_containing(base_loc,
2889
3955
                possible_transports)
2890
3956
        # Find the revision ids
2891
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
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:
2892
3965
            other_revision_id = _mod_revision.ensure_null(
2893
3966
                other_branch.last_revision())
2894
 
        else:
2895
 
            other_revision_id = \
2896
 
                _mod_revision.ensure_null(
2897
 
                    revision[-1].in_history(other_branch).rev_id)
2898
 
        if (revision is not None and len(revision) == 2
2899
 
            and revision[0] is not None):
2900
 
            base_revision_id = \
2901
 
                _mod_revision.ensure_null(
2902
 
                    revision[0].in_history(base_branch).rev_id)
2903
 
        else:
2904
 
            base_revision_id = None
2905
3967
        # Remember where we merge from
2906
 
        if ((tree.branch.get_parent() is None or remember) and
2907
 
            other_branch is not None):
2908
 
            tree.branch.set_parent(other_branch.base)
 
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)
2909
3971
        _merge_tags_if_possible(other_branch, tree.branch)
2910
3972
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
2911
3973
            other_revision_id, base_revision_id, other_branch, base_branch)
2916
3978
            allow_pending = True
2917
3979
        return merger, allow_pending
2918
3980
 
2919
 
    def _select_branch_location(self, tree, location, revision=None,
 
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,
2920
3996
                                index=None):
2921
3997
        """Select a branch location, according to possible inputs.
2922
3998
 
2924
4000
        ``revision`` and ``index`` must be supplied.)
2925
4001
 
2926
4002
        Otherwise, the ``location`` parameter is used.  If it is None, then the
2927
 
        ``parent`` location is used, and a note is printed.
 
4003
        ``submit`` or ``parent`` location is used, and a note is printed.
2928
4004
 
2929
4005
        :param tree: The working tree to select a branch for merging into
2930
4006
        :param location: The location entered by the user
2931
4007
        :param revision: The revision parameter to the command
2932
4008
        :param index: The index to use for the revision parameter.  Negative
2933
4009
            indices are permitted.
2934
 
        :return: (selected_location, default_location).  The default location
2935
 
            will be the user-entered location, if any, or else the remembered
2936
 
            location.
 
4010
        :return: (selected_location, user_location).  The default location
 
4011
            will be the user-entered location.
2937
4012
        """
2938
4013
        if (revision is not None and index is not None
2939
4014
            and revision[index] is not None):
2940
4015
            branch = revision[index].get_branch()
2941
4016
            if branch is not None:
2942
 
                return branch, location
2943
 
        location = self._get_remembered_parent(tree, location, 'Merging from')
2944
 
        return location, location
 
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
2945
4023
 
2946
 
    # TODO: move up to common parent; this isn't merge-specific anymore. 
2947
 
    def _get_remembered_parent(self, tree, supplied_location, verb_string):
 
4024
    def _get_remembered(self, tree, verb_string):
2948
4025
        """Use tree.branch's parent if none was supplied.
2949
4026
 
2950
4027
        Report if the remembered location was used.
2951
4028
        """
2952
 
        if supplied_location is not None:
2953
 
            return supplied_location
2954
 
        stored_location = tree.branch.get_parent()
 
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"
2955
4034
        mutter("%s", stored_location)
2956
4035
        if stored_location is None:
2957
4036
            raise errors.BzrCommandError("No location specified or remembered")
2958
 
        display_url = urlutils.unescape_for_display(stored_location,
2959
 
            self.outf.encoding)
2960
 
        self.outf.write("%s remembered location %s\n" % (verb_string,
2961
 
            display_url))
 
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)
2962
4040
        return stored_location
2963
4041
 
2964
4042
 
2965
4043
class cmd_remerge(Command):
2966
 
    """Redo a merge.
 
4044
    __doc__ = """Redo a merge.
2967
4045
 
2968
4046
    Use this if you want to try a different merge technique while resolving
2969
 
    conflicts.  Some merge techniques are better than others, and remerge 
 
4047
    conflicts.  Some merge techniques are better than others, and remerge
2970
4048
    lets you try different ones on different files.
2971
4049
 
2972
4050
    The options for remerge have the same meaning and defaults as the ones for
2976
4054
    :Examples:
2977
4055
        Re-do the merge of all conflicted files, and show the base text in
2978
4056
        conflict regions, in addition to the usual THIS and OTHER texts::
2979
 
      
 
4057
 
2980
4058
            bzr remerge --show-base
2981
4059
 
2982
4060
        Re-do the merge of "foobar", using the weave merge algorithm, with
2983
4061
        additional processing to reduce the size of conflict regions::
2984
 
      
 
4062
 
2985
4063
            bzr remerge --merge-type weave --reprocess foobar
2986
4064
    """
2987
4065
    takes_args = ['file*']
2994
4072
 
2995
4073
    def run(self, file_list=None, merge_type=None, show_base=False,
2996
4074
            reprocess=False):
 
4075
        from bzrlib.conflicts import restore
2997
4076
        if merge_type is None:
2998
4077
            merge_type = _mod_merge.Merge3Merger
2999
4078
        tree, file_list = tree_files(file_list)
3000
 
        tree.lock_write()
 
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:
 
4112
            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])
3001
4122
        try:
3002
 
            parents = tree.get_parent_ids()
3003
 
            if len(parents) != 2:
3004
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3005
 
                                             " merges.  Not cherrypicking or"
3006
 
                                             " multi-merges.")
3007
 
            repository = tree.branch.repository
3008
 
            graph = repository.get_graph()
3009
 
            base_revision = graph.find_unique_lca(parents[0], parents[1])
3010
 
            base_tree = repository.revision_tree(base_revision)
3011
 
            other_tree = repository.revision_tree(parents[1])
3012
 
            interesting_ids = None
3013
 
            new_conflicts = []
3014
 
            conflicts = tree.conflicts()
3015
 
            if file_list is not None:
3016
 
                interesting_ids = set()
3017
 
                for filename in file_list:
3018
 
                    file_id = tree.path2id(filename)
3019
 
                    if file_id is None:
3020
 
                        raise errors.NotVersionedError(filename)
3021
 
                    interesting_ids.add(file_id)
3022
 
                    if tree.kind(file_id) != "directory":
3023
 
                        continue
3024
 
                    
3025
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3026
 
                        interesting_ids.add(ie.file_id)
3027
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3028
 
            else:
3029
 
                # Remerge only supports resolving contents conflicts
3030
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3031
 
                restore_files = [c.path for c in conflicts
3032
 
                                 if c.typestring in allowed_conflicts]
3033
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3034
 
            tree.set_conflicts(ConflictList(new_conflicts))
3035
 
            if file_list is not None:
3036
 
                restore_files = file_list
3037
 
            for filename in restore_files:
3038
 
                try:
3039
 
                    restore(tree.abspath(filename))
3040
 
                except errors.NotConflicted:
3041
 
                    pass
3042
 
            # Disable pending merges, because the file texts we are remerging
3043
 
            # have not had those merges performed.  If we use the wrong parents
3044
 
            # list, we imply that the working tree text has seen and rejected
3045
 
            # all the changes from the other tree, when in fact those changes
3046
 
            # have not yet been seen.
3047
 
            tree.set_parent_ids(parents[:1])
3048
 
            try:
3049
 
                conflicts = _mod_merge.merge_inner(
3050
 
                                          tree.branch, other_tree, base_tree,
3051
 
                                          this_tree=tree,
3052
 
                                          interesting_ids=interesting_ids,
3053
 
                                          other_rev_id=parents[1],
3054
 
                                          merge_type=merge_type,
3055
 
                                          show_base=show_base,
3056
 
                                          reprocess=reprocess)
3057
 
            finally:
3058
 
                tree.set_parent_ids(parents)
 
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()
3059
4129
        finally:
3060
 
            tree.unlock()
 
4130
            tree.set_parent_ids(parents)
3061
4131
        if conflicts > 0:
3062
4132
            return 1
3063
4133
        else:
3065
4135
 
3066
4136
 
3067
4137
class cmd_revert(Command):
3068
 
    """Revert files to a previous revision.
 
4138
    __doc__ = """Revert files to a previous revision.
3069
4139
 
3070
4140
    Giving a list of files will revert only those files.  Otherwise, all files
3071
4141
    will be reverted.  If the revision is not specified with '--revision', the
3072
4142
    last committed revision is used.
3073
4143
 
3074
4144
    To remove only some changes, without reverting to a prior version, use
3075
 
    merge instead.  For example, "merge . --r-2..-3" will remove the changes
3076
 
    introduced by -2, without affecting the changes introduced by -1.  Or
3077
 
    to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3078
 
    
 
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
 
3079
4149
    By default, any files that have been manually changed will be backed up
3080
4150
    first.  (Files changed only by merge are not backed up.)  Backup files have
3081
4151
    '.~#~' appended to their name, where # is a number.
3085
4155
    name.  If you name a directory, all the contents of that directory will be
3086
4156
    reverted.
3087
4157
 
3088
 
    Any files that have been newly added since that revision will be deleted,
3089
 
    with a backup kept if appropriate.  Directories containing unknown files
3090
 
    will not be deleted.
 
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.
3091
4162
 
3092
 
    The working tree contains a list of pending merged revisions, which will
3093
 
    be included as parents in the next commit.  Normally, revert clears that
3094
 
    list as well as reverting the files.  If any files, are specified, revert
3095
 
    leaves the pending merge list alnone and reverts only the files.  Use "bzr
3096
 
    revert ." in the tree root to revert all files but keep the merge record,
3097
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
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
3098
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.
3099
4181
    """
3100
4182
 
3101
4183
    _see_also = ['cat', 'export']
3110
4192
    def run(self, revision=None, no_backup=False, file_list=None,
3111
4193
            forget_merges=None):
3112
4194
        tree, file_list = tree_files(file_list)
 
4195
        self.add_cleanup(tree.lock_tree_write().unlock)
3113
4196
        if forget_merges:
3114
4197
            tree.set_parent_ids(tree.get_parent_ids()[:1])
3115
4198
        else:
3117
4200
 
3118
4201
    @staticmethod
3119
4202
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3120
 
        if revision is None:
3121
 
            rev_id = tree.last_revision()
3122
 
        elif len(revision) != 1:
3123
 
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3124
 
        else:
3125
 
            rev_id = revision[0].in_history(tree.branch).rev_id
3126
 
        pb = ui.ui_factory.nested_progress_bar()
3127
 
        try:
3128
 
            tree.revert(file_list,
3129
 
                        tree.branch.repository.revision_tree(rev_id),
3130
 
                        not no_backup, pb, report_changes=True)
3131
 
        finally:
3132
 
            pb.finished()
 
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)
3133
4206
 
3134
4207
 
3135
4208
class cmd_assert_fail(Command):
3136
 
    """Test reporting of assertion failures"""
 
4209
    __doc__ = """Test reporting of assertion failures"""
3137
4210
    # intended just for use in testing
3138
4211
 
3139
4212
    hidden = True
3143
4216
 
3144
4217
 
3145
4218
class cmd_help(Command):
3146
 
    """Show help on a command or other topic.
 
4219
    __doc__ = """Show help on a command or other topic.
3147
4220
    """
3148
4221
 
3149
4222
    _see_also = ['topics']
3152
4225
            ]
3153
4226
    takes_args = ['topic?']
3154
4227
    aliases = ['?', '--help', '-?', '-h']
3155
 
    
 
4228
 
3156
4229
    @display_command
3157
4230
    def run(self, topic=None, long=False):
3158
4231
        import bzrlib.help
3162
4235
 
3163
4236
 
3164
4237
class cmd_shell_complete(Command):
3165
 
    """Show appropriate completions for context.
 
4238
    __doc__ = """Show appropriate completions for context.
3166
4239
 
3167
4240
    For a list of all available commands, say 'bzr shell-complete'.
3168
4241
    """
3169
4242
    takes_args = ['context?']
3170
4243
    aliases = ['s-c']
3171
4244
    hidden = True
3172
 
    
 
4245
 
3173
4246
    @display_command
3174
4247
    def run(self, context=None):
3175
4248
        import shellcomplete
3176
4249
        shellcomplete.shellcomplete(context)
3177
4250
 
3178
4251
 
3179
 
class cmd_fetch(Command):
3180
 
    """Copy in history from another branch but don't merge it.
3181
 
 
3182
 
    This is an internal method used for pull and merge.
3183
 
    """
3184
 
    hidden = True
3185
 
    takes_args = ['from_branch', 'to_branch']
3186
 
    def run(self, from_branch, to_branch):
3187
 
        from bzrlib.fetch import Fetcher
3188
 
        from_b = Branch.open(from_branch)
3189
 
        to_b = Branch.open(to_branch)
3190
 
        Fetcher(to_b, from_b)
3191
 
 
3192
 
 
3193
4252
class cmd_missing(Command):
3194
 
    """Show unmerged/unpulled revisions between two branches.
3195
 
    
 
4253
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4254
 
3196
4255
    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
3197
4285
    """
3198
4286
 
3199
4287
    _see_also = ['merge', 'pull']
3200
4288
    takes_args = ['other_branch?']
3201
4289
    takes_options = [
3202
 
            Option('reverse', 'Reverse the order of revisions.'),
3203
 
            Option('mine-only',
3204
 
                   'Display changes in the local branch only.'),
3205
 
            Option('this' , 'Same as --mine-only.'),
3206
 
            Option('theirs-only',
3207
 
                   'Display changes in the remote branch only.'),
3208
 
            Option('other', 'Same as --theirs-only.'),
3209
 
            'log-format',
3210
 
            'show-ids',
3211
 
            'verbose'
3212
 
            ]
 
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
        ]
3213
4310
    encoding_type = 'replace'
3214
4311
 
3215
4312
    @display_command
3216
4313
    def run(self, other_branch=None, reverse=False, mine_only=False,
3217
 
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
3218
 
            show_ids=False, verbose=False, this=False, other=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):
3219
4318
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
4319
        def message(s):
 
4320
            if not is_quiet():
 
4321
                self.outf.write(s)
3220
4322
 
3221
4323
        if this:
3222
 
          mine_only = this
 
4324
            mine_only = this
3223
4325
        if other:
3224
 
          theirs_only = 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'
3225
4335
 
3226
4336
        local_branch = Branch.open_containing(u".")[0]
 
4337
        self.add_cleanup(local_branch.lock_read().unlock)
 
4338
 
3227
4339
        parent = local_branch.get_parent()
3228
4340
        if other_branch is None:
3229
4341
            other_branch = parent
3232
4344
                                             " or specified.")
3233
4345
            display_url = urlutils.unescape_for_display(parent,
3234
4346
                                                        self.outf.encoding)
3235
 
            self.outf.write("Using last location: " + display_url + "\n")
 
4347
            message("Using saved parent location: "
 
4348
                    + display_url + "\n")
3236
4349
 
3237
4350
        remote_branch = Branch.open(other_branch)
3238
4351
        if remote_branch.base == local_branch.base:
3239
4352
            remote_branch = local_branch
3240
 
        local_branch.lock_read()
3241
 
        try:
3242
 
            remote_branch.lock_read()
3243
 
            try:
3244
 
                local_extra, remote_extra = find_unmerged(local_branch,
3245
 
                                                          remote_branch)
3246
 
                if log_format is None:
3247
 
                    registry = log.log_formatter_registry
3248
 
                    log_format = registry.get_default(local_branch)
3249
 
                lf = log_format(to_file=self.outf,
3250
 
                                show_ids=show_ids,
3251
 
                                show_timezone='original')
3252
 
                if reverse is False:
3253
 
                    local_extra.reverse()
3254
 
                    remote_extra.reverse()
3255
 
                if local_extra and not theirs_only:
3256
 
                    self.outf.write("You have %d extra revision(s):\n" %
3257
 
                                    len(local_extra))
3258
 
                    for revision in iter_log_revisions(local_extra,
3259
 
                                        local_branch.repository,
3260
 
                                        verbose):
3261
 
                        lf.log_revision(revision)
3262
 
                    printed_local = True
3263
 
                else:
3264
 
                    printed_local = False
3265
 
                if remote_extra and not mine_only:
3266
 
                    if printed_local is True:
3267
 
                        self.outf.write("\n\n\n")
3268
 
                    self.outf.write("You are missing %d revision(s):\n" %
3269
 
                                    len(remote_extra))
3270
 
                    for revision in iter_log_revisions(remote_extra,
3271
 
                                        remote_branch.repository,
3272
 
                                        verbose):
3273
 
                        lf.log_revision(revision)
3274
 
                if not remote_extra and not local_extra:
3275
 
                    status_code = 0
3276
 
                    self.outf.write("Branches are up to date.\n")
3277
 
                else:
3278
 
                    status_code = 1
3279
 
            finally:
3280
 
                remote_branch.unlock()
3281
 
        finally:
3282
 
            local_branch.unlock()
 
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()
3283
4414
        if not status_code and parent is None and other_branch is not None:
3284
 
            local_branch.lock_write()
3285
 
            try:
3286
 
                # handle race conditions - a parent might be set while we run.
3287
 
                if local_branch.get_parent() is None:
3288
 
                    local_branch.set_parent(remote_branch.base)
3289
 
            finally:
3290
 
                local_branch.unlock()
 
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)
3291
4419
        return status_code
3292
4420
 
3293
4421
 
3294
4422
class cmd_pack(Command):
3295
 
    """Compress the data within a repository."""
 
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
    """
3296
4440
 
3297
4441
    _see_also = ['repositories']
3298
4442
    takes_args = ['branch_or_repo?']
 
4443
    takes_options = [
 
4444
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
4445
        ]
3299
4446
 
3300
 
    def run(self, branch_or_repo='.'):
 
4447
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
3301
4448
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
3302
4449
        try:
3303
4450
            branch = dir.open_branch()
3304
4451
            repository = branch.repository
3305
4452
        except errors.NotBranchError:
3306
4453
            repository = dir.open_repository()
3307
 
        repository.pack()
 
4454
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
3308
4455
 
3309
4456
 
3310
4457
class cmd_plugins(Command):
3311
 
    """List the installed plugins.
3312
 
    
3313
 
    This command displays the list of installed plugins including the
3314
 
    path where each one is located and a short description of each.
 
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.
3315
4464
 
3316
4465
    A plugin is an external component for Bazaar that extends the
3317
4466
    revision control system, by adding or replacing code in Bazaar.
3319
4468
    adding new commands, providing additional network transports and
3320
4469
    customizing log output.
3321
4470
 
3322
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
3323
 
    information on plugins including where to find them and how to
3324
 
    install them. Instructions are also provided there on how to
3325
 
    write new plugins using the Python programming language.
 
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.
3326
4475
    """
 
4476
    takes_options = ['verbose']
3327
4477
 
3328
4478
    @display_command
3329
 
    def run(self):
 
4479
    def run(self, verbose=False):
3330
4480
        import bzrlib.plugin
3331
4481
        from inspect import getdoc
 
4482
        result = []
3332
4483
        for name, plugin in bzrlib.plugin.plugins().items():
3333
 
            print plugin.path(), "[%s]" % plugin.__version__
 
4484
            version = plugin.__version__
 
4485
            if version == 'unknown':
 
4486
                version = ''
 
4487
            name_ver = '%s %s' % (name, version)
3334
4488
            d = getdoc(plugin.module)
3335
4489
            if d:
3336
 
                print '\t', d.split('\n')[0]
 
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")
3337
4500
 
3338
4501
 
3339
4502
class cmd_testament(Command):
3340
 
    """Show testament (signing-form) of a revision."""
 
4503
    __doc__ = """Show testament (signing-form) of a revision."""
3341
4504
    takes_options = [
3342
4505
            'revision',
3343
4506
            Option('long', help='Produce long-format testament.'),
3351
4514
            testament_class = StrictTestament
3352
4515
        else:
3353
4516
            testament_class = Testament
3354
 
        b = WorkingTree.open_containing(branch)[0].branch
3355
 
        b.lock_read()
3356
 
        try:
3357
 
            if revision is None:
3358
 
                rev_id = b.last_revision()
3359
 
            else:
3360
 
                rev_id = revision[0].in_history(b).rev_id
3361
 
            t = testament_class.from_revision(b.repository, rev_id)
3362
 
            if long:
3363
 
                sys.stdout.writelines(t.as_text_lines())
3364
 
            else:
3365
 
                sys.stdout.write(t.as_short_text())
3366
 
        finally:
3367
 
            b.unlock()
 
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())
3368
4531
 
3369
4532
 
3370
4533
class cmd_annotate(Command):
3371
 
    """Show the origin of each line in a file.
 
4534
    __doc__ = """Show the origin of each line in a file.
3372
4535
 
3373
4536
    This prints out the given file with an annotation on the left side
3374
4537
    indicating which revision, author and date introduced the change.
3375
4538
 
3376
 
    If the origin is the same for a run of consecutive lines, it is 
 
4539
    If the origin is the same for a run of consecutive lines, it is
3377
4540
    shown only at the top, unless the --all option is given.
3378
4541
    """
3379
4542
    # TODO: annotate directories; showing when each file was last changed
3380
 
    # TODO: if the working copy is modified, show annotations on that 
 
4543
    # TODO: if the working copy is modified, show annotations on that
3381
4544
    #       with new uncommitted lines marked
3382
4545
    aliases = ['ann', 'blame', 'praise']
3383
4546
    takes_args = ['filename']
3385
4548
                     Option('long', help='Show commit date in annotations.'),
3386
4549
                     'revision',
3387
4550
                     'show-ids',
 
4551
                     'directory',
3388
4552
                     ]
3389
4553
    encoding_type = 'exact'
3390
4554
 
3391
4555
    @display_command
3392
4556
    def run(self, filename, all=False, long=False, revision=None,
3393
 
            show_ids=False):
3394
 
        from bzrlib.annotate import annotate_file
3395
 
        tree, relpath = WorkingTree.open_containing(filename)
3396
 
        branch = tree.branch
3397
 
        branch.lock_read()
3398
 
        try:
3399
 
            if revision is None:
3400
 
                revision_id = branch.last_revision()
3401
 
            elif len(revision) != 1:
3402
 
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3403
 
            else:
3404
 
                revision_id = revision[0].in_history(branch).rev_id
 
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:
3405
4570
            file_id = tree.path2id(relpath)
3406
 
            if file_id is None:
3407
 
                raise errors.NotVersionedError(filename)
3408
 
            tree = branch.repository.revision_tree(revision_id)
3409
 
            file_version = tree.inventory[file_id].revision
 
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:
3410
4580
            annotate_file(branch, file_version, file_id, long, all, self.outf,
3411
4581
                          show_ids=show_ids)
3412
 
        finally:
3413
 
            branch.unlock()
3414
4582
 
3415
4583
 
3416
4584
class cmd_re_sign(Command):
3417
 
    """Create a digital signature for an existing revision."""
 
4585
    __doc__ = """Create a digital signature for an existing revision."""
3418
4586
    # TODO be able to replace existing ones.
3419
4587
 
3420
4588
    hidden = True # is this right ?
3421
4589
    takes_args = ['revision_id*']
3422
 
    takes_options = ['revision']
3423
 
    
3424
 
    def run(self, revision_id_list=None, revision=None):
3425
 
        import bzrlib.gpg as gpg
 
4590
    takes_options = ['directory', 'revision']
 
4591
 
 
4592
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
3426
4593
        if revision_id_list is not None and revision is not None:
3427
4594
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
3428
4595
        if revision_id_list is None and revision is None:
3429
4596
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3430
 
        b = WorkingTree.open_containing(u'.')[0].branch
 
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
3431
4603
        gpg_strategy = gpg.GPGStrategy(b.get_config())
3432
4604
        if revision_id_list is not None:
3433
 
            for revision_id in revision_id_list:
3434
 
                b.repository.sign_revision(revision_id, gpg_strategy)
 
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()
3435
4614
        elif revision is not None:
3436
4615
            if len(revision) == 1:
3437
4616
                revno, rev_id = revision[0].in_history(b)
3438
 
                b.repository.sign_revision(rev_id, gpg_strategy)
 
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()
3439
4625
            elif len(revision) == 2:
3440
4626
                # are they both on rh- if so we can walk between them
3441
4627
                # might be nice to have a range helper for arbitrary
3446
4632
                    to_revno = b.revno()
3447
4633
                if from_revno is None or to_revno is None:
3448
4634
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
3449
 
                for revno in range(from_revno, to_revno + 1):
3450
 
                    b.repository.sign_revision(b.get_rev_id(revno), 
3451
 
                                               gpg_strategy)
 
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()
3452
4645
            else:
3453
4646
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
3454
4647
 
3455
4648
 
3456
4649
class cmd_bind(Command):
3457
 
    """Convert the current branch into a checkout of the supplied branch.
 
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.
3458
4652
 
3459
4653
    Once converted into a checkout, commits must succeed on the master branch
3460
4654
    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.
3461
4659
    """
3462
4660
 
3463
4661
    _see_also = ['checkouts', 'unbind']
3464
4662
    takes_args = ['location?']
3465
 
    takes_options = []
 
4663
    takes_options = ['directory']
3466
4664
 
3467
 
    def run(self, location=None):
3468
 
        b, relpath = Branch.open_containing(u'.')
 
4665
    def run(self, location=None, directory=u'.'):
 
4666
        b, relpath = Branch.open_containing(directory)
3469
4667
        if location is None:
3470
4668
            try:
3471
4669
                location = b.get_old_bound_location()
3474
4672
                    'This format does not remember old locations.')
3475
4673
            else:
3476
4674
                if location is None:
3477
 
                    raise errors.BzrCommandError('No location supplied and no '
3478
 
                        'previous location known')
 
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')
3479
4680
        b_other = Branch.open(location)
3480
4681
        try:
3481
4682
            b.bind(b_other)
3482
4683
        except errors.DivergedBranches:
3483
4684
            raise errors.BzrCommandError('These branches have diverged.'
3484
4685
                                         ' Try merging, and then bind again.')
 
4686
        if b.get_config().has_explicit_nickname():
 
4687
            b.nick = b_other.nick
3485
4688
 
3486
4689
 
3487
4690
class cmd_unbind(Command):
3488
 
    """Convert the current checkout into a regular branch.
 
4691
    __doc__ = """Convert the current checkout into a regular branch.
3489
4692
 
3490
4693
    After unbinding, the local branch is considered independent and subsequent
3491
4694
    commits will be local only.
3493
4696
 
3494
4697
    _see_also = ['checkouts', 'bind']
3495
4698
    takes_args = []
3496
 
    takes_options = []
 
4699
    takes_options = ['directory']
3497
4700
 
3498
 
    def run(self):
3499
 
        b, relpath = Branch.open_containing(u'.')
 
4701
    def run(self, directory=u'.'):
 
4702
        b, relpath = Branch.open_containing(directory)
3500
4703
        if not b.unbind():
3501
4704
            raise errors.BzrCommandError('Local branch is not bound')
3502
4705
 
3503
4706
 
3504
4707
class cmd_uncommit(Command):
3505
 
    """Remove the last committed revision.
 
4708
    __doc__ = """Remove the last committed revision.
3506
4709
 
3507
4710
    --verbose will print out what is being removed.
3508
4711
    --dry-run will go through all the motions, but not actually
3512
4715
    specified revision.  For example, "bzr uncommit -r 15" will leave the
3513
4716
    branch at revision 15.
3514
4717
 
3515
 
    In the future, uncommit will create a revision bundle, which can then
3516
 
    be re-applied.
 
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.
3517
4721
    """
3518
4722
 
3519
4723
    # TODO: jam 20060108 Add an option to allow uncommit to remove
3523
4727
    _see_also = ['commit']
3524
4728
    takes_options = ['verbose', 'revision',
3525
4729
                    Option('dry-run', help='Don\'t actually make changes.'),
3526
 
                    Option('force', help='Say yes to all questions.')]
 
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
                    ]
3527
4736
    takes_args = ['location?']
3528
4737
    aliases = []
 
4738
    encoding_type = 'replace'
3529
4739
 
3530
4740
    def run(self, location=None,
3531
4741
            dry_run=False, verbose=False,
3532
 
            revision=None, force=False):
 
4742
            revision=None, force=False, local=False):
 
4743
        if location is None:
 
4744
            location = u'.'
 
4745
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4746
        try:
 
4747
            tree = control.open_workingtree()
 
4748
            b = tree.branch
 
4749
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4750
            tree = None
 
4751
            b = control.open_branch()
 
4752
 
 
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):
3533
4760
        from bzrlib.log import log_formatter, show_log
3534
4761
        from bzrlib.uncommit import uncommit
3535
4762
 
3536
 
        if location is None:
3537
 
            location = u'.'
3538
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
3539
 
        try:
3540
 
            tree = control.open_workingtree()
3541
 
            b = tree.branch
3542
 
        except (errors.NoWorkingTree, errors.NotLocalUrl):
3543
 
            tree = None
3544
 
            b = control.open_branch()
 
4763
        last_revno, last_rev_id = b.last_revision_info()
3545
4764
 
3546
4765
        rev_id = None
3547
4766
        if revision is None:
3548
 
            revno = b.revno()
 
4767
            revno = last_revno
 
4768
            rev_id = last_rev_id
3549
4769
        else:
3550
4770
            # 'bzr uncommit -r 10' actually means uncommit
3551
4771
            # so that the final tree is at revno 10.
3552
4772
            # but bzrlib.uncommit.uncommit() actually uncommits
3553
4773
            # the revisions that are supplied.
3554
4774
            # So we need to offset it by one
3555
 
            revno = revision[0].in_history(b).revno+1
 
4775
            revno = revision[0].in_history(b).revno + 1
 
4776
            if revno <= last_revno:
 
4777
                rev_id = b.get_rev_id(revno)
3556
4778
 
3557
 
        if revno <= b.revno():
3558
 
            rev_id = b.get_rev_id(revno)
3559
 
        if rev_id is None:
 
4779
        if rev_id is None or _mod_revision.is_null(rev_id):
3560
4780
            self.outf.write('No revisions to uncommit.\n')
3561
4781
            return 1
3562
4782
 
3569
4789
                 verbose=False,
3570
4790
                 direction='forward',
3571
4791
                 start_revision=revno,
3572
 
                 end_revision=b.revno())
 
4792
                 end_revision=last_revno)
3573
4793
 
3574
4794
        if dry_run:
3575
 
            print 'Dry-run, pretending to remove the above revisions.'
3576
 
            if not force:
3577
 
                val = raw_input('Press <enter> to continue')
 
4795
            self.outf.write('Dry-run, pretending to remove'
 
4796
                            ' the above revisions.\n')
3578
4797
        else:
3579
 
            print 'The above revision(s) will be removed.'
3580
 
            if not force:
3581
 
                val = raw_input('Are you sure [y/N]? ')
3582
 
                if val.lower() not in ('y', 'yes'):
3583
 
                    print 'Canceled'
3584
 
                    return 0
3585
 
 
 
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)
3586
4807
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3587
 
                revno=revno)
 
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)
3588
4811
 
3589
4812
 
3590
4813
class cmd_break_lock(Command):
3591
 
    """Break a dead lock on a repository, branch or working directory.
 
4814
    __doc__ = """Break a dead lock on a repository, branch or working directory.
3592
4815
 
3593
4816
    CAUTION: Locks should only be broken when you are sure that the process
3594
4817
    holding the lock has been stopped.
3595
4818
 
3596
 
    You can get information on what locks are open via the 'bzr info' command.
3597
 
    
 
4819
    You can get information on what locks are open via the 'bzr info
 
4820
    [location]' command.
 
4821
 
3598
4822
    :Examples:
3599
4823
        bzr break-lock
 
4824
        bzr break-lock bzr+ssh://example.com/bzr/foo
3600
4825
    """
3601
4826
    takes_args = ['location?']
3602
4827
 
3608
4833
            control.break_lock()
3609
4834
        except NotImplementedError:
3610
4835
            pass
3611
 
        
 
4836
 
3612
4837
 
3613
4838
class cmd_wait_until_signalled(Command):
3614
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4839
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3615
4840
 
3616
4841
    This just prints a line to signal when it is ready, then blocks on stdin.
3617
4842
    """
3625
4850
 
3626
4851
 
3627
4852
class cmd_serve(Command):
3628
 
    """Run the bzr server."""
 
4853
    __doc__ = """Run the bzr server."""
3629
4854
 
3630
4855
    aliases = ['server']
3631
4856
 
3632
4857
    takes_options = [
3633
4858
        Option('inet',
3634
4859
               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),
3635
4864
        Option('port',
3636
4865
               help='Listen for connections on nominated port of the form '
3637
4866
                    '[hostname:]portnumber.  Passing 0 as the port number will '
3638
 
                    'result in a dynamically allocated port.  The default port is '
3639
 
                    '4155.',
 
4867
                    'result in a dynamically allocated port.  The default port '
 
4868
                    'depends on the protocol.',
3640
4869
               type=str),
3641
 
        Option('directory',
3642
 
               help='Serve contents of this directory.',
3643
 
               type=unicode),
 
4870
        custom_help('directory',
 
4871
               help='Serve contents of this directory.'),
3644
4872
        Option('allow-writes',
3645
4873
               help='By default the server is a readonly server.  Supplying '
3646
4874
                    '--allow-writes enables write access to the contents of '
3647
 
                    'the served directory and below.'
 
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.'
3648
4880
                ),
3649
4881
        ]
3650
4882
 
3651
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
3652
 
        from bzrlib.smart import medium, server
3653
 
        from bzrlib.transport import get_transport
3654
 
        from bzrlib.transport.chroot import ChrootServer
3655
 
        from bzrlib.transport.remote import BZR_DEFAULT_PORT, BZR_DEFAULT_INTERFACE
 
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
3656
4905
        if directory is None:
3657
4906
            directory = os.getcwd()
 
4907
        if protocol is None:
 
4908
            protocol = transport_server_registry.get()
 
4909
        host, port = self.get_host_and_port(port)
3658
4910
        url = urlutils.local_path_to_url(directory)
3659
4911
        if not allow_writes:
3660
4912
            url = 'readonly+' + url
3661
 
        chroot_server = ChrootServer(get_transport(url))
3662
 
        chroot_server.setUp()
3663
 
        t = get_transport(chroot_server.get_url())
3664
 
        if inet:
3665
 
            smart_server = medium.SmartServerPipeStreamMedium(
3666
 
                sys.stdin, sys.stdout, t)
3667
 
        else:
3668
 
            host = BZR_DEFAULT_INTERFACE
3669
 
            if port is None:
3670
 
                port = BZR_DEFAULT_PORT
3671
 
            else:
3672
 
                if ':' in port:
3673
 
                    host, port = port.split(':')
3674
 
                port = int(port)
3675
 
            smart_server = server.SmartTCPServer(t, host=host, port=port)
3676
 
            print 'listening on port: ', smart_server.port
3677
 
            sys.stdout.flush()
3678
 
        # for the duration of this server, no UI output is permitted.
3679
 
        # note that this may cause problems with blackbox tests. This should
3680
 
        # be changed with care though, as we dont want to use bandwidth sending
3681
 
        # progress over stderr to smart server clients!
3682
 
        old_factory = ui.ui_factory
3683
 
        try:
3684
 
            ui.ui_factory = ui.SilentUIFactory()
3685
 
            smart_server.serve()
3686
 
        finally:
3687
 
            ui.ui_factory = old_factory
 
4913
        transport = get_transport(url)
 
4914
        protocol(transport, host, port, inet)
3688
4915
 
3689
4916
 
3690
4917
class cmd_join(Command):
3691
 
    """Combine a subtree into its containing tree.
3692
 
    
3693
 
    This command is for experimental use only.  It requires the target tree
3694
 
    to be in dirstate-with-subtree format, which cannot be converted into
3695
 
    earlier formats.
 
4918
    __doc__ = """Combine a tree into its containing tree.
 
4919
 
 
4920
    This command requires the target tree to be in a rich-root format.
3696
4921
 
3697
4922
    The TREE argument should be an independent tree, inside another tree, but
3698
4923
    not part of it.  (Such trees can be produced by "bzr split", but also by
3701
4926
    The result is a combined tree, with the subtree no longer an independant
3702
4927
    part.  This is marked as a merge of the subtree into the containing tree,
3703
4928
    and all history is preserved.
3704
 
 
3705
 
    If --reference is specified, the subtree retains its independence.  It can
3706
 
    be branched by itself, and can be part of multiple projects at the same
3707
 
    time.  But operations performed in the containing tree, such as commit
3708
 
    and merge, will recurse into the subtree.
3709
4929
    """
3710
4930
 
3711
4931
    _see_also = ['split']
3712
4932
    takes_args = ['tree']
3713
4933
    takes_options = [
3714
 
            Option('reference', help='Join by reference.'),
 
4934
            Option('reference', help='Join by reference.', hidden=True),
3715
4935
            ]
3716
 
    hidden = True
3717
4936
 
3718
4937
    def run(self, tree, reference=False):
3719
4938
        sub_tree = WorkingTree.open(tree)
3737
4956
            try:
3738
4957
                containing_tree.subsume(sub_tree)
3739
4958
            except errors.BadSubsumeSource, e:
3740
 
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
4959
                raise errors.BzrCommandError("Cannot join %s.  %s" %
3741
4960
                                             (tree, e.reason))
3742
4961
 
3743
4962
 
3744
4963
class cmd_split(Command):
3745
 
    """Split a tree into two trees.
 
4964
    __doc__ = """Split a subdirectory of a tree into a separate tree.
3746
4965
 
3747
 
    This command is for experimental use only.  It requires the target tree
3748
 
    to be in dirstate-with-subtree format, which cannot be converted into
3749
 
    earlier formats.
 
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'.
3750
4969
 
3751
4970
    The TREE argument should be a subdirectory of a working tree.  That
3752
4971
    subdirectory will be converted into an independent tree, with its own
3753
4972
    branch.  Commits in the top-level tree will not apply to the new subtree.
3754
 
    If you want that behavior, do "bzr join --reference TREE".
3755
4973
    """
3756
4974
 
3757
4975
    _see_also = ['join']
3758
4976
    takes_args = ['tree']
3759
4977
 
3760
 
    hidden = True
3761
 
 
3762
4978
    def run(self, tree):
3763
4979
        containing_tree, subdir = WorkingTree.open_containing(tree)
3764
4980
        sub_id = containing_tree.path2id(subdir)
3767
4983
        try:
3768
4984
            containing_tree.extract(sub_id)
3769
4985
        except errors.RootNotRich:
3770
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
3771
 
 
 
4986
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
3772
4987
 
3773
4988
 
3774
4989
class cmd_merge_directive(Command):
3775
 
    """Generate a merge directive for auto-merge tools.
 
4990
    __doc__ = """Generate a merge directive for auto-merge tools.
3776
4991
 
3777
4992
    A directive requests a merge to be performed, and also provides all the
3778
4993
    information necessary to do so.  This means it must either include a
3845
5060
            if len(revision) > 2:
3846
5061
                raise errors.BzrCommandError('bzr merge-directive takes '
3847
5062
                    'at most two one revision identifiers')
3848
 
            revision_id = revision[-1].in_history(branch).rev_id
 
5063
            revision_id = revision[-1].as_revision_id(branch)
3849
5064
            if len(revision) == 2:
3850
 
                base_revision_id = revision[0].in_history(branch).rev_id
3851
 
                base_revision_id = ensure_null(base_revision_id)
 
5065
                base_revision_id = revision[0].as_revision_id(branch)
3852
5066
        else:
3853
5067
            revision_id = branch.last_revision()
3854
5068
        revision_id = ensure_null(revision_id)
3872
5086
 
3873
5087
 
3874
5088
class cmd_send(Command):
3875
 
    """Mail or create a merge-directive for submiting changes.
 
5089
    __doc__ = """Mail or create a merge-directive for submitting changes.
3876
5090
 
3877
5091
    A merge directive provides many things needed for requesting merges:
3878
5092
 
3884
5098
      directly from the merge directive, without retrieving data from a
3885
5099
      branch.
3886
5100
 
3887
 
    If --no-bundle is specified, then public_branch is needed (and must be
3888
 
    up-to-date), so that the receiver can perform the merge using the
3889
 
    public_branch.  The public_branch is always included if known, so that
3890
 
    people can check it later.
3891
 
 
3892
 
    The submit branch defaults to the parent, but can be overridden.  Both
3893
 
    submit branch and public branch will be remembered if supplied.
3894
 
 
3895
 
    If a public_branch is known for the submit_branch, that public submit
3896
 
    branch is used in the merge instructions.  This means that a local mirror
3897
 
    can be used as your actual submit branch, once you have set public_branch
3898
 
    for that mirror.
 
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.
3899
5127
 
3900
5128
    Mail is sent using your preferred mail program.  This should be transparent
3901
 
    on Windows (it uses MAPI).  On *nix, it requires the xdg-email utility.  If
3902
 
    the preferred client can't be found (or used), your editor will be used.
3903
 
    
 
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
 
3904
5132
    To use a specific mail program, set the mail_client configuration option.
3905
5133
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
3906
 
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
3907
 
    generic options are "default", "editor", "mapi", and "xdg-email".
 
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.
3908
5138
 
3909
5139
    If mail is being sent, a to address is required.  This can be supplied
3910
 
    either on the commandline, or by setting the submit_to configuration
3911
 
    option.
 
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.
3912
5143
 
3913
5144
    Two formats are currently supported: "4" uses revision bundle format 4 and
3914
5145
    merge directive format 2.  It is significantly faster and smaller than
3915
5146
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
3916
5147
    default.  "0.9" uses revision bundle format 0.9 and merge directive
3917
5148
    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.
3918
5156
    """
3919
5157
 
3920
5158
    encoding_type = 'exact'
3921
5159
 
3922
 
    _see_also = ['merge']
 
5160
    _see_also = ['merge', 'pull']
3923
5161
 
3924
5162
    takes_args = ['submit_branch?', 'public_branch?']
3925
5163
 
3935
5173
               'rather than the one containing the working directory.',
3936
5174
               short_name='f',
3937
5175
               type=unicode),
3938
 
        Option('output', short_name='o', help='Write directive to this file.',
 
5176
        Option('output', short_name='o',
 
5177
               help='Write merge directive to this file or directory; '
 
5178
                    'use - for stdout.',
3939
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.'),
3940
5183
        Option('mail-to', help='Mail the request to this address.',
3941
5184
               type=unicode),
3942
5185
        'revision',
3943
5186
        'message',
3944
 
        RegistryOption.from_kwargs('format',
3945
 
        'Use the specified output format.',
3946
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
3947
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
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')),
3948
5191
        ]
3949
5192
 
3950
5193
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
3951
5194
            no_patch=False, revision=None, remember=False, output=None,
3952
 
            format='4', mail_to=None, message=None, **kwargs):
3953
 
        return self._run(submit_branch, revision, public_branch, remember,
3954
 
                         format, no_bundle, no_patch, output,
3955
 
                         kwargs.get('from', '.'), mail_to, message)
3956
 
 
3957
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
3958
 
             no_bundle, no_patch, output, from_, mail_to, message):
3959
 
        from bzrlib.revision import NULL_REVISION
3960
 
        if output is None:
3961
 
            outfile = StringIO()
3962
 
        elif output == '-':
3963
 
            outfile = self.outf
3964
 
        else:
3965
 
            outfile = open(output, 'wb')
3966
 
        try:
3967
 
            branch = Branch.open_containing(from_)[0]
3968
 
            if output is None:
3969
 
                config = branch.get_config()
3970
 
                if mail_to is None:
3971
 
                    mail_to = config.get_user_option('submit_to')
3972
 
                if mail_to is None:
3973
 
                    raise errors.BzrCommandError('No mail-to address'
3974
 
                                                 ' specified')
3975
 
                mail_client = config.get_mail_client()
3976
 
            if remember and submit_branch is None:
3977
 
                raise errors.BzrCommandError(
3978
 
                    '--remember requires a branch to be specified.')
3979
 
            stored_submit_branch = branch.get_submit_branch()
3980
 
            remembered_submit_branch = False
3981
 
            if submit_branch is None:
3982
 
                submit_branch = stored_submit_branch
3983
 
                remembered_submit_branch = True
3984
 
            else:
3985
 
                if stored_submit_branch is None or remember:
3986
 
                    branch.set_submit_branch(submit_branch)
3987
 
            if submit_branch is None:
3988
 
                submit_branch = branch.get_parent()
3989
 
                remembered_submit_branch = True
3990
 
            if submit_branch is None:
3991
 
                raise errors.BzrCommandError('No submit branch known or'
3992
 
                                             ' specified')
3993
 
            if remembered_submit_branch:
3994
 
                note('Using saved location: %s', submit_branch)
3995
 
 
3996
 
            stored_public_branch = branch.get_public_branch()
3997
 
            if public_branch is None:
3998
 
                public_branch = stored_public_branch
3999
 
            elif stored_public_branch is None or remember:
4000
 
                branch.set_public_branch(public_branch)
4001
 
            if no_bundle and public_branch is None:
4002
 
                raise errors.BzrCommandError('No public branch specified or'
4003
 
                                             ' known')
4004
 
            base_revision_id = None
4005
 
            revision_id = None
4006
 
            if revision is not None:
4007
 
                if len(revision) > 2:
4008
 
                    raise errors.BzrCommandError('bzr send takes '
4009
 
                        'at most two one revision identifiers')
4010
 
                revision_id = revision[-1].in_history(branch).rev_id
4011
 
                if len(revision) == 2:
4012
 
                    base_revision_id = revision[0].in_history(branch).rev_id
4013
 
            if revision_id is None:
4014
 
                revision_id = branch.last_revision()
4015
 
            if revision_id == NULL_REVISION:
4016
 
                raise errors.BzrCommandError('No revisions to submit.')
4017
 
            if format == '4':
4018
 
                directive = merge_directive.MergeDirective2.from_objects(
4019
 
                    branch.repository, revision_id, time.time(),
4020
 
                    osutils.local_time_offset(), submit_branch,
4021
 
                    public_branch=public_branch, include_patch=not no_patch,
4022
 
                    include_bundle=not no_bundle, message=message,
4023
 
                    base_revision_id=base_revision_id)
4024
 
            elif format == '0.9':
4025
 
                if not no_bundle:
4026
 
                    if not no_patch:
4027
 
                        patch_type = 'bundle'
4028
 
                    else:
4029
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4030
 
                            ' permit bundle with no patch')
4031
 
                else:
4032
 
                    if not no_patch:
4033
 
                        patch_type = 'diff'
4034
 
                    else:
4035
 
                        patch_type = None
4036
 
                directive = merge_directive.MergeDirective.from_objects(
4037
 
                    branch.repository, revision_id, time.time(),
4038
 
                    osutils.local_time_offset(), submit_branch,
4039
 
                    public_branch=public_branch, patch_type=patch_type,
4040
 
                    message=message)
4041
 
 
4042
 
            outfile.writelines(directive.to_lines())
4043
 
            if output is None:
4044
 
                subject = '[MERGE] '
4045
 
                if message is not None:
4046
 
                    subject += message
4047
 
                else:
4048
 
                    revision = branch.repository.get_revision(revision_id)
4049
 
                    subject += revision.get_summary()
4050
 
                mail_client.compose_merge_request(mail_to, subject,
4051
 
                                                  outfile.getvalue())
4052
 
        finally:
4053
 
            if output != '-':
4054
 
                outfile.close()
 
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)
4055
5203
 
4056
5204
 
4057
5205
class cmd_bundle_revisions(cmd_send):
4058
 
 
4059
 
    """Create a merge-directive for submiting changes.
 
5206
    __doc__ = """Create a merge-directive for submitting changes.
4060
5207
 
4061
5208
    A merge directive provides many things needed for requesting merges:
4062
5209
 
4102
5249
               type=unicode),
4103
5250
        Option('output', short_name='o', help='Write directive to this file.',
4104
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.'),
4105
5255
        'revision',
4106
 
        RegistryOption.from_kwargs('format',
4107
 
        'Use the specified output format.',
4108
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4109
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5256
        RegistryOption('format',
 
5257
                       help='Use the specified output format.',
 
5258
                       lazy_registry=('bzrlib.send', 'format_registry')),
4110
5259
        ]
4111
5260
    aliases = ['bundle']
4112
5261
 
4116
5265
 
4117
5266
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4118
5267
            no_patch=False, revision=None, remember=False, output=None,
4119
 
            format='4', **kwargs):
 
5268
            format=None, strict=None, **kwargs):
4120
5269
        if output is None:
4121
5270
            output = '-'
4122
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5271
        from bzrlib.send import send
 
5272
        return send(submit_branch, revision, public_branch, remember,
4123
5273
                         format, no_bundle, no_patch, output,
4124
 
                         kwargs.get('from', '.'), None, None)
 
5274
                         kwargs.get('from', '.'), None, None, None,
 
5275
                         self.outf, strict=strict)
4125
5276
 
4126
5277
 
4127
5278
class cmd_tag(Command):
4128
 
    """Create, remove or modify a tag naming a revision.
4129
 
    
 
5279
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5280
 
4130
5281
    Tags give human-meaningful names to revisions.  Commands that take a -r
4131
5282
    (--revision) option can be given -rtag:X, where X is any previously
4132
5283
    created tag.
4134
5285
    Tags are stored in the branch.  Tags are copied from one branch to another
4135
5286
    along when you branch, push, pull or merge.
4136
5287
 
4137
 
    It is an error to give a tag name that already exists unless you pass 
 
5288
    It is an error to give a tag name that already exists unless you pass
4138
5289
    --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.
4139
5298
    """
4140
5299
 
4141
5300
    _see_also = ['commit', 'tags']
4142
 
    takes_args = ['tag_name']
 
5301
    takes_args = ['tag_name?']
4143
5302
    takes_options = [
4144
5303
        Option('delete',
4145
5304
            help='Delete this tag rather than placing it.',
4146
5305
            ),
4147
 
        Option('directory',
4148
 
            help='Branch in which to place the tag.',
4149
 
            short_name='d',
4150
 
            type=unicode,
4151
 
            ),
 
5306
        custom_help('directory',
 
5307
            help='Branch in which to place the tag.'),
4152
5308
        Option('force',
4153
5309
            help='Replace existing tags.',
4154
5310
            ),
4155
5311
        'revision',
4156
5312
        ]
4157
5313
 
4158
 
    def run(self, tag_name,
 
5314
    def run(self, tag_name=None,
4159
5315
            delete=None,
4160
5316
            directory='.',
4161
5317
            force=None,
4162
5318
            revision=None,
4163
5319
            ):
4164
5320
        branch, relpath = Branch.open_containing(directory)
4165
 
        branch.lock_write()
4166
 
        try:
4167
 
            if delete:
4168
 
                branch.tags.delete_tag(tag_name)
4169
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
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)
4170
5334
            else:
4171
 
                if revision:
4172
 
                    if len(revision) != 1:
4173
 
                        raise errors.BzrCommandError(
4174
 
                            "Tags can only be placed on a single revision, "
4175
 
                            "not on a range")
4176
 
                    revision_id = revision[0].in_history(branch).rev_id
4177
 
                else:
4178
 
                    revision_id = branch.last_revision()
4179
 
                if (not force) and branch.tags.has_tag(tag_name):
4180
 
                    raise errors.TagAlreadyExists(tag_name)
4181
 
                branch.tags.set_tag(tag_name, revision_id)
4182
 
                self.outf.write('Created tag %s.\n' % tag_name)
4183
 
        finally:
4184
 
            branch.unlock()
 
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)
4185
5345
 
4186
5346
 
4187
5347
class cmd_tags(Command):
4188
 
    """List tags.
 
5348
    __doc__ = """List tags.
4189
5349
 
4190
 
    This tag shows a table of tag names and the revisions they reference.
 
5350
    This command shows a table of tag names and the revisions they reference.
4191
5351
    """
4192
5352
 
4193
5353
    _see_also = ['tag']
4194
5354
    takes_options = [
4195
 
        Option('directory',
4196
 
            help='Branch whose tags should be displayed.',
4197
 
            short_name='d',
4198
 
            type=unicode,
4199
 
            ),
 
5355
        custom_help('directory',
 
5356
            help='Branch whose tags should be displayed.'),
4200
5357
        RegistryOption.from_kwargs('sort',
4201
5358
            'Sort tags by different criteria.', title='Sorting',
4202
5359
            alpha='Sort tags lexicographically (default).',
4203
5360
            time='Sort tags chronologically.',
4204
5361
            ),
4205
5362
        'show-ids',
 
5363
        'revision',
4206
5364
    ]
4207
5365
 
4208
5366
    @display_command
4210
5368
            directory='.',
4211
5369
            sort='alpha',
4212
5370
            show_ids=False,
 
5371
            revision=None,
4213
5372
            ):
4214
5373
        branch, relpath = Branch.open_containing(directory)
 
5374
 
4215
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)]
4216
5387
        if sort == 'alpha':
4217
5388
            tags.sort()
4218
5389
        elif sort == 'time':
4228
5399
            tags.sort(key=lambda x: timestamps[x[1]])
4229
5400
        if not show_ids:
4230
5401
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4231
 
            revno_map = branch.get_revision_id_to_revno_map()
4232
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4233
 
                        for tag, revid in tags ]
 
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()
4234
5413
        for tag, revspec in tags:
4235
5414
            self.outf.write('%-20s %s\n' % (tag, revspec))
4236
5415
 
4237
5416
 
4238
5417
class cmd_reconfigure(Command):
4239
 
    """Reconfigure the type of a bzr directory.
 
5418
    __doc__ = """Reconfigure the type of a bzr directory.
4240
5419
 
4241
5420
    A target configuration must be specified.
4242
5421
 
4249
5428
    If none of these is available, --bind-to must be specified.
4250
5429
    """
4251
5430
 
 
5431
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4252
5432
    takes_args = ['location?']
4253
 
    takes_options = [RegistryOption.from_kwargs('target_type',
4254
 
                     title='Target type',
4255
 
                     help='The type to reconfigure the directory to.',
4256
 
                     value_switches=True, enum_switch=False,
4257
 
                     branch='Reconfigure to a branch.',
4258
 
                     tree='Reconfigure to a tree.',
4259
 
                     checkout='Reconfigure to a checkout.'),
4260
 
                     Option('bind-to', help='Branch to bind checkout to.',
4261
 
                            type=str),
4262
 
                     Option('force',
4263
 
                        help='Perform reconfiguration even if local changes'
4264
 
                        ' will be lost.')
4265
 
                     ]
 
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
        ]
4266
5465
 
4267
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5466
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5467
            stacked_on=None,
 
5468
            unstacked=None):
4268
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.
4269
5479
        if target_type is None:
4270
 
            raise errors.BzrCommandError('No target configuration specified')
 
5480
            if stacked_on or unstacked:
 
5481
                return
 
5482
            else:
 
5483
                raise errors.BzrCommandError('No target configuration '
 
5484
                    'specified')
4271
5485
        elif target_type == 'branch':
4272
5486
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4273
5487
        elif target_type == 'tree':
4274
5488
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4275
5489
        elif target_type == 'checkout':
4276
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4277
 
                                                                  bind_to)
 
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)
4278
5505
        reconfiguration.apply(force)
4279
5506
 
4280
5507
 
4281
 
def _create_prefix(cur_transport):
4282
 
    needed = [cur_transport]
4283
 
    # Recurse upwards until we can create a directory successfully
4284
 
    while True:
4285
 
        new_transport = cur_transport.clone('..')
4286
 
        if new_transport.base == cur_transport.base:
4287
 
            raise errors.BzrCommandError(
4288
 
                "Failed to create path prefix for %s."
4289
 
                % cur_transport.base)
4290
 
        try:
4291
 
            new_transport.mkdir('.')
4292
 
        except errors.NoSuchFile:
4293
 
            needed.append(new_transport)
4294
 
            cur_transport = new_transport
4295
 
        else:
4296
 
            break
4297
 
    # Now we only need to create child directories
4298
 
    while needed:
4299
 
        cur_transport = needed.pop()
4300
 
        cur_transport.ensure_base()
4301
 
 
4302
 
 
4303
 
def _get_mergeable_helper(location):
4304
 
    """Get a merge directive or bundle if 'location' points to one.
4305
 
 
4306
 
    Try try to identify a bundle and returns its mergeable form. If it's not,
4307
 
    we return the tried transport anyway so that it can reused to access the
4308
 
    branch
4309
 
 
4310
 
    :param location: can point to a bundle or a branch.
4311
 
 
4312
 
    :return: mergeable, transport
4313
 
    """
4314
 
    mergeable = None
4315
 
    url = urlutils.normalize_url(location)
4316
 
    url, filename = urlutils.split(url, exclude_trailing_slash=False)
4317
 
    location_transport = transport.get_transport(url)
4318
 
    if filename:
4319
 
        try:
4320
 
            # There may be redirections but we ignore the intermediate
4321
 
            # and final transports used
4322
 
            read = bundle.read_mergeable_from_transport
4323
 
            mergeable, t = read(location_transport, filename)
4324
 
        except errors.NotABundle:
4325
 
            # Continue on considering this url a Branch but adjust the
4326
 
            # location_transport
4327
 
            location_transport = location_transport.clone(filename)
4328
 
    return mergeable, location_transport
4329
 
 
4330
 
 
4331
 
# these get imported and then picked up by the scan for cmd_*
4332
 
# TODO: Some more consistent way to split command definitions across files;
4333
 
# we do need to load at least some information about them to know of 
4334
 
# aliases.  ideally we would avoid loading the implementation until the
4335
 
# details were needed.
4336
 
from bzrlib.cmd_version_info import cmd_version_info
4337
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4338
 
from bzrlib.bundle.commands import (
4339
 
    cmd_bundle_info,
4340
 
    )
4341
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
4342
 
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
4343
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
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)