← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Patch Queue Manager
  • Date: 2016-04-21 04:10:52 UTC
  • mfrom: (6616.1.1 fix-en-user-guide)
  • Revision ID: pqm@pqm.ubuntu.com-20160421041052-clcye7ns1qcl2n7w
(richard-wilbur) Ensure build of English use guide always uses English text
 even when user's locale specifies a different language. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005, 2006, 2007, 2008 Canonical Ltd
 
1
# Copyright (C) 2005-2012 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
import os
20
 
from StringIO import StringIO
21
 
 
22
 
from bzrlib.lazy_import import lazy_import
23
 
lazy_import(globals(), """
24
 
import codecs
 
22
 
 
23
import bzrlib.bzrdir
 
24
 
 
25
from bzrlib import lazy_import
 
26
lazy_import.lazy_import(globals(), """
 
27
import cStringIO
 
28
import errno
25
29
import sys
26
30
import time
27
31
 
29
33
from bzrlib import (
30
34
    bugtracker,
31
35
    bundle,
32
 
    bzrdir,
 
36
    btree_index,
 
37
    controldir,
 
38
    directory_service,
33
39
    delta,
34
 
    config,
 
40
    config as _mod_config,
35
41
    errors,
36
42
    globbing,
37
 
    ignores,
 
43
    hooks,
38
44
    log,
39
45
    merge as _mod_merge,
40
46
    merge_directive,
41
47
    osutils,
42
48
    reconfigure,
 
49
    rename_map,
43
50
    revision as _mod_revision,
44
 
    symbol_versioning,
 
51
    static_tuple,
 
52
    timestamp,
45
53
    transport,
46
 
    tree as _mod_tree,
47
54
    ui,
48
55
    urlutils,
 
56
    views,
 
57
    gpg,
49
58
    )
50
59
from bzrlib.branch import Branch
51
60
from bzrlib.conflicts import ConflictList
52
 
from bzrlib.revisionspec import RevisionSpec
 
61
from bzrlib.transport import memory
 
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
53
63
from bzrlib.smtp_connection import SMTPConnection
54
64
from bzrlib.workingtree import WorkingTree
 
65
from bzrlib.i18n import gettext, ngettext
55
66
""")
56
67
 
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
 
    return tree, safe_relpath_files(tree, file_list)
91
 
 
92
 
 
93
 
def safe_relpath_files(tree, file_list):
94
 
    """Convert file_list into a list of relpaths in tree.
95
 
 
96
 
    :param tree: A tree to operate on.
97
 
    :param file_list: A list of user provided paths or None.
98
 
    :return: A list of relative paths.
99
 
    :raises errors.PathNotChild: When a provided path is in a different tree
100
 
        than tree.
101
 
    """
102
 
    if file_list is None:
 
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:
103
257
        return None
104
 
    new_list = []
105
 
    for filename in file_list:
106
 
        try:
107
 
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
108
 
        except errors.PathNotChild:
109
 
            raise errors.FileInWrongBranch(tree.branch, filename)
110
 
    return new_list
 
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)
111
306
 
112
307
 
113
308
# TODO: Make sure no commands unconditionally use the working directory as a
117
312
# opens the branch?)
118
313
 
119
314
class cmd_status(Command):
120
 
    """Display status summary.
 
315
    __doc__ = """Display status summary.
121
316
 
122
317
    This reports on versioned and unknown files, reporting them
123
318
    grouped by state.  Possible states are:
143
338
    unknown
144
339
        Not versioned and not matching an ignore pattern.
145
340
 
 
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
 
146
346
    To see ignored files use 'bzr ignored'.  For details on the
147
347
    changes to file texts, use 'bzr diff'.
148
 
    
 
348
 
149
349
    Note that --short or -S gives status flags for each item, similar
150
350
    to Subversion's status command. To get output similar to svn -q,
151
351
    use bzr status -SV.
155
355
    files or directories is reported.  If a directory is given, status
156
356
    is reported for everything inside that directory.
157
357
 
158
 
    If a revision argument is given, the status is calculated against
159
 
    that revision, or between two revisions if two are provided.
 
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'.
160
369
    """
161
 
    
162
 
    # TODO: --no-recurse, --recurse options
163
 
    
 
370
 
 
371
    # TODO: --no-recurse/-N, --recurse options
 
372
 
164
373
    takes_args = ['file*']
165
 
    takes_options = ['show-ids', 'revision', 'change',
 
374
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
166
375
                     Option('short', help='Use short status indicators.',
167
376
                            short_name='S'),
168
377
                     Option('versioned', help='Only show versioned files.',
169
378
                            short_name='V'),
170
379
                     Option('no-pending', help='Don\'t show pending merges.',
171
380
                           ),
 
381
                     Option('no-classify',
 
382
                            help='Do not mark object type using indicator.',
 
383
                           ),
172
384
                     ]
173
385
    aliases = ['st', 'stat']
174
386
 
175
387
    encoding_type = 'replace'
176
388
    _see_also = ['diff', 'revert', 'status-flags']
177
 
    
 
389
 
178
390
    @display_command
179
391
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
180
 
            versioned=False, no_pending=False):
 
392
            versioned=False, no_pending=False, verbose=False,
 
393
            no_classify=False):
181
394
        from bzrlib.status import show_tree_status
182
395
 
183
396
        if revision and len(revision) > 2:
184
 
            raise errors.BzrCommandError('bzr status --revision takes exactly'
185
 
                                         ' one or two revision specifiers')
 
397
            raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
 
398
                                         ' one or two revision specifiers'))
186
399
 
187
 
        tree, relfile_list = tree_files(file_list)
 
400
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
188
401
        # Avoid asking for specific files when that is not needed.
189
402
        if relfile_list == ['']:
190
403
            relfile_list = None
197
410
        show_tree_status(tree, show_ids=show_ids,
198
411
                         specific_files=relfile_list, revision=revision,
199
412
                         to_file=self.outf, short=short, versioned=versioned,
200
 
                         show_pending=(not no_pending))
 
413
                         show_pending=(not no_pending), verbose=verbose,
 
414
                         classify=not no_classify)
201
415
 
202
416
 
203
417
class cmd_cat_revision(Command):
204
 
    """Write out metadata for a revision.
205
 
    
 
418
    __doc__ = """Write out metadata for a revision.
 
419
 
206
420
    The revision to print can either be specified by a specific
207
421
    revision identifier, or you can use --revision.
208
422
    """
209
423
 
210
424
    hidden = True
211
425
    takes_args = ['revision_id?']
212
 
    takes_options = ['revision']
 
426
    takes_options = ['directory', 'revision']
213
427
    # cat-revision is more for frontends so should be exact
214
428
    encoding = 'strict'
215
 
    
 
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
 
216
438
    @display_command
217
 
    def run(self, revision_id=None, revision=None):
 
439
    def run(self, revision_id=None, revision=None, directory=u'.'):
218
440
        if revision_id is not None and revision is not None:
219
 
            raise errors.BzrCommandError('You can only supply one of'
220
 
                                         ' revision_id or --revision')
 
441
            raise errors.BzrCommandError(gettext('You can only supply one of'
 
442
                                         ' revision_id or --revision'))
221
443
        if revision_id is None and revision is None:
222
 
            raise errors.BzrCommandError('You must supply either'
223
 
                                         ' --revision or a revision_id')
224
 
        b = WorkingTree.open_containing(u'.')[0].branch
225
 
 
226
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
227
 
        if revision_id is not None:
228
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
444
            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])
229
550
            try:
230
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
231
 
            except errors.NoSuchRevision:
232
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
233
 
                    revision_id)
234
 
                raise errors.BzrCommandError(msg)
235
 
        elif revision is not None:
236
 
            for rev in revision:
237
 
                if rev is None:
238
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
239
 
                                                 ' revision.')
240
 
                rev_id = rev.as_revision_id(b)
241
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
242
 
    
 
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
 
243
559
 
244
560
class cmd_remove_tree(Command):
245
 
    """Remove the working tree from a given branch/checkout.
 
561
    __doc__ = """Remove the working tree from a given branch/checkout.
246
562
 
247
563
    Since a lightweight checkout is little more than a working tree
248
564
    this will refuse to run against one.
250
566
    To re-create the working tree, use "bzr checkout".
251
567
    """
252
568
    _see_also = ['checkout', 'working-trees']
253
 
 
254
 
    takes_args = ['location?']
255
 
 
256
 
    def run(self, location='.'):
257
 
        d = bzrdir.BzrDir.open(location)
258
 
        
 
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]
259
644
        try:
260
 
            working = d.open_workingtree()
261
 
        except errors.NoWorkingTree:
262
 
            raise errors.BzrCommandError("No working tree to remove")
263
 
        except errors.NotLocalUrl:
264
 
            raise errors.BzrCommandError("You cannot remove the working tree of a "
265
 
                                         "remote path")
266
 
        
267
 
        working_path = working.bzrdir.root_transport.base
268
 
        branch_path = working.branch.bzrdir.root_transport.base
269
 
        if working_path != branch_path:
270
 
            raise errors.BzrCommandError("You cannot remove the working tree from "
271
 
                                         "a lightweight checkout")
272
 
        
273
 
        d.destroy_workingtree()
274
 
        
 
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
 
275
654
 
276
655
class cmd_revno(Command):
277
 
    """Show current revision number.
 
656
    __doc__ = """Show current revision number.
278
657
 
279
658
    This is equal to the number of revisions on this branch.
280
659
    """
281
660
 
282
661
    _see_also = ['info']
283
662
    takes_args = ['location?']
 
663
    takes_options = [
 
664
        Option('tree', help='Show revno of working tree.'),
 
665
        'revision',
 
666
        ]
284
667
 
285
668
    @display_command
286
 
    def run(self, location=u'.'):
287
 
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
288
 
        self.outf.write('\n')
 
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')
289
700
 
290
701
 
291
702
class cmd_revision_info(Command):
292
 
    """Show revision number and revision id for a given revision identifier.
 
703
    __doc__ = """Show revision number and revision id for a given revision identifier.
293
704
    """
294
705
    hidden = True
295
706
    takes_args = ['revision_info*']
296
 
    takes_options = ['revision']
 
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
        ]
297
714
 
298
715
    @display_command
299
 
    def run(self, revision=None, revision_info_list=[]):
 
716
    def run(self, revision=None, directory=u'.', tree=False,
 
717
            revision_info_list=[]):
300
718
 
301
 
        revs = []
 
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 = []
302
728
        if revision is not None:
303
 
            revs.extend(revision)
 
729
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
304
730
        if revision_info_list is not None:
305
 
            for rev in revision_info_list:
306
 
                revs.append(RevisionSpec.from_string(rev))
307
 
 
308
 
        b = Branch.open_containing(u'.')[0]
309
 
 
310
 
        if len(revs) == 0:
311
 
            revs.append(RevisionSpec.from_string('-1'))
312
 
 
313
 
        for rev in revs:
314
 
            revision_id = rev.as_revision_id(b)
 
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:
315
746
            try:
316
 
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
 
747
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
 
748
                revno = '.'.join(str(i) for i in dotted_revno)
317
749
            except errors.NoSuchRevision:
318
 
                dotted_map = b.get_revision_id_to_revno_map()
319
 
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
320
 
            print '%s %s' % (revno, revision_id)
321
 
 
322
 
    
 
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
 
323
759
class cmd_add(Command):
324
 
    """Add specified files or directories.
 
760
    __doc__ = """Add specified files or directories.
325
761
 
326
762
    In non-recursive mode, all the named items are added, regardless
327
763
    of whether they were previously ignored.  A warning is given if
335
771
    are added.  This search proceeds recursively into versioned
336
772
    directories.  If no names are given '.' is assumed.
337
773
 
 
774
    A warning will be printed when nested trees are encountered,
 
775
    unless they are explicitly ignored.
 
776
 
338
777
    Therefore simply saying 'bzr add' will version all files that
339
778
    are currently unknown.
340
779
 
343
782
    you should never need to explicitly add a directory, they'll just
344
783
    get added when you add a file in the directory.
345
784
 
346
 
    --dry-run will show which files would be added, but not actually 
 
785
    --dry-run will show which files would be added, but not actually
347
786
    add them.
348
787
 
349
788
    --file-ids-from will try to use the file ids from the supplied path.
353
792
    branches that will be merged later (without showing the two different
354
793
    adds as a conflict). It is also useful when merging another project
355
794
    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.
356
802
    """
357
803
    takes_args = ['file*']
358
804
    takes_options = [
359
805
        Option('no-recurse',
360
 
               help="Don't recursively add the contents of directories."),
 
806
               help="Don't recursively add the contents of directories.",
 
807
               short_name='N'),
361
808
        Option('dry-run',
362
809
               help="Show what would be done, but don't actually do anything."),
363
810
        'verbose',
366
813
               help='Lookup file ids from this tree.'),
367
814
        ]
368
815
    encoding_type = 'replace'
369
 
    _see_also = ['remove']
 
816
    _see_also = ['remove', 'ignore']
370
817
 
371
818
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
372
819
            file_ids_from=None):
385
832
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
386
833
                          to_file=self.outf, should_print=(not is_quiet()))
387
834
        else:
388
 
            action = bzrlib.add.AddAction(to_file=self.outf,
 
835
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
389
836
                should_print=(not is_quiet()))
390
837
 
391
838
        if base_tree:
392
 
            base_tree.lock_read()
393
 
        try:
394
 
            file_list = self._maybe_expand_globs(file_list)
395
 
            if file_list:
396
 
                tree = WorkingTree.open_containing(file_list[0])[0]
397
 
            else:
398
 
                tree = WorkingTree.open_containing(u'.')[0]
399
 
            added, ignored = tree.smart_add(file_list, not
400
 
                no_recurse, action=action, save=not dry_run)
401
 
        finally:
402
 
            if base_tree is not None:
403
 
                base_tree.unlock()
 
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()
404
844
        if len(ignored) > 0:
405
845
            if verbose:
406
846
                for glob in sorted(ignored.keys()):
407
847
                    for path in ignored[glob]:
408
 
                        self.outf.write("ignored %s matching \"%s\"\n" 
409
 
                                        % (path, glob))
410
 
            else:
411
 
                match_len = 0
412
 
                for glob, paths in ignored.items():
413
 
                    match_len += len(paths)
414
 
                self.outf.write("ignored %d file(s).\n" % match_len)
415
 
            self.outf.write("If you wish to add some of these files,"
416
 
                            " please add them by name.\n")
 
848
                        self.outf.write(
 
849
                         gettext("ignored {0} matching \"{1}\"\n").format(
 
850
                         path, glob))
417
851
 
418
852
 
419
853
class cmd_mkdir(Command):
420
 
    """Create a new versioned directory.
 
854
    __doc__ = """Create a new versioned directory.
421
855
 
422
856
    This is equivalent to creating the directory and then adding it.
423
857
    """
424
858
 
425
859
    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
        ]
426
867
    encoding_type = 'replace'
427
868
 
428
 
    def run(self, dir_list):
429
 
        for d in dir_list:
430
 
            os.mkdir(d)
431
 
            wt, dd = WorkingTree.open_containing(d)
432
 
            wt.add([dd])
433
 
            self.outf.write('added %s\n' % d)
 
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)
434
898
 
435
899
 
436
900
class cmd_relpath(Command):
437
 
    """Show path of a file relative to root"""
 
901
    __doc__ = """Show path of a file relative to root"""
438
902
 
439
903
    takes_args = ['filename']
440
904
    hidden = True
441
 
    
 
905
 
442
906
    @display_command
443
907
    def run(self, filename):
444
908
        # TODO: jam 20050106 Can relpath return a munged path if
449
913
 
450
914
 
451
915
class cmd_inventory(Command):
452
 
    """Show inventory of the current working copy or a revision.
 
916
    __doc__ = """Show inventory of the current working copy or a revision.
453
917
 
454
918
    It is possible to limit the output to a particular entry
455
919
    type using the --kind option.  For example: --kind file.
472
936
    @display_command
473
937
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
474
938
        if kind and kind not in ['file', 'directory', 'symlink']:
475
 
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
476
 
 
477
 
        work_tree, file_list = tree_files(file_list)
478
 
        work_tree.lock_read()
479
 
        try:
480
 
            if revision is not None:
481
 
                if len(revision) > 1:
482
 
                    raise errors.BzrCommandError(
483
 
                        'bzr inventory --revision takes exactly one revision'
484
 
                        ' identifier')
485
 
                revision_id = revision[0].as_revision_id(work_tree.branch)
486
 
                tree = work_tree.branch.repository.revision_tree(revision_id)
487
 
 
488
 
                extra_trees = [work_tree]
489
 
                tree.lock_read()
490
 
            else:
491
 
                tree = work_tree
492
 
                extra_trees = []
493
 
 
494
 
            if file_list is not None:
495
 
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
496
 
                                          require_versioned=True)
497
 
                # find_ids_across_trees may include some paths that don't
498
 
                # exist in 'tree'.
499
 
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
500
 
                                 for file_id in file_ids if file_id in tree)
501
 
            else:
502
 
                entries = tree.inventory.entries()
503
 
        finally:
504
 
            tree.unlock()
505
 
            if tree is not work_tree:
506
 
                work_tree.unlock()
507
 
 
508
 
        for path, entry in entries:
 
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):
509
964
            if kind and kind != entry.kind:
510
965
                continue
 
966
            if path == "":
 
967
                continue
511
968
            if show_ids:
512
969
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
513
970
            else:
516
973
 
517
974
 
518
975
class cmd_mv(Command):
519
 
    """Move or rename a file.
 
976
    __doc__ = """Move or rename a file.
520
977
 
521
978
    :Usage:
522
979
        bzr mv OLDNAME NEWNAME
539
996
    takes_args = ['names*']
540
997
    takes_options = [Option("after", help="Move only the bzr identifier"
541
998
        " 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.'),
542
1001
        ]
543
1002
    aliases = ['move', 'rename']
544
1003
    encoding_type = 'replace'
545
1004
 
546
 
    def run(self, names_list, after=False):
 
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.'))
547
1010
        if names_list is None:
548
1011
            names_list = []
549
 
 
550
1012
        if len(names_list) < 2:
551
 
            raise errors.BzrCommandError("missing file argument")
552
 
        tree, rel_names = tree_files(names_list)
553
 
        tree.lock_write()
554
 
        try:
555
 
            self._run(tree, names_list, rel_names, after)
556
 
        finally:
557
 
            tree.unlock()
 
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)
558
1032
 
559
1033
    def _run(self, tree, names_list, rel_names, after):
560
1034
        into_existing = osutils.isdir(names_list[-1])
568
1042
                and rel_names[0].lower() == rel_names[1].lower()):
569
1043
                into_existing = False
570
1044
            else:
571
 
                inv = tree.inventory
572
 
                from_id = tree.path2id(rel_names[0])
 
1045
                # 'fix' the case of a potential 'from'
 
1046
                from_id = tree.path2id(
 
1047
                            tree.get_canonical_inventory_path(rel_names[0]))
573
1048
                if (not osutils.lexists(names_list[0]) and
574
 
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
1049
                    from_id and tree.stored_kind(from_id) == "directory"):
575
1050
                    into_existing = False
576
1051
        # move/rename
577
1052
        if into_existing:
578
1053
            # move into existing directory
579
 
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
580
 
                self.outf.write("%s => %s\n" % pair)
 
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))
581
1060
        else:
582
1061
            if len(names_list) != 2:
583
 
                raise errors.BzrCommandError('to mv multiple files the'
 
1062
                raise errors.BzrCommandError(gettext('to mv multiple files the'
584
1063
                                             ' destination must be a versioned'
585
 
                                             ' directory')
586
 
            tree.rename_one(rel_names[0], rel_names[1], after=after)
587
 
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
 
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))
588
1111
 
589
1112
 
590
1113
class cmd_pull(Command):
591
 
    """Turn this branch into a mirror of another branch.
 
1114
    __doc__ = """Turn this branch into a mirror of another branch.
592
1115
 
593
 
    This command only works on branches that have not diverged.  Branches are
594
 
    considered diverged if the destination branch's most recent commit is one
595
 
    that has not been merged (directly or indirectly) into the parent.
 
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.
596
1120
 
597
1121
    If branches have diverged, you can use 'bzr merge' to integrate the changes
598
1122
    from one into the other.  Once one branch has merged, the other should
599
1123
    be able to pull it again.
600
1124
 
601
 
    If you want to forget your local changes and just update your branch to
602
 
    match the remote one, use pull --overwrite.
603
 
 
604
 
    If there is no default location set, the first pull will set it.  After
605
 
    that, you can omit the location to use the default.  To change the
606
 
    default, use --remember. The value will only be saved if the remote
607
 
    location can be accessed.
 
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>.
608
1137
 
609
1138
    Note: The location can be specified either in the form of a branch,
610
1139
    or in the form of a path to a file containing a merge directive generated
611
1140
    with bzr send.
