← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-11 06:10:59 UTC
  • mfrom: (3702.1.1 trivial)
  • Revision ID: pqm@pqm.ubuntu.com-20080911061059-svzqfejar17ui4zw
(mbp) KnitVersionedFiles repr

Show diffs side-by-side

added added

removed removed

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