← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 08:15:14 UTC
  • mto: This revision was merged to the branch mainline in revision 5498.
  • Revision ID: andrew.bennetts@canonical.com-20101008081514-dviqzrdfwyzsqbz2
Split NEWS into per-release doc/en/release-notes/bzr-*.txt

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