612
1141
    """
613
1142
 
614
 
    _see_also = ['push', 'update', 'status-flags']
 
1143
    _see_also = ['push', 'update', 'status-flags', 'send']
615
1144
    takes_options = ['remember', 'overwrite', 'revision',
616
1145
        custom_help('verbose',
617
1146
            help='Show logs of pulled revisions.'),
618
 
        Option('directory',
 
1147
        custom_help('directory',
619
1148
            help='Branch to pull into, '
620
 
                 'rather than the one containing the working directory.',
621
 
            short_name='d',
622
 
            type=unicode,
 
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."
623
1154
            ),
 
1155
        Option('show-base',
 
1156
            help="Show base revision text in conflicts."),
 
1157
        Option('overwrite-tags',
 
1158
            help="Overwrite tags only."),
624
1159
        ]
625
1160
    takes_args = ['location?']
626
1161
    encoding_type = 'replace'
627
1162
 
628
 
    def run(self, location=None, remember=False, overwrite=False,
 
1163
    def run(self, location=None, remember=None, overwrite=False,
629
1164
            revision=None, verbose=False,
630
 
            directory=None):
 
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 = []
631
1174
        # FIXME: too much stuff is in the command class
632
1175
        revision_id = None
633
1176
        mergeable = None
636
1179
        try:
637
1180
            tree_to = WorkingTree.open_containing(directory)[0]
638
1181
            branch_to = tree_to.branch
 
1182
            self.add_cleanup(tree_to.lock_write().unlock)
639
1183
        except errors.NoWorkingTree:
640
1184
            tree_to = None
641
1185
            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()
642
1192
 
643
1193
        possible_transports = []
644
1194
        if location is not None:
651
1201
        stored_loc = branch_to.get_parent()
652
1202
        if location is None:
653
1203
            if stored_loc is None:
654
 
                raise errors.BzrCommandError("No pull location known or"
655
 
                                             " specified.")
 
1204
                raise errors.BzrCommandError(gettext("No pull location known or"
 
1205
                                             " specified."))
656
1206
            else:
657
1207
                display_url = urlutils.unescape_for_display(stored_loc,
658
1208
                        self.outf.encoding)
659
1209
                if not is_quiet():
660
 
                    self.outf.write("Using saved parent location: %s\n" % display_url)
 
1210
                    self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
661
1211
                location = stored_loc
662
1212
 
 
1213
        revision = _get_one_revision('pull', revision)
663
1214
        if mergeable is not None:
664
1215
            if revision is not None:
665
 
                raise errors.BzrCommandError(
666
 
                    'Cannot use -r with merge directives or bundles')
 
1216
                raise errors.BzrCommandError(gettext(
 
1217
                    'Cannot use -r with merge directives or bundles'))
667
1218
            mergeable.install_revisions(branch_to.repository)
668
1219
            base_revision_id, revision_id, verified = \
669
1220
                mergeable.get_merge_request(branch_to.repository)
671
1222
        else:
672
1223
            branch_from = Branch.open(location,
673
1224
                possible_transports=possible_transports)
674
 
 
675
 
            if branch_to.get_parent() is None or remember:
 
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
676
1231
                branch_to.set_parent(branch_from.base)
677
1232
 
678
1233
        if revision is not None:
679
 
            if len(revision) == 1:
680
 
                revision_id = revision[0].as_revision_id(branch_from)
681
 
            else:
682
 
                raise errors.BzrCommandError(
683
 
                    'bzr pull --revision takes one value.')
684
 
 
685
 
        branch_to.lock_write()
686
 
        try:
687
 
            if tree_to is not None:
688
 
                change_reporter = delta._ChangeReporter(
689
 
                    unversioned_filter=tree_to.is_ignored)
690
 
                result = tree_to.pull(branch_from, overwrite, revision_id,
691
 
                                      change_reporter,
692
 
                                      possible_transports=possible_transports)
693
 
            else:
694
 
                result = branch_to.pull(branch_from, overwrite, revision_id)
695
 
 
696
 
            result.report(self.outf)
697
 
            if verbose and result.old_revid != result.new_revid:
698
 
                old_rh = list(
699
 
                    branch_to.repository.iter_reverse_revision_history(
700
 
                    result.old_revid))
701
 
                old_rh.reverse()
702
 
                new_rh = branch_to.revision_history()
703
 
                log.show_changed_revisions(branch_to, old_rh, new_rh,
704
 
                                           to_file=self.outf)
705
 
        finally:
706
 
            branch_to.unlock()
 
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
707
1257
 
708
1258
 
709
1259
class cmd_push(Command):
710
 
    """Update a mirror of this branch.
711
 
    
 
1260
    __doc__ = """Update a mirror of this branch.
 
1261
 
712
1262
    The target branch will not have its working tree populated because this
713
1263
    is both expensive, and is not supported on remote file systems.
714
 
    
 
1264
 
715
1265
    Some smart servers or protocols *may* put the working tree in place in
716
1266
    the future.
717
1267
 
721
1271
 
722
1272
    If branches have diverged, you can use 'bzr push --overwrite' to replace
723
1273
    the other branch completely, discarding its unmerged changes.
724
 
    
 
1274
 
725
1275
    If you want to ensure you have the different changes in the other branch,
726
1276
    do a merge (see bzr help merge) from the other branch, and commit that.
727
1277
    After that you will be able to do a push without '--overwrite'.
728
1278
 
729
 
    If there is no default push location set, the first push will set it.
730
 
    After that, you can omit the location to use the default.  To change the
731
 
    default, use --remember. The value will only be saved if the remote
732
 
    location can be accessed.
 
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>.
733
1287
    """
734
1288
 
735
1289
    _see_also = ['pull', 'update', 'working-trees']
737
1291
        Option('create-prefix',
738
1292
               help='Create the path leading up to the branch '
739
1293
                    'if it does not already exist.'),
740
 
        Option('directory',
 
1294
        custom_help('directory',
741
1295
            help='Branch to push from, '
742
 
                 'rather than the one containing the working directory.',
743
 
            short_name='d',
744
 
            type=unicode,
745
 
            ),
 
1296
                 'rather than the one containing the working directory.'),
746
1297
        Option('use-existing-dir',
747
1298
               help='By default push will fail if the target'
748
1299
                    ' directory exists, but does not already'
756
1307
                'for the commit history. Only the work not present in the '
757
1308
                'referenced branch is included in the branch created.',
758
1309
            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."),
759
1318
        ]
760
1319
    takes_args = ['location?']
761
1320
    encoding_type = 'replace'
762
1321
 
763
 
    def run(self, location=None, remember=False, overwrite=False,
 
1322
    def run(self, location=None, remember=None, overwrite=False,
764
1323
        create_prefix=False, verbose=False, revision=None,
765
1324
        use_existing_dir=False, directory=None, stacked_on=None,
766
 
        stacked=False):
 
1325
        stacked=False, strict=None, no_tree=False,
 
1326
        overwrite_tags=False):
767
1327
        from bzrlib.push import _show_push_branch
768
1328
 
769
 
        # Get the source branch and revision_id
 
1329
        if overwrite:
 
1330
            overwrite = ["history", "tags"]
 
1331
        elif overwrite_tags:
 
1332
            overwrite = ["tags"]
 
1333
        else:
 
1334
            overwrite = []
 
1335
 
770
1336
        if directory is None:
771
1337
            directory = '.'
772
 
        br_from = Branch.open_containing(directory)[0]
 
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)
773
1343
        if revision is not None:
774
 
            if len(revision) == 1:
775
 
                revision_id = revision[0].in_history(br_from).rev_id
776
 
            else:
777
 
                raise errors.BzrCommandError(
778
 
                    'bzr push --revision takes one value.')
 
1344
            revision_id = revision.in_history(br_from).rev_id
779
1345
        else:
780
 
            revision_id = br_from.last_revision()
781
 
 
 
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.')
782
1352
        # Get the stacked_on branch, if any
783
1353
        if stacked_on is not None:
784
1354
            stacked_on = urlutils.normalize_url(stacked_on)
794
1364
                    # error by the feedback given to them. RBC 20080227.
795
1365
                    stacked_on = parent_url
796
1366
            if not stacked_on:
797
 
                raise errors.BzrCommandError(
798
 
                    "Could not determine branch to refer to.")
 
1367
                raise errors.BzrCommandError(gettext(
 
1368
                    "Could not determine branch to refer to."))
799
1369
 
800
1370
        # Get the destination location
801
1371
        if location is None:
802
1372
            stored_loc = br_from.get_push_location()
803
1373
            if stored_loc is None:
804
 
                raise errors.BzrCommandError(
805
 
                    "No push location known or specified.")
 
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."))
806
1384
            else:
807
1385
                display_url = urlutils.unescape_for_display(stored_loc,
808
1386
                        self.outf.encoding)
809
 
                self.outf.write("Using saved push location: %s\n" % display_url)
 
1387
                note(gettext("Using saved push location: %s") % display_url)
810
1388
                location = stored_loc
811
1389
 
812
1390
        _show_push_branch(br_from, revision_id, location, self.outf,
813
1391
            verbose=verbose, overwrite=overwrite, remember=remember,
814
1392
            stacked_on=stacked_on, create_prefix=create_prefix,
815
 
            use_existing_dir=use_existing_dir)
 
1393
            use_existing_dir=use_existing_dir, no_tree=no_tree)
816
1394
 
817
1395
 
818
1396
class cmd_branch(Command):
819
 
    """Create a new copy of a branch.
 
1397
    __doc__ = """Create a new branch that is a copy of an existing branch.
820
1398
 
821
1399
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
822
1400
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
827
1405
 
828
1406
    To retrieve the branch as of a particular revision, supply the --revision
829
1407
    parameter, as in "branch foo/bar -r 5".
 
1408
 
 
1409
    The synonyms 'clone' and 'get' for this command are deprecated.
830
1410
    """
831
1411
 
832
1412
    _see_also = ['checkout']
833
1413
    takes_args = ['from_location', 'to_location?']
834
 
    takes_options = ['revision', Option('hardlink',
835
 
        help='Hard-link working tree files where possible.'),
 
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."),
836
1423
        Option('stacked',
837
1424
            help='Create a stacked branch referring to the source branch. '
838
1425
                'The new branch will depend on the availability of the source '
839
1426
                '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."),
840
1436
        ]
841
1437
    aliases = ['get', 'clone']
842
1438
 
843
1439
    def run(self, from_location, to_location=None, revision=None,
844
 
            hardlink=False, stacked=False):
 
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
845
1444
        from bzrlib.tag import _merge_tags_if_possible
846
 
        if revision is None:
847
 
            revision = [None]
848
 
        elif len(revision) > 1:
849
 
            raise errors.BzrCommandError(
850
 
                'bzr branch --revision takes exactly 1 revision value')
851
 
 
852
 
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
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(
853
1452
            from_location)
854
 
        br_from.lock_read()
855
 
        try:
856
 
            if len(revision) == 1 and revision[0] is not None:
857
 
                revision_id = revision[0].as_revision_id(br_from)
858
 
            else:
859
 
                # FIXME - wt.last_revision, fallback to branch, fall back to
860
 
                # None or perhaps NULL_REVISION to mean copy nothing
861
 
                # RBC 20060209
862
 
                revision_id = br_from.last_revision()
863
 
            if to_location is None:
 
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:
864
1472
                to_location = urlutils.derive_to_location(from_location)
865
 
            to_transport = transport.get_transport(to_location)
 
1473
        to_transport = transport.get_transport(to_location)
 
1474
        try:
 
1475
            to_transport.mkdir('.')
 
1476
        except errors.FileExists:
866
1477
            try:
867
 
                to_transport.mkdir('.')
868
 
            except errors.FileExists:
869
 
                raise errors.BzrCommandError('Target directory "%s" already'
870
 
                                             ' exists.' % to_location)
871
 
            except errors.NoSuchFile:
872
 
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
873
 
                                             % to_location)
 
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:
874
1499
            try:
875
1500
                # preserve whatever source format we have.
876
 
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1501
                to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
877
1502
                                            possible_transports=[to_transport],
878
1503
                                            accelerator_tree=accelerator_tree,
879
 
                                            hardlink=hardlink, stacked=stacked)
880
 
                branch = dir.open_branch()
 
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])
881
1511
            except errors.NoSuchRevision:
882
1512
                to_transport.delete_tree('.')
883
 
                msg = "The branch %s has no revision %s." % (from_location,
884
 
                    revision[0])
 
1513
                msg = gettext("The branch {0} has no revision {1}.").format(
 
1514
                    from_location, revision)
885
1515
                raise errors.BzrCommandError(msg)
886
 
            _merge_tags_if_possible(br_from, branch)
887
 
            # If the source branch is stacked, the new branch may
888
 
            # be stacked whether we asked for that explicitly or not.
889
 
            # We therefore need a try/except here and not just 'if stacked:'
890
 
            try:
891
 
                note('Created new stacked branch referring to %s.' %
892
 
                    branch.get_stacked_on_url())
893
 
            except (errors.NotStacked, errors.UnstackableBranchFormat,
894
 
                errors.UnstackableRepositoryFormat), e:
895
 
                note('Branched %d revision(s).' % branch.revno())
896
 
        finally:
897
 
            br_from.unlock()
 
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)))
898
1594
 
899
1595
 
900
1596
class cmd_checkout(Command):
901
 
    """Create a new checkout of an existing branch.
 
1597
    __doc__ = """Create a new checkout of an existing branch.
902
1598
 
903
1599
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
904
1600
    the branch found in '.'. This is useful if you have removed the working tree
905
1601
    or if it was never created - i.e. if you pushed the branch to its current
906
1602
    location using SFTP.
907
 
    
 
1603
 
908
1604
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
909
1605
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
910
1606
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
918
1614
    code.)
919
1615
    """
920
1616
 
921
 
    _see_also = ['checkouts', 'branch']
 
1617
    _see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
922
1618
    takes_args = ['branch_location?', 'to_location?']
