← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

(parthm) Better regex compile errors (Parth Malwankar)

Show diffs side-by-side

added added

removed removed

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