← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

Fix some more PEP8isms and delete useless import

Show diffs side-by-side

added added

removed removed

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