923
1619
    takes_options = ['revision',
924
1620
                     Option('lightweight',
938
1634
 
939
1635
    def run(self, branch_location=None, to_location=None, revision=None,
940
1636
            lightweight=False, files_from=None, hardlink=False):
941
 
        if revision is None:
942
 
            revision = [None]
943
 
        elif len(revision) > 1:
944
 
            raise errors.BzrCommandError(
945
 
                'bzr checkout --revision takes exactly 1 revision value')
946
1637
        if branch_location is None:
947
1638
            branch_location = osutils.getcwd()
948
1639
            to_location = branch_location
949
 
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1640
        accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
950
1641
            branch_location)
951
 
        if files_from is not None:
 
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:
952
1649
            accelerator_tree = WorkingTree.open(files_from)
953
 
        if len(revision) == 1 and revision[0] is not None:
954
 
            revision_id = revision[0].as_revision_id(source)
 
1650
        if revision is not None:
 
1651
            revision_id = revision.as_revision_id(source)
955
1652
        else:
956
1653
            revision_id = None
957
1654
        if to_location is None:
958
1655
            to_location = urlutils.derive_to_location(branch_location)
959
 
        # if the source and to_location are the same, 
 
1656
        # if the source and to_location are the same,
960
1657
        # and there is no working tree,
961
1658
        # then reconstitute a branch
962
1659
        if (osutils.abspath(to_location) ==
971
1668
 
972
1669
 
973
1670
class cmd_renames(Command):
974
 
    """Show list of renamed files.
 
1671
    __doc__ = """Show list of renamed files.
975
1672
    """
976
1673
    # TODO: Option to show renames between two historical versions.
977
1674
 
982
1679
    @display_command
983
1680
    def run(self, dir=u'.'):
984
1681
        tree = WorkingTree.open_containing(dir)[0]
985
 
        tree.lock_read()
986
 
        try:
987
 
            new_inv = tree.inventory
988
 
            old_tree = tree.basis_tree()
989
 
            old_tree.lock_read()
990
 
            try:
991
 
                old_inv = old_tree.inventory
992
 
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
993
 
                renames.sort()
994
 
                for old_name, new_name in renames:
995
 
                    self.outf.write("%s => %s\n" % (old_name, new_name))
996
 
            finally:
997
 
                old_tree.unlock()
998
 
        finally:
999
 
            tree.unlock()
 
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))
1000
1696
 
1001
1697
 
1002
1698
class cmd_update(Command):
1003
 
    """Update a tree to have the latest code committed to its branch.
1004
 
    
1005
 
    This will perform a merge into the working tree, and may generate
1006
 
    conflicts. If you have any local changes, you will still 
1007
 
    need to commit them after the update for the update to be complete.
1008
 
    
1009
 
    If you want to discard your local changes, you can just do a 
1010
 
    'bzr revert' instead of 'bzr commit' after the update.
 
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.
1011
1726
    """
1012
1727
 
1013
1728
    _see_also = ['pull', 'working-trees', 'status-flags']
1014
1729
    takes_args = ['dir?']
 
1730
    takes_options = ['revision',
 
1731
                     Option('show-base',
 
1732
                            help="Show base revision text in conflicts."),
 
1733
                     ]
1015
1734
    aliases = ['up']
1016
1735
 
1017
 
    def run(self, dir='.'):
1018
 
        tree = WorkingTree.open_containing(dir)[0]
 
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
1019
1750
        possible_transports = []
1020
 
        master = tree.branch.get_master_branch(
 
1751
        master = branch.get_master_branch(
1021
1752
            possible_transports=possible_transports)
1022
1753
        if master is not None:
 
1754
            branch_location = master.base
1023
1755
            tree.lock_write()
1024
1756
        else:
 
1757
            branch_location = tree.branch.base
1025
1758
            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)
1026
1785
        try:
1027
 
            existing_pending_merges = tree.get_parent_ids()[1:]
1028
 
            last_rev = _mod_revision.ensure_null(tree.last_revision())
1029
 
            if last_rev == _mod_revision.ensure_null(
1030
 
                tree.branch.last_revision()):
1031
 
                # may be up to date, check master too.
1032
 
                if master is None or last_rev == _mod_revision.ensure_null(
1033
 
                    master.last_revision()):
1034
 
                    revno = tree.branch.revision_id_to_revno(last_rev)
1035
 
                    note("Tree is up to date at revision %d." % (revno,))
1036
 
                    return 0
1037
1786
            conflicts = tree.update(
1038
 
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
1039
 
                possible_transports=possible_transports)
1040
 
            revno = tree.branch.revision_id_to_revno(
1041
 
                _mod_revision.ensure_null(tree.last_revision()))
1042
 
            note('Updated to revision %d.' % (revno,))
1043
 
            if tree.get_parent_ids()[1:] != existing_pending_merges:
1044
 
                note('Your local commits will now show as pending merges with '
1045
 
                     "'bzr status', and can be committed with 'bzr commit'.")
1046
 
            if conflicts != 0:
1047
 
                return 1
1048
 
            else:
1049
 
                return 0
1050
 
        finally:
1051
 
            tree.unlock()
 
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
1052
1810
 
1053
1811
 
1054
1812
class cmd_info(Command):
1055
 
    """Show information about a working tree, branch or repository.
 
1813
    __doc__ = """Show information about a working tree, branch or repository.
1056
1814
 
1057
1815
    This command will show all known locations and formats associated to the
1058
 
    tree, branch or repository.  Statistical information is included with
1059
 
    each report.
 
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.
1060
1821
 
1061
1822
    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
1062
1839
    """
1063
1840
    _see_also = ['revno', 'working-trees', 'repositories']
1064
1841
    takes_args = ['location?']
1068
1845
    @display_command
1069
1846
    def run(self, location=None, verbose=False):
1070
1847
        if verbose:
1071
 
            noise_level = 2
 
1848
            noise_level = get_verbosity_level()
1072
1849
        else:
1073
1850
            noise_level = 0
1074
1851
        from bzrlib.info import show_bzrdir_info
1075
 
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1852
        show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1076
1853
                         verbose=noise_level, outfile=self.outf)
1077
1854
 
1078
1855
 
1079
1856
class cmd_remove(Command):
1080
 
    """Remove files or directories.
 
1857
    __doc__ = """Remove files or directories.
1081
1858
 
1082
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1083
 
    them if they can easily be recovered using revert. If no options or
1084
 
    parameters are given bzr will scan for files that are being tracked by bzr
1085
 
    but missing in your tree and stop tracking them for you.
 
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.
1086
1864
    """
1087
1865
    takes_args = ['file*']
1088
1866
    takes_options = ['verbose',
1090
1868
        RegistryOption.from_kwargs('file-deletion-strategy',
1091
1869
            'The file deletion mode to be used.',
1092
1870
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1093
 
            safe='Only delete files if they can be'
1094
 
                 ' safely recovered (default).',
1095
 
            keep="Don't delete any files.",
1096
 
            force='Delete all the specified files, even if they can not be '
1097
 
                'recovered and even if they are non-empty directories.')]
 
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
        ]
1098
1875
    aliases = ['rm', 'del']
1099
1876
    encoding_type = 'replace'
1100
1877
 
1101
1878
    def run(self, file_list, verbose=False, new=False,
1102
1879
        file_deletion_strategy='safe'):
1103
 
        tree, file_list = tree_files(file_list)
 
1880
 
 
1881
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1104
1882
 
1105
1883
        if file_list is not None:
1106
1884
            file_list = [f for f in file_list]
1107
1885
 
1108
 
        tree.lock_write()
1109
 
        try:
1110
 
            # Heuristics should probably all move into tree.remove_smart or
1111
 
            # some such?
1112
 
            if new:
1113
 
                added = tree.changes_from(tree.basis_tree(),
1114
 
                    specific_files=file_list).added
1115
 
                file_list = sorted([f[0] for f in added], reverse=True)
1116
 
                if len(file_list) == 0:
1117
 
                    raise errors.BzrCommandError('No matching files.')
1118
 
            elif file_list is None:
1119
 
                # missing files show up in iter_changes(basis) as
1120
 
                # versioned-with-no-kind.
1121
 
                missing = []
1122
 
                for change in tree.iter_changes(tree.basis_tree()):
1123
 
                    # Find paths in the working tree that have no kind:
1124
 
                    if change[1][1] is not None and change[6][1] is None:
1125
 
                        missing.append(change[1][1])
1126
 
                file_list = sorted(missing, reverse=True)
1127
 
                file_deletion_strategy = 'keep'
1128
 
            tree.remove(file_list, verbose=verbose, to_file=self.outf,
1129
 
                keep_files=file_deletion_strategy=='keep',
1130
 
                force=file_deletion_strategy=='force')
1131
 
        finally:
1132
 
            tree.unlock()
 
1886
        self.add_cleanup(tree.lock_write().unlock)
 
1887
        # Heuristics should probably all move into tree.remove_smart or
 
1888
        # some such?
 
1889
        if new:
 
1890
            added = tree.changes_from(tree.basis_tree(),
 
1891
                specific_files=file_list).added
 
1892
            file_list = sorted([f[0] for f in added], reverse=True)
 
1893
            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'
 
1905
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1906
            keep_files=file_deletion_strategy=='keep',
 
1907
            force=(file_deletion_strategy=='no-backup'))
1133
1908
 
1134
1909
 
1135
1910
class cmd_file_id(Command):
1136
 
    """Print file_id of a particular file or directory.
 
1911
    __doc__ = """Print file_id of a particular file or directory.
1137
1912
 
1138
1913
    The file_id is assigned when the file is first added and remains the
1139
1914
    same through all revisions where the file exists, even when it is
1155
1930
 
1156
1931
 
1157
1932
class cmd_file_path(Command):
1158
 
    """Print path of file_ids to a file or directory.
 
1933
    __doc__ = """Print path of file_ids to a file or directory.
1159
1934
 
1160
1935
    This prints one line for each directory down to the target,
1161
1936
    starting at the branch root.
1177
1952
 
1178
1953
 
1179
1954
class cmd_reconcile(Command):
1180
 
    """Reconcile bzr metadata in a branch.
 
1955
    __doc__ = """Reconcile bzr metadata in a branch.
1181
1956
 
1182
1957
    This can correct data mismatches that may have been caused by
1183
1958
    previous ghost operations or bzr upgrades. You should only
1184
 
    need to run this command if 'bzr check' or a bzr developer 
 
1959
    need to run this command if 'bzr check' or a bzr developer
1185
1960
    advises you to run it.
1186
1961
 
1187
1962
    If a second branch is provided, cross-branch reconciliation is
1189
1964
    id which was not present in very early bzr versions is represented
1190
1965
    correctly in both branches.
1191
1966
 
1192
 
    At the same time it is run it may recompress data resulting in 
 
1967
    At the same time it is run it may recompress data resulting in
1193
1968
    a potential saving in disk space or performance gain.
1194
1969
 
1195
1970
    The branch *MUST* be on a listable system such as local disk or sftp.
1197
1972
 
1198
1973
    _see_also = ['check']
1199
1974
    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
        ]
1200
1981
 
1201
 
    def run(self, branch="."):
 
1982
    def run(self, branch=".", canonicalize_chks=False):
1202
1983
        from bzrlib.reconcile import reconcile
1203
 
        dir = bzrdir.BzrDir.open(branch)
1204
 
        reconcile(dir)
 
1984
        dir = controldir.ControlDir.open(branch)
 
1985
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1205
1986
 
1206
1987
 
1207
1988
class cmd_revision_history(Command):
1208
 
    """Display the list of revision ids on a branch."""
 
1989
    __doc__ = """Display the list of revision ids on a branch."""
1209
1990
 
1210
1991
    _see_also = ['log']
1211
1992
    takes_args = ['location?']
1215
1996
    @display_command
1216
1997
    def run(self, location="."):
1217
1998
        branch = Branch.open_containing(location)[0]
1218
 
        for revid in branch.revision_history():
 
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):
1219
2004
            self.outf.write(revid)
1220
2005
            self.outf.write('\n')
1221
2006
 
1222
2007
 
1223
2008
class cmd_ancestry(Command):
1224
 
    """List all revisions merged into this branch."""
 
2009
    __doc__ = """List all revisions merged into this branch."""
1225
2010
 
1226
2011
    _see_also = ['log', 'revision-history']
1227
2012
    takes_args = ['location?']
1239
2024
            b = wt.branch
1240
2025
            last_revision = wt.last_revision()
1241
2026
 
1242
 
        revision_ids = b.repository.get_ancestry(last_revision)
1243
 
        revision_ids.pop(0)
1244
 
        for revision_id in revision_ids:
 
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
1245
2034
            self.outf.write(revision_id + '\n')
1246
2035
 
1247
2036
 
1248
2037
class cmd_init(Command):
1249
 
    """Make a directory into a versioned branch.
 
2038
    __doc__ = """Make a directory into a versioned branch.
1250
2039
 
1251
2040
    Use this to create an empty branch, or before importing an
1252
2041
    existing project.
1253
2042
 
1254
 
    If there is a repository in a parent directory of the location, then 
 
2043
    If there is a repository in a parent directory of the location, then
1255
2044
    the history of the branch will be stored in the repository.  Otherwise
1256
2045
    init creates a standalone branch which carries its own history
1257
2046
    in the .bzr directory.
1277
2066
         RegistryOption('format',
1278
2067
                help='Specify a format for this branch. '
1279
2068
                'See "help formats".',
1280
 
                registry=bzrdir.format_registry,
1281
 
                converter=bzrdir.format_registry.make_bzrdir,
 
2069
                lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2070
                converter=lambda name: controldir.format_registry.make_bzrdir(name),
1282
2071
                value_switches=True,
1283
 
                title="Branch Format",
 
2072
                title="Branch format",
1284
2073
                ),
1285
2074
         Option('append-revisions-only',
1286
2075
                help='Never change revnos or the existing log.'
1287
 
                '  Append revisions to it only.')
 
2076
                '  Append revisions to it only.'),
 
2077
         Option('no-tree',
 
2078
                'Create a branch without a working tree.')
1288
2079
         ]
1289
2080
    def run(self, location=None, format=None, append_revisions_only=False,
1290
 
            create_prefix=False):
 
2081
            create_prefix=False, no_tree=False):
1291
2082
        if format is None:
1292
 
            format = bzrdir.format_registry.make_bzrdir('default')
 
2083
            format = controldir.format_registry.make_bzrdir('default')
1293
2084
        if location is None:
1294
2085
            location = u'.'
1295
2086
 
1304
2095
            to_transport.ensure_base()
1305
2096
        except errors.NoSuchFile:
1306
2097
            if not create_prefix:
1307
 
                raise errors.BzrCommandError("Parent directory of %s"
 
2098
                raise errors.BzrCommandError(gettext("Parent directory of %s"
1308
2099
                    " does not exist."
1309
2100
                    "\nYou may supply --create-prefix to create all"
1310
 
                    " leading parent directories."
 
2101
                    " leading parent directories.")
1311
2102
                    % location)
1312
 
            _create_prefix(to_transport)
 
2103
            to_transport.create_prefix()
1313
2104
 
1314
2105
        try:
1315
 
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
2106
            a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1316
2107
        except errors.NotBranchError:
1317
2108
            # really a NotBzrDir error...
1318
 
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
2109
            create_branch = controldir.ControlDir.create_branch_convenience
 
2110
            if no_tree:
 
2111
                force_new_tree = False
 
2112
            else:
 
2113
                force_new_tree = None
1319
2114
            branch = create_branch(to_transport.base, format=format,
1320
 
                                   possible_transports=[to_transport])
 
2115
                                   possible_transports=[to_transport],
 
2116
                                   force_new_tree=force_new_tree)
 
2117
            a_bzrdir = branch.bzrdir
1321
2118
        else:
1322
2119
            from bzrlib.transport.local import LocalTransport
1323
 
            if existing_bzrdir.has_branch():
 
2120
            if a_bzrdir.has_branch():
1324
2121
                if (isinstance(to_transport, LocalTransport)
1325
 
                    and not existing_bzrdir.has_workingtree()):
 
2122
                    and not a_bzrdir.has_workingtree()):
1326
2123
                        raise errors.BranchExistsWithoutWorkingTree(location)
1327
2124
                raise errors.AlreadyBranchError(location)
1328
 
            else:
1329
 
                branch = existing_bzrdir.create_branch()
1330
 
                existing_bzrdir.create_workingtree()
 
2125
            branch = a_bzrdir.create_branch()
 
2126
            if not no_tree and not a_bzrdir.has_workingtree():
 
2127
                a_bzrdir.create_workingtree()
1331
2128
        if append_revisions_only:
1332
2129
            try:
1333
2130
                branch.set_append_revisions_only(True)
1334
2131
            except errors.UpgradeRequired:
1335
 
                raise errors.BzrCommandError('This branch format cannot be set'
1336
 
                    ' to append-revisions-only.  Try --experimental-branch6')
 
2132
                raise errors.BzrCommandError(gettext('This branch format cannot be set'
 
2133
                    ' to append-revisions-only.  Try --default.'))
1337
2134
        if not is_quiet():
1338
 
            from bzrlib.info import show_bzrdir_info
1339
 
            show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1340
 
                to_transport)[0], verbose=0, outfile=self.outf)
 
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)
1341
2153
 
1342
2154
 
1343
2155
class cmd_init_repository(Command):
1344
 
    """Create a shared repository to hold branches.
 
2156
    __doc__ = """Create a shared repository for branches to share storage space.
1345
2157
 
1346
2158
    New branches created under the repository directory will store their
1347
 
    revisions in the repository, not in the branch directory.
 
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.
1348
2162
 
1349
 
    If the --no-trees option is used then the branches in the repository
1350
 
    will not have working trees by default.
 
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.
1351
2169
 
1352
2170
    :Examples:
1353
 
        Create a shared repositories holding just branches::
 
2171
        Create a shared repository holding just branches::
1354
2172
 
1355
2173
            bzr init-repo --no-trees repo
1356
2174
            bzr init repo/trunk
1367
2185
    takes_options = [RegistryOption('format',
1368
2186
                            help='Specify a format for this repository. See'
1369
2187
                                 ' "bzr help formats" for details.',
1370
 
                            registry=bzrdir.format_registry,
1371
 
                            converter=bzrdir.format_registry.make_bzrdir,
 
2188
                            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2189
                            converter=lambda name: controldir.format_registry.make_bzrdir(name),
1372
2190
                            value_switches=True, title='Repository format'),
1373
2191
                     Option('no-trees',
1374
2192
                             help='Branches in the repository will default to'
1378
2196
 
1379
2197
    def run(self, location, format=None, no_trees=False):
1380
2198
        if format is None:
1381
 
            format = bzrdir.format_registry.make_bzrdir('default')
 
2199
            format = controldir.format_registry.make_bzrdir('default')
1382
2200
 
1383
2201
        if location is None:
1384
2202
            location = '.'
1385
2203
 
1386
2204
        to_transport = transport.get_transport(location)
1387
 
        to_transport.ensure_base()
1388
2205
 
1389
 
        newdir = format.initialize_on_transport(to_transport)
1390
 
        repo = newdir.create_repository(shared=True)
1391
 
        repo.set_make_working_trees(not no_trees)
 
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()))
1392
2212
        if not is_quiet():
1393
2213
            from bzrlib.info import show_bzrdir_info
1394
 
            show_bzrdir_info(bzrdir.BzrDir.open_containing_from_transport(
1395
 
                to_transport)[0], verbose=0, outfile=self.outf)
 
2214
            show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
1396
2215
 
1397
2216
 
1398
2217
class cmd_diff(Command):
1399
 
    """Show differences in the working tree, between revisions or branches.
1400
 
    
 
2218
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
2219
 
1401
2220
    If no arguments are given, all changes for the current tree are listed.
1402
2221
    If files are given, only the changes in those files are listed.
1403
2222
    Remote and multiple branches can be compared by using the --old and
1408
2227
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1409
2228
    produces patches suitable for "patch -p1".
1410
2229
 
 
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
 
1411
2237
    :Exit values:
1412
2238
        1 - changed
1413
2239
        2 - unrepresentable changes
1423
2249
 
1424
2250
            bzr diff -r1
1425
2251
 
1426
 
        Difference between revision 2 and revision 1::
1427
 
 
1428
 
            bzr diff -r1..2
1429
 
 
1430
 
        Difference between revision 2 and revision 1 for branch xxx::
1431
 
 
1432
 
            bzr diff -r1..2 xxx
 
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..
1433
2278
 
1434
2279
        Show just the differences for file NEWS::
1435
2280
 
1450
2295
        Same as 'bzr diff' but prefix paths with old/ and new/::
1451
2296
 
1452
2297
            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
1453
2302
    """
1454
2303
    _see_also = ['status']
1455
2304
    takes_args = ['file*']
1474
2323
            help='Use this command to compare files.',
1475
2324
            type=unicode,
1476
2325
            ),
 
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
            ),
1477
2335
        ]
1478
2336
    aliases = ['di', 'dif']
1479
2337
    encoding_type = 'exact'
1480
2338
 
1481
2339
    @display_command
1482
2340
    def run(self, revision=None, file_list=None, diff_options=None,
1483
 
            prefix=None, old=None, new=None, using=None):
1484
 
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
 
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)
1485
2345
 
1486
2346
        if (prefix is None) or (prefix == '0'):
1487
2347
            # diff -p0 format
1493
2353
        elif ':' in prefix:
1494
2354
            old_label, new_label = prefix.split(":")
1495
2355
        else:
1496
 
            raise errors.BzrCommandError(
 
2356
            raise errors.BzrCommandError(gettext(
1497
2357
                '--prefix expects two values separated by a colon'
1498
 
                ' (eg "old/:new/")')
 
2358
                ' (eg "old/:new/")'))
1499
2359
 
1500
2360
        if revision and len(revision) > 2:
1501
 
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1502
 
                                         ' one or two revision specifiers')
1503
 
 
1504
 
        old_tree, new_tree, specific_files, extra_trees = \
1505
 
                _get_trees_to_diff(file_list, revision, old, new)
1506
 
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
 
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,
1507
2376
                               specific_files=specific_files,
1508
2377
                               external_diff_options=diff_options,
1509
2378
                               old_label=old_label, new_label=new_label,
1510
 
                               extra_trees=extra_trees, using=using)
 
2379
                               extra_trees=extra_trees,
 
2380
                               path_encoding=path_encoding,
 
2381
                               using=using, context=context,
 
2382
                               format_cls=format)
1511
2383
 
1512
2384
 
1513
2385
class cmd_deleted(Command):
1514
 
    """List files deleted in the working tree.
 
2386
    __doc__ = """List files deleted in the working tree.
1515
2387
    """
1516
2388
    # TODO: Show files deleted since a previous revision, or
1517
2389
    # between two revisions.
1520
2392
    # level of effort but possibly much less IO.  (Or possibly not,
1521
2393
    # if the directories are very large...)
1522
2394
    _see_also = ['status', 'ls']
1523
 
    takes_options = ['show-ids']
 
2395
    takes_options = ['directory', 'show-ids']
1524
2396
 
1525
2397
    @display_command
1526
 
    def run(self, show_ids=False):
1527
 
        tree = WorkingTree.open_containing(u'.')[0]
1528
 
        tree.lock_read()
1529
 
        try:
1530
 
            old = tree.basis_tree()
1531
 
            old.lock_read()
1532
 
            try:
1533
 
                for path, ie in old.inventory.iter_entries():
1534
 
                    if not tree.has_id(ie.file_id):
1535
 
                        self.outf.write(path)
1536
 
                        if show_ids:
1537
 
                            self.outf.write(' ')
1538
 
                            self.outf.write(ie.file_id)
1539
 
                        self.outf.write('\n')
1540
 
            finally:
1541
 
                old.unlock()
1542
 
        finally:
1543
 
            tree.unlock()
 
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')
1544
2410
 
1545
2411
 
1546
2412
class cmd_modified(Command):
1547
 
    """List files modified in working tree.
 
2413
    __doc__ = """List files modified in working tree.
1548
2414
    """
1549
2415
 
1550
2416
    hidden = True
1551
2417
    _see_also = ['status', 'ls']
1552
 
    takes_options = [
1553
 
            Option('null',
1554
 
                   help='Write an ascii NUL (\\0) separator '
1555
 
                   'between files rather than a newline.')
1556
 
            ]
 
2418
    takes_options = ['directory', 'null']
1557
2419
 
1558
2420
    @display_command
1559
 
    def run(self, null=False):
1560
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2421
    def run(self, null=False, directory=u'.'):
 
2422
        tree = WorkingTree.open_containing(directory)[0]
 
2423
        self.add_cleanup(tree.lock_read().unlock)
1561
2424
        td = tree.changes_from(tree.basis_tree())
 
2425
        self.cleanup_now()
1562
2426
        for path, id, kind, text_modified, meta_modified in td.modified:
1563
2427
            if null:
1564
2428
                self.outf.write(path + '\0')
1567
2431
 
1568
2432
 
1569
2433
class cmd_added(Command):
1570
 
    """List files added in working tree.
 
2434
    __doc__ = """List files added in working tree.
1571
2435
    """
1572
2436
 
1573
2437
    hidden = True
1574
2438
    _see_also = ['status', 'ls']
1575
 
    takes_options = [
1576
 
            Option('null',
1577
 
                   help='Write an ascii NUL (\\0) separator '
1578
 
                   'between files rather than a newline.')
1579
 
            ]
 
2439
    takes_options = ['directory', 'null']
1580
2440
 
1581
2441
    @display_command
1582
 
    def run(self, null=False):
1583
 
        wt = WorkingTree.open_containing(u'.')[0]
1584
 
        wt.lock_read()
1585
 
        try:
1586
 
            basis = wt.basis_tree()
1587
 
            basis.lock_read()
1588
 
            try:
1589
 
                basis_inv = basis.inventory
1590
 
                inv = wt.inventory
1591
 
                for file_id in inv:
1592
 
                    if file_id in basis_inv:
1593
 
                        continue
1594
 
                    if inv.is_root(file_id) and len(basis_inv) == 0:
1595
 
                        continue
1596
 
                    path = inv.id2path(file_id)
1597
 
                    if not os.access(osutils.abspath(path), os.F_OK):
1598
 
                        continue
1599
 
                    if null:
1600
 
                        self.outf.write(path + '\0')
1601
 
                    else:
1602
 
                        self.outf.write(osutils.quotefn(path) + '\n')
1603
 
            finally:
1604
 
                basis.unlock()
1605
 
        finally:
1606
 
            wt.unlock()
 
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')
1607
2460
 
1608
2461
 
1609
2462
class cmd_root(Command):
1610
 
    """Show the tree root directory.
 
2463
    __doc__ = """Show the tree root directory.
1611
2464
 
1612
2465
    The root is the nearest enclosing directory with a .bzr control
1613
2466
    directory."""
1624
2477
    try:
1625
2478
        return int(limitstring)
1626
2479
    except ValueError:
1627
 
        msg = "The limit argument must be an integer."
 
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.")
1628
2489
        raise errors.BzrCommandError(msg)
1629
2490
 
1630
2491
 
1631
2492
class cmd_log(Command):
1632
 
    """Show log of a branch, file, or directory.
1633
 
 
1634
 
    By default show the log of the branch containing the working directory.
1635
 
 
1636
 
    To request a range of logs, you can use the command -r begin..end
1637
 
    -r revision requests a specific revision, -r ..end or -r begin.. are
1638
 
    also valid.
1639
 
 
1640
 
    :Examples:
1641
 
        Log the current branch::
1642
 
 
1643
 
            bzr log
1644
 
 
1645
 
        Log a file::
1646
 
 
1647
 
            bzr log foo.c
1648
 
 
1649
 
        Log the last 10 revisions of a branch::
1650
 
 
1651
 
            bzr log -r -10.. http://server/branch
 
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.
1652
2646
    """
1653
 
 
1654
 
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
1655
 
 
1656
 
    takes_args = ['location?']
 
2647
    takes_args = ['file*']
 
2648
    _see_also = ['log-formats', 'revisionspec']
1657
2649
    takes_options = [
1658
2650
            Option('forward',
1659
2651
                   help='Show from oldest to newest.'),
1660
 
            Option('timezone',
1661
 
                   type=str,
1662
 
                   help='Display timezone as local, original, or utc.'),
 
2652
            'timezone',
1663
2653
            custom_help('verbose',
1664
2654
                   help='Show files changed in each revision.'),
1665
2655
            'show-ids',
1666
2656
            '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".'),
1667
2662
            '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),
1668
2673
            Option('message',
1669
 
                   short_name='m',
1670
2674
                   help='Show revisions whose message matches this '
1671
2675
                        'regular expression.',
1672
 
                   type=str),
 
2676
                   type=str,
 
2677
                   hidden=True),
1673
2678
            Option('limit',
1674
2679
                   short_name='l',
1675
2680
                   help='Limit the output to the first N revisions.',
1676
2681
                   argname='N',
1677
2682
                   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)
1678
2719
            ]
1679
2720
    encoding_type = 'replace'
1680
2721
 
1681
2722
    @display_command
1682
 
    def run(self, location=None, timezone='original',
 
2723
    def run(self, file_list=None, timezone='original',
1683
2724
            verbose=False,
1684
2725
            show_ids=False,
1685
2726
            forward=False,
1686
2727
            revision=None,
 
2728
            change=None,
1687
2729
            log_format=None,
 
2730
            levels=None,
1688
2731
            message=None,
1689
 
            limit=None):
1690
 
        from bzrlib.log import show_log
 
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
            )
1691
2751
        direction = (forward and 'forward') or 'reverse'
1692
 
        
1693
 
        # log everything
1694
 
        file_id = None
1695
 
        if location:
1696
 
            # find the file id to log:
1697
 
 
1698
 
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
1699
 
                location)
1700
 
            if fp != '':
1701
 
                if tree is None:
1702
 
                    tree = b.basis_tree()
1703
 
                file_id = tree.path2id(fp)
 
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:
1704
2796
                if file_id is None:
1705
 
                    raise errors.BzrCommandError(
1706
 
                        "Path does not have any revision history: %s" %
1707
 
                        location)
 
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'])
1708
2808
        else:
1709
 
            # local dir only
1710
 
            # FIXME ? log the current subdir only RBC 20060203 
 
2809
            # log everything
 
2810
            # FIXME ? log the current subdir only RBC 20060203
1711
2811
            if revision is not None \
1712
2812
                    and len(revision) > 0 and revision[0].get_branch():
1713
2813
                location = revision[0].get_branch()
1714
2814
            else:
1715
2815
                location = '.'
1716
 
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2816
            dir, relpath = controldir.ControlDir.open_containing(location)
1717
2817
            b = dir.open_branch()
1718
 
 
1719
 
        b.lock_read()
1720
 
        try:
1721
 
            if revision is None:
1722
 
                rev1 = None
1723
 
                rev2 = None
1724
 
            elif len(revision) == 1:
1725
 
                rev1 = rev2 = revision[0].in_history(b)
1726
 
            elif len(revision) == 2:
1727
 
                if revision[1].get_branch() != revision[0].get_branch():
1728
 
                    # b is taken from revision[0].get_branch(), and
1729
 
                    # show_log will use its revision_history. Having
1730
 
                    # different branches will lead to weird behaviors.
1731
 
                    raise errors.BzrCommandError(
1732
 
                        "Log doesn't accept two revisions in different"
1733
 
                        " branches.")
1734
 
                rev1 = revision[0].in_history(b)
1735
 
                rev2 = revision[1].in_history(b)
1736
 
            else:
1737
 
                raise errors.BzrCommandError(
1738
 
                    'bzr log --revision takes one or two values.')
1739
 
 
1740
 
            if log_format is None:
1741
 
                log_format = log.log_formatter_registry.get_default(b)
1742
 
 
1743
 
            lf = log_format(show_ids=show_ids, to_file=self.outf,
1744
 
                            show_timezone=timezone)
1745
 
 
1746
 
            show_log(b,
1747
 
                     lf,
1748
 
                     file_id,
1749
 
                     verbose=verbose,
1750
 
                     direction=direction,
1751
 
                     start_revision=rev1,
1752
 
                     end_revision=rev2,
1753
 
                     search=message,
1754
 
                     limit=limit)
1755
 
        finally:
1756
 
            b.unlock()
1757
 
 
 
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
1758
2943
 
1759
2944
def get_log_format(long=False, short=False, line=False, default='long'):
1760
2945
    log_format = default
1768
2953
 
1769
2954
 
1770
2955
class cmd_touching_revisions(Command):
1771
 
    """Return revision-ids which affected a particular file.
 
2956
    __doc__ = """Return revision-ids which affected a particular file.
1772
2957
 
1773
2958
    A more user-friendly interface is "bzr log FILE".
1774
2959
    """
1779
2964
    @display_command
1780
2965
    def run(self, filename):
1781
2966
        tree, relpath = WorkingTree.open_containing(filename)
 
2967
        file_id = tree.path2id(relpath)
1782
2968
        b = tree.branch
1783
 
        file_id = tree.path2id(relpath)
1784
 
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
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:
1785
2972
            self.outf.write("%6d %s\n" % (revno, what))
1786
2973
 
1787
2974
 
1788
2975
class cmd_ls(Command):
1789
 
    """List files in a tree.
 
2976
    __doc__ = """List files in a tree.
1790
2977
    """
1791
2978
 
1792
2979
    _see_also = ['status', 'cat']
1793
2980
    takes_args = ['path?']
1794
 
    # TODO: Take a revision or remote path and list that tree instead.
1795
2981
    takes_options = [
1796
2982
            'verbose',
1797
2983
            'revision',
1798
 
            Option('non-recursive',
1799
 
                   help='Don\'t recurse into subdirectories.'),
 
2984
            Option('recursive', short_name='R',
 
2985
                   help='Recurse into subdirectories.'),
1800
2986
            Option('from-root',
1801
2987
                   help='Print paths relative to the root of the branch.'),
1802
 
            Option('unknown', help='Print unknown files.'),
 
2988
            Option('unknown', short_name='u',
 
2989
                help='Print unknown files.'),
1803
2990
            Option('versioned', help='Print versioned files.',
1804
2991
                   short_name='V'),
1805
 
            Option('ignored', help='Print ignored files.'),
1806
 
            Option('null',
1807
 
                   help='Write an ascii NUL (\\0) separator '
1808
 
                   'between files rather than a newline.'),
1809
 
            Option('kind',
 
2992
            Option('ignored', short_name='i',
 
2993
                help='Print ignored files.'),
 
2994
            Option('kind', short_name='k',
1810
2995
                   help='List entries of a particular kind: file, directory, symlink.',
1811
2996
                   type=unicode),
 
2997
            'null',
1812
2998
            'show-ids',
 
2999
            'directory',
1813
3000
            ]
1814
3001
    @display_command
1815
3002
    def run(self, revision=None, verbose=False,
1816
 
            non_recursive=False, from_root=False,
 
3003
            recursive=False, from_root=False,
1817
3004
            unknown=False, versioned=False, ignored=False,
1818
 
            null=False, kind=None, show_ids=False, path=None):
 
3005
            null=False, kind=None, show_ids=False, path=None, directory=None):
1819
3006
 
1820
3007
        if kind and kind not in ('file', 'directory', 'symlink'):
1821
 
            raise errors.BzrCommandError('invalid kind specified')
 
3008
            raise errors.BzrCommandError(gettext('invalid kind specified'))
1822
3009
 
1823
3010
        if verbose and null:
1824
 
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
3011
            raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
1825
3012
        all = not (unknown or versioned or ignored)
1826
3013
 
1827
3014
        selection = {'I':ignored, '?':unknown, 'V':versioned}
1828
3015
 
1829
3016
        if path is None:
1830
3017
            fs_path = '.'
1831
 
            prefix = ''
1832
3018
        else:
1833
3019
            if from_root:
1834
 
                raise errors.BzrCommandError('cannot specify both --from-root'
1835
 
                                             ' and PATH')
 
3020
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
 
3021
                                             ' and PATH'))
1836
3022
            fs_path = path
1837
 
            prefix = path
1838
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
1839
 
            fs_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
1840
3028
        if from_root:
1841
 
            relpath = u''
1842
 
        elif relpath:
1843
 
            relpath += '/'
1844
 
        if revision is not None:
1845
 
            tree = branch.repository.revision_tree(
1846
 
                revision[0].as_revision_id(branch))
1847
 
        elif tree is None:
1848
 
            tree = branch.basis_tree()
1849
 
 
1850
 
        tree.lock_read()
1851
 
        try:
1852
 
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
1853
 
                if fp.startswith(relpath):
1854
 
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
1855
 
                    if non_recursive and '/' in fp:
1856
 
                        continue
1857
 
                    if not all and not selection[fc]:
1858
 
                        continue
1859
 
                    if kind is not None and fkind != kind:
1860
 
                        continue
1861
 
                    if verbose:
1862
 
                        kindch = entry.kind_character()
1863
 
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
1864
 
                        if show_ids and fid is not None:
1865
 
                            outstring = "%-50s %s" % (outstring, fid)
1866
 
                        self.outf.write(outstring + '\n')
1867
 
                    elif null:
1868
 
                        self.outf.write(fp + '\0')
1869
 
                        if show_ids:
1870
 
                            if fid is not None:
1871
 
                                self.outf.write(fid)
1872
 
                            self.outf.write('\0')
1873
 
                        self.outf.flush()
1874
 
                    else:
1875
 
                        if fid is not None:
1876
 
                            my_id = fid
1877
 
                        else:
1878
 
                            my_id = ''
1879
 
                        if show_ids:
1880
 
                            self.outf.write('%-50s %s\n' % (fp, my_id))
1881
 
                        else:
1882
 
                            self.outf.write(fp + '\n')
1883
 
        finally:
1884
 
            tree.unlock()
 
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')
1885
3090
 
1886
3091
 
1887
3092
class cmd_unknowns(Command):
1888
 
    """List unknown files.
 
3093
    __doc__ = """List unknown files.
1889
3094
    """
1890
3095
 
1891
3096
    hidden = True
1892
3097
    _see_also = ['ls']
 
3098
    takes_options = ['directory']
1893
3099
 
1894
3100
    @display_command
1895
 
    def run(self):
1896
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
3101
    def run(self, directory=u'.'):
 
3102
        for f in WorkingTree.open_containing(directory)[0].unknowns():
1897
3103
            self.outf.write(osutils.quotefn(f) + '\n')
1898
3104
 
1899
3105
 
1900
3106
class cmd_ignore(Command):
1901
 
    """Ignore specified files or patterns.
 
3107
    __doc__ = """Ignore specified files or patterns.
1902
3108
 
1903
3109
    See ``bzr help patterns`` for details on the syntax of patterns.
1904
3110
 
 
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
 
1905
3117
    To remove patterns from the ignore list, edit the .bzrignore file.
1906
3118
    After adding, editing or deleting that file either indirectly by
1907
3119
    using this command or directly by using an editor, be sure to commit
1908
3120
    it.
1909
 
 
1910
 
    Note: ignore patterns containing shell wildcards must be quoted from 
1911
 
    the shell on Unix.
 
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.
1912
3142
 
1913
3143
    :Examples:
1914
3144
        Ignore the top level Makefile::
1915
3145
 
1916
3146
            bzr ignore ./Makefile
1917
3147
 
1918
 
        Ignore class files in all directories::
 
3148
        Ignore .class files in all directories...::
1919
3149
 
1920
3150
            bzr ignore "*.class"
1921
3151
 
 
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
 
1922
3160
        Ignore .o files under the lib directory::
1923
3161
 
1924
3162
            bzr ignore "lib/**/*.o"
1930
3168
        Ignore everything but the "debian" toplevel directory::
1931
3169
 
1932
3170
            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 "!!*~"
1933
3178
    """
1934
3179
 
1935
3180
    _see_also = ['status', 'ignored', 'patterns']
1936
3181
    takes_args = ['name_pattern*']
1937
 
    takes_options = [
1938
 
        Option('old-default-rules',
1939
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
3182
    takes_options = ['directory',
 
3183
        Option('default-rules',
 
3184
               help='Display the default ignore rules that bzr uses.')
1940
3185
        ]
1941
 
    
1942
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
3186
 
 
3187
    def run(self, name_pattern_list=None, default_rules=None,
 
3188
            directory=u'.'):
1943
3189
        from bzrlib import ignores
1944
 
        if old_default_rules is not None:
1945
 
            # dump the rules and exit
1946
 
            for pattern in ignores.OLD_DEFAULTS:
1947
 
                print pattern
 
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)
1948
3194
            return
1949
3195
        if not name_pattern_list:
1950
 
            raise errors.BzrCommandError("ignore requires at least one "
1951
 
                                  "NAME_PATTERN or --old-default-rules")
1952
 
        name_pattern_list = [globbing.normalize_pattern(p) 
 
3196
            raise errors.BzrCommandError(gettext("ignore requires at least one "
 
3197
                "NAME_PATTERN or --default-rules."))
 
3198
        name_pattern_list = [globbing.normalize_pattern(p)
1953
3199
                             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('')
1954
3212
        for name_pattern in name_pattern_list:
1955
 
            if (name_pattern[0] == '/' or 
 
3213
            if (name_pattern[0] == '/' or
1956
3214
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
1957
 
                raise errors.BzrCommandError(
1958
 
                    "NAME_PATTERN should not be an absolute path")
1959
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
3215
                raise errors.BzrCommandError(gettext(
 
3216
                    "NAME_PATTERN should not be an absolute path"))
 
3217
        tree, relpath = WorkingTree.open_containing(directory)
1960
3218
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
1961
3219
        ignored = globbing.Globster(name_pattern_list)
1962
3220
        matches = []
1963
 
        tree.lock_read()
 
3221
        self.add_cleanup(tree.lock_read().unlock)
1964
3222
        for entry in tree.list_files():
1965
3223
            id = entry[3]
1966
3224
            if id is not None:
1967
3225
                filename = entry[0]
1968
3226
                if ignored.match(filename):
1969
 
                    matches.append(filename.encode('utf-8'))
1970
 
        tree.unlock()
 
3227
                    matches.append(filename)
1971
3228
        if len(matches) > 0:
1972
 
            print "Warning: the following files are version controlled and" \
1973
 
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
 
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),))
1974
3233
 
1975
3234
 
1976
3235
class cmd_ignored(Command):
1977
 
    """List ignored files and the patterns that matched them.
 
3236
    __doc__ = """List ignored files and the patterns that matched them.
1978
3237
 
1979
3238
    List all the ignored files and the ignore pattern that caused the file to
1980
3239
    be ignored.
1986
3245
 
1987
3246
    encoding_type = 'replace'
1988
3247
    _see_also = ['ignore', 'ls']
 
3248
    takes_options = ['directory']
1989
3249
 
1990
3250
    @display_command
1991
 
    def run(self):
1992
 
        tree = WorkingTree.open_containing(u'.')[0]
1993
 
        tree.lock_read()
1994
 
        try:
1995
 
            for path, file_class, kind, file_id, entry in tree.list_files():
1996
 
                if file_class != 'I':
1997
 
                    continue
1998
 
                ## XXX: Slightly inefficient since this was already calculated
1999
 
                pat = tree.is_ignored(path)
2000
 
                self.outf.write('%-50s %s\n' % (path, pat))
2001
 
        finally:
2002
 
            tree.unlock()
 
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))
2003
3260
 
2004
3261
 
2005
3262
class cmd_lookup_revision(Command):
2006
 
    """Lookup the revision-id from a revision-number
 
3263
    __doc__ = """Lookup the revision-id from a revision-number
2007
3264
 
2008
3265
    :Examples:
2009
3266
        bzr lookup-revision 33
2010
3267
    """
2011
3268
    hidden = True
2012
3269
    takes_args = ['revno']
2013
 
    
 
3270
    takes_options = ['directory']
 
3271
 
2014
3272
    @display_command
2015
 
    def run(self, revno):
 
3273
    def run(self, revno, directory=u'.'):
2016
3274
        try:
2017
3275
            revno = int(revno)
2018
3276
        except ValueError:
2019
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2020
 
 
2021
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
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)
2022
3281
 
2023
3282
 
2024
3283
class cmd_export(Command):
2025
 
    """Export current or past revision to a destination directory or archive.
 
3284
    __doc__ = """Export current or past revision to a destination directory or archive.
2026
3285
 
2027
3286
    If no revision is specified this exports the last committed revision.
2028
3287
 
2049
3308
         zip                          .zip
2050
3309
      =================       =========================
2051
3310
    """
 
3311
    encoding = 'exact'
2052
3312
    takes_args = ['dest', 'branch_or_subdir?']
2053
 
    takes_options = [
 
3313
    takes_options = ['directory',
2054
3314
        Option('format',
2055
3315
               help="Type of file to export to.",
2056
3316
               type=unicode),
2057
3317
        'revision',
 
3318
        Option('filters', help='Apply content filters to export the '
 
3319
                'convenient form.'),
2058
3320
        Option('root',
2059
3321
               type=str,
2060
3322
               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.'),
2061
3329
        ]
2062
3330
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2063
 
        root=None):
 
3331
        root=None, filters=False, per_file_timestamps=False, uncommitted=False,
 
3332
        directory=u'.'):
2064
3333
        from bzrlib.export import export
2065
3334
 
2066
3335
        if branch_or_subdir is None:
2067
 
            tree = WorkingTree.open_containing(u'.')[0]
2068
 
            b = tree.branch
2069
 
            subdir = None
2070
 
        else:
2071
 
            b, subdir = Branch.open_containing(branch_or_subdir)
2072
 
            
2073
 
        if revision is None:
2074
 
            # should be tree.last_revision  FIXME
2075
 
            rev_id = b.last_revision()
2076
 
        else:
2077
 
            if len(revision) != 1:
2078
 
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
2079
 
            rev_id = revision[0].as_revision_id(b)
2080
 
        t = b.repository.revision_tree(rev_id)
 
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)
2081
3350
        try:
2082
 
            export(t, dest, format, root, subdir)
 
3351
            export(export_tree, dest, format, root, subdir, filtered=filters,
 
3352
                   per_file_timestamps=per_file_timestamps)
2083
3353
        except errors.NoSuchExportFormat, e:
2084
 
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
3354
            raise errors.BzrCommandError(
 
3355
                gettext('Unsupported export format: %s') % e.format)
2085
3356
 
2086
3357
 
2087
3358
class cmd_cat(Command):
2088
 
    """Write the contents of a file as of a given revision to standard output.
 
3359
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2089
3360
 
2090
3361
    If no revision is nominated, the last revision is used.
2091
3362
 
2092
3363
    Note: Take care to redirect standard output when using this command on a
2093
 
    binary file. 
 
3364
    binary file.
2094
3365
    """
2095
3366
 
2096
3367
    _see_also = ['ls']
2097
 
    takes_options = [
 
3368
    takes_options = ['directory',
2098
3369
        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.'),
2099
3372
        'revision',
2100
3373
        ]
2101
3374
    takes_args = ['filename']
2102
3375
    encoding_type = 'exact'
2103
3376
 
2104
3377
    @display_command
2105
 
    def run(self, filename, revision=None, name_from_revision=False):
 
3378
    def run(self, filename, revision=None, name_from_revision=False,
 
3379
            filters=False, directory=None):
2106
3380
        if revision is not None and len(revision) != 1:
2107
 
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2108
 
                                         " one revision specifier")
 
3381
            raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
 
3382
                                         " one revision specifier"))
2109
3383
        tree, branch, relpath = \
2110
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2111
 
        branch.lock_read()
2112
 
        try:
2113
 
            return self._run(tree, branch, relpath, filename, revision,
2114
 
                             name_from_revision)
2115
 
        finally:
2116
 
            branch.unlock()
 
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)
2117
3388
 
2118
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
 
3389
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
3390
        filtered):
2119
3391
        if tree is None:
2120
3392
            tree = b.basis_tree()
2121
 
        if revision is None:
2122
 
            revision_id = b.last_revision()
2123
 
        else:
2124
 
            revision_id = revision[0].as_revision_id(b)
 
3393
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
3394
        self.add_cleanup(rev_tree.lock_read().unlock)
2125
3395
 
2126
 
        cur_file_id = tree.path2id(relpath)
2127
 
        rev_tree = b.repository.revision_tree(revision_id)
2128
3396
        old_file_id = rev_tree.path2id(relpath)
2129
 
        
 
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.
2130
3402
        if name_from_revision:
 
3403
            # Try in revision if requested
2131
3404
            if old_file_id is None:
2132
 
                raise errors.BzrCommandError("%r is not present in revision %s"
2133
 
                                                % (filename, revision_id))
2134
 
            else:
2135
 
                content = rev_tree.get_file_text(old_file_id)
2136
 
        elif cur_file_id is not None:
2137
 
            content = rev_tree.get_file_text(cur_file_id)
2138
 
        elif old_file_id is not None:
2139
 
            content = rev_tree.get_file_text(old_file_id)
2140
 
        else:
2141
 
            raise errors.BzrCommandError("%r is not present in revision %s" %
2142
 
                                         (filename, revision_id))
 
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()
2143
3428
        self.outf.write(content)
2144
3429
 
2145
3430
 
2146
3431
class cmd_local_time_offset(Command):
2147
 
    """Show the offset in seconds from GMT to local time."""
2148
 
    hidden = True    
 
3432
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
3433
    hidden = True
2149
3434
    @display_command
2150
3435
    def run(self):
2151
 
        print osutils.local_time_offset()
 
3436
        self.outf.write("%s\n" % osutils.local_time_offset())
2152
3437
 
2153
3438
 
2154
3439
 
2155
3440
class cmd_commit(Command):
2156
 
    """Commit changes into a new revision.
2157
 
    
2158
 
    If no arguments are given, the entire tree is committed.
2159
 
 
2160
 
    If selected files are specified, only changes to those files are
2161
 
    committed.  If a directory is specified then the directory and everything 
2162
 
    within it is committed.
2163
 
 
2164
 
    When excludes are given, they take precedence over selected files.
2165
 
    For example, too commit only changes within foo, but not changes within
2166
 
    foo/bar::
2167
 
 
2168
 
      bzr commit foo -x foo/bar
2169
 
 
2170
 
    If author of the change is not the same person as the committer, you can
2171
 
    specify the author's name using the --author option. The name should be
2172
 
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
2173
 
 
2174
 
    A selected-file commit may fail in some cases where the committed
2175
 
    tree would be invalid. Consider::
2176
 
 
2177
 
      bzr init foo
2178
 
      mkdir foo/bar
2179
 
      bzr add foo/bar
2180
 
      bzr commit foo -m "committing foo"
2181
 
      bzr mv foo/bar foo/baz
2182
 
      mkdir foo/bar
2183
 
      bzr add foo/bar
2184
 
      bzr commit foo/bar -m "committing bar but not baz"
2185
 
 
2186
 
    In the example above, the last commit will fail by design. This gives
2187
 
    the user the opportunity to decide whether they want to commit the
2188
 
    rename at the same time, separately first, or not at all. (As a general
2189
 
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2190
 
 
2191
 
    Note: A selected-file commit after a merge is not yet supported.
 
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.
2192
3495
    """
2193
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
2194
 
 
2195
 
    # TODO: Strict commit that fails if there are deleted files.
2196
 
    #       (what does "deleted files" mean ??)
2197
 
 
2198
 
    # TODO: Give better message for -s, --summary, used by tla people
2199
 
 
2200
 
    # XXX: verbose currently does nothing
2201
 
 
2202
 
    _see_also = ['bugs', 'uncommit']
 
3496
 
 
3497
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2203
3498
    takes_args = ['selected*']
2204
3499
    takes_options = [
2205
3500
            ListOption('exclude', type=str, short_name='x',
2217
3512
             Option('strict',
2218
3513
                    help="Refuse to commit if there are unknown "
2219
3514
                    "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'."),
2220
3518
             ListOption('fixes', type=str,
2221
 
                    help="Mark a bug as being fixed by this revision."),
2222
 
             Option('author', type=unicode,
 
3519
                    help="Mark a bug as being fixed by this revision "
 
3520
                         "(see \"bzr help bugs\")."),
 
3521
             ListOption('author', type=unicode,
2223
3522
                    help="Set the author's name, if it's different "
2224
3523
                         "from the committer."),
2225
3524
             Option('local',
2228
3527
                         "the master branch until a normal commit "
2229
3528
                         "is performed."
2230
3529
                    ),
2231
 
              Option('show-diff',
2232
 
                     help='When no message is supplied, show the diff along'
2233
 
                     ' with the status summary in the message editor.'),
 
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.'),
2234
3537
             ]
2235
3538
    aliases = ['ci', 'checkin']
2236
3539
 
2237
 
    def _get_bug_fix_properties(self, fixes, branch):
2238
 
        properties = []
 
3540
    def _iter_bug_fix_urls(self, fixes, branch):
 
3541
        default_bugtracker  = None
2239
3542
        # Configure the properties for bug fixing attributes.
2240
3543
        for fixed_bug in fixes:
2241
3544
            tokens = fixed_bug.split(':')
2242
 
            if len(tokens) != 2:
2243
 
                raise errors.BzrCommandError(
2244
 
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
2245
 
                    "Commit refused." % fixed_bug)
2246
 
            tag, bug_id = tokens
 
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
2247
3566
            try:
2248
 
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
 
3567
                yield bugtracker.get_bug_url(tag, branch, bug_id)
2249
3568
            except errors.UnknownBugTrackerAbbreviation:
2250
 
                raise errors.BzrCommandError(
2251
 
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
2252
 
            except errors.MalformedBugIdentifier:
2253
 
                raise errors.BzrCommandError(
2254
 
                    "Invalid bug identifier for %s. Commit refused."
2255
 
                    % fixed_bug)
2256
 
            properties.append('%s fixed' % bug_url)
2257
 
        return '\n'.join(properties)
 
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),))
2258
3574
 
2259
3575
    def run(self, message=None, file=None, verbose=False, selected_list=None,
2260
3576
            unchanged=False, strict=False, local=False, fixes=None,
2261
 
            author=None, show_diff=False, exclude=None):
 
3577
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3578
            lossy=False):
2262
3579
        from bzrlib.errors import (
2263
3580
            PointlessCommit,
2264
3581
            ConflictsInTree,
2266
3583
        )
2267
3584
        from bzrlib.msgeditor import (
2268
3585
            edit_commit_message_encoded,
2269
 
            make_commit_message_template_encoded
 
3586
            generate_commit_message_template,
 
3587
            make_commit_message_template_encoded,
 
3588
            set_commit_message,
2270
3589
        )
2271
3590
 
2272
 
        # TODO: Need a blackbox test for invoking the external editor; may be
2273
 
        # slightly problematic to run this cross-platform.
2274
 
 
2275
 
        # TODO: do more checks that the commit will succeed before 
2276
 
        # spending the user's valuable time typing a commit message.
 
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)))
2277
3598
 
2278
3599
        properties = {}
2279
3600
 
2280
 
        tree, selected_list = tree_files(selected_list)
 
3601
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
2281
3602
        if selected_list == ['']:
2282
3603
            # workaround - commit of root of tree should be exactly the same
2283
3604
            # as just default commit in that tree, and succeed even though
2286
3607
 
2287
3608
        if fixes is None:
2288
3609
            fixes = []
2289
 
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
 
3610
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3611
            self._iter_bug_fix_urls(fixes, tree.branch))
2290
3612
        if bug_property:
2291
3613
            properties['bugs'] = bug_property
2292
3614
 
2293
3615
        if local and not tree.branch.get_bound_location():
2294
3616
            raise errors.LocalRequiresBoundBranch()
2295
3617
 
 
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
 
2296
3639
        def get_message(commit_obj):
2297
3640
            """Callback to get commit message"""
2298
 
            my_message = message
2299
 
            if my_message is None and not file:
2300
 
                t = make_commit_message_template_encoded(tree,
 
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,
2301
3653
                        selected_list, diff=show_diff,
2302
 
                        output_encoding=bzrlib.user_encoding)
2303
 
                my_message = edit_commit_message_encoded(t)
2304
 
                if my_message is None:
2305
 
                    raise errors.BzrCommandError("please specify a commit"
2306
 
                        " message with either --message or --file")
2307
 
            elif my_message and file:
2308
 
                raise errors.BzrCommandError(
2309
 
                    "please specify either --message or --file")
2310
 
            if file:
2311
 
                my_message = codecs.open(file, 'rt',
2312
 
                                         bzrlib.user_encoding).read()
2313
 
            if my_message == "":
2314
 
                raise errors.BzrCommandError("empty commit message specified")
 
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 \"\"."))
2315
3673
            return my_message
2316
3674
 
 
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
2317
3679
        try:
2318
3680
            tree.commit(message_callback=get_message,
2319
3681
                        specific_files=selected_list,
2320
3682
                        allow_pointless=unchanged, strict=strict, local=local,
2321
3683
                        reporter=None, verbose=verbose, revprops=properties,
2322
 
                        author=author,
2323
 
                        exclude=safe_relpath_files(tree, exclude))
 
3684
                        authors=author, timestamp=commit_stamp,
 
3685
                        timezone=offset,
 
3686
                        exclude=tree.safe_relpath_files(exclude),
 
3687
                        lossy=lossy)
2324
3688
        except PointlessCommit:
2325
 
            # FIXME: This should really happen before the file is read in;
2326
 
            # perhaps prepare the commit; get the message; then actually commit
2327
 
            raise errors.BzrCommandError("no changes to commit."
2328
 
                              " use --unchanged to commit anyhow")
 
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."))
2329
3692
        except ConflictsInTree:
2330
 
            raise errors.BzrCommandError('Conflicts detected in working '
 
3693
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
2331
3694
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
2332
 
                ' resolve.')
 
3695
                ' resolve.'))
2333
3696
        except StrictCommitFailed:
2334
 
            raise errors.BzrCommandError("Commit refused because there are"
2335
 
                              " unknown files in the working tree.")
 
3697
            raise errors.BzrCommandError(gettext("Commit refused because there are"
 
3698
                              " unknown files in the working tree."))
2336
3699
        except errors.BoundBranchOutOfDate, e:
2337
 
            raise errors.BzrCommandError(str(e) + "\n"
2338
 
            'To commit to master branch, run update and then commit.\n'
2339
 
            'You can also pass --local to commit to continue working '
2340
 
            'disconnected.')
 
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
2341
3705
 
2342
3706
 
2343
3707
class cmd_check(Command):
2344
 
    """Validate working tree structure, branch consistency and repository history.
 
3708
    __doc__ = """Validate working tree structure, branch consistency and repository history.
2345
3709
 
2346
3710
    This command checks various invariants about branch and repository storage
2347
3711
    to detect data corruption or bzr bugs.
2349
3713
    The working tree and branch checks will only give output if a problem is
2350
3714
    detected. The output fields of the repository check are:
2351
3715
 
2352
 
        revisions: This is just the number of revisions checked.  It doesn't
2353
 
            indicate a problem.
2354
 
        versionedfiles: This is just the number of versionedfiles checked.  It
2355
 
            doesn't indicate a problem.
2356
 
        unreferenced ancestors: Texts that are ancestors of other texts, but
2357
 
            are not properly referenced by the revision ancestry.  This is a
2358
 
            subtle problem that Bazaar can work around.
2359
 
        unique file texts: This is the total number of unique file contents
2360
 
            seen in the checked revisions.  It does not indicate a problem.
2361
 
        repeated file texts: This is the total number of repeated texts seen
2362
 
            in the checked revisions.  Texts can be repeated when their file
2363
 
            entries are modified, but the file contents are not.  It does not
2364
 
            indicate a problem.
 
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.
2365
3738
 
2366
3739
    If no restrictions are specified, all Bazaar data that is found at the given
2367
3740
    location will be checked.
2402
3775
 
2403
3776
 
2404
3777
class cmd_upgrade(Command):
2405
 
    """Upgrade branch storage to current format.
2406
 
 
2407
 
    The check command or bzr developers may sometimes advise you to run
2408
 
    this command. When the default format has changed you may also be warned
2409
 
    during other operations to upgrade.
 
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/.
2410
3808
    """
2411
3809
 
2412
 
    _see_also = ['check']
 
3810
    _see_also = ['check', 'reconcile', 'formats']
2413
3811
    takes_args = ['url?']
2414
3812
    takes_options = [
2415
 
                    RegistryOption('format',
2416
 
                        help='Upgrade to a specific format.  See "bzr help'
2417
 
                             ' formats" for details.',
2418
 
                        registry=bzrdir.format_registry,
2419
 
                        converter=bzrdir.format_registry.make_bzrdir,
2420
 
                        value_switches=True, title='Branch format'),
2421
 
                    ]
 
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
    ]
2422
3824
 
2423
 
    def run(self, url='.', format=None):
 
3825
    def run(self, url='.', format=None, clean=False, dry_run=False):
2424
3826
        from bzrlib.upgrade import upgrade
2425
 
        if format is None:
2426
 
            format = bzrdir.format_registry.make_bzrdir('default')
2427
 
        upgrade(url, format)
 
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
2428
3834
 
2429
3835
 
2430
3836
class cmd_whoami(Command):
2431
 
    """Show or set bzr user id.
2432
 
    
 
3837
    __doc__ = """Show or set bzr user id.
 
3838
 
2433
3839
    :Examples:
2434
3840
        Show the email of the current user::
2435
3841
 
2439
3845
 
2440
3846
            bzr whoami "Frank Chu <fchu@example.com>"
2441
3847
    """
2442
 
    takes_options = [ Option('email',
 
3848
    takes_options = [ 'directory',
 
3849
                      Option('email',
2443
3850
                             help='Display email address only.'),
2444
3851
                      Option('branch',
2445
3852
                             help='Set identity for the current branch instead of '
2447
3854
                    ]
2448
3855
    takes_args = ['name?']
2449
3856
    encoding_type = 'replace'
2450
 
    
 
3857
 
2451
3858
    @display_command
2452
 
    def run(self, email=False, branch=False, name=None):
 
3859
    def run(self, email=False, branch=False, name=None, directory=None):
2453
3860
        if name is None:
2454
 
            # use branch if we're inside one; otherwise global config
2455
 
            try:
2456
 
                c = Branch.open_containing('.')[0].get_config()
2457
 
            except errors.NotBranchError:
2458
 
                c = config.GlobalConfig()
 
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')
2459
3870
            if email:
2460
 
                self.outf.write(c.user_email() + '\n')
 
3871
                self.outf.write(_mod_config.extract_email_address(identity)
 
3872
                                + '\n')
2461
3873
            else:
2462
 
                self.outf.write(c.username() + '\n')
 
3874
                self.outf.write(identity + '\n')
2463
3875
            return
2464
3876
 
 
3877
        if email:
 
3878
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
 
3879
                                         "identity"))
 
3880
 
2465
3881
        # display a warning if an email address isn't included in the given name.
2466
3882
        try:
2467
 
            config.extract_email_address(name)
 
3883
            _mod_config.extract_email_address(name)
2468
3884
        except errors.NoEmailInUsername, e:
2469
3885
            warning('"%s" does not seem to contain an email address.  '
2470
3886
                    'This is allowed, but not recommended.', name)
2471
 
        
 
3887
 
2472
3888
        # use global config unless --branch given
2473
3889
        if branch:
2474
 
            c = Branch.open_containing('.')[0].get_config()
 
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()
2475
3896
        else:
2476
 
            c = config.GlobalConfig()
2477
 
        c.set_user_option('email', name)
 
3897
            c = _mod_config.GlobalStack()
 
3898
        c.set('email', name)
2478
3899
 
2479
3900
 
2480
3901
class cmd_nick(Command):
2481
 
    """Print or set the branch nickname.  
2482
 
 
2483
 
    If unset, the tree root directory name is used as the nickname
2484
 
    To print the current nickname, execute with no argument.  
 
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.
2485
3910
    """
2486
3911
 
2487
3912
    _see_also = ['info']
2488
3913
    takes_args = ['nickname?']
2489
 
    def run(self, nickname=None):
2490
 
        branch = Branch.open_containing(u'.')[0]
 
3914
    takes_options = ['directory']
 
3915
    def run(self, nickname=None, directory=u'.'):
 
3916
        branch = Branch.open_containing(directory)[0]
2491
3917
        if nickname is None:
2492
3918
            self.printme(branch)
2493
3919
        else:
2495
3921
 
2496
3922
    @display_command
2497
3923
    def printme(self, branch):
2498
 
        print branch.nick
 
3924
        self.outf.write('%s\n' % branch.nick)
2499
3925
 
2500
3926
 
2501
3927
class cmd_alias(Command):
2502
 
    """Set/unset and display aliases.
 
3928
    __doc__ = """Set/unset and display aliases.
2503
3929
 
2504
3930
    :Examples:
2505
3931
        Show the current aliases::
2538
3964
 
2539
3965
    def remove_alias(self, alias_name):
2540
3966
        if alias_name is None:
2541
 
            raise errors.BzrCommandError(
2542
 
                'bzr alias --remove expects an alias to remove.')
 
3967
            raise errors.BzrCommandError(gettext(
 
3968
                'bzr alias --remove expects an alias to remove.'))
2543
3969
        # If alias is not found, print something like:
2544
3970
        # unalias: foo: not found
2545
 
        c = config.GlobalConfig()
 
3971
        c = _mod_config.GlobalConfig()
2546
3972
        c.unset_alias(alias_name)
2547
3973
 
2548
3974
    @display_command
2549
3975
    def print_aliases(self):
2550
3976
        """Print out the defined aliases in a similar format to bash."""
2551
 
        aliases = config.GlobalConfig().get_aliases()
 
3977
        aliases = _mod_config.GlobalConfig().get_aliases()
2552
3978
        for key, value in sorted(aliases.iteritems()):
2553
3979
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
2554
3980
 
2564
3990
 
2565
3991
    def set_alias(self, alias_name, alias_command):
2566
3992
        """Save the alias in the global config."""
2567
 
        c = config.GlobalConfig()
 
3993
        c = _mod_config.GlobalConfig()
2568
3994
        c.set_alias(alias_name, alias_command)
2569
3995
 
2570
3996
 
2571
3997
class cmd_selftest(Command):
2572
 
    """Run internal test suite.
2573
 
    
 
3998
    __doc__ = """Run internal test suite.
 
3999
 
2574
4000
    If arguments are given, they are regular expressions that say which tests
2575
4001
    should run.  Tests matching any expression are run, and other tests are
2576
4002
    not run.
2599
4025
    modified by plugins will not be tested, and tests provided by plugins will
2600
4026
    not be run.
2601
4027
 
2602
 
    Tests that need working space on disk use a common temporary directory, 
 
4028
    Tests that need working space on disk use a common temporary directory,
2603
4029
    typically inside $TMPDIR or /tmp.
2604
4030
 
 
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
 
2605
4037
    :Examples:
2606
4038
        Run only tests relating to 'ignore'::
2607
4039
 
2616
4048
    def get_transport_type(typestring):
2617
4049
        """Parse and return a transport specifier."""
2618
4050
        if typestring == "sftp":
2619
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
2620
 
            return SFTPAbsoluteServer
2621
 
        if typestring == "memory":
2622
 
            from bzrlib.transport.memory import MemoryServer
2623
 
            return MemoryServer
2624
 
        if typestring == "fakenfs":
2625
 
            from bzrlib.transport.fakenfs import FakeNFSServer
2626
 
            return FakeNFSServer
 
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
2627
4059
        msg = "No known transport type %s. Supported types are: sftp\n" %\
2628
4060
            (typestring)
2629
4061
        raise errors.BzrCommandError(msg)
2640
4072
                                 'throughout the test suite.',
2641
4073
                            type=get_transport_type),
2642
4074
                     Option('benchmark',
2643
 
                            help='Run the benchmarks rather than selftests.'),
 
4075
                            help='Run the benchmarks rather than selftests.',
 
4076
                            hidden=True),
2644
4077
                     Option('lsprof-timed',
2645
4078
                            help='Generate lsprof output for benchmarked'
2646
4079
                                 ' sections of code.'),
2647
 
                     Option('cache-dir', type=str,
2648
 
                            help='Cache intermediate benchmark output in this '
2649
 
                                 'directory.'),
 
4080
                     Option('lsprof-tests',
 
4081
                            help='Generate lsprof output for each test.'),
2650
4082
                     Option('first',
2651
4083
                            help='Run all tests, but run specified tests first.',
2652
4084
                            short_name='f',
2653
4085
                            ),
2654
4086
                     Option('list-only',
2655
4087
                            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
                        ),
2656
4093
                     Option('randomize', type=str, argname="SEED",
2657
4094
                            help='Randomize the order of tests using the given'
2658
4095
                                 ' seed or "now" for the current time.'),
2659
 
                     Option('exclude', type=str, argname="PATTERN",
2660
 
                            short_name='x',
2661
 
                            help='Exclude tests that match this regular'
2662
 
                                 ' expression.'),
 
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.'),
2663
4102
                     Option('strict', help='Fail on missing dependencies or '
2664
4103
                            'known failures.'),
2665
4104
                     Option('load-list', type=str, argname='TESTLISTFILE',
2670
4109
                                param_name='starting_with', short_name='s',
2671
4110
                                help=
2672
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.")
2673
4115
                     ]
2674
4116
    encoding_type = 'replace'
2675
4117
 
 
4118
    def __init__(self):
 
4119
        Command.__init__(self)
 
4120
        self.additional_selftest_args = {}
 
4121
 
2676
4122
    def run(self, testspecs_list=None, verbose=False, one=False,
2677
4123
            transport=None, benchmark=None,
2678
 
            lsprof_timed=None, cache_dir=None,
 
4124
            lsprof_timed=None,
2679
4125
            first=False, list_only=False,
2680
4126
            randomize=None, exclude=None, strict=False,
2681
 
            load_list=None, debugflag=None, starting_with=None):
2682
 
        import bzrlib.ui
2683
 
        from bzrlib.tests import selftest
2684
 
        import bzrlib.benchmarks as benchmarks
2685
 
        from bzrlib.benchmarks import tree_creator
2686
 
 
2687
 
        # Make deprecation warnings visible, unless -Werror is set
2688
 
        symbol_versioning.activate_deprecation_warnings(override=False)
2689
 
 
2690
 
        if cache_dir is not None:
2691
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
2692
 
        if not list_only:
2693
 
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
2694
 
            print '   %s (%s python%s)' % (
2695
 
                    bzrlib.__path__[0],
2696
 
                    bzrlib.version_string,
2697
 
                    bzrlib._format_version_tuple(sys.version_info),
2698
 
                    )
2699
 
        print
 
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
 
2700
4141
        if testspecs_list is not None:
2701
4142
            pattern = '|'.join(testspecs_list)
2702
4143
        else:
2703
4144
            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)
2704
4164
        if benchmark:
2705
 
            test_suite_factory = benchmarks.test_suite
2706
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
2707
 
            verbose = not is_quiet()
2708
 
            # TODO: should possibly lock the history file...
2709
 
            benchfile = open(".perf_history", "at", buffering=1)
 
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
2710
4171
        else:
2711
 
            test_suite_factory = None
2712
 
            benchfile = None
 
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)
2713
4196
        try:
2714
 
            result = selftest(verbose=verbose,
2715
 
                              pattern=pattern,
2716
 
                              stop_on_failure=one,
2717
 
                              transport=transport,
2718
 
                              test_suite_factory=test_suite_factory,
2719
 
                              lsprof_timed=lsprof_timed,
2720
 
                              bench_history=benchfile,
2721
 
                              matching_tests_first=first,
2722
 
                              list_only=list_only,
2723
 
                              random_seed=randomize,
2724
 
                              exclude_pattern=exclude,
2725
 
                              strict=strict,
2726
 
                              load_list=load_list,
2727
 
                              debug_flags=debugflag,
2728
 
                              starting_with=starting_with,
2729
 
                              )
 
4197
            result = tests.selftest(**selftest_kwargs)
2730
4198
        finally:
2731
 
            if benchfile is not None:
2732
 
                benchfile.close()
2733
 
        if result:
2734
 
            note('tests passed')
2735
 
        else:
2736
 
            note('tests failed')
 
4199
            cleanup()
2737
4200
        return int(not result)
2738
4201
 
 
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
 
2739
4211
 
2740
4212
class cmd_version(Command):
2741
 
    """Show version of bzr."""
 
4213
    __doc__ = """Show version of bzr."""
2742
4214
 
2743
4215
    encoding_type = 'replace'
2744
4216
    takes_options = [
2755
4227
 
2756
4228
 
2757
4229
class cmd_rocks(Command):
2758
 
    """Statement of optimism."""
 
4230
    __doc__ = """Statement of optimism."""
2759
4231
 
2760
4232
    hidden = True
2761
4233
 
2762
4234
    @display_command
2763
4235
    def run(self):
2764
 
        print "It sure does!"
 
4236
        self.outf.write(gettext("It sure does!\n"))
2765
4237
 
2766
4238
 
2767
4239
class cmd_find_merge_base(Command):
2768
 
    """Find and print a base revision for merging two branches."""
 
4240
    __doc__ = """Find and print a base revision for merging two branches."""
2769
4241
    # TODO: Options to specify revisions on either side, as if
2770
4242
    #       merging only part of the history.
2771
4243
    takes_args = ['branch', 'other']
2772
4244
    hidden = True
2773
 
    
 
4245
 
2774
4246
    @display_command
2775
4247
    def run(self, branch, other):
2776
4248
        from bzrlib.revision import ensure_null
2777
 
        
 
4249
 
2778
4250
        branch1 = Branch.open_containing(branch)[0]
2779
4251
        branch2 = Branch.open_containing(other)[0]
2780
 
        branch1.lock_read()
2781
 
        try:
2782
 
            branch2.lock_read()
2783
 
            try:
2784
 
                last1 = ensure_null(branch1.last_revision())
2785
 
                last2 = ensure_null(branch2.last_revision())
2786
 
 
2787
 
                graph = branch1.repository.get_graph(branch2.repository)
2788
 
                base_rev_id = graph.find_unique_lca(last1, last2)
2789
 
 
2790
 
                print 'merge base is revision %s' % base_rev_id
2791
 
            finally:
2792
 
                branch2.unlock()
2793
 
        finally:
2794
 
            branch1.unlock()
 
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)
2795
4261
 
2796
4262
 
2797
4263
class cmd_merge(Command):
2798
 
    """Perform a three-way merge.
2799
 
    
 
4264
    __doc__ = """Perform a three-way merge.
 
4265
 
2800
4266
    The source of the merge can be specified either in the form of a branch,
2801
4267
    or in the form of a path to a file containing a merge directive generated
2802
4268
    with bzr send. If neither is specified, the default is the upstream branch
2803
 
    or the branch most recently merged using --remember.
2804
 
 
2805
 
    When merging a branch, by default the tip will be merged. To pick a different
2806
 
    revision, pass --revision. If you specify two values, the first will be used as
2807
 
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
2808
 
    available revisions, like this is commonly referred to as "cherrypicking".
2809
 
 
2810
 
    Revision numbers are always relative to the branch being merged.
2811
 
 
2812
 
    By default, bzr will try to merge in all new work from the other
2813
 
    branch, automatically determining an appropriate base.  If this
2814
 
    fails, you may need to give an explicit base.
2815
 
    
 
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
 
2816
4291
    Merge will do its best to combine the changes in two branches, but there
2817
4292
    are some kinds of problems only a human can fix.  When it encounters those,
2818
4293
    it will mark a conflict.  A conflict means that you need to fix something,
2819
 
    before you should commit.
 
4294
    before you can commit.
2820
4295
 
2821
4296
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
2822
4297
 
2823
 
    If there is no default branch set, the first merge will set it. After
2824
 
    that, you can omit the branch to use the default.  To change the
2825
 
    default, use --remember. The value will only be saved if the remote
2826
 
    location can be accessed.
 
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.
2827
4302
 
2828
4303
    The results of the merge are placed into the destination working
2829
4304
    directory, where they can be reviewed (with bzr diff), tested, and then
2830
4305
    committed to record the result of the merge.
2831
 
    
 
4306
 
2832
4307
    merge refuses to run if there are any uncommitted changes, unless
2833
 
    --force is given.
 
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".
2834
4319
 
2835
4320
    :Examples:
2836
 
        To merge the latest revision from bzr.dev::
 
4321
        To merge all new revisions from bzr.dev::
2837
4322
 
2838
4323
            bzr merge ../bzr.dev
2839
4324
 
2845
4330
 
2846
4331
            bzr merge -r 81..82 ../bzr.dev
2847
4332
 
2848
 
        To apply a merge directive contained in in /tmp/merge:
 
4333
        To apply a merge directive contained in /tmp/merge::
2849
4334
 
2850
4335
            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'
2851
4343
    """
2852
4344
 
2853
4345
    encoding_type = 'exact'
2854
 
    _see_also = ['update', 'remerge', 'status-flags']
 
4346
    _see_also = ['update', 'remerge', 'status-flags', 'send']
2855
4347
    takes_args = ['location?']
2856
4348
    takes_options = [
2857
4349
        'change',
2869
4361
                ' completely merged into the source, pull from the'
2870
4362
                ' source rather than merging.  When this happens,'
2871
4363
                ' you do not need to commit the result.'),
2872
 
        Option('directory',
 
4364
        custom_help('directory',
2873
4365
               help='Branch to merge into, '
2874
 
                    'rather than the one containing the working directory.',
2875
 
               short_name='d',
2876
 
               type=unicode,
2877
 
               ),
2878
 
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
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')
2879
4371
    ]
2880
4372
 
2881
4373
    def run(self, location=None, revision=None, force=False,
2882
 
            merge_type=None, show_base=False, reprocess=False, remember=False,
 
4374
            merge_type=None, show_base=False, reprocess=None, remember=None,
2883
4375
            uncommitted=False, pull=False,
2884
4376
            directory=None,
2885
4377
            preview=False,
 
4378
            interactive=False,
2886
4379
            ):
2887
4380
        if merge_type is None:
2888
4381
            merge_type = _mod_merge.Merge3Merger
2892
4385
        merger = None
2893
4386
        allow_pending = True
2894
4387
        verified = 'inapplicable'
 
4388
 
2895
4389
        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
 
 
4394
        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)
2896
4405
        change_reporter = delta._ChangeReporter(
2897
 
            unversioned_filter=tree.is_ignored)
2898
 
        cleanups = []
2899
 
        try:
2900
 
            pb = ui.ui_factory.nested_progress_bar()
2901
 
            cleanups.append(pb.finished)
2902
 
            tree.lock_write()
2903
 
            cleanups.append(tree.unlock)
2904
 
            if location is not None:
2905
 
                try:
2906
 
                    mergeable = bundle.read_mergeable_from_url(location,
2907
 
                        possible_transports=possible_transports)
2908
 
                except errors.NotABundle:
2909
 
                    mergeable = None
2910
 
                else:
2911
 
                    if uncommitted:
2912
 
                        raise errors.BzrCommandError('Cannot use --uncommitted'
2913
 
                            ' with bundles or merge directives.')
2914
 
 
2915
 
                    if revision is not None:
2916
 
                        raise errors.BzrCommandError(
2917
 
                            'Cannot use -r with merge directives or bundles')
2918
 
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
2919
 
                       mergeable, pb)
2920
 
 
2921
 
            if merger is None and uncommitted:
2922
 
                if revision is not None and len(revision) > 0:
2923
 
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
2924
 
                        ' --revision at the same time.')
2925
 
                location = self._select_branch_location(tree, location)[0]
2926
 
                other_tree, other_path = WorkingTree.open_containing(location)
2927
 
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
2928
 
                    pb)
2929
 
                allow_pending = False
2930
 
                if other_path != '':
2931
 
                    merger.interesting_files = [other_path]
2932
 
 
2933
 
            if merger is None:
2934
 
                merger, allow_pending = self._get_merger_from_branch(tree,
2935
 
                    location, revision, remember, possible_transports, pb)
2936
 
 
2937
 
            merger.merge_type = merge_type
2938
 
            merger.reprocess = reprocess
2939
 
            merger.show_base = show_base
2940
 
            self.sanity_check_merger(merger)
2941
 
            if (merger.base_rev_id == merger.other_rev_id and
2942
 
                merger.other_rev_id is not None):
2943
 
                note('Nothing to do.')
 
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
 
4416
            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)
2944
4460
                return 0
2945
 
            if pull:
2946
 
                if merger.interesting_files is not None:
2947
 
                    raise errors.BzrCommandError('Cannot pull individual files')
2948
 
                if (merger.base_rev_id == tree.last_revision()):
2949
 
                    result = tree.pull(merger.other_branch, False,
2950
 
                                       merger.other_rev_id)
2951
 
                    result.report(self.outf)
2952
 
                    return 0
2953
 
            merger.check_basis(not force)
2954
 
            if preview:
2955
 
                return self._do_preview(merger)
2956
 
            else:
2957
 
                return self._do_merge(merger, change_reporter, allow_pending,
2958
 
                                      verified)
2959
 
        finally:
2960
 
            for cleanup in reversed(cleanups):
2961
 
                cleanup()
 
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):
 
4474
        tree_merger = merger.make_merger()
 
4475
        tt = tree_merger.make_preview_transform()
 
4476
        self.add_cleanup(tt.finalize)
 
4477
        result_tree = tt.get_preview_tree()
 
4478
        return result_tree
2962
4479
 
2963
4480
    def _do_preview(self, merger):
2964
4481
        from bzrlib.diff import show_diff_trees
2965
 
        tree_merger = merger.make_merger()
2966
 
        tt = tree_merger.make_preview_transform()
2967
 
        try:
2968
 
            result_tree = tt.get_preview_tree()
2969
 
            show_diff_trees(merger.this_tree, result_tree, self.outf,
2970
 
                            old_label='', new_label='')
2971
 
        finally:
2972
 
            tt.finalize()
 
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)
2973
4487
 
2974
4488
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
2975
4489
        merger.change_reporter = change_reporter
2983
4497
        else:
2984
4498
            return 0
2985
4499
 
 
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
 
2986
4518
    def sanity_check_merger(self, merger):
2987
4519
        if (merger.show_base and
2988
4520
            not merger.merge_type is _mod_merge.Merge3Merger):
2989
 
            raise errors.BzrCommandError("Show-base is not supported for this"
2990
 
                                         " merge type. %s" % merger.merge_type)
 
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
2991
4529
        if merger.reprocess and not merger.merge_type.supports_reprocess:
2992
 
            raise errors.BzrCommandError("Conflict reduction is not supported"
2993
 
                                         " for merge type %s." %
 
4530
            raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
 
4531
                                         " for merge type %s.") %
2994
4532
                                         merger.merge_type)
2995
4533
        if merger.reprocess and merger.show_base:
2996
 
            raise errors.BzrCommandError("Cannot do conflict reduction and"
2997
 
                                         " show base.")
 
4534
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
 
4535
                                         " show base."))
2998
4536
 
2999
4537
    def _get_merger_from_branch(self, tree, location, revision, remember,
3000
4538
                                possible_transports, pb):
3017
4555
            base_branch, base_path = Branch.open_containing(base_loc,
3018
4556
                possible_transports)
3019
4557
        # Find the revision ids
3020
 
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
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:
3021
4566
            other_revision_id = _mod_revision.ensure_null(
3022
4567
                other_branch.last_revision())
3023
 
        else:
3024
 
            other_revision_id = revision[-1].as_revision_id(other_branch)
3025
 
        if (revision is not None and len(revision) == 2
3026
 
            and revision[0] is not None):
3027
 
            base_revision_id = revision[0].as_revision_id(base_branch)
3028
 
        else:
3029
 
            base_revision_id = None
3030
 
        # Remember where we merge from
3031
 
        if ((remember or tree.branch.get_submit_branch() is None) and
3032
 
             user_location is not None):
 
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)))):
3033
4577
            tree.branch.set_submit_branch(other_branch.base)
3034
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
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)
3035
4581
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3036
4582
            other_revision_id, base_revision_id, other_branch, base_branch)
3037
4583
        if other_path != '':
3041
4587
            allow_pending = True
3042
4588
        return merger, allow_pending
3043
4589
 
 
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
 
3044
4604
    def _select_branch_location(self, tree, user_location, revision=None,
3045
4605
                                index=None):
3046
4606
        """Select a branch location, according to possible inputs.
3082
4642
            stored_location_type = "parent"
3083
4643
        mutter("%s", stored_location)
3084
4644
        if stored_location is None:
3085
 
            raise errors.BzrCommandError("No location specified or remembered")
 
4645
            raise errors.BzrCommandError(gettext("No location specified or remembered"))
3086
4646
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3087
 
        note(u"%s remembered %s location %s", verb_string,
3088
 
                stored_location_type, display_url)
 
4647
        note(gettext("{0} remembered {1} location {2}").format(verb_string,
 
4648
                stored_location_type, display_url))
3089
4649
        return stored_location
3090
4650
 
3091
4651
 
3092
4652
class cmd_remerge(Command):
3093
 
    """Redo a merge.
 
4653
    __doc__ = """Redo a merge.
3094
4654
 
3095
4655
    Use this if you want to try a different merge technique while resolving
3096
 
    conflicts.  Some merge techniques are better than others, and remerge 
 
4656
    conflicts.  Some merge techniques are better than others, and remerge
3097
4657
    lets you try different ones on different files.
3098
4658
 
3099
4659
    The options for remerge have the same meaning and defaults as the ones for
3103
4663
    :Examples:
3104
4664
        Re-do the merge of all conflicted files, and show the base text in
3105
4665
        conflict regions, in addition to the usual THIS and OTHER texts::
3106
 
      
 
4666
 
3107
4667
            bzr remerge --show-base
3108
4668
 
3109
4669
        Re-do the merge of "foobar", using the weave merge algorithm, with
3110
4670
        additional processing to reduce the size of conflict regions::
3111
 
      
 
4671
 
3112
4672
            bzr remerge --merge-type weave --reprocess foobar
3113
4673
    """
3114
4674
    takes_args = ['file*']
3121
4681
 
3122
4682
    def run(self, file_list=None, merge_type=None, show_base=False,
3123
4683
            reprocess=False):
 
4684
        from bzrlib.conflicts import restore
3124
4685
        if merge_type is None:
3125
4686
            merge_type = _mod_merge.Merge3Merger
3126
 
        tree, file_list = tree_files(file_list)
3127
 
        tree.lock_write()
 
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:
 
4722
            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])
3128
4732
        try:
3129
 
            parents = tree.get_parent_ids()
3130
 
            if len(parents) != 2:
3131
 
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
3132
 
                                             " merges.  Not cherrypicking or"
3133
 
                                             " multi-merges.")
3134
 
            repository = tree.branch.repository
3135
 
            interesting_ids = None
3136
 
            new_conflicts = []
3137
 
            conflicts = tree.conflicts()
3138
 
            if file_list is not None:
3139
 
                interesting_ids = set()
3140
 
                for filename in file_list:
3141
 
                    file_id = tree.path2id(filename)
3142
 
                    if file_id is None:
3143
 
                        raise errors.NotVersionedError(filename)
3144
 
                    interesting_ids.add(file_id)
3145
 
                    if tree.kind(file_id) != "directory":
3146
 
                        continue
3147
 
                    
3148
 
                    for name, ie in tree.inventory.iter_entries(file_id):
3149
 
                        interesting_ids.add(ie.file_id)
3150
 
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
3151
 
            else:
3152
 
                # Remerge only supports resolving contents conflicts
3153
 
                allowed_conflicts = ('text conflict', 'contents conflict')
3154
 
                restore_files = [c.path for c in conflicts
3155
 
                                 if c.typestring in allowed_conflicts]
3156
 
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
3157
 
            tree.set_conflicts(ConflictList(new_conflicts))
3158
 
            if file_list is not None:
3159
 
                restore_files = file_list
3160
 
            for filename in restore_files:
3161
 
                try:
3162
 
                    restore(tree.abspath(filename))
3163
 
                except errors.NotConflicted:
3164
 
                    pass
3165
 
            # Disable pending merges, because the file texts we are remerging
3166
 
            # have not had those merges performed.  If we use the wrong parents
3167
 
            # list, we imply that the working tree text has seen and rejected
3168
 
            # all the changes from the other tree, when in fact those changes
3169
 
            # have not yet been seen.
3170
 
            pb = ui.ui_factory.nested_progress_bar()
3171
 
            tree.set_parent_ids(parents[:1])
3172
 
            try:
3173
 
                merger = _mod_merge.Merger.from_revision_ids(pb,
3174
 
                                                             tree, parents[1])
3175
 
                merger.interesting_ids = interesting_ids
3176
 
                merger.merge_type = merge_type
3177
 
                merger.show_base = show_base
3178
 
                merger.reprocess = reprocess
3179
 
                conflicts = merger.do_merge()
3180
 
            finally:
3181
 
                tree.set_parent_ids(parents)
3182
 
                pb.finished()
 
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()
3183
4739
        finally:
3184
 
            tree.unlock()
 
4740
            tree.set_parent_ids(parents)
3185
4741
        if conflicts > 0:
3186
4742
            return 1
3187
4743
        else:
3189
4745
 
3190
4746
 
3191
4747
class cmd_revert(Command):
3192
 
    """Revert files to a previous revision.
 
4748
    __doc__ = """\
 
4749
    Set files in the working tree back to the contents of a previous revision.
3193
4750
 
3194
4751
    Giving a list of files will revert only those files.  Otherwise, all files
3195
4752
    will be reverted.  If the revision is not specified with '--revision', the
3196
 
    last committed revision is used.
 
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.
3197
4756
 
3198
4757
    To remove only some changes, without reverting to a prior version, use
3199
 
    merge instead.  For example, "merge . --revision -2..-3" will remove the
3200
 
    changes introduced by -2, without affecting the changes introduced by -1.
3201
 
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
3202
 
    
3203
 
    By default, any files that have been manually changed will be backed up
3204
 
    first.  (Files changed only by merge are not backed up.)  Backup files have
3205
 
    '.~#~' appended to their name, where # is a number.
 
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.
3206
4770
 
3207
4771
    When you provide files, you can use their current pathname or the pathname
3208
4772
    from the target revision.  So you can use revert to "undelete" a file by
3209
4773
    name.  If you name a directory, all the contents of that directory will be
3210
4774
    reverted.
3211
4775
 
3212
 
    Any files that have been newly added since that revision will be deleted,
3213
 
    with a backup kept if appropriate.  Directories containing unknown files
3214
 
    will not be deleted.
 
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.
3215
4780
 
3216
 
    The working tree contains a list of pending merged revisions, which will
3217
 
    be included as parents in the next commit.  Normally, revert clears that
3218
 
    list as well as reverting the files.  If any files are specified, revert
3219
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
3220
 
    revert ." in the tree root to revert all files but keep the merge record,
3221
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
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
3222
4788
    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.
3223
4799
    """
3224
4800
 
3225
 
    _see_also = ['cat', 'export']
 
4801
    _see_also = ['cat', 'export', 'merge', 'shelve']
3226
4802
    takes_options = [
3227
4803
        'revision',
3228
4804
        Option('no-backup', "Do not save backups of reverted files."),
3233
4809
 
3234
4810
    def run(self, revision=None, no_backup=False, file_list=None,
3235
4811
            forget_merges=None):
3236
 
        tree, file_list = tree_files(file_list)
 
4812
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4813
        self.add_cleanup(tree.lock_tree_write().unlock)
3237
4814
        if forget_merges:
3238
4815
            tree.set_parent_ids(tree.get_parent_ids()[:1])
3239
4816
        else:
3241
4818
 
3242
4819
    @staticmethod
3243
4820
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
3244
 
        if revision is None:
3245
 
            rev_id = tree.last_revision()
3246
 
        elif len(revision) != 1:
3247
 
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
3248
 
        else:
3249
 
            rev_id = revision[0].as_revision_id(tree.branch)
3250
 
        pb = ui.ui_factory.nested_progress_bar()
3251
 
        try:
3252
 
            tree.revert(file_list,
3253
 
                        tree.branch.repository.revision_tree(rev_id),
3254
 
                        not no_backup, pb, report_changes=True)
3255
 
        finally:
3256
 
            pb.finished()
 
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)
3257
4824
 
3258
4825
 
3259
4826
class cmd_assert_fail(Command):
3260
 
    """Test reporting of assertion failures"""
 
4827
    __doc__ = """Test reporting of assertion failures"""
3261
4828
    # intended just for use in testing
3262
4829
 
3263
4830
    hidden = True
3267
4834
 
3268
4835
 
3269
4836
class cmd_help(Command):
3270
 
    """Show help on a command or other topic.
 
4837
    __doc__ = """Show help on a command or other topic.
3271
4838
    """
3272
4839
 
3273
4840
    _see_also = ['topics']
3276
4843
            ]
3277
4844
    takes_args = ['topic?']
3278
4845
    aliases = ['?', '--help', '-?', '-h']
3279
 
    
 
4846
 
3280
4847
    @display_command
3281
4848
    def run(self, topic=None, long=False):
3282
4849
        import bzrlib.help
3286
4853
 
3287
4854
 
3288
4855
class cmd_shell_complete(Command):
3289
 
    """Show appropriate completions for context.
 
4856
    __doc__ = """Show appropriate completions for context.
3290
4857
 
3291
4858
    For a list of all available commands, say 'bzr shell-complete'.
3292
4859
    """
3293
4860
    takes_args = ['context?']
3294
4861
    aliases = ['s-c']
3295
4862
    hidden = True
3296
 
    
 
4863
 
3297
4864
    @display_command
3298
4865
    def run(self, context=None):
3299
 
        import shellcomplete
 
4866
        from bzrlib import shellcomplete
3300
4867
        shellcomplete.shellcomplete(context)
3301
4868
 
3302
4869
 
3303
4870
class cmd_missing(Command):
3304
 
    """Show unmerged/unpulled revisions between two branches.
3305
 
    
 
4871
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4872
 
3306
4873
    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
3307
4903
    """
3308
4904
 
3309
4905
    _see_also = ['merge', 'pull']
3310
4906
    takes_args = ['other_branch?']
3311
4907
    takes_options = [
3312
 
            Option('reverse', 'Reverse the order of revisions.'),
3313
 
            Option('mine-only',
3314
 
                   'Display changes in the local branch only.'),
3315
 
            Option('this' , 'Same as --mine-only.'),
3316
 
            Option('theirs-only',
3317
 
                   'Display changes in the remote branch only.'),
3318
 
            Option('other', 'Same as --theirs-only.'),
3319
 
            'log-format',
3320
 
            'show-ids',
3321
 
            'verbose'
3322
 
            ]
 
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
        ]
3323
4931
    encoding_type = 'replace'
3324
4932
 
3325
4933
    @display_command
3326
4934
    def run(self, other_branch=None, reverse=False, mine_only=False,
3327
 
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
3328
 
            show_ids=False, verbose=False, this=False, other=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):
3329
4941
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
4942
        def message(s):
 
4943
            if not is_quiet():
 
4944
                self.outf.write(s)
3330
4945
 
 
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
3331
4961
        if this:
3332
4962
            mine_only = this
3333
4963
        if other:
3341
4971
        elif theirs_only:
3342
4972
            restrict = 'remote'
3343
4973
 
3344
 
        local_branch = Branch.open_containing(u".")[0]
 
4974
        local_branch = Branch.open_containing(directory)[0]
 
4975
        self.add_cleanup(local_branch.lock_read().unlock)
 
4976
 
3345
4977
        parent = local_branch.get_parent()
3346
4978
        if other_branch is None:
3347
4979
            other_branch = parent
3348
4980
            if other_branch is None:
3349
 
                raise errors.BzrCommandError("No peer location known"
3350
 
                                             " or specified.")
 
4981
                raise errors.BzrCommandError(gettext("No peer location known"
 
4982
                                             " or specified."))
3351
4983
            display_url = urlutils.unescape_for_display(parent,
3352
4984
                                                        self.outf.encoding)
3353
 
            self.outf.write("Using saved parent location: "
3354
 
                    + display_url + "\n")
 
4985
            message(gettext("Using saved parent location: {0}\n").format(
 
4986
                    display_url))
3355
4987
 
3356
4988
        remote_branch = Branch.open(other_branch)
3357
4989
        if remote_branch.base == local_branch.base:
3358
4990
            remote_branch = local_branch
3359
 
        local_branch.lock_read()
3360
 
        try:
3361
 
            remote_branch.lock_read()
3362
 
            try:
3363
 
                local_extra, remote_extra = find_unmerged(
3364
 
                    local_branch, remote_branch, restrict)
3365
 
 
3366
 
                if log_format is None:
3367
 
                    registry = log.log_formatter_registry
3368
 
                    log_format = registry.get_default(local_branch)
3369
 
                lf = log_format(to_file=self.outf,
3370
 
                                show_ids=show_ids,
3371
 
                                show_timezone='original')
3372
 
                if reverse is False:
3373
 
                    if local_extra is not None:
3374
 
                        local_extra.reverse()
3375
 
                    if remote_extra is not None:
3376
 
                        remote_extra.reverse()
3377
 
 
3378
 
                status_code = 0
3379
 
                if local_extra and not theirs_only:
3380
 
                    self.outf.write("You have %d extra revision(s):\n" %
3381
 
                                    len(local_extra))
3382
 
                    for revision in iter_log_revisions(local_extra,
3383
 
                                        local_branch.repository,
3384
 
                                        verbose):
3385
 
                        lf.log_revision(revision)
3386
 
                    printed_local = True
3387
 
                    status_code = 1
3388
 
                else:
3389
 
                    printed_local = False
3390
 
 
3391
 
                if remote_extra and not mine_only:
3392
 
                    if printed_local is True:
3393
 
                        self.outf.write("\n\n\n")
3394
 
                    self.outf.write("You are missing %d revision(s):\n" %
3395
 
                                    len(remote_extra))
3396
 
                    for revision in iter_log_revisions(remote_extra,
3397
 
                                        remote_branch.repository,
3398
 
                                        verbose):
3399
 
                        lf.log_revision(revision)
3400
 
                    status_code = 1
3401
 
 
3402
 
                if mine_only and not local_extra:
3403
 
                    # We checked local, and found nothing extra
3404
 
                    self.outf.write('This branch is up to date.\n')
3405
 
                elif theirs_only and not remote_extra:
3406
 
                    # We checked remote, and found nothing extra
3407
 
                    self.outf.write('Other branch is up to date.\n')
3408
 
                elif not (mine_only or theirs_only or local_extra or
3409
 
                          remote_extra):
3410
 
                    # We checked both branches, and neither one had extra
3411
 
                    # revisions
3412
 
                    self.outf.write("Branches are up to date.\n")
3413
 
            finally:
3414
 
                remote_branch.unlock()
3415
 
        finally:
3416
 
            local_branch.unlock()
 
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()
3417
5063
        if not status_code and parent is None and other_branch is not None:
3418
 
            local_branch.lock_write()
3419
 
            try:
3420
 
                # handle race conditions - a parent might be set while we run.
3421
 
                if local_branch.get_parent() is None:
3422
 
                    local_branch.set_parent(remote_branch.base)
3423
 
            finally:
3424
 
                local_branch.unlock()
 
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)
3425
5068
        return status_code
3426
5069
 
3427
5070
 
3428
5071
class cmd_pack(Command):
3429
 
    """Compress the data within a repository."""
 
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
    """
3430
5089
 
3431
5090
    _see_also = ['repositories']
3432
5091
    takes_args = ['branch_or_repo?']
 
5092
    takes_options = [
 
5093
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
5094
        ]
3433
5095
 
3434
 
    def run(self, branch_or_repo='.'):
3435
 
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
5096
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
5097
        dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
3436
5098
        try:
3437
5099
            branch = dir.open_branch()
3438
5100
            repository = branch.repository
3439
5101
        except errors.NotBranchError:
3440
5102
            repository = dir.open_repository()
3441
 
        repository.pack()
 
5103
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
3442
5104
 
3443
5105
 
3444
5106
class cmd_plugins(Command):
3445
 
    """List the installed plugins.
3446
 
    
 
5107
    __doc__ = """List the installed plugins.
 
5108
 
3447
5109
    This command displays the list of installed plugins including
3448
5110
    version of plugin and a short description of each.
3449
5111
 
3455
5117
    adding new commands, providing additional network transports and
3456
5118
    customizing log output.
3457
5119
 
3458
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
3459
 
    information on plugins including where to find them and how to
3460
 
    install them. Instructions are also provided there on how to
3461
 
    write new plugins using the Python programming language.
 
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.
3462
5124
    """
3463
5125
    takes_options = ['verbose']
3464
5126
 
3465
5127
    @display_command
3466
5128
    def run(self, verbose=False):
3467
 
        import bzrlib.plugin
3468
 
        from inspect import getdoc
3469
 
        result = []
3470
 
        for name, plugin in bzrlib.plugin.plugins().items():
3471
 
            version = plugin.__version__
3472
 
            if version == 'unknown':
3473
 
                version = ''
3474
 
            name_ver = '%s %s' % (name, version)
3475
 
            d = getdoc(plugin.module)
3476
 
            if d:
3477
 
                doc = d.split('\n')[0]
3478
 
            else:
3479
 
                doc = '(no description)'
3480
 
            result.append((name_ver, doc, plugin.path()))
3481
 
        for name_ver, doc, path in sorted(result):
3482
 
            print name_ver
3483
 
            print '   ', doc
3484
 
            if verbose:
3485
 
                print '   ', path
3486
 
            print
 
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)))
3487
5133
 
3488
5134
 
3489
5135
class cmd_testament(Command):
3490
 
    """Show testament (signing-form) of a revision."""
 
5136
    __doc__ = """Show testament (signing-form) of a revision."""
3491
5137
    takes_options = [
3492
5138
            'revision',
3493
5139
            Option('long', help='Produce long-format testament.'),
3494
5140
            Option('strict',
3495
5141
                   help='Produce a strict-format testament.')]
3496
5142
    takes_args = ['branch?']
 
5143
    encoding_type = 'exact'
3497
5144
    @display_command
3498
5145
    def run(self, branch=u'.', revision=None, long=False, strict=False):
3499
5146
        from bzrlib.testament import Testament, StrictTestament
3505
5152
            b = Branch.open_containing(branch)[0]
3506
5153
        else:
3507
5154
            b = Branch.open(branch)
3508
 
        b.lock_read()
3509
 
        try:
3510
 
            if revision is None:
3511
 
                rev_id = b.last_revision()
3512
 
            else:
3513
 
                rev_id = revision[0].as_revision_id(b)
3514
 
            t = testament_class.from_revision(b.repository, rev_id)
3515
 
            if long:
3516
 
                sys.stdout.writelines(t.as_text_lines())
3517
 
            else:
3518
 
                sys.stdout.write(t.as_short_text())
3519
 
        finally:
3520
 
            b.unlock()
 
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())
3521
5165
 
3522
5166
 
3523
5167
class cmd_annotate(Command):
3524
 
    """Show the origin of each line in a file.
 
5168
    __doc__ = """Show the origin of each line in a file.
3525
5169
 
3526
5170
    This prints out the given file with an annotation on the left side
3527
5171
    indicating which revision, author and date introduced the change.
3528
5172
 
3529
 
    If the origin is the same for a run of consecutive lines, it is 
 
5173
    If the origin is the same for a run of consecutive lines, it is
3530
5174
    shown only at the top, unless the --all option is given.
3531
5175
    """
3532
5176
    # TODO: annotate directories; showing when each file was last changed
3533
 
    # TODO: if the working copy is modified, show annotations on that 
 
5177
    # TODO: if the working copy is modified, show annotations on that
3534
5178
    #       with new uncommitted lines marked
3535
5179
    aliases = ['ann', 'blame', 'praise']
3536
5180
    takes_args = ['filename']
3538
5182
                     Option('long', help='Show commit date in annotations.'),
3539
5183
                     'revision',
3540
5184
                     'show-ids',
 
5185
                     'directory',
3541
5186
                     ]
3542
5187
    encoding_type = 'exact'
3543
5188
 
3544
5189
    @display_command
3545
5190
    def run(self, filename, all=False, long=False, revision=None,
3546
 
            show_ids=False):
3547
 
        from bzrlib.annotate import annotate_file
 
5191
            show_ids=False, directory=None):
 
5192
        from bzrlib.annotate import (
 
5193
            annotate_file_tree,
 
5194
            )
3548
5195
        wt, branch, relpath = \
3549
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
5196
            _open_directory_or_containing_tree_or_branch(filename, directory)
3550
5197
        if wt is not None:
3551
 
            wt.lock_read()
3552
 
        else:
3553
 
            branch.lock_read()
3554
 
        try:
3555
 
            if revision is None:
3556
 
                revision_id = branch.last_revision()
3557
 
            elif len(revision) != 1:
3558
 
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
3559
 
            else:
3560
 
                revision_id = revision[0].as_revision_id(branch)
3561
 
            tree = branch.repository.revision_tree(revision_id)
3562
 
            if wt is not None:
3563
 
                file_id = wt.path2id(relpath)
3564
 
            else:
3565
 
                file_id = tree.path2id(relpath)
3566
 
            if file_id is None:
3567
 
                raise errors.NotVersionedError(filename)
3568
 
            file_version = tree.inventory[file_id].revision
3569
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
3570
 
                          show_ids=show_ids)
3571
 
        finally:
3572
 
            if wt is not None:
3573
 
                wt.unlock()
3574
 
            else:
3575
 
                branch.unlock()
 
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)
3576
5217
 
3577
5218
 
3578
5219
class cmd_re_sign(Command):
3579
 
    """Create a digital signature for an existing revision."""
 
5220
    __doc__ = """Create a digital signature for an existing revision."""
3580
5221
    # TODO be able to replace existing ones.
3581
5222
 
3582
5223
    hidden = True # is this right ?
3583
5224
    takes_args = ['revision_id*']
3584
 
    takes_options = ['revision']
3585
 
    
3586
 
    def run(self, revision_id_list=None, revision=None):
 
5225
    takes_options = ['directory', 'revision']
 
5226
 
 
5227
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
3587
5228
        if revision_id_list is not None and revision is not None:
3588
 
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
5229
            raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
3589
5230
        if revision_id_list is None and revision is None:
3590
 
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
3591
 
        b = WorkingTree.open_containing(u'.')[0].branch
3592
 
        b.lock_write()
3593
 
        try:
3594
 
            return self._run(b, revision_id_list, revision)
3595
 
        finally:
3596
 
            b.unlock()
 
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)
3597
5235
 
3598
5236
    def _run(self, b, revision_id_list, revision):
3599
5237
        import bzrlib.gpg as gpg
3600
 
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
5238
        gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
3601
5239
        if revision_id_list is not None:
3602
5240
            b.repository.start_write_group()
3603
5241
            try:
3628
5266
                if to_revid is None:
3629
5267
                    to_revno = b.revno()
3630
5268
                if from_revno is None or to_revno is None:
3631
 
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
5269
                    raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
3632
5270
                b.repository.start_write_group()
3633
5271
                try:
3634
5272
                    for revno in range(from_revno, to_revno + 1):
3640
5278
                else:
3641
5279
                    b.repository.commit_write_group()
3642
5280
            else:
3643
 
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
5281
                raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
3644
5282
 
3645
5283
 
3646
5284
class cmd_bind(Command):
3647
 
    """Convert the current branch into a checkout of the supplied branch.
 
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.
3648
5287
 
3649
5288
    Once converted into a checkout, commits must succeed on the master branch
3650
5289
    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.
3651
5294
    """
3652
5295
 
3653
5296
    _see_also = ['checkouts', 'unbind']
3654
5297
    takes_args = ['location?']
3655
 
    takes_options = []
 
5298
    takes_options = ['directory']
3656
5299
 
3657
 
    def run(self, location=None):
3658
 
        b, relpath = Branch.open_containing(u'.')
 
5300
    def run(self, location=None, directory=u'.'):
 
5301
        b, relpath = Branch.open_containing(directory)
3659
5302
        if location is None:
3660
5303
            try:
3661
5304
                location = b.get_old_bound_location()
3662
5305
            except errors.UpgradeRequired:
3663
 
                raise errors.BzrCommandError('No location supplied.  '
3664
 
                    'This format does not remember old locations.')
 
5306
                raise errors.BzrCommandError(gettext('No location supplied.  '
 
5307
                    'This format does not remember old locations.'))
3665
5308
            else:
3666
5309
                if location is None:
3667
 
                    raise errors.BzrCommandError('No location supplied and no '
3668
 
                        'previous location known')
 
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'))
3669
5317
        b_other = Branch.open(location)
3670
5318
        try:
3671
5319
            b.bind(b_other)
3672
5320
        except errors.DivergedBranches:
3673
 
            raise errors.BzrCommandError('These branches have diverged.'
3674
 
                                         ' Try merging, and then bind again.')
 
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
3675
5325
 
3676
5326
 
3677
5327
class cmd_unbind(Command):
3678
 
    """Convert the current checkout into a regular branch.
 
5328
    __doc__ = """Convert the current checkout into a regular branch.
3679
5329
 
3680
5330
    After unbinding, the local branch is considered independent and subsequent
3681
5331
    commits will be local only.
3683
5333
 
3684
5334
    _see_also = ['checkouts', 'bind']
3685
5335
    takes_args = []
3686
 
    takes_options = []
 
5336
    takes_options = ['directory']
3687
5337
 
3688
 
    def run(self):
3689
 
        b, relpath = Branch.open_containing(u'.')
 
5338
    def run(self, directory=u'.'):
 
5339
        b, relpath = Branch.open_containing(directory)
3690
5340
        if not b.unbind():
3691
 
            raise errors.BzrCommandError('Local branch is not bound')
 
5341
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
3692
5342
 
3693
5343
 
3694
5344
class cmd_uncommit(Command):
3695
 
    """Remove the last committed revision.
 
5345
    __doc__ = """Remove the last committed revision.
3696
5346
 
3697
5347
    --verbose will print out what is being removed.
3698
5348
    --dry-run will go through all the motions, but not actually
3715
5365
    takes_options = ['verbose', 'revision',
3716
5366
                    Option('dry-run', help='Don\'t actually make changes.'),
3717
5367
                    Option('force', help='Say yes to all questions.'),
 
5368
                    Option('keep-tags',
 
5369
                           help='Keep tags that point to removed revisions.'),
3718
5370
                    Option('local',
3719
5371
                           help="Only remove the commits from the local branch"
3720
5372
                                " when in a checkout."
3724
5376
    aliases = []
3725
5377
    encoding_type = 'replace'
3726
5378
 
3727
 
    def run(self, location=None,
3728
 
            dry_run=False, verbose=False,
3729
 
            revision=None, force=False, local=False):
 
5379
    def run(self, location=None, dry_run=False, verbose=False,
 
5380
            revision=None, force=False, local=False, keep_tags=False):
3730
5381
        if location is None:
3731
5382
            location = u'.'
3732
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
5383
        control, relpath = controldir.ControlDir.open_containing(location)
3733
5384
        try:
3734
5385
            tree = control.open_workingtree()
3735
5386
            b = tree.branch
3738
5389
            b = control.open_branch()
3739
5390
 
3740
5391
        if tree is not None:
3741
 
            tree.lock_write()
 
5392
            self.add_cleanup(tree.lock_write().unlock)
3742
5393
        else:
3743
 
            b.lock_write()
3744
 
        try:
3745
 
            return self._run(b, tree, dry_run, verbose, revision, force,
3746
 
                             local=local)
3747
 
        finally:
3748
 
            if tree is not None:
3749
 
                tree.unlock()
3750
 
            else:
3751
 
                b.unlock()
 
5394
            self.add_cleanup(b.lock_write().unlock)
 
5395
        return self._run(b, tree, dry_run, verbose, revision, force,
 
5396
                         local, keep_tags)
3752
5397
 
3753
 
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
5398
    def _run(self, b, tree, dry_run, verbose, revision, force, local,
 
5399
             keep_tags):
3754
5400
        from bzrlib.log import log_formatter, show_log
3755
5401
        from bzrlib.uncommit import uncommit
3756
5402
 
3771
5417
                rev_id = b.get_rev_id(revno)
3772
5418
 
3773
5419
        if rev_id is None or _mod_revision.is_null(rev_id):
3774
 
            self.outf.write('No revisions to uncommit.\n')
 
5420
            self.outf.write(gettext('No revisions to uncommit.\n'))
3775
5421
            return 1
3776
5422
 
3777
5423
        lf = log_formatter('short',
3786
5432
                 end_revision=last_revno)
3787
5433
 
3788
5434
        if dry_run:
3789
 
            print 'Dry-run, pretending to remove the above revisions.'
3790
 
            if not force:
3791
 
                val = raw_input('Press <enter> to continue')
 
5435
            self.outf.write(gettext('Dry-run, pretending to remove'
 
5436
                            ' the above revisions.\n'))
3792
5437
        else:
3793
 
            print 'The above revision(s) will be removed.'
3794
 
            if not force:
3795
 
                val = raw_input('Are you sure [y/N]? ')
3796
 
                if val.lower() not in ('y', 'yes'):
3797
 
                    print 'Canceled'
3798
 
                    return 0
 
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
3799
5447
 
3800
5448
        mutter('Uncommitting from {%s} to {%s}',
3801
5449
               last_rev_id, rev_id)
3802
5450
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
3803
 
                 revno=revno, local=local)
3804
 
        note('You can restore the old tip by running:\n'
3805
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
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)
3806
5454
 
3807
5455
 
3808
5456
class cmd_break_lock(Command):
3809
 
    """Break a dead lock on a repository, branch or working directory.
 
5457
    __doc__ = """Break a dead lock.
 
5458
 
 
5459
    This command breaks a lock on a repository, branch, working directory or
 
5460
    config file.
3810
5461
 
3811
5462
    CAUTION: Locks should only be broken when you are sure that the process
3812
5463
    holding the lock has been stopped.
3813
5464
 
3814
 
    You can get information on what locks are open via the 'bzr info' command.
3815
 
    
 
5465
    You can get information on what locks are open via the 'bzr info
 
5466
    [location]' command.
 
5467
 
3816
5468
    :Examples:
3817
5469
        bzr break-lock
 
5470
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5471
        bzr break-lock --conf ~/.bazaar
3818
5472
    """
 
5473
 
3819
5474
    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
        ]
3820
5481
 
3821
 
    def run(self, location=None, show=False):
 
5482
    def run(self, location=None, config=False, force=False):
3822
5483
        if location is None:
3823
5484
            location = u'.'
3824
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
3825
 
        try:
3826
 
            control.break_lock()
3827
 
        except NotImplementedError:
3828
 
            pass
3829
 
        
 
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
 
3830
5499
 
3831
5500
class cmd_wait_until_signalled(Command):
3832
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
5501
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
3833
5502
 
3834
5503
    This just prints a line to signal when it is ready, then blocks on stdin.
3835
5504
    """
3843
5512
 
3844
5513
 
3845
5514
class cmd_serve(Command):
3846
 
    """Run the bzr server."""
 
5515
    __doc__ = """Run the bzr server."""
3847
5516
 
3848
5517
    aliases = ['server']
3849
5518
 
3850
5519
    takes_options = [
3851
5520
        Option('inet',
3852
5521
               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),
3853
5528
        Option('port',
3854
 
               help='Listen for connections on nominated port of the form '
3855
 
                    '[hostname:]portnumber.  Passing 0 as the port number will '
3856
 
                    'result in a dynamically allocated port.  The default port is '
3857
 
                    '4155.',
3858
 
               type=str),
3859
 
        Option('directory',
3860
 
               help='Serve contents of this directory.',
3861
 
               type=unicode),
 
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.'),
3862
5535
        Option('allow-writes',
3863
5536
               help='By default the server is a readonly server.  Supplying '
3864
5537
                    '--allow-writes enables write access to the contents of '
3865
 
                    'the served directory and below.'
 
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.'
3866
5543
                ),
 
5544
        Option('client-timeout', type=float,
 
5545
               help='Override the default idle client timeout (5min).'),
3867
5546
        ]
3868
5547
 
3869
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
3870
 
        from bzrlib import lockdir
3871
 
        from bzrlib.smart import medium, server
3872
 
        from bzrlib.transport import get_transport
3873
 
        from bzrlib.transport.chroot import ChrootServer
 
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
3874
5551
        if directory is None:
3875
5552
            directory = os.getcwd()
3876
 
        url = urlutils.local_path_to_url(directory)
 
5553
        if protocol is None:
 
5554
            protocol = transport.transport_server_registry.get()
 
5555
        url = transport.location_to_url(directory)
3877
5556
        if not allow_writes:
3878
5557
            url = 'readonly+' + url
3879
 
        chroot_server = ChrootServer(get_transport(url))
3880
 
        chroot_server.setUp()
3881
 
        t = get_transport(chroot_server.get_url())
3882
 
        if inet:
3883
 
            smart_server = medium.SmartServerPipeStreamMedium(
3884
 
                sys.stdin, sys.stdout, t)
3885
 
        else:
3886
 
            host = medium.BZR_DEFAULT_INTERFACE
3887
 
            if port is None:
3888
 
                port = medium.BZR_DEFAULT_PORT
3889
 
            else:
3890
 
                if ':' in port:
3891
 
                    host, port = port.split(':')
3892
 
                port = int(port)
3893
 
            smart_server = server.SmartTCPServer(t, host=host, port=port)
3894
 
            print 'listening on port: ', smart_server.port
3895
 
            sys.stdout.flush()
3896
 
        # for the duration of this server, no UI output is permitted.
3897
 
        # note that this may cause problems with blackbox tests. This should
3898
 
        # be changed with care though, as we dont want to use bandwidth sending
3899
 
        # progress over stderr to smart server clients!
3900
 
        old_factory = ui.ui_factory
3901
 
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
3902
 
        try:
3903
 
            ui.ui_factory = ui.SilentUIFactory()
3904
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
3905
 
            smart_server.serve()
3906
 
        finally:
3907
 
            ui.ui_factory = old_factory
3908
 
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
5558
        t = transport.get_transport_from_url(url)
 
5559
        protocol(t, listen, port, inet, client_timeout)
3909
5560
 
3910
5561
 
3911
5562
class cmd_join(Command):
3912
 
    """Combine a subtree into its containing tree.
3913
 
    
3914
 
    This command is for experimental use only.  It requires the target tree
3915
 
    to be in dirstate-with-subtree format, which cannot be converted into
3916
 
    earlier formats.
 
5563
    __doc__ = """Combine a tree into its containing tree.
 
5564
 
 
5565
    This command requires the target tree to be in a rich-root format.
3917
5566
 
3918
5567
    The TREE argument should be an independent tree, inside another tree, but
3919
5568
    not part of it.  (Such trees can be produced by "bzr split", but also by
3920
5569
    running "bzr branch" with the target inside a tree.)
3921
5570
 
3922
 
    The result is a combined tree, with the subtree no longer an independant
 
5571
    The result is a combined tree, with the subtree no longer an independent
3923
5572
    part.  This is marked as a merge of the subtree into the containing tree,
3924
5573
    and all history is preserved.
3925
 
 
3926
 
    If --reference is specified, the subtree retains its independence.  It can
3927
 
    be branched by itself, and can be part of multiple projects at the same
3928
 
    time.  But operations performed in the containing tree, such as commit
3929
 
    and merge, will recurse into the subtree.
3930
5574
    """
3931
5575
 
3932
5576
    _see_also = ['split']
3933
5577
    takes_args = ['tree']
3934
5578
    takes_options = [
3935
 
            Option('reference', help='Join by reference.'),
 
5579
            Option('reference', help='Join by reference.', hidden=True),
3936
5580
            ]
3937
 
    hidden = True
3938
5581
 
3939
5582
    def run(self, tree, reference=False):
3940
5583
        sub_tree = WorkingTree.open(tree)
3942
5585
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
3943
5586
        repo = containing_tree.branch.repository
3944
5587
        if not repo.supports_rich_root():
3945
 
            raise errors.BzrCommandError(
 
5588
            raise errors.BzrCommandError(gettext(
3946
5589
                "Can't join trees because %s doesn't support rich root data.\n"
3947
 
                "You can use bzr upgrade on the repository."
 
5590
                "You can use bzr upgrade on the repository.")
3948
5591
                % (repo,))
3949
5592
        if reference:
3950
5593
            try:
3952
5595
            except errors.BadReferenceTarget, e:
3953
5596
                # XXX: Would be better to just raise a nicely printable
3954
5597
                # exception from the real origin.  Also below.  mbp 20070306
3955
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
3956
 
                                             (tree, e.reason))
 
5598
                raise errors.BzrCommandError(
 
5599
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
3957
5600
        else:
3958
5601
            try:
3959
5602
                containing_tree.subsume(sub_tree)
3960
5603
            except errors.BadSubsumeSource, e:
3961
 
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
3962
 
                                             (tree, e.reason))
 
5604
                raise errors.BzrCommandError(
 
5605
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
3963
5606
 
3964
5607
 
3965
5608
class cmd_split(Command):
3966
 
    """Split a subdirectory of a tree into a separate tree.
 
5609
    __doc__ = """Split a subdirectory of a tree into a separate tree.
3967
5610
 
3968
5611
    This command will produce a target tree in a format that supports
3969
5612
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
3974
5617
    branch.  Commits in the top-level tree will not apply to the new subtree.
3975
5618
    """
3976
5619
 
3977
 
    # join is not un-hidden yet
3978
 
    #_see_also = ['join']
 
5620
    _see_also = ['join']
3979
5621
    takes_args = ['tree']
3980
5622
 
3981
5623
    def run(self, tree):
3986
5628
        try:
3987
5629
            containing_tree.extract(sub_id)
3988
5630
        except errors.RootNotRich:
3989
 
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
5631
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
3990
5632
 
3991
5633
 
3992
5634
class cmd_merge_directive(Command):
3993
 
    """Generate a merge directive for auto-merge tools.
 
5635
    __doc__ = """Generate a merge directive for auto-merge tools.
3994
5636
 
3995
5637
    A directive requests a merge to be performed, and also provides all the
3996
5638
    information necessary to do so.  This means it must either include a
4013
5655
    _see_also = ['send']
4014
5656
 
4015
5657
    takes_options = [
 
5658
        'directory',
4016
5659
        RegistryOption.from_kwargs('patch-type',
4017
5660
            'The type of patch to include in the directive.',
4018
5661
            title='Patch type',
4031
5674
    encoding_type = 'exact'
4032
5675
 
4033
5676
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4034
 
            sign=False, revision=None, mail_to=None, message=None):
 
5677
            sign=False, revision=None, mail_to=None, message=None,
 
5678
            directory=u'.'):
4035
5679
        from bzrlib.revision import ensure_null, NULL_REVISION
4036
5680
        include_patch, include_bundle = {
4037
5681
            'plain': (False, False),
4038
5682
            'diff': (True, False),
4039
5683
            'bundle': (True, True),
4040
5684
            }[patch_type]
4041
 
        branch = Branch.open('.')
 
5685
        branch = Branch.open(directory)
4042
5686
        stored_submit_branch = branch.get_submit_branch()
4043
5687
        if submit_branch is None:
4044
5688
            submit_branch = stored_submit_branch
4048
5692
        if submit_branch is None:
4049
5693
            submit_branch = branch.get_parent()
4050
5694
        if submit_branch is None:
4051
 
            raise errors.BzrCommandError('No submit branch specified or known')
 
5695
            raise errors.BzrCommandError(gettext('No submit branch specified or known'))
4052
5696
 
4053
5697
        stored_public_branch = branch.get_public_branch()
4054
5698
        if public_branch is None:
4055
5699
            public_branch = stored_public_branch
4056
5700
        elif stored_public_branch is None:
 
5701
            # FIXME: Should be done only if we succeed ? -- vila 2012-01-03
4057
5702
            branch.set_public_branch(public_branch)
4058
5703
        if not include_bundle and public_branch is None:
4059
 
            raise errors.BzrCommandError('No public branch specified or'
4060
 
                                         ' known')
 
5704
            raise errors.BzrCommandError(gettext('No public branch specified or'
 
5705
                                         ' known'))
4061
5706
        base_revision_id = None
4062
5707
        if revision is not None:
4063
5708
            if len(revision) > 2:
4064
 
                raise errors.BzrCommandError('bzr merge-directive takes '
4065
 
                    'at most two one revision identifiers')
 
5709
                raise errors.BzrCommandError(gettext('bzr merge-directive takes '
 
5710
                    'at most two one revision identifiers'))
4066
5711
            revision_id = revision[-1].as_revision_id(branch)
4067
5712
            if len(revision) == 2:
4068
5713
                base_revision_id = revision[0].as_revision_id(branch)
4070
5715
            revision_id = branch.last_revision()
4071
5716
        revision_id = ensure_null(revision_id)
4072
5717
        if revision_id == NULL_REVISION:
4073
 
            raise errors.BzrCommandError('No revisions to bundle.')
 
5718
            raise errors.BzrCommandError(gettext('No revisions to bundle.'))
4074
5719
        directive = merge_directive.MergeDirective2.from_objects(
4075
5720
            branch.repository, revision_id, time.time(),
4076
5721
            osutils.local_time_offset(), submit_branch,
4084
5729
                self.outf.writelines(directive.to_lines())
4085
5730
        else:
4086
5731
            message = directive.to_email(mail_to, branch, sign)
4087
 
            s = SMTPConnection(branch.get_config())
 
5732
            s = SMTPConnection(branch.get_config_stack())
4088
5733
            s.send_email(message)
4089
5734
 
4090
5735
 
4091
5736
class cmd_send(Command):
4092
 
    """Mail or create a merge-directive for submiting changes.
 
5737
    __doc__ = """Mail or create a merge-directive for submitting changes.
4093
5738
 
4094
5739
    A merge directive provides many things needed for requesting merges:
4095
5740
 
4101
5746
      directly from the merge directive, without retrieving data from a
4102
5747
      branch.
4103
5748
 
4104
 
    If --no-bundle is specified, then public_branch is needed (and must be
4105
 
    up-to-date), so that the receiver can perform the merge using the
4106
 
    public_branch.  The public_branch is always included if known, so that
4107
 
    people can check it later.
4108
 
 
4109
 
    The submit branch defaults to the parent, but can be overridden.  Both
4110
 
    submit branch and public branch will be remembered if supplied.
4111
 
 
4112
 
    If a public_branch is known for the submit_branch, that public submit
4113
 
    branch is used in the merge instructions.  This means that a local mirror
4114
 
    can be used as your actual submit branch, once you have set public_branch
4115
 
    for that mirror.
 
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.
4116
5781
 
4117
5782
    Mail is sent using your preferred mail program.  This should be transparent
4118
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5783
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
4119
5784
    If the preferred client can't be found (or used), your editor will be used.
4120
 
    
 
5785
 
4121
5786
    To use a specific mail program, set the mail_client configuration option.
4122
5787
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
4123
 
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
4124
 
    generic options are "default", "editor", "emacsclient", "mapi", and
4125
 
    "xdg-email".  Plugins may also add supported clients.
 
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.
4126
5792
 
4127
5793
    If mail is being sent, a to address is required.  This can be supplied
4128
5794
    either on the commandline, by setting the submit_to configuration
4129
 
    option in the branch itself or the child_submit_to configuration option 
 
5795
    option in the branch itself or the child_submit_to configuration option
4130
5796
    in the submit branch.
4131
5797
 
4132
5798
    Two formats are currently supported: "4" uses revision bundle format 4 and
4134
5800
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
4135
5801
    default.  "0.9" uses revision bundle format 0.9 and merge directive
4136
5802
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
4137
 
    
4138
 
    Merge directives are applied using the merge command or the pull command.
 
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.
4139
5810
    """
4140
5811
 
4141
5812
    encoding_type = 'exact'
4157
5828
               short_name='f',
4158
5829
               type=unicode),
4159
5830
        Option('output', short_name='o',
4160
 
               help='Write merge directive to this file; '
 
5831
               help='Write merge directive to this file or directory; '
4161
5832
                    'use - for stdout.',
4162
5833
               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.'),
4163
5837
        Option('mail-to', help='Mail the request to this address.',
4164
5838
               type=unicode),
4165
5839
        'revision',
4166
5840
        'message',
4167
 
        RegistryOption.from_kwargs('format',
4168
 
        'Use the specified output format.',
4169
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4170
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
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')),
4171
5845
        ]
4172
5846
 
4173
5847
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4174
 
            no_patch=False, revision=None, remember=False, output=None,
4175
 
            format='4', mail_to=None, message=None, **kwargs):
4176
 
        return self._run(submit_branch, revision, public_branch, remember,
4177
 
                         format, no_bundle, no_patch, output,
4178
 
                         kwargs.get('from', '.'), mail_to, message)
4179
 
 
4180
 
    def _run(self, submit_branch, revision, public_branch, remember, format,
4181
 
             no_bundle, no_patch, output, from_, mail_to, message):
4182
 
        from bzrlib.revision import NULL_REVISION
4183
 
        branch = Branch.open_containing(from_)[0]
4184
 
        if output is None:
4185
 
            outfile = StringIO()
4186
 
        elif output == '-':
4187
 
            outfile = self.outf
4188
 
        else:
4189
 
            outfile = open(output, 'wb')
4190
 
        # we may need to write data into branch's repository to calculate
4191
 
        # the data to send.
4192
 
        branch.lock_write()
4193
 
        try:
4194
 
            if output is None:
4195
 
                config = branch.get_config()
4196
 
                if mail_to is None:
4197
 
                    mail_to = config.get_user_option('submit_to')
4198
 
                mail_client = config.get_mail_client()
4199
 
            if remember and submit_branch is None:
4200
 
                raise errors.BzrCommandError(
4201
 
                    '--remember requires a branch to be specified.')
4202
 
            stored_submit_branch = branch.get_submit_branch()
4203
 
            remembered_submit_branch = None
4204
 
            if submit_branch is None:
4205
 
                submit_branch = stored_submit_branch
4206
 
                remembered_submit_branch = "submit"
4207
 
            else:
4208
 
                if stored_submit_branch is None or remember:
4209
 
                    branch.set_submit_branch(submit_branch)
4210
 
            if submit_branch is None:
4211
 
                submit_branch = branch.get_parent()
4212
 
                remembered_submit_branch = "parent"
4213
 
            if submit_branch is None:
4214
 
                raise errors.BzrCommandError('No submit branch known or'
4215
 
                                             ' specified')
4216
 
            if remembered_submit_branch is not None:
4217
 
                note('Using saved %s location "%s" to determine what '
4218
 
                        'changes to submit.', remembered_submit_branch,
4219
 
                        submit_branch)
4220
 
 
4221
 
            if mail_to is None:
4222
 
                submit_config = Branch.open(submit_branch).get_config()
4223
 
                mail_to = submit_config.get_user_option("child_submit_to")
4224
 
 
4225
 
            stored_public_branch = branch.get_public_branch()
4226
 
            if public_branch is None:
4227
 
                public_branch = stored_public_branch
4228
 
            elif stored_public_branch is None or remember:
4229
 
                branch.set_public_branch(public_branch)
4230
 
            if no_bundle and public_branch is None:
4231
 
                raise errors.BzrCommandError('No public branch specified or'
4232
 
                                             ' known')
4233
 
            base_revision_id = None
4234
 
            revision_id = None
4235
 
            if revision is not None:
4236
 
                if len(revision) > 2:
4237
 
                    raise errors.BzrCommandError('bzr send takes '
4238
 
                        'at most two one revision identifiers')
4239
 
                revision_id = revision[-1].as_revision_id(branch)
4240
 
                if len(revision) == 2:
4241
 
                    base_revision_id = revision[0].as_revision_id(branch)
4242
 
            if revision_id is None:
4243
 
                revision_id = branch.last_revision()
4244
 
            if revision_id == NULL_REVISION:
4245
 
                raise errors.BzrCommandError('No revisions to submit.')
4246
 
            if format == '4':
4247
 
                directive = merge_directive.MergeDirective2.from_objects(
4248
 
                    branch.repository, revision_id, time.time(),
4249
 
                    osutils.local_time_offset(), submit_branch,
4250
 
                    public_branch=public_branch, include_patch=not no_patch,
4251
 
                    include_bundle=not no_bundle, message=message,
4252
 
                    base_revision_id=base_revision_id)
4253
 
            elif format == '0.9':
4254
 
                if not no_bundle:
4255
 
                    if not no_patch:
4256
 
                        patch_type = 'bundle'
4257
 
                    else:
4258
 
                        raise errors.BzrCommandError('Format 0.9 does not'
4259
 
                            ' permit bundle with no patch')
4260
 
                else:
4261
 
                    if not no_patch:
4262
 
                        patch_type = 'diff'
4263
 
                    else:
4264
 
                        patch_type = None
4265
 
                directive = merge_directive.MergeDirective.from_objects(
4266
 
                    branch.repository, revision_id, time.time(),
4267
 
                    osutils.local_time_offset(), submit_branch,
4268
 
                    public_branch=public_branch, patch_type=patch_type,
4269
 
                    message=message)
4270
 
 
4271
 
            outfile.writelines(directive.to_lines())
4272
 
            if output is None:
4273
 
                subject = '[MERGE] '
4274
 
                if message is not None:
4275
 
                    subject += message
4276
 
                else:
4277
 
                    revision = branch.repository.get_revision(revision_id)
4278
 
                    subject += revision.get_summary()
4279
 
                basename = directive.get_disk_name(branch)
4280
 
                mail_client.compose_merge_request(mail_to, subject,
4281
 
                                                  outfile.getvalue(), basename)
4282
 
        finally:
4283
 
            if output != '-':
4284
 
                outfile.close()
4285
 
            branch.unlock()
 
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)
4286
5857
 
4287
5858
 
4288
5859
class cmd_bundle_revisions(cmd_send):
4289
 
 
4290
 
    """Create a merge-directive for submiting changes.
 
5860
    __doc__ = """Create a merge-directive for submitting changes.
4291
5861
 
4292
5862
    A merge directive provides many things needed for requesting merges:
4293
5863
 
4333
5903
               type=unicode),
4334
5904
        Option('output', short_name='o', help='Write directive to this file.',
4335
5905
               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.'),
4336
5909
        'revision',
4337
 
        RegistryOption.from_kwargs('format',
4338
 
        'Use the specified output format.',
4339
 
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
4340
 
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5910
        RegistryOption('format',
 
5911
                       help='Use the specified output format.',
 
5912
                       lazy_registry=('bzrlib.send', 'format_registry')),
4341
5913
        ]
4342
5914
    aliases = ['bundle']
4343
5915
 
4347
5919
 
4348
5920
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
4349
5921
            no_patch=False, revision=None, remember=False, output=None,
4350
 
            format='4', **kwargs):
 
5922
            format=None, strict=None, **kwargs):
4351
5923
        if output is None:
4352
5924
            output = '-'
4353
 
        return self._run(submit_branch, revision, public_branch, remember,
 
5925
        from bzrlib.send import send
 
5926
        return send(submit_branch, revision, public_branch, remember,
4354
5927
                         format, no_bundle, no_patch, output,
4355
 
                         kwargs.get('from', '.'), None, None)
 
5928
                         kwargs.get('from', '.'), None, None, None,
 
5929
                         self.outf, strict=strict)
4356
5930
 
4357
5931
 
4358
5932
class cmd_tag(Command):
4359
 
    """Create, remove or modify a tag naming a revision.
4360
 
    
 
5933
    __doc__ = """Create, remove or modify a tag naming a revision.
 
5934
 
4361
5935
    Tags give human-meaningful names to revisions.  Commands that take a -r
4362
5936
    (--revision) option can be given -rtag:X, where X is any previously
4363
5937
    created tag.
4365
5939
    Tags are stored in the branch.  Tags are copied from one branch to another
4366
5940
    along when you branch, push, pull or merge.
4367
5941
 
4368
 
    It is an error to give a tag name that already exists unless you pass 
 
5942
    It is an error to give a tag name that already exists unless you pass
4369
5943
    --force, in which case the tag is moved to point to the new revision.
4370
5944
 
4371
5945
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
4372
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.
4373
5952
    """
4374
5953
 
4375
5954
    _see_also = ['commit', 'tags']
4376
 
    takes_args = ['tag_name']
 
5955
    takes_args = ['tag_name?']
4377
5956
    takes_options = [
4378
5957
        Option('delete',
4379
5958
            help='Delete this tag rather than placing it.',
4380
5959
            ),
4381
 
        Option('directory',
4382
 
            help='Branch in which to place the tag.',
4383
 
            short_name='d',
4384
 
            type=unicode,
4385
 
            ),
 
5960
        custom_help('directory',
 
5961
            help='Branch in which to place the tag.'),
4386
5962
        Option('force',
4387
5963
            help='Replace existing tags.',
4388
5964
            ),
4389
5965
        'revision',
4390
5966
        ]
4391
5967
 
4392
 
    def run(self, tag_name,
 
5968
    def run(self, tag_name=None,
4393
5969
            delete=None,
4394
5970
            directory='.',
4395
5971
            force=None,
4396
5972
            revision=None,
4397
5973
            ):
4398
5974
        branch, relpath = Branch.open_containing(directory)
4399
 
        branch.lock_write()
4400
 
        try:
4401
 
            if delete:
4402
 
                branch.tags.delete_tag(tag_name)
4403
 
                self.outf.write('Deleted tag %s.\n' % tag_name)
4404
 
            else:
4405
 
                if revision:
4406
 
                    if len(revision) != 1:
4407
 
                        raise errors.BzrCommandError(
4408
 
                            "Tags can only be placed on a single revision, "
4409
 
                            "not on a range")
4410
 
                    revision_id = revision[0].as_revision_id(branch)
4411
 
                else:
4412
 
                    revision_id = branch.last_revision()
4413
 
                if (not force) and branch.tags.has_tag(tag_name):
4414
 
                    raise errors.TagAlreadyExists(tag_name)
 
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:
4415
6004
                branch.tags.set_tag(tag_name, revision_id)
4416
 
                self.outf.write('Created tag %s.\n' % tag_name)
4417
 
        finally:
4418
 
            branch.unlock()
 
6005
                if existing_target is None:
 
6006
                    note(gettext('Created tag %s.') % tag_name)
 
6007
                else:
 
6008
                    note(gettext('Updated tag %s.') % tag_name)
4419
6009
 
4420
6010
 
4421
6011
class cmd_tags(Command):
4422
 
    """List tags.
 
6012
    __doc__ = """List tags.
4423
6013
 
4424
6014
    This command shows a table of tag names and the revisions they reference.
4425
6015
    """
4426
6016
 
4427
6017
    _see_also = ['tag']
4428
6018
    takes_options = [
4429
 
        Option('directory',
4430
 
            help='Branch whose tags should be displayed.',
4431
 
            short_name='d',
4432
 
            type=unicode,
4433
 
            ),
4434
 
        RegistryOption.from_kwargs('sort',
 
6019
        custom_help('directory',
 
6020
            help='Branch whose tags should be displayed.'),
 
6021
        RegistryOption('sort',
4435
6022
            'Sort tags by different criteria.', title='Sorting',
4436
 
            alpha='Sort tags lexicographically (default).',
4437
 
            time='Sort tags chronologically.',
 
6023
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
4438
6024
            ),
4439
6025
        'show-ids',
 
6026
        'revision',
4440
6027
    ]
4441
6028
 
4442
6029
    @display_command
4443
 
    def run(self,
4444
 
            directory='.',
4445
 
            sort='alpha',
4446
 
            show_ids=False,
4447
 
            ):
 
6030
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
6031
        from bzrlib.tag import tag_sort_methods
4448
6032
        branch, relpath = Branch.open_containing(directory)
 
6033
 
4449
6034
        tags = branch.tags.get_tag_dict().items()
4450
6035
        if not tags:
4451
6036
            return
4452
 
        if sort == 'alpha':
4453
 
            tags.sort()
4454
 
        elif sort == 'time':
4455
 
            timestamps = {}
4456
 
            for tag, revid in tags:
4457
 
                try:
4458
 
                    revobj = branch.repository.get_revision(revid)
4459
 
                except errors.NoSuchRevision:
4460
 
                    timestamp = sys.maxint # place them at the end
4461
 
                else:
4462
 
                    timestamp = revobj.timestamp
4463
 
                timestamps[revid] = timestamp
4464
 
            tags.sort(key=lambda x: timestamps[x[1]])
 
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)
4465
6045
        if not show_ids:
4466
6046
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
4467
 
            revno_map = branch.get_revision_id_to_revno_map()
4468
 
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
4469
 
                        for tag, revid in tags ]
 
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()
4470
6060
        for tag, revspec in tags:
4471
6061
            self.outf.write('%-20s %s\n' % (tag, revspec))
4472
6062
 
 
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
 
4473
6089
 
4474
6090
class cmd_reconfigure(Command):
4475
 
    """Reconfigure the type of a bzr directory.
 
6091
    __doc__ = """Reconfigure the type of a bzr directory.
4476
6092
 
4477
6093
    A target configuration must be specified.
4478
6094
 
4487
6103
 
4488
6104
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
4489
6105
    takes_args = ['location?']
4490
 
    takes_options = [RegistryOption.from_kwargs('target_type',
4491
 
                     title='Target type',
4492
 
                     help='The type to reconfigure the directory to.',
4493
 
                     value_switches=True, enum_switch=False,
4494
 
                     branch='Reconfigure to be an unbound branch '
4495
 
                        'with no working tree.',
4496
 
                     tree='Reconfigure to be an unbound branch '
4497
 
                        'with a working tree.',
4498
 
                     checkout='Reconfigure to be a bound branch '
4499
 
                        'with a working tree.',
4500
 
                     lightweight_checkout='Reconfigure to be a lightweight'
4501
 
                     ' checkout (with no local history).',
4502
 
                     standalone='Reconfigure to be a standalone branch '
4503
 
                        '(i.e. stop using shared repository).',
4504
 
                     use_shared='Reconfigure to use a shared repository.'),
4505
 
                     Option('bind-to', help='Branch to bind checkout to.',
4506
 
                            type=str),
4507
 
                     Option('force',
4508
 
                        help='Perform reconfiguration even if local changes'
4509
 
                        ' will be lost.')
4510
 
                     ]
 
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
        ]
4511
6150
 
4512
 
    def run(self, location=None, target_type=None, bind_to=None, force=False):
4513
 
        directory = bzrdir.BzrDir.open(location)
4514
 
        if target_type is None:
4515
 
            raise errors.BzrCommandError('No target configuration specified')
4516
 
        elif target_type == 'branch':
 
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':
4517
6174
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
4518
 
        elif target_type == 'tree':
 
6175
        elif tree_type == 'tree':
4519
6176
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
4520
 
        elif target_type == 'checkout':
4521
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
4522
 
                                                                  bind_to)
4523
 
        elif target_type == 'lightweight-checkout':
 
6177
        elif tree_type == 'checkout':
 
6178
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
6179
                directory, bind_to)
 
6180
        elif tree_type == 'lightweight-checkout':
4524
6181
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
4525
6182
                directory, bind_to)
4526
 
        elif target_type == 'use-shared':
 
6183
        if reconfiguration:
 
6184
            reconfiguration.apply(force)
 
6185
            reconfiguration = None
 
6186
        if repository_type == 'use-shared':
4527
6187
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
4528
 
        elif target_type == 'standalone':
 
6188
        elif repository_type == 'standalone':
4529
6189
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
4530
 
        reconfiguration.apply(force)
 
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
4531
6202
 
4532
6203
 
4533
6204
class cmd_switch(Command):
4534
 
    """Set the branch of a checkout and update.
4535
 
    
 
6205
    __doc__ = """Set the branch of a checkout and update.
 
6206
 
4536
6207
    For lightweight checkouts, this changes the branch being referenced.
4537
6208
    For heavyweight checkouts, this checks that there are no local commits
4538
6209
    versus the current bound branch, then it makes the local branch a mirror
4539
6210
    of the new location and binds to it.
4540
 
    
 
6211
 
4541
6212
    In both cases, the working tree is updated and uncommitted changes
4542
6213
    are merged. The user can commit or revert these as they desire.
4543
6214
 
4547
6218
    directory of the current branch. For example, if you are currently in a
4548
6219
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
4549
6220
    /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.
4550
6225
    """
4551
6226
 
4552
 
    takes_args = ['to_location']
4553
 
    takes_options = [Option('force',
4554
 
                        help='Switch even if local commits will be lost.')
4555
 
                     ]
 
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
                    ]
4556
6239
 
4557
 
    def run(self, to_location, force=False):
 
6240
    def run(self, to_location=None, force=False, create_branch=False,
 
6241
            revision=None, directory=u'.', store=False):
4558
6242
        from bzrlib import switch
4559
 
        tree_location = '.'
4560
 
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
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
4561
6253
        try:
4562
 
            to_branch = Branch.open(to_location)
 
6254
            branch = control_dir.open_branch(
 
6255
                possible_transports=possible_transports)
 
6256
            had_explicit_nick = branch.get_config().has_explicit_nickname()
4563
6257
        except errors.NotBranchError:
4564
 
            to_branch = Branch.open(
4565
 
                control_dir.open_branch().base + '../' + to_location)
4566
 
        switch.switch(control_dir, to_branch, force)
4567
 
        note('Switched to branch: %s',
 
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'),
4568
6284
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
4569
6285
 
4570
6286
 
 
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
 
4571
6443
class cmd_hooks(Command):
4572
 
    """Show a branch's currently registered hooks.
4573
 
    """
4574
 
 
4575
 
    hidden = True
4576
 
    takes_args = ['path?']
4577
 
 
4578
 
    def run(self, path=None):
 
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()
4579
6677
        if path is None:
4580
 
            path = '.'
4581
 
        branch_hooks = Branch.open(path).hooks
4582
 
        for hook_type in branch_hooks:
4583
 
            hooks = branch_hooks[hook_type]
4584
 
            self.outf.write("%s:\n" % (hook_type,))
4585
 
            if hooks:
4586
 
                for hook in hooks:
4587
 
                    self.outf.write("  %s\n" %
4588
 
                                    (branch_hooks.get_hook_name(hook),))
 
6678
            info = branch._get_all_reference_info().iteritems()
 
6679
            self._display_reference_info(tree, branch, info)
 
6680
        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)
4589
6687
            else:
4590
 
                self.outf.write("  <no hooks installed>\n")
4591
 
 
4592
 
 
4593
 
def _create_prefix(cur_transport):
4594
 
    needed = [cur_transport]
4595
 
    # Recurse upwards until we can create a directory successfully
4596
 
    while True:
4597
 
        new_transport = cur_transport.clone('..')
4598
 
        if new_transport.base == cur_transport.base:
4599
 
            raise errors.BzrCommandError(
4600
 
                "Failed to create path prefix for %s."
4601
 
                % cur_transport.base)
4602
 
        try:
4603
 
            new_transport.mkdir('.')
4604
 
        except errors.NoSuchFile:
4605
 
            needed.append(new_transport)
4606
 
            cur_transport = new_transport
4607
 
        else:
4608
 
            break
4609
 
    # Now we only need to create child directories
4610
 
    while needed:
4611
 
        cur_transport = needed.pop()
4612
 
        cur_transport.ensure_base()
4613
 
 
4614
 
 
4615
 
# these get imported and then picked up by the scan for cmd_*
4616
 
# TODO: Some more consistent way to split command definitions across files;
4617
 
# we do need to load at least some information about them to know of 
4618
 
# aliases.  ideally we would avoid loading the implementation until the
4619
 
# details were needed.
4620
 
from bzrlib.cmd_version_info import cmd_version_info
4621
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
4622
 
from bzrlib.bundle.commands import (
4623
 
    cmd_bundle_info,
4624
 
    )
4625
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
4626
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
4627
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
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)