~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2012-03-13 16:42:20 UTC
  • mto: This revision was merged to the branch mainline in revision 6512.
  • Revision ID: v.ladeuil+lp@free.fr-20120313164220-atkou2zprhlspmwg
Mention that a given config option cannot be safely handled via both APIs at the same time.

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
# Copyright (C) 2004-2010 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
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
 
19
from __future__ import absolute_import
 
20
 
19
21
import os
20
22
 
21
 
from bzrlib.lazy_import import lazy_import
22
 
lazy_import(globals(), """
23
 
import codecs
 
23
import bzrlib.bzrdir
 
24
 
 
25
from bzrlib import lazy_import
 
26
lazy_import.lazy_import(globals(), """
24
27
import cStringIO
 
28
import errno
25
29
import sys
26
30
import time
27
31
 
30
34
    bugtracker,
31
35
    bundle,
32
36
    btree_index,
33
 
    bzrdir,
 
37
    controldir,
34
38
    directory_service,
35
39
    delta,
36
 
    config,
 
40
    config as _mod_config,
37
41
    errors,
38
42
    globbing,
39
43
    hooks,
45
49
    rename_map,
46
50
    revision as _mod_revision,
47
51
    static_tuple,
48
 
    symbol_versioning,
49
52
    timestamp,
50
53
    transport,
51
54
    ui,
52
55
    urlutils,
53
56
    views,
 
57
    gpg,
54
58
    )
55
59
from bzrlib.branch import Branch
56
60
from bzrlib.conflicts import ConflictList
 
61
from bzrlib.transport import memory
57
62
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
58
63
from bzrlib.smtp_connection import SMTPConnection
59
64
from bzrlib.workingtree import WorkingTree
 
65
from bzrlib.i18n import gettext, ngettext
60
66
""")
61
67
 
62
 
from bzrlib.commands import Command, display_command
 
68
from bzrlib.commands import (
 
69
    Command,
 
70
    builtin_command_registry,
 
71
    display_command,
 
72
    )
63
73
from bzrlib.option import (
64
74
    ListOption,
65
75
    Option,
68
78
    _parse_revision_str,
69
79
    )
70
80
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
71
 
 
72
 
 
73
 
def tree_files(file_list, default_branch=u'.', canonicalize=True,
74
 
    apply_view=True):
75
 
    try:
76
 
        return internal_tree_files(file_list, default_branch, canonicalize,
77
 
            apply_view)
78
 
    except errors.FileInWrongBranch, e:
79
 
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
80
 
                                     (e.path, file_list[0]))
 
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
81
221
 
82
222
 
83
223
def tree_files_for_add(file_list):
108
248
            if view_files:
109
249
                file_list = view_files
110
250
                view_str = views.view_display_str(view_files)
111
 
                note("Ignoring files outside view. View is %s" % view_str)
 
251
                note(gettext("Ignoring files outside view. View is %s") % view_str)
112
252
    return tree, file_list
113
253
 
114
254
 
116
256
    if revisions is None:
117
257
        return None
118
258
    if len(revisions) != 1:
119
 
        raise errors.BzrCommandError(
120
 
            'bzr %s --revision takes exactly one revision identifier' % (
 
259
        raise errors.BzrCommandError(gettext(
 
260
            'bzr %s --revision takes exactly one revision identifier') % (
121
261
                command_name,))
122
262
    return revisions[0]
123
263
 
145
285
    return rev_tree
146
286
 
147
287
 
148
 
# XXX: Bad function name; should possibly also be a class method of
149
 
# WorkingTree rather than a function.
150
 
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
151
 
    apply_view=True):
152
 
    """Convert command-line paths to a WorkingTree and relative paths.
153
 
 
154
 
    This is typically used for command-line processors that take one or
155
 
    more filenames, and infer the workingtree that contains them.
156
 
 
157
 
    The filenames given are not required to exist.
158
 
 
159
 
    :param file_list: Filenames to convert.
160
 
 
161
 
    :param default_branch: Fallback tree path to use if file_list is empty or
162
 
        None.
163
 
 
164
 
    :param apply_view: if True and a view is set, apply it or check that
165
 
        specified files are within it
166
 
 
167
 
    :return: workingtree, [relative_paths]
168
 
    """
169
 
    if file_list is None or len(file_list) == 0:
170
 
        tree = WorkingTree.open_containing(default_branch)[0]
171
 
        if tree.supports_views() and apply_view:
172
 
            view_files = tree.views.lookup_view()
173
 
            if view_files:
174
 
                file_list = view_files
175
 
                view_str = views.view_display_str(view_files)
176
 
                note("Ignoring files outside view. View is %s" % view_str)
177
 
        return tree, file_list
178
 
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
179
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
180
 
        apply_view=apply_view)
181
 
 
182
 
 
183
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
184
 
    """Convert file_list into a list of relpaths in tree.
185
 
 
186
 
    :param tree: A tree to operate on.
187
 
    :param file_list: A list of user provided paths or None.
188
 
    :param apply_view: if True and a view is set, apply it or check that
189
 
        specified files are within it
190
 
    :return: A list of relative paths.
191
 
    :raises errors.PathNotChild: When a provided path is in a different tree
192
 
        than tree.
193
 
    """
194
 
    if file_list is None:
195
 
        return None
196
 
    if tree.supports_views() and apply_view:
197
 
        view_files = tree.views.lookup_view()
198
 
    else:
199
 
        view_files = []
200
 
    new_list = []
201
 
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
202
 
    # doesn't - fix that up here before we enter the loop.
203
 
    if canonicalize:
204
 
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
205
 
    else:
206
 
        fixer = tree.relpath
207
 
    for filename in file_list:
208
 
        try:
209
 
            relpath = fixer(osutils.dereference_path(filename))
210
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
211
 
                raise errors.FileOutsideView(filename, view_files)
212
 
            new_list.append(relpath)
213
 
        except errors.PathNotChild:
214
 
            raise errors.FileInWrongBranch(tree.branch, filename)
215
 
    return new_list
216
 
 
217
 
 
218
288
def _get_view_info_for_change_reporter(tree):
219
289
    """Get the view information from a tree for change reporting."""
220
290
    view_info = None
227
297
    return view_info
228
298
 
229
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)
 
306
 
 
307
 
230
308
# TODO: Make sure no commands unconditionally use the working directory as a
231
309
# branch.  If a filename argument is used, the first of them should be used to
232
310
# specify the branch.  (Perhaps this can be factored out into some kind of
234
312
# opens the branch?)
235
313
 
236
314
class cmd_status(Command):
237
 
    """Display status summary.
 
315
    __doc__ = """Display status summary.
238
316
 
239
317
    This reports on versioned and unknown files, reporting them
240
318
    grouped by state.  Possible states are:
260
338
    unknown
261
339
        Not versioned and not matching an ignore pattern.
262
340
 
263
 
    Additionally for directories, symlinks and files with an executable
264
 
    bit, Bazaar indicates their type using a trailing character: '/', '@'
265
 
    or '*' respectively.
 
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.
266
345
 
267
346
    To see ignored files use 'bzr ignored'.  For details on the
268
347
    changes to file texts, use 'bzr diff'.
281
360
    To skip the display of pending merge information altogether, use
282
361
    the no-pending option or specify a file/directory.
283
362
 
284
 
    If a revision argument is given, the status is calculated against
285
 
    that revision, or between two revisions if two are provided.
 
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'.
286
369
    """
287
370
 
288
 
    # TODO: --no-recurse, --recurse options
 
371
    # TODO: --no-recurse/-N, --recurse options
289
372
 
290
373
    takes_args = ['file*']
291
374
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
295
378
                            short_name='V'),
296
379
                     Option('no-pending', help='Don\'t show pending merges.',
297
380
                           ),
 
381
                     Option('no-classify',
 
382
                            help='Do not mark object type using indicator.',
 
383
                           ),
298
384
                     ]
299
385
    aliases = ['st', 'stat']
300
386
 
303
389
 
304
390
    @display_command
305
391
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
306
 
            versioned=False, no_pending=False, verbose=False):
 
392
            versioned=False, no_pending=False, verbose=False,
 
393
            no_classify=False):
307
394
        from bzrlib.status import show_tree_status
308
395
 
309
396
        if revision and len(revision) > 2:
310
 
            raise errors.BzrCommandError('bzr status --revision takes exactly'
311
 
                                         ' one or two revision specifiers')
 
397
            raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
 
398
                                         ' one or two revision specifiers'))
312
399
 
313
 
        tree, relfile_list = tree_files(file_list)
 
400
        tree, relfile_list = WorkingTree.open_containing_paths(file_list)
314
401
        # Avoid asking for specific files when that is not needed.
315
402
        if relfile_list == ['']:
316
403
            relfile_list = None
323
410
        show_tree_status(tree, show_ids=show_ids,
324
411
                         specific_files=relfile_list, revision=revision,
325
412
                         to_file=self.outf, short=short, versioned=versioned,
326
 
                         show_pending=(not no_pending), verbose=verbose)
 
413
                         show_pending=(not no_pending), verbose=verbose,
 
414
                         classify=not no_classify)
327
415
 
328
416
 
329
417
class cmd_cat_revision(Command):
330
 
    """Write out metadata for a revision.
 
418
    __doc__ = """Write out metadata for a revision.
331
419
 
332
420
    The revision to print can either be specified by a specific
333
421
    revision identifier, or you can use --revision.
335
423
 
336
424
    hidden = True
337
425
    takes_args = ['revision_id?']
338
 
    takes_options = ['revision']
 
426
    takes_options = ['directory', 'revision']
339
427
    # cat-revision is more for frontends so should be exact
340
428
    encoding = 'strict'
341
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
 
342
438
    @display_command
343
 
    def run(self, revision_id=None, revision=None):
 
439
    def run(self, revision_id=None, revision=None, directory=u'.'):
344
440
        if revision_id is not None and revision is not None:
345
 
            raise errors.BzrCommandError('You can only supply one of'
346
 
                                         ' revision_id or --revision')
 
441
            raise errors.BzrCommandError(gettext('You can only supply one of'
 
442
                                         ' revision_id or --revision'))
347
443
        if revision_id is None and revision is None:
348
 
            raise errors.BzrCommandError('You must supply either'
349
 
                                         ' --revision or a revision_id')
350
 
        b = WorkingTree.open_containing(u'.')[0].branch
351
 
 
352
 
        # TODO: jam 20060112 should cat-revision always output utf-8?
353
 
        if revision_id is not None:
354
 
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
355
 
            try:
356
 
                self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
357
 
            except errors.NoSuchRevision:
358
 
                msg = "The repository %s contains no revision %s." % (b.repository.base,
359
 
                    revision_id)
360
 
                raise errors.BzrCommandError(msg)
361
 
        elif revision is not None:
362
 
            for rev in revision:
363
 
                if rev is None:
364
 
                    raise errors.BzrCommandError('You cannot specify a NULL'
365
 
                                                 ' revision.')
366
 
                rev_id = rev.as_revision_id(b)
367
 
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
368
 
 
 
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
        
369
475
 
370
476
class cmd_dump_btree(Command):
371
 
    """Dump the contents of a btree index file to stdout.
 
477
    __doc__ = """Dump the contents of a btree index file to stdout.
372
478
 
373
479
    PATH is a btree index file, it can be any URL. This includes things like
374
480
    .bzr/repository/pack-names, or .bzr/repository/indices/a34b3a...ca4a4.iix
422
528
                self.outf.write(page_bytes[:header_end])
423
529
                page_bytes = data
424
530
            self.outf.write('\nPage %d\n' % (page_idx,))
425
 
            decomp_bytes = zlib.decompress(page_bytes)
426
 
            self.outf.write(decomp_bytes)
427
 
            self.outf.write('\n')
 
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')
428
537
 
429
538
    def _dump_entries(self, trans, basename):
430
539
        try:
438
547
        for node in bt.iter_all_entries():
439
548
            # Node is made up of:
440
549
            # (index, key, value, [references])
441
 
            refs_as_tuples = static_tuple.as_tuples(node[3])
 
550
            try:
 
551
                refs = node[3]
 
552
            except IndexError:
 
553
                refs_as_tuples = None
 
554
            else:
 
555
                refs_as_tuples = static_tuple.as_tuples(refs)
442
556
            as_tuple = (tuple(node[1]), node[2], refs_as_tuples)
443
557
            self.outf.write('%s\n' % (as_tuple,))
444
558
 
445
559
 
446
560
class cmd_remove_tree(Command):
447
 
    """Remove the working tree from a given branch/checkout.
 
561
    __doc__ = """Remove the working tree from a given branch/checkout.
448
562
 
449
563
    Since a lightweight checkout is little more than a working tree
450
564
    this will refuse to run against one.
452
566
    To re-create the working tree, use "bzr checkout".
453
567
    """
454
568
    _see_also = ['checkout', 'working-trees']
455
 
    takes_args = ['location?']
 
569
    takes_args = ['location*']
456
570
    takes_options = [
457
571
        Option('force',
458
572
               help='Remove the working tree even if it has '
459
 
                    'uncommitted changes.'),
 
573
                    'uncommitted or shelved changes.'),
460
574
        ]
461
575
 
462
 
    def run(self, location='.', force=False):
463
 
        d = bzrdir.BzrDir.open(location)
464
 
 
 
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]
465
644
        try:
466
 
            working = d.open_workingtree()
467
 
        except errors.NoWorkingTree:
468
 
            raise errors.BzrCommandError("No working tree to remove")
469
 
        except errors.NotLocalUrl:
470
 
            raise errors.BzrCommandError("You cannot remove the working tree"
471
 
                                         " of a remote path")
472
 
        if not force:
473
 
            if (working.has_changes()):
474
 
                raise errors.UncommittedChanges(working)
475
 
 
476
 
        working_path = working.bzrdir.root_transport.base
477
 
        branch_path = working.branch.bzrdir.root_transport.base
478
 
        if working_path != branch_path:
479
 
            raise errors.BzrCommandError("You cannot remove the working tree"
480
 
                                         " from a lightweight checkout")
481
 
 
482
 
        d.destroy_workingtree()
 
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))
483
653
 
484
654
 
485
655
class cmd_revno(Command):
486
 
    """Show current revision number.
 
656
    __doc__ = """Show current revision number.
487
657
 
488
658
    This is equal to the number of revisions on this branch.
489
659
    """
491
661
    _see_also = ['info']
492
662
    takes_args = ['location?']
493
663
    takes_options = [
494
 
        Option('tree', help='Show revno of working tree'),
 
664
        Option('tree', help='Show revno of working tree.'),
 
665
        'revision',
495
666
        ]
496
667
 
497
668
    @display_command
498
 
    def run(self, tree=False, location=u'.'):
 
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
 
499
674
        if tree:
500
675
            try:
501
676
                wt = WorkingTree.open_containing(location)[0]
502
 
                wt.lock_read()
 
677
                self.add_cleanup(wt.lock_read().unlock)
503
678
            except (errors.NoWorkingTree, errors.NotLocalUrl):
504
679
                raise errors.NoWorkingTree(location)
505
 
            self.add_cleanup(wt.unlock)
 
680
            b = wt.branch
506
681
            revid = wt.last_revision()
507
 
            try:
508
 
                revno_t = wt.branch.revision_id_to_dotted_revno(revid)
509
 
            except errors.NoSuchRevision:
510
 
                revno_t = ('???',)
511
 
            revno = ".".join(str(n) for n in revno_t)
512
682
        else:
513
683
            b = Branch.open_containing(location)[0]
514
 
            b.lock_read()
515
 
            self.add_cleanup(b.unlock)
516
 
            revno = b.revno()
 
684
            self.add_cleanup(b.lock_read().unlock)
 
685
            if revision:
 
686
                if len(revision) != 1:
 
687
                    raise errors.BzrCommandError(gettext(
 
688
                        "Tags can only be placed on a single revision, "
 
689
                        "not on a range"))
 
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)
517
698
        self.cleanup_now()
518
 
        self.outf.write(str(revno) + '\n')
 
699
        self.outf.write(revno + '\n')
519
700
 
520
701
 
521
702
class cmd_revision_info(Command):
522
 
    """Show revision number and revision id for a given revision identifier.
 
703
    __doc__ = """Show revision number and revision id for a given revision identifier.
523
704
    """
524
705
    hidden = True
525
706
    takes_args = ['revision_info*']
526
707
    takes_options = [
527
708
        'revision',
528
 
        Option('directory',
 
709
        custom_help('directory',
529
710
            help='Branch to examine, '
530
 
                 'rather than the one containing the working directory.',
531
 
            short_name='d',
532
 
            type=unicode,
533
 
            ),
534
 
        Option('tree', help='Show revno of working tree'),
 
711
                 'rather than the one containing the working directory.'),
 
712
        Option('tree', help='Show revno of working tree.'),
535
713
        ]
536
714
 
537
715
    @display_command
541
719
        try:
542
720
            wt = WorkingTree.open_containing(directory)[0]
543
721
            b = wt.branch
544
 
            wt.lock_read()
545
 
            self.add_cleanup(wt.unlock)
 
722
            self.add_cleanup(wt.lock_read().unlock)
546
723
        except (errors.NoWorkingTree, errors.NotLocalUrl):
547
724
            wt = None
548
725
            b = Branch.open_containing(directory)[0]
549
 
            b.lock_read()
550
 
            self.add_cleanup(b.unlock)
 
726
            self.add_cleanup(b.lock_read().unlock)
551
727
        revision_ids = []
552
728
        if revision is not None:
553
729
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
581
757
 
582
758
 
583
759
class cmd_add(Command):
584
 
    """Add specified files or directories.
 
760
    __doc__ = """Add specified files or directories.
585
761
 
586
762
    In non-recursive mode, all the named items are added, regardless
587
763
    of whether they were previously ignored.  A warning is given if
595
771
    are added.  This search proceeds recursively into versioned
596
772
    directories.  If no names are given '.' is assumed.
597
773
 
 
774
    A warning will be printed when nested trees are encountered,
 
775
    unless they are explicitly ignored.
 
776
 
598
777
    Therefore simply saying 'bzr add' will version all files that
599
778
    are currently unknown.
600
779
 
616
795
    
617
796
    Any files matching patterns in the ignore list will not be added
618
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.
619
802
    """
620
803
    takes_args = ['file*']
621
804
    takes_options = [
622
805
        Option('no-recurse',
623
 
               help="Don't recursively add the contents of directories."),
 
806
               help="Don't recursively add the contents of directories.",
 
807
               short_name='N'),
624
808
        Option('dry-run',
625
809
               help="Show what would be done, but don't actually do anything."),
626
810
        'verbose',
648
832
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
649
833
                          to_file=self.outf, should_print=(not is_quiet()))
650
834
        else:
651
 
            action = bzrlib.add.AddAction(to_file=self.outf,
 
835
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
652
836
                should_print=(not is_quiet()))
653
837
 
654
838
        if base_tree:
655
 
            base_tree.lock_read()
656
 
            self.add_cleanup(base_tree.unlock)
 
839
            self.add_cleanup(base_tree.lock_read().unlock)
657
840
        tree, file_list = tree_files_for_add(file_list)
658
841
        added, ignored = tree.smart_add(file_list, not
659
842
            no_recurse, action=action, save=not dry_run)
662
845
            if verbose:
663
846
                for glob in sorted(ignored.keys()):
664
847
                    for path in ignored[glob]:
665
 
                        self.outf.write("ignored %s matching \"%s\"\n"
666
 
                                        % (path, glob))
 
848
                        self.outf.write(
 
849
                         gettext("ignored {0} matching \"{1}\"\n").format(
 
850
                         path, glob))
667
851
 
668
852
 
669
853
class cmd_mkdir(Command):
670
 
    """Create a new versioned directory.
 
854
    __doc__ = """Create a new versioned directory.
671
855
 
672
856
    This is equivalent to creating the directory and then adding it.
673
857
    """
674
858
 
675
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
        ]
676
867
    encoding_type = 'replace'
677
868
 
678
 
    def run(self, dir_list):
679
 
        for d in dir_list:
680
 
            os.mkdir(d)
681
 
            wt, dd = WorkingTree.open_containing(d)
682
 
            wt.add([dd])
683
 
            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)
684
898
 
685
899
 
686
900
class cmd_relpath(Command):
687
 
    """Show path of a file relative to root"""
 
901
    __doc__ = """Show path of a file relative to root"""
688
902
 
689
903
    takes_args = ['filename']
690
904
    hidden = True
699
913
 
700
914
 
701
915
class cmd_inventory(Command):
702
 
    """Show inventory of the current working copy or a revision.
 
916
    __doc__ = """Show inventory of the current working copy or a revision.
703
917
 
704
918
    It is possible to limit the output to a particular entry
705
919
    type using the --kind option.  For example: --kind file.
722
936
    @display_command
723
937
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
724
938
        if kind and kind not in ['file', 'directory', 'symlink']:
725
 
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
939
            raise errors.BzrCommandError(gettext('invalid kind %r specified') % (kind,))
726
940
 
727
941
        revision = _get_one_revision('inventory', revision)
728
 
        work_tree, file_list = tree_files(file_list)
729
 
        work_tree.lock_read()
730
 
        self.add_cleanup(work_tree.unlock)
 
942
        work_tree, file_list = WorkingTree.open_containing_paths(file_list)
 
943
        self.add_cleanup(work_tree.lock_read().unlock)
731
944
        if revision is not None:
732
945
            tree = revision.as_tree(work_tree.branch)
733
946
 
734
947
            extra_trees = [work_tree]
735
 
            tree.lock_read()
736
 
            self.add_cleanup(tree.unlock)
 
948
            self.add_cleanup(tree.lock_read().unlock)
737
949
        else:
738
950
            tree = work_tree
739
951
            extra_trees = []
740
952
 
 
953
        self.add_cleanup(tree.lock_read().unlock)
741
954
        if file_list is not None:
742
955
            file_ids = tree.paths2ids(file_list, trees=extra_trees,
743
956
                                      require_versioned=True)
744
957
            # find_ids_across_trees may include some paths that don't
745
958
            # exist in 'tree'.
746
 
            entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
747
 
                             for file_id in file_ids if file_id in tree)
 
959
            entries = tree.iter_entries_by_dir(specific_file_ids=file_ids)
748
960
        else:
749
 
            entries = tree.inventory.entries()
 
961
            entries = tree.iter_entries_by_dir()
750
962
 
751
 
        self.cleanup_now()
752
 
        for path, entry in entries:
 
963
        for path, entry in sorted(entries):
753
964
            if kind and kind != entry.kind:
754
965
                continue
 
966
            if path == "":
 
967
                continue
755
968
            if show_ids:
756
969
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
757
970
            else:
760
973
 
761
974
 
762
975
class cmd_mv(Command):
763
 
    """Move or rename a file.
 
976
    __doc__ = """Move or rename a file.
764
977
 
765
978
    :Usage:
766
979
        bzr mv OLDNAME NEWNAME
793
1006
        if auto:
794
1007
            return self.run_auto(names_list, after, dry_run)
795
1008
        elif dry_run:
796
 
            raise errors.BzrCommandError('--dry-run requires --auto.')
 
1009
            raise errors.BzrCommandError(gettext('--dry-run requires --auto.'))
797
1010
        if names_list is None:
798
1011
            names_list = []
799
1012
        if len(names_list) < 2:
800
 
            raise errors.BzrCommandError("missing file argument")
801
 
        tree, rel_names = tree_files(names_list, canonicalize=False)
802
 
        tree.lock_tree_write()
803
 
        self.add_cleanup(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)
804
1019
        self._run(tree, names_list, rel_names, after)
805
1020
 
806
1021
    def run_auto(self, names_list, after, dry_run):
807
1022
        if names_list is not None and len(names_list) > 1:
808
 
            raise errors.BzrCommandError('Only one path may be specified to'
809
 
                                         ' --auto.')
 
1023
            raise errors.BzrCommandError(gettext('Only one path may be specified to'
 
1024
                                         ' --auto.'))
810
1025
        if after:
811
 
            raise errors.BzrCommandError('--after cannot be specified with'
812
 
                                         ' --auto.')
813
 
        work_tree, file_list = tree_files(names_list, default_branch='.')
814
 
        work_tree.lock_tree_write()
815
 
        self.add_cleanup(work_tree.unlock)
 
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)
816
1031
        rename_map.RenameMap.guess_renames(work_tree, dry_run)
817
1032
 
818
1033
    def _run(self, tree, names_list, rel_names, after):
827
1042
                and rel_names[0].lower() == rel_names[1].lower()):
828
1043
                into_existing = False
829
1044
            else:
830
 
                inv = tree.inventory
831
1045
                # 'fix' the case of a potential 'from'
832
1046
                from_id = tree.path2id(
833
1047
                            tree.get_canonical_inventory_path(rel_names[0]))
834
1048
                if (not osutils.lexists(names_list[0]) and
835
 
                    from_id and inv.get_file_kind(from_id) == "directory"):
 
1049
                    from_id and tree.stored_kind(from_id) == "directory"):
836
1050
                    into_existing = False
837
1051
        # move/rename
838
1052
        if into_existing:
845
1059
                    self.outf.write("%s => %s\n" % (src, dest))
846
1060
        else:
847
1061
            if len(names_list) != 2:
848
 
                raise errors.BzrCommandError('to mv multiple files the'
 
1062
                raise errors.BzrCommandError(gettext('to mv multiple files the'
849
1063
                                             ' destination must be a versioned'
850
 
                                             ' directory')
 
1064
                                             ' directory'))
851
1065
 
852
1066
            # for cicp file-systems: the src references an existing inventory
853
1067
            # item:
897
1111
 
898
1112
 
899
1113
class cmd_pull(Command):
900
 
    """Turn this branch into a mirror of another branch.
 
1114
    __doc__ = """Turn this branch into a mirror of another branch.
901
1115
 
902
1116
    By default, this command only works on branches that have not diverged.
903
1117
    Branches are considered diverged if the destination branch's most recent 
912
1126
    match the remote one, use pull --overwrite. This will work even if the two
913
1127
    branches have diverged.
914
1128
 
915
 
    If there is no default location set, the first pull will set it.  After
916
 
    that, you can omit the location to use the default.  To change the
917
 
    default, use --remember. The value will only be saved if the remote
918
 
    location can be accessed.
 
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>.
919
1137
 
920
1138
    Note: The location can be specified either in the form of a branch,
921
1139
    or in the form of a path to a file containing a merge directive generated
926
1144
    takes_options = ['remember', 'overwrite', 'revision',
927
1145
        custom_help('verbose',
928
1146
            help='Show logs of pulled revisions.'),
929
 
        Option('directory',
 
1147
        custom_help('directory',
930
1148
            help='Branch to pull into, '
931
 
                 'rather than the one containing the working directory.',
932
 
            short_name='d',
933
 
            type=unicode,
934
 
            ),
 
1149
                 'rather than the one containing the working directory.'),
935
1150
        Option('local',
936
1151
            help="Perform a local pull in a bound "
937
1152
                 "branch.  Local pulls are not applied to "
938
1153
                 "the master branch."
939
1154
            ),
 
1155
        Option('show-base',
 
1156
            help="Show base revision text in conflicts.")
940
1157
        ]
941
1158
    takes_args = ['location?']
942
1159
    encoding_type = 'replace'
943
1160
 
944
 
    def run(self, location=None, remember=False, overwrite=False,
 
1161
    def run(self, location=None, remember=None, overwrite=False,
945
1162
            revision=None, verbose=False,
946
 
            directory=None, local=False):
 
1163
            directory=None, local=False,
 
1164
            show_base=False):
947
1165
        # FIXME: too much stuff is in the command class
948
1166
        revision_id = None
949
1167
        mergeable = None
952
1170
        try:
953
1171
            tree_to = WorkingTree.open_containing(directory)[0]
954
1172
            branch_to = tree_to.branch
 
1173
            self.add_cleanup(tree_to.lock_write().unlock)
955
1174
        except errors.NoWorkingTree:
956
1175
            tree_to = None
957
1176
            branch_to = Branch.open_containing(directory)[0]
958
 
        
 
1177
            self.add_cleanup(branch_to.lock_write().unlock)
 
1178
 
 
1179
        if tree_to is None and show_base:
 
1180
            raise errors.BzrCommandError(gettext("Need working tree for --show-base."))
 
1181
 
959
1182
        if local and not branch_to.get_bound_location():
960
1183
            raise errors.LocalRequiresBoundBranch()
961
1184
 
970
1193
        stored_loc = branch_to.get_parent()
971
1194
        if location is None:
972
1195
            if stored_loc is None:
973
 
                raise errors.BzrCommandError("No pull location known or"
974
 
                                             " specified.")
 
1196
                raise errors.BzrCommandError(gettext("No pull location known or"
 
1197
                                             " specified."))
975
1198
            else:
976
1199
                display_url = urlutils.unescape_for_display(stored_loc,
977
1200
                        self.outf.encoding)
978
1201
                if not is_quiet():
979
 
                    self.outf.write("Using saved parent location: %s\n" % display_url)
 
1202
                    self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
980
1203
                location = stored_loc
981
1204
 
982
1205
        revision = _get_one_revision('pull', revision)
983
1206
        if mergeable is not None:
984
1207
            if revision is not None:
985
 
                raise errors.BzrCommandError(
986
 
                    'Cannot use -r with merge directives or bundles')
 
1208
                raise errors.BzrCommandError(gettext(
 
1209
                    'Cannot use -r with merge directives or bundles'))
987
1210
            mergeable.install_revisions(branch_to.repository)
988
1211
            base_revision_id, revision_id, verified = \
989
1212
                mergeable.get_merge_request(branch_to.repository)
991
1214
        else:
992
1215
            branch_from = Branch.open(location,
993
1216
                possible_transports=possible_transports)
994
 
 
995
 
            if branch_to.get_parent() is None or remember:
 
1217
            self.add_cleanup(branch_from.lock_read().unlock)
 
1218
            # Remembers if asked explicitly or no previous location is set
 
1219
            if (remember
 
1220
                or (remember is None and branch_to.get_parent() is None)):
 
1221
                # FIXME: This shouldn't be done before the pull
 
1222
                # succeeds... -- vila 2012-01-02
996
1223
                branch_to.set_parent(branch_from.base)
997
1224
 
998
 
        if branch_from is not branch_to:
999
 
            branch_from.lock_read()
1000
 
            self.add_cleanup(branch_from.unlock)
1001
1225
        if revision is not None:
1002
1226
            revision_id = revision.as_revision_id(branch_from)
1003
1227
 
1004
 
        branch_to.lock_write()
1005
 
        self.add_cleanup(branch_to.unlock)
1006
1228
        if tree_to is not None:
1007
1229
            view_info = _get_view_info_for_change_reporter(tree_to)
1008
1230
            change_reporter = delta._ChangeReporter(
1010
1232
                view_info=view_info)
1011
1233
            result = tree_to.pull(
1012
1234
                branch_from, overwrite, revision_id, change_reporter,
1013
 
                possible_transports=possible_transports, local=local)
 
1235
                local=local, show_base=show_base)
1014
1236
        else:
1015
1237
            result = branch_to.pull(
1016
1238
                branch_from, overwrite, revision_id, local=local)
1020
1242
            log.show_branch_change(
1021
1243
                branch_to, self.outf, result.old_revno,
1022
1244
                result.old_revid)
 
1245
        if getattr(result, 'tag_conflicts', None):
 
1246
            return 1
 
1247
        else:
 
1248
            return 0
1023
1249
 
1024
1250
 
1025
1251
class cmd_push(Command):
1026
 
    """Update a mirror of this branch.
 
1252
    __doc__ = """Update a mirror of this branch.
1027
1253
 
1028
1254
    The target branch will not have its working tree populated because this
1029
1255
    is both expensive, and is not supported on remote file systems.
1042
1268
    do a merge (see bzr help merge) from the other branch, and commit that.
1043
1269
    After that you will be able to do a push without '--overwrite'.
1044
1270
 
1045
 
    If there is no default push location set, the first push will set it.
1046
 
    After that, you can omit the location to use the default.  To change the
1047
 
    default, use --remember. The value will only be saved if the remote
1048
 
    location can be accessed.
 
1271
    If there is no default push location set, the first push will set it (use
 
1272
    --no-remember to avoid setting it).  After that, you can omit the
 
1273
    location to use the default.  To change the default, use --remember. The
 
1274
    value will only be saved if the remote location can be accessed.
 
1275
 
 
1276
    The --verbose option will display the revisions pushed using the log_format
 
1277
    configuration option. You can use a different format by overriding it with
 
1278
    -Olog_format=<other_format>.
1049
1279
    """
1050
1280
 
1051
1281
    _see_also = ['pull', 'update', 'working-trees']
1053
1283
        Option('create-prefix',
1054
1284
               help='Create the path leading up to the branch '
1055
1285
                    'if it does not already exist.'),
1056
 
        Option('directory',
 
1286
        custom_help('directory',
1057
1287
            help='Branch to push from, '
1058
 
                 'rather than the one containing the working directory.',
1059
 
            short_name='d',
1060
 
            type=unicode,
1061
 
            ),
 
1288
                 'rather than the one containing the working directory.'),
1062
1289
        Option('use-existing-dir',
1063
1290
               help='By default push will fail if the target'
1064
1291
                    ' directory exists, but does not already'
1075
1302
        Option('strict',
1076
1303
               help='Refuse to push if there are uncommitted changes in'
1077
1304
               ' the working tree, --no-strict disables the check.'),
 
1305
        Option('no-tree',
 
1306
               help="Don't populate the working tree, even for protocols"
 
1307
               " that support it."),
1078
1308
        ]
1079
1309
    takes_args = ['location?']
1080
1310
    encoding_type = 'replace'
1081
1311
 
1082
 
    def run(self, location=None, remember=False, overwrite=False,
 
1312
    def run(self, location=None, remember=None, overwrite=False,
1083
1313
        create_prefix=False, verbose=False, revision=None,
1084
1314
        use_existing_dir=False, directory=None, stacked_on=None,
1085
 
        stacked=False, strict=None):
 
1315
        stacked=False, strict=None, no_tree=False):
1086
1316
        from bzrlib.push import _show_push_branch
1087
1317
 
1088
1318
        if directory is None:
1089
1319
            directory = '.'
1090
1320
        # Get the source branch
1091
1321
        (tree, br_from,
1092
 
         _unused) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
1093
 
        if strict is None:
1094
 
            strict = br_from.get_config().get_user_option_as_bool('push_strict')
1095
 
        if strict is None: strict = True # default value
 
1322
         _unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
1096
1323
        # Get the tip's revision_id
1097
1324
        revision = _get_one_revision('push', revision)
1098
1325
        if revision is not None:
1099
1326
            revision_id = revision.in_history(br_from).rev_id
1100
1327
        else:
1101
1328
            revision_id = None
1102
 
        if strict and tree is not None and revision_id is None:
1103
 
            if (tree.has_changes()):
1104
 
                raise errors.UncommittedChanges(
1105
 
                    tree, more='Use --no-strict to force the push.')
1106
 
            if tree.last_revision() != tree.branch.last_revision():
1107
 
                # The tree has lost sync with its branch, there is little
1108
 
                # chance that the user is aware of it but he can still force
1109
 
                # the push with --no-strict
1110
 
                raise errors.OutOfDateTree(
1111
 
                    tree, more='Use --no-strict to force the push.')
1112
 
 
 
1329
        if tree is not None and revision_id is None:
 
1330
            tree.check_changed_or_out_of_date(
 
1331
                strict, 'push_strict',
 
1332
                more_error='Use --no-strict to force the push.',
 
1333
                more_warning='Uncommitted changes will not be pushed.')
1113
1334
        # Get the stacked_on branch, if any
1114
1335
        if stacked_on is not None:
1115
1336
            stacked_on = urlutils.normalize_url(stacked_on)
1125
1346
                    # error by the feedback given to them. RBC 20080227.
1126
1347
                    stacked_on = parent_url
1127
1348
            if not stacked_on:
1128
 
                raise errors.BzrCommandError(
1129
 
                    "Could not determine branch to refer to.")
 
1349
                raise errors.BzrCommandError(gettext(
 
1350
                    "Could not determine branch to refer to."))
1130
1351
 
1131
1352
        # Get the destination location
1132
1353
        if location is None:
1133
1354
            stored_loc = br_from.get_push_location()
1134
1355
            if stored_loc is None:
1135
 
                raise errors.BzrCommandError(
1136
 
                    "No push location known or specified.")
 
1356
                parent_loc = br_from.get_parent()
 
1357
                if parent_loc:
 
1358
                    raise errors.BzrCommandError(gettext(
 
1359
                        "No push location known or specified. To push to the "
 
1360
                        "parent branch (at %s), use 'bzr push :parent'." %
 
1361
                        urlutils.unescape_for_display(parent_loc,
 
1362
                            self.outf.encoding)))
 
1363
                else:
 
1364
                    raise errors.BzrCommandError(gettext(
 
1365
                        "No push location known or specified."))
1137
1366
            else:
1138
1367
                display_url = urlutils.unescape_for_display(stored_loc,
1139
1368
                        self.outf.encoding)
1140
 
                self.outf.write("Using saved push location: %s\n" % display_url)
 
1369
                note(gettext("Using saved push location: %s") % display_url)
1141
1370
                location = stored_loc
1142
1371
 
1143
1372
        _show_push_branch(br_from, revision_id, location, self.outf,
1144
1373
            verbose=verbose, overwrite=overwrite, remember=remember,
1145
1374
            stacked_on=stacked_on, create_prefix=create_prefix,
1146
 
            use_existing_dir=use_existing_dir)
 
1375
            use_existing_dir=use_existing_dir, no_tree=no_tree)
1147
1376
 
1148
1377
 
1149
1378
class cmd_branch(Command):
1150
 
    """Create a new branch that is a copy of an existing branch.
 
1379
    __doc__ = """Create a new branch that is a copy of an existing branch.
1151
1380
 
1152
1381
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1153
1382
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1158
1387
 
1159
1388
    To retrieve the branch as of a particular revision, supply the --revision
1160
1389
    parameter, as in "branch foo/bar -r 5".
 
1390
 
 
1391
    The synonyms 'clone' and 'get' for this command are deprecated.
1161
1392
    """
1162
1393
 
1163
1394
    _see_also = ['checkout']
1164
1395
    takes_args = ['from_location', 'to_location?']
1165
 
    takes_options = ['revision', Option('hardlink',
1166
 
        help='Hard-link working tree files where possible.'),
 
1396
    takes_options = ['revision',
 
1397
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1398
        Option('files-from', type=str,
 
1399
               help="Get file contents from this tree."),
1167
1400
        Option('no-tree',
1168
1401
            help="Create a branch without a working-tree."),
1169
1402
        Option('switch',
1187
1420
 
1188
1421
    def run(self, from_location, to_location=None, revision=None,
1189
1422
            hardlink=False, stacked=False, standalone=False, no_tree=False,
1190
 
            use_existing_dir=False, switch=False, bind=False):
 
1423
            use_existing_dir=False, switch=False, bind=False,
 
1424
            files_from=None):
1191
1425
        from bzrlib import switch as _mod_switch
1192
1426
        from bzrlib.tag import _merge_tags_if_possible
1193
 
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
 
1427
        if self.invoked_as in ['get', 'clone']:
 
1428
            ui.ui_factory.show_user_warning(
 
1429
                'deprecated_command',
 
1430
                deprecated_name=self.invoked_as,
 
1431
                recommended_name='branch',
 
1432
                deprecated_in_version='2.4')
 
1433
        accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
1194
1434
            from_location)
 
1435
        if not (hardlink or files_from):
 
1436
            # accelerator_tree is usually slower because you have to read N
 
1437
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1438
            # explicitly request it
 
1439
            accelerator_tree = None
 
1440
        if files_from is not None and files_from != from_location:
 
1441
            accelerator_tree = WorkingTree.open(files_from)
1195
1442
        revision = _get_one_revision('branch', revision)
1196
 
        br_from.lock_read()
1197
 
        self.add_cleanup(br_from.unlock)
 
1443
        self.add_cleanup(br_from.lock_read().unlock)
1198
1444
        if revision is not None:
1199
1445
            revision_id = revision.as_revision_id(br_from)
1200
1446
        else:
1203
1449
            # RBC 20060209
1204
1450
            revision_id = br_from.last_revision()
1205
1451
        if to_location is None:
1206
 
            to_location = urlutils.derive_to_location(from_location)
 
1452
            to_location = getattr(br_from, "name", None)
 
1453
            if not to_location:
 
1454
                to_location = urlutils.derive_to_location(from_location)
1207
1455
        to_transport = transport.get_transport(to_location)
1208
1456
        try:
1209
1457
            to_transport.mkdir('.')
1210
1458
        except errors.FileExists:
1211
 
            if not use_existing_dir:
1212
 
                raise errors.BzrCommandError('Target directory "%s" '
1213
 
                    'already exists.' % to_location)
 
1459
            try:
 
1460
                to_dir = controldir.ControlDir.open_from_transport(
 
1461
                    to_transport)
 
1462
            except errors.NotBranchError:
 
1463
                if not use_existing_dir:
 
1464
                    raise errors.BzrCommandError(gettext('Target directory "%s" '
 
1465
                        'already exists.') % to_location)
 
1466
                else:
 
1467
                    to_dir = None
1214
1468
            else:
1215
1469
                try:
1216
 
                    bzrdir.BzrDir.open_from_transport(to_transport)
 
1470
                    to_dir.open_branch()
1217
1471
                except errors.NotBranchError:
1218
1472
                    pass
1219
1473
                else:
1220
1474
                    raise errors.AlreadyBranchError(to_location)
1221
1475
        except errors.NoSuchFile:
1222
 
            raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
1476
            raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
1223
1477
                                         % to_location)
1224
 
        try:
1225
 
            # preserve whatever source format we have.
1226
 
            dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
1227
 
                                        possible_transports=[to_transport],
1228
 
                                        accelerator_tree=accelerator_tree,
1229
 
                                        hardlink=hardlink, stacked=stacked,
1230
 
                                        force_new_repo=standalone,
1231
 
                                        create_tree_if_local=not no_tree,
1232
 
                                        source_branch=br_from)
1233
 
            branch = dir.open_branch()
1234
 
        except errors.NoSuchRevision:
1235
 
            to_transport.delete_tree('.')
1236
 
            msg = "The branch %s has no revision %s." % (from_location,
1237
 
                revision)
1238
 
            raise errors.BzrCommandError(msg)
 
1478
        else:
 
1479
            to_dir = None
 
1480
        if to_dir is None:
 
1481
            try:
 
1482
                # preserve whatever source format we have.
 
1483
                to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1484
                                            possible_transports=[to_transport],
 
1485
                                            accelerator_tree=accelerator_tree,
 
1486
                                            hardlink=hardlink, stacked=stacked,
 
1487
                                            force_new_repo=standalone,
 
1488
                                            create_tree_if_local=not no_tree,
 
1489
                                            source_branch=br_from)
 
1490
                branch = to_dir.open_branch(
 
1491
                    possible_transports=[
 
1492
                        br_from.bzrdir.root_transport, to_transport])
 
1493
            except errors.NoSuchRevision:
 
1494
                to_transport.delete_tree('.')
 
1495
                msg = gettext("The branch {0} has no revision {1}.").format(
 
1496
                    from_location, revision)
 
1497
                raise errors.BzrCommandError(msg)
 
1498
        else:
 
1499
            try:
 
1500
                to_repo = to_dir.open_repository()
 
1501
            except errors.NoRepositoryPresent:
 
1502
                to_repo = to_dir.create_repository()
 
1503
            to_repo.fetch(br_from.repository, revision_id=revision_id)
 
1504
            branch = br_from.sprout(to_dir, revision_id=revision_id)
1239
1505
        _merge_tags_if_possible(br_from, branch)
1240
1506
        # If the source branch is stacked, the new branch may
1241
1507
        # be stacked whether we asked for that explicitly or not.
1242
1508
        # We therefore need a try/except here and not just 'if stacked:'
1243
1509
        try:
1244
 
            note('Created new stacked branch referring to %s.' %
 
1510
            note(gettext('Created new stacked branch referring to %s.') %
1245
1511
                branch.get_stacked_on_url())
1246
1512
        except (errors.NotStacked, errors.UnstackableBranchFormat,
1247
1513
            errors.UnstackableRepositoryFormat), e:
1248
 
            note('Branched %d revision(s).' % branch.revno())
 
1514
            note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
1249
1515
        if bind:
1250
1516
            # Bind to the parent
1251
1517
            parent_branch = Branch.open(from_location)
1252
1518
            branch.bind(parent_branch)
1253
 
            note('New branch bound to %s' % from_location)
 
1519
            note(gettext('New branch bound to %s') % from_location)
1254
1520
        if switch:
1255
1521
            # Switch to the new branch
1256
1522
            wt, _ = WorkingTree.open_containing('.')
1257
1523
            _mod_switch.switch(wt.bzrdir, branch)
1258
 
            note('Switched to branch: %s',
 
1524
            note(gettext('Switched to branch: %s'),
1259
1525
                urlutils.unescape_for_display(branch.base, 'utf-8'))
1260
1526
 
1261
1527
 
 
1528
class cmd_branches(Command):
 
1529
    __doc__ = """List the branches available at the current location.
 
1530
 
 
1531
    This command will print the names of all the branches at the current
 
1532
    location.
 
1533
    """
 
1534
 
 
1535
    takes_args = ['location?']
 
1536
    takes_options = [
 
1537
                  Option('recursive', short_name='R',
 
1538
                         help='Recursively scan for branches rather than '
 
1539
                              'just looking in the specified location.')]
 
1540
 
 
1541
    def run(self, location=".", recursive=False):
 
1542
        if recursive:
 
1543
            t = transport.get_transport(location)
 
1544
            if not t.listable():
 
1545
                raise errors.BzrCommandError(
 
1546
                    "Can't scan this type of location.")
 
1547
            for b in controldir.ControlDir.find_branches(t):
 
1548
                self.outf.write("%s\n" % urlutils.unescape_for_display(
 
1549
                    urlutils.relative_url(t.base, b.base),
 
1550
                    self.outf.encoding).rstrip("/"))
 
1551
        else:
 
1552
            dir = controldir.ControlDir.open_containing(location)[0]
 
1553
            try:
 
1554
                active_branch = dir.open_branch(name="")
 
1555
            except errors.NotBranchError:
 
1556
                active_branch = None
 
1557
            names = {}
 
1558
            for name, branch in iter_sibling_branches(dir):
 
1559
                if name == "":
 
1560
                    continue
 
1561
                active = (active_branch is not None and
 
1562
                          active_branch.base == branch.base)
 
1563
                names[name] = active
 
1564
            # Only mention the current branch explicitly if it's not
 
1565
            # one of the colocated branches
 
1566
            if not any(names.values()) and active_branch is not None:
 
1567
                self.outf.write("* %s\n" % gettext("(default)"))
 
1568
            for name in sorted(names.keys()):
 
1569
                active = names[name]
 
1570
                if active:
 
1571
                    prefix = "*"
 
1572
                else:
 
1573
                    prefix = " "
 
1574
                self.outf.write("%s %s\n" % (
 
1575
                    prefix, name.encode(self.outf.encoding)))
 
1576
 
 
1577
 
1262
1578
class cmd_checkout(Command):
1263
 
    """Create a new checkout of an existing branch.
 
1579
    __doc__ = """Create a new checkout of an existing branch.
1264
1580
 
1265
1581
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1266
1582
    the branch found in '.'. This is useful if you have removed the working tree
1303
1619
        if branch_location is None:
1304
1620
            branch_location = osutils.getcwd()
1305
1621
            to_location = branch_location
1306
 
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
 
1622
        accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
1307
1623
            branch_location)
 
1624
        if not (hardlink or files_from):
 
1625
            # accelerator_tree is usually slower because you have to read N
 
1626
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1627
            # explicitly request it
 
1628
            accelerator_tree = None
1308
1629
        revision = _get_one_revision('checkout', revision)
1309
 
        if files_from is not None:
 
1630
        if files_from is not None and files_from != branch_location:
1310
1631
            accelerator_tree = WorkingTree.open(files_from)
1311
1632
        if revision is not None:
1312
1633
            revision_id = revision.as_revision_id(source)
1329
1650
 
1330
1651
 
1331
1652
class cmd_renames(Command):
1332
 
    """Show list of renamed files.
 
1653
    __doc__ = """Show list of renamed files.
1333
1654
    """
1334
1655
    # TODO: Option to show renames between two historical versions.
1335
1656
 
1340
1661
    @display_command
1341
1662
    def run(self, dir=u'.'):
1342
1663
        tree = WorkingTree.open_containing(dir)[0]
1343
 
        tree.lock_read()
1344
 
        self.add_cleanup(tree.unlock)
1345
 
        new_inv = tree.inventory
 
1664
        self.add_cleanup(tree.lock_read().unlock)
1346
1665
        old_tree = tree.basis_tree()
1347
 
        old_tree.lock_read()
1348
 
        self.add_cleanup(old_tree.unlock)
1349
 
        old_inv = old_tree.inventory
 
1666
        self.add_cleanup(old_tree.lock_read().unlock)
1350
1667
        renames = []
1351
1668
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
1352
1669
        for f, paths, c, v, p, n, k, e in iterator:
1361
1678
 
1362
1679
 
1363
1680
class cmd_update(Command):
1364
 
    """Update a tree to have the latest code committed to its branch.
1365
 
 
1366
 
    This will perform a merge into the working tree, and may generate
1367
 
    conflicts. If you have any local changes, you will still
1368
 
    need to commit them after the update for the update to be complete.
1369
 
 
1370
 
    If you want to discard your local changes, you can just do a
1371
 
    'bzr revert' instead of 'bzr commit' after the update.
1372
 
 
1373
 
    If the tree's branch is bound to a master branch, it will also update
 
1681
    __doc__ = """Update a working tree to a new revision.
 
1682
 
 
1683
    This will perform a merge of the destination revision (the tip of the
 
1684
    branch, or the specified revision) into the working tree, and then make
 
1685
    that revision the basis revision for the working tree.  
 
1686
 
 
1687
    You can use this to visit an older revision, or to update a working tree
 
1688
    that is out of date from its branch.
 
1689
    
 
1690
    If there are any uncommitted changes in the tree, they will be carried
 
1691
    across and remain as uncommitted changes after the update.  To discard
 
1692
    these changes, use 'bzr revert'.  The uncommitted changes may conflict
 
1693
    with the changes brought in by the change in basis revision.
 
1694
 
 
1695
    If the tree's branch is bound to a master branch, bzr will also update
1374
1696
    the branch from the master.
 
1697
 
 
1698
    You cannot update just a single file or directory, because each Bazaar
 
1699
    working tree has just a single basis revision.  If you want to restore a
 
1700
    file that has been removed locally, use 'bzr revert' instead of 'bzr
 
1701
    update'.  If you want to restore a file to its state in a previous
 
1702
    revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
 
1703
    out the old content of that file to a new location.
 
1704
 
 
1705
    The 'dir' argument, if given, must be the location of the root of a
 
1706
    working tree to update.  By default, the working tree that contains the 
 
1707
    current working directory is used.
1375
1708
    """
1376
1709
 
1377
1710
    _see_also = ['pull', 'working-trees', 'status-flags']
1378
1711
    takes_args = ['dir?']
1379
 
    takes_options = ['revision']
 
1712
    takes_options = ['revision',
 
1713
                     Option('show-base',
 
1714
                            help="Show base revision text in conflicts."),
 
1715
                     ]
1380
1716
    aliases = ['up']
1381
1717
 
1382
 
    def run(self, dir='.', revision=None):
 
1718
    def run(self, dir=None, revision=None, show_base=None):
1383
1719
        if revision is not None and len(revision) != 1:
1384
 
            raise errors.BzrCommandError(
1385
 
                        "bzr update --revision takes exactly one revision")
1386
 
        tree = WorkingTree.open_containing(dir)[0]
 
1720
            raise errors.BzrCommandError(gettext(
 
1721
                "bzr update --revision takes exactly one revision"))
 
1722
        if dir is None:
 
1723
            tree = WorkingTree.open_containing('.')[0]
 
1724
        else:
 
1725
            tree, relpath = WorkingTree.open_containing(dir)
 
1726
            if relpath:
 
1727
                # See bug 557886.
 
1728
                raise errors.BzrCommandError(gettext(
 
1729
                    "bzr update can only update a whole tree, "
 
1730
                    "not a file or subdirectory"))
1387
1731
        branch = tree.branch
1388
1732
        possible_transports = []
1389
1733
        master = branch.get_master_branch(
1390
1734
            possible_transports=possible_transports)
1391
1735
        if master is not None:
1392
 
            tree.lock_write()
1393
1736
            branch_location = master.base
 
1737
            tree.lock_write()
1394
1738
        else:
 
1739
            branch_location = tree.branch.base
1395
1740
            tree.lock_tree_write()
1396
 
            branch_location = tree.branch.base
1397
1741
        self.add_cleanup(tree.unlock)
1398
1742
        # get rid of the final '/' and be ready for display
1399
 
        branch_location = urlutils.unescape_for_display(branch_location[:-1],
1400
 
                                                        self.outf.encoding)
 
1743
        branch_location = urlutils.unescape_for_display(
 
1744
            branch_location.rstrip('/'),
 
1745
            self.outf.encoding)
1401
1746
        existing_pending_merges = tree.get_parent_ids()[1:]
1402
1747
        if master is None:
1403
1748
            old_tip = None
1411
1756
        else:
1412
1757
            revision_id = branch.last_revision()
1413
1758
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
1414
 
            revno = branch.revision_id_to_revno(revision_id)
1415
 
            note("Tree is up to date at revision %d of branch %s" %
1416
 
                (revno, branch_location))
 
1759
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1760
            note(gettext("Tree is up to date at revision {0} of branch {1}"
 
1761
                        ).format('.'.join(map(str, revno)), branch_location))
1417
1762
            return 0
1418
1763
        view_info = _get_view_info_for_change_reporter(tree)
1419
1764
        change_reporter = delta._ChangeReporter(
1424
1769
                change_reporter,
1425
1770
                possible_transports=possible_transports,
1426
1771
                revision=revision_id,
1427
 
                old_tip=old_tip)
 
1772
                old_tip=old_tip,
 
1773
                show_base=show_base)
1428
1774
        except errors.NoSuchRevision, e:
1429
 
            raise errors.BzrCommandError(
 
1775
            raise errors.BzrCommandError(gettext(
1430
1776
                                  "branch has no revision %s\n"
1431
1777
                                  "bzr update --revision only works"
1432
 
                                  " for a revision in the branch history"
 
1778
                                  " for a revision in the branch history")
1433
1779
                                  % (e.revision))
1434
 
        revno = tree.branch.revision_id_to_revno(
 
1780
        revno = tree.branch.revision_id_to_dotted_revno(
1435
1781
            _mod_revision.ensure_null(tree.last_revision()))
1436
 
        note('Updated to revision %d of branch %s' %
1437
 
             (revno, branch_location))
1438
 
        if tree.get_parent_ids()[1:] != existing_pending_merges:
1439
 
            note('Your local commits will now show as pending merges with '
1440
 
                 "'bzr status', and can be committed with 'bzr commit'.")
 
1782
        note(gettext('Updated to revision {0} of branch {1}').format(
 
1783
             '.'.join(map(str, revno)), branch_location))
 
1784
        parent_ids = tree.get_parent_ids()
 
1785
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1786
            note(gettext('Your local commits will now show as pending merges with '
 
1787
                 "'bzr status', and can be committed with 'bzr commit'."))
1441
1788
        if conflicts != 0:
1442
1789
            return 1
1443
1790
        else:
1445
1792
 
1446
1793
 
1447
1794
class cmd_info(Command):
1448
 
    """Show information about a working tree, branch or repository.
 
1795
    __doc__ = """Show information about a working tree, branch or repository.
1449
1796
 
1450
1797
    This command will show all known locations and formats associated to the
1451
1798
    tree, branch or repository.
1484
1831
        else:
1485
1832
            noise_level = 0
1486
1833
        from bzrlib.info import show_bzrdir_info
1487
 
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
1834
        show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
1488
1835
                         verbose=noise_level, outfile=self.outf)
1489
1836
 
1490
1837
 
1491
1838
class cmd_remove(Command):
1492
 
    """Remove files or directories.
 
1839
    __doc__ = """Remove files or directories.
1493
1840
 
1494
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1495
 
    them if they can easily be recovered using revert. If no options or
1496
 
    parameters are given bzr will scan for files that are being tracked by bzr
1497
 
    but missing in your tree and stop tracking them for you.
 
1841
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1842
    delete them if they can easily be recovered using revert otherwise they
 
1843
    will be backed up (adding an extention of the form .~#~). If no options or
 
1844
    parameters are given Bazaar will scan for files that are being tracked by
 
1845
    Bazaar but missing in your tree and stop tracking them for you.
1498
1846
    """
1499
1847
    takes_args = ['file*']
1500
1848
    takes_options = ['verbose',
1502
1850
        RegistryOption.from_kwargs('file-deletion-strategy',
1503
1851
            'The file deletion mode to be used.',
1504
1852
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1505
 
            safe='Only delete files if they can be'
1506
 
                 ' safely recovered (default).',
 
1853
            safe='Backup changed files (default).',
1507
1854
            keep='Delete from bzr but leave the working copy.',
 
1855
            no_backup='Don\'t backup changed files.',
1508
1856
            force='Delete all the specified files, even if they can not be '
1509
 
                'recovered and even if they are non-empty directories.')]
 
1857
                'recovered and even if they are non-empty directories. '
 
1858
                '(deprecated, use no-backup)')]
1510
1859
    aliases = ['rm', 'del']
1511
1860
    encoding_type = 'replace'
1512
1861
 
1513
1862
    def run(self, file_list, verbose=False, new=False,
1514
1863
        file_deletion_strategy='safe'):
1515
 
        tree, file_list = tree_files(file_list)
 
1864
        if file_deletion_strategy == 'force':
 
1865
            note(gettext("(The --force option is deprecated, rather use --no-backup "
 
1866
                "in future.)"))
 
1867
            file_deletion_strategy = 'no-backup'
 
1868
 
 
1869
        tree, file_list = WorkingTree.open_containing_paths(file_list)
1516
1870
 
1517
1871
        if file_list is not None:
1518
1872
            file_list = [f for f in file_list]
1519
1873
 
1520
 
        tree.lock_write()
1521
 
        self.add_cleanup(tree.unlock)
 
1874
        self.add_cleanup(tree.lock_write().unlock)
1522
1875
        # Heuristics should probably all move into tree.remove_smart or
1523
1876
        # some such?
1524
1877
        if new:
1526
1879
                specific_files=file_list).added
1527
1880
            file_list = sorted([f[0] for f in added], reverse=True)
1528
1881
            if len(file_list) == 0:
1529
 
                raise errors.BzrCommandError('No matching files.')
 
1882
                raise errors.BzrCommandError(gettext('No matching files.'))
1530
1883
        elif file_list is None:
1531
1884
            # missing files show up in iter_changes(basis) as
1532
1885
            # versioned-with-no-kind.
1539
1892
            file_deletion_strategy = 'keep'
1540
1893
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1541
1894
            keep_files=file_deletion_strategy=='keep',
1542
 
            force=file_deletion_strategy=='force')
 
1895
            force=(file_deletion_strategy=='no-backup'))
1543
1896
 
1544
1897
 
1545
1898
class cmd_file_id(Command):
1546
 
    """Print file_id of a particular file or directory.
 
1899
    __doc__ = """Print file_id of a particular file or directory.
1547
1900
 
1548
1901
    The file_id is assigned when the file is first added and remains the
1549
1902
    same through all revisions where the file exists, even when it is
1565
1918
 
1566
1919
 
1567
1920
class cmd_file_path(Command):
1568
 
    """Print path of file_ids to a file or directory.
 
1921
    __doc__ = """Print path of file_ids to a file or directory.
1569
1922
 
1570
1923
    This prints one line for each directory down to the target,
1571
1924
    starting at the branch root.
1587
1940
 
1588
1941
 
1589
1942
class cmd_reconcile(Command):
1590
 
    """Reconcile bzr metadata in a branch.
 
1943
    __doc__ = """Reconcile bzr metadata in a branch.
1591
1944
 
1592
1945
    This can correct data mismatches that may have been caused by
1593
1946
    previous ghost operations or bzr upgrades. You should only
1607
1960
 
1608
1961
    _see_also = ['check']
1609
1962
    takes_args = ['branch?']
 
1963
    takes_options = [
 
1964
        Option('canonicalize-chks',
 
1965
               help='Make sure CHKs are in canonical form (repairs '
 
1966
                    'bug 522637).',
 
1967
               hidden=True),
 
1968
        ]
1610
1969
 
1611
 
    def run(self, branch="."):
 
1970
    def run(self, branch=".", canonicalize_chks=False):
1612
1971
        from bzrlib.reconcile import reconcile
1613
 
        dir = bzrdir.BzrDir.open(branch)
1614
 
        reconcile(dir)
 
1972
        dir = controldir.ControlDir.open(branch)
 
1973
        reconcile(dir, canonicalize_chks=canonicalize_chks)
1615
1974
 
1616
1975
 
1617
1976
class cmd_revision_history(Command):
1618
 
    """Display the list of revision ids on a branch."""
 
1977
    __doc__ = """Display the list of revision ids on a branch."""
1619
1978
 
1620
1979
    _see_also = ['log']
1621
1980
    takes_args = ['location?']
1625
1984
    @display_command
1626
1985
    def run(self, location="."):
1627
1986
        branch = Branch.open_containing(location)[0]
1628
 
        for revid in branch.revision_history():
 
1987
        self.add_cleanup(branch.lock_read().unlock)
 
1988
        graph = branch.repository.get_graph()
 
1989
        history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
 
1990
            [_mod_revision.NULL_REVISION]))
 
1991
        for revid in reversed(history):
1629
1992
            self.outf.write(revid)
1630
1993
            self.outf.write('\n')
1631
1994
 
1632
1995
 
1633
1996
class cmd_ancestry(Command):
1634
 
    """List all revisions merged into this branch."""
 
1997
    __doc__ = """List all revisions merged into this branch."""
1635
1998
 
1636
1999
    _see_also = ['log', 'revision-history']
1637
2000
    takes_args = ['location?']
1649
2012
            b = wt.branch
1650
2013
            last_revision = wt.last_revision()
1651
2014
 
1652
 
        revision_ids = b.repository.get_ancestry(last_revision)
1653
 
        revision_ids.pop(0)
1654
 
        for revision_id in revision_ids:
 
2015
        self.add_cleanup(b.repository.lock_read().unlock)
 
2016
        graph = b.repository.get_graph()
 
2017
        revisions = [revid for revid, parents in
 
2018
            graph.iter_ancestry([last_revision])]
 
2019
        for revision_id in reversed(revisions):
 
2020
            if _mod_revision.is_null(revision_id):
 
2021
                continue
1655
2022
            self.outf.write(revision_id + '\n')
1656
2023
 
1657
2024
 
1658
2025
class cmd_init(Command):
1659
 
    """Make a directory into a versioned branch.
 
2026
    __doc__ = """Make a directory into a versioned branch.
1660
2027
 
1661
2028
    Use this to create an empty branch, or before importing an
1662
2029
    existing project.
1687
2054
         RegistryOption('format',
1688
2055
                help='Specify a format for this branch. '
1689
2056
                'See "help formats".',
1690
 
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1691
 
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2057
                lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2058
                converter=lambda name: controldir.format_registry.make_bzrdir(name),
1692
2059
                value_switches=True,
1693
2060
                title="Branch format",
1694
2061
                ),
1695
2062
         Option('append-revisions-only',
1696
2063
                help='Never change revnos or the existing log.'
1697
 
                '  Append revisions to it only.')
 
2064
                '  Append revisions to it only.'),
 
2065
         Option('no-tree',
 
2066
                'Create a branch without a working tree.')
1698
2067
         ]
1699
2068
    def run(self, location=None, format=None, append_revisions_only=False,
1700
 
            create_prefix=False):
 
2069
            create_prefix=False, no_tree=False):
1701
2070
        if format is None:
1702
 
            format = bzrdir.format_registry.make_bzrdir('default')
 
2071
            format = controldir.format_registry.make_bzrdir('default')
1703
2072
        if location is None:
1704
2073
            location = u'.'
1705
2074
 
1714
2083
            to_transport.ensure_base()
1715
2084
        except errors.NoSuchFile:
1716
2085
            if not create_prefix:
1717
 
                raise errors.BzrCommandError("Parent directory of %s"
 
2086
                raise errors.BzrCommandError(gettext("Parent directory of %s"
1718
2087
                    " does not exist."
1719
2088
                    "\nYou may supply --create-prefix to create all"
1720
 
                    " leading parent directories."
 
2089
                    " leading parent directories.")
1721
2090
                    % location)
1722
2091
            to_transport.create_prefix()
1723
2092
 
1724
2093
        try:
1725
 
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
2094
            a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
1726
2095
        except errors.NotBranchError:
1727
2096
            # really a NotBzrDir error...
1728
 
            create_branch = bzrdir.BzrDir.create_branch_convenience
 
2097
            create_branch = controldir.ControlDir.create_branch_convenience
 
2098
            if no_tree:
 
2099
                force_new_tree = False
 
2100
            else:
 
2101
                force_new_tree = None
1729
2102
            branch = create_branch(to_transport.base, format=format,
1730
 
                                   possible_transports=[to_transport])
 
2103
                                   possible_transports=[to_transport],
 
2104
                                   force_new_tree=force_new_tree)
1731
2105
            a_bzrdir = branch.bzrdir
1732
2106
        else:
1733
2107
            from bzrlib.transport.local import LocalTransport
1737
2111
                        raise errors.BranchExistsWithoutWorkingTree(location)
1738
2112
                raise errors.AlreadyBranchError(location)
1739
2113
            branch = a_bzrdir.create_branch()
1740
 
            a_bzrdir.create_workingtree()
 
2114
            if not no_tree and not a_bzrdir.has_workingtree():
 
2115
                a_bzrdir.create_workingtree()
1741
2116
        if append_revisions_only:
1742
2117
            try:
1743
2118
                branch.set_append_revisions_only(True)
1744
2119
            except errors.UpgradeRequired:
1745
 
                raise errors.BzrCommandError('This branch format cannot be set'
1746
 
                    ' to append-revisions-only.  Try --default.')
 
2120
                raise errors.BzrCommandError(gettext('This branch format cannot be set'
 
2121
                    ' to append-revisions-only.  Try --default.'))
1747
2122
        if not is_quiet():
1748
2123
            from bzrlib.info import describe_layout, describe_format
1749
2124
            try:
1753
2128
            repository = branch.repository
1754
2129
            layout = describe_layout(repository, branch, tree).lower()
1755
2130
            format = describe_format(a_bzrdir, repository, branch, tree)
1756
 
            self.outf.write("Created a %s (format: %s)\n" % (layout, format))
 
2131
            self.outf.write(gettext("Created a {0} (format: {1})\n").format(
 
2132
                  layout, format))
1757
2133
            if repository.is_shared():
1758
2134
                #XXX: maybe this can be refactored into transport.path_or_url()
1759
2135
                url = repository.bzrdir.root_transport.external_url()
1761
2137
                    url = urlutils.local_path_from_url(url)
1762
2138
                except errors.InvalidURL:
1763
2139
                    pass
1764
 
                self.outf.write("Using shared repository: %s\n" % url)
 
2140
                self.outf.write(gettext("Using shared repository: %s\n") % url)
1765
2141
 
1766
2142
 
1767
2143
class cmd_init_repository(Command):
1768
 
    """Create a shared repository for branches to share storage space.
 
2144
    __doc__ = """Create a shared repository for branches to share storage space.
1769
2145
 
1770
2146
    New branches created under the repository directory will store their
1771
2147
    revisions in the repository, not in the branch directory.  For branches
1797
2173
    takes_options = [RegistryOption('format',
1798
2174
                            help='Specify a format for this repository. See'
1799
2175
                                 ' "bzr help formats" for details.',
1800
 
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1801
 
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2176
                            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2177
                            converter=lambda name: controldir.format_registry.make_bzrdir(name),
1802
2178
                            value_switches=True, title='Repository format'),
1803
2179
                     Option('no-trees',
1804
2180
                             help='Branches in the repository will default to'
1808
2184
 
1809
2185
    def run(self, location, format=None, no_trees=False):
1810
2186
        if format is None:
1811
 
            format = bzrdir.format_registry.make_bzrdir('default')
 
2187
            format = controldir.format_registry.make_bzrdir('default')
1812
2188
 
1813
2189
        if location is None:
1814
2190
            location = '.'
1815
2191
 
1816
2192
        to_transport = transport.get_transport(location)
1817
 
        to_transport.ensure_base()
1818
2193
 
1819
 
        newdir = format.initialize_on_transport(to_transport)
1820
 
        repo = newdir.create_repository(shared=True)
1821
 
        repo.set_make_working_trees(not no_trees)
 
2194
        (repo, newdir, require_stacking, repository_policy) = (
 
2195
            format.initialize_on_transport_ex(to_transport,
 
2196
            create_prefix=True, make_working_trees=not no_trees,
 
2197
            shared_repo=True, force_new_repo=True,
 
2198
            use_existing_dir=True,
 
2199
            repo_format_name=format.repository_format.get_format_string()))
1822
2200
        if not is_quiet():
1823
2201
            from bzrlib.info import show_bzrdir_info
1824
 
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
 
2202
            show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
1825
2203
 
1826
2204
 
1827
2205
class cmd_diff(Command):
1828
 
    """Show differences in the working tree, between revisions or branches.
 
2206
    __doc__ = """Show differences in the working tree, between revisions or branches.
1829
2207
 
1830
2208
    If no arguments are given, all changes for the current tree are listed.
1831
2209
    If files are given, only the changes in those files are listed.
1837
2215
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1838
2216
    produces patches suitable for "patch -p1".
1839
2217
 
 
2218
    Note that when using the -r argument with a range of revisions, the
 
2219
    differences are computed between the two specified revisions.  That
 
2220
    is, the command does not show the changes introduced by the first 
 
2221
    revision in the range.  This differs from the interpretation of 
 
2222
    revision ranges used by "bzr log" which includes the first revision
 
2223
    in the range.
 
2224
 
1840
2225
    :Exit values:
1841
2226
        1 - changed
1842
2227
        2 - unrepresentable changes
1860
2245
 
1861
2246
            bzr diff -r1..3 xxx
1862
2247
 
1863
 
        To see the changes introduced in revision X::
 
2248
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
2249
 
 
2250
            bzr diff -c2
 
2251
 
 
2252
        To see the changes introduced by revision X::
1864
2253
        
1865
2254
            bzr diff -cX
1866
2255
 
1870
2259
 
1871
2260
            bzr diff -r<chosen_parent>..X
1872
2261
 
1873
 
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
2262
        The changes between the current revision and the previous revision
 
2263
        (equivalent to -c-1 and -r-2..-1)
1874
2264
 
1875
 
            bzr diff -c2
 
2265
            bzr diff -r-2..
1876
2266
 
1877
2267
        Show just the differences for file NEWS::
1878
2268
 
1893
2283
        Same as 'bzr diff' but prefix paths with old/ and new/::
1894
2284
 
1895
2285
            bzr diff --prefix old/:new/
 
2286
            
 
2287
        Show the differences using a custom diff program with options::
 
2288
        
 
2289
            bzr diff --using /usr/bin/diff --diff-options -wu
1896
2290
    """
1897
2291
    _see_also = ['status']
1898
2292
    takes_args = ['file*']
1917
2311
            help='Use this command to compare files.',
1918
2312
            type=unicode,
1919
2313
            ),
 
2314
        RegistryOption('format',
 
2315
            short_name='F',
 
2316
            help='Diff format to use.',
 
2317
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
2318
            title='Diff format'),
1920
2319
        ]
1921
2320
    aliases = ['di', 'dif']
1922
2321
    encoding_type = 'exact'
1923
2322
 
1924
2323
    @display_command
1925
2324
    def run(self, revision=None, file_list=None, diff_options=None,
1926
 
            prefix=None, old=None, new=None, using=None):
1927
 
        from bzrlib.diff import get_trees_and_branches_to_diff, show_diff_trees
 
2325
            prefix=None, old=None, new=None, using=None, format=None):
 
2326
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
2327
            show_diff_trees)
1928
2328
 
1929
2329
        if (prefix is None) or (prefix == '0'):
1930
2330
            # diff -p0 format
1936
2336
        elif ':' in prefix:
1937
2337
            old_label, new_label = prefix.split(":")
1938
2338
        else:
1939
 
            raise errors.BzrCommandError(
 
2339
            raise errors.BzrCommandError(gettext(
1940
2340
                '--prefix expects two values separated by a colon'
1941
 
                ' (eg "old/:new/")')
 
2341
                ' (eg "old/:new/")'))
1942
2342
 
1943
2343
        if revision and len(revision) > 2:
1944
 
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1945
 
                                         ' one or two revision specifiers')
 
2344
            raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
 
2345
                                         ' one or two revision specifiers'))
 
2346
 
 
2347
        if using is not None and format is not None:
 
2348
            raise errors.BzrCommandError(gettext(
 
2349
                '{0} and {1} are mutually exclusive').format(
 
2350
                '--using', '--format'))
1946
2351
 
1947
2352
        (old_tree, new_tree,
1948
2353
         old_branch, new_branch,
1949
 
         specific_files, extra_trees) = get_trees_and_branches_to_diff(
1950
 
            file_list, revision, old, new, apply_view=True)
 
2354
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
2355
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2356
        # GNU diff on Windows uses ANSI encoding for filenames
 
2357
        path_encoding = osutils.get_diff_header_encoding()
1951
2358
        return show_diff_trees(old_tree, new_tree, sys.stdout,
1952
2359
                               specific_files=specific_files,
1953
2360
                               external_diff_options=diff_options,
1954
2361
                               old_label=old_label, new_label=new_label,
1955
 
                               extra_trees=extra_trees, using=using)
 
2362
                               extra_trees=extra_trees,
 
2363
                               path_encoding=path_encoding,
 
2364
                               using=using,
 
2365
                               format_cls=format)
1956
2366
 
1957
2367
 
1958
2368
class cmd_deleted(Command):
1959
 
    """List files deleted in the working tree.
 
2369
    __doc__ = """List files deleted in the working tree.
1960
2370
    """
1961
2371
    # TODO: Show files deleted since a previous revision, or
1962
2372
    # between two revisions.
1965
2375
    # level of effort but possibly much less IO.  (Or possibly not,
1966
2376
    # if the directories are very large...)
1967
2377
    _see_also = ['status', 'ls']
1968
 
    takes_options = ['show-ids']
 
2378
    takes_options = ['directory', 'show-ids']
1969
2379
 
1970
2380
    @display_command
1971
 
    def run(self, show_ids=False):
1972
 
        tree = WorkingTree.open_containing(u'.')[0]
1973
 
        tree.lock_read()
1974
 
        self.add_cleanup(tree.unlock)
 
2381
    def run(self, show_ids=False, directory=u'.'):
 
2382
        tree = WorkingTree.open_containing(directory)[0]
 
2383
        self.add_cleanup(tree.lock_read().unlock)
1975
2384
        old = tree.basis_tree()
1976
 
        old.lock_read()
1977
 
        self.add_cleanup(old.unlock)
1978
 
        for path, ie in old.inventory.iter_entries():
 
2385
        self.add_cleanup(old.lock_read().unlock)
 
2386
        for path, ie in old.iter_entries_by_dir():
1979
2387
            if not tree.has_id(ie.file_id):
1980
2388
                self.outf.write(path)
1981
2389
                if show_ids:
1985
2393
 
1986
2394
 
1987
2395
class cmd_modified(Command):
1988
 
    """List files modified in working tree.
 
2396
    __doc__ = """List files modified in working tree.
1989
2397
    """
1990
2398
 
1991
2399
    hidden = True
1992
2400
    _see_also = ['status', 'ls']
1993
 
    takes_options = [
1994
 
            Option('null',
1995
 
                   help='Write an ascii NUL (\\0) separator '
1996
 
                   'between files rather than a newline.')
1997
 
            ]
 
2401
    takes_options = ['directory', 'null']
1998
2402
 
1999
2403
    @display_command
2000
 
    def run(self, null=False):
2001
 
        tree = WorkingTree.open_containing(u'.')[0]
 
2404
    def run(self, null=False, directory=u'.'):
 
2405
        tree = WorkingTree.open_containing(directory)[0]
 
2406
        self.add_cleanup(tree.lock_read().unlock)
2002
2407
        td = tree.changes_from(tree.basis_tree())
 
2408
        self.cleanup_now()
2003
2409
        for path, id, kind, text_modified, meta_modified in td.modified:
2004
2410
            if null:
2005
2411
                self.outf.write(path + '\0')
2008
2414
 
2009
2415
 
2010
2416
class cmd_added(Command):
2011
 
    """List files added in working tree.
 
2417
    __doc__ = """List files added in working tree.
2012
2418
    """
2013
2419
 
2014
2420
    hidden = True
2015
2421
    _see_also = ['status', 'ls']
2016
 
    takes_options = [
2017
 
            Option('null',
2018
 
                   help='Write an ascii NUL (\\0) separator '
2019
 
                   'between files rather than a newline.')
2020
 
            ]
 
2422
    takes_options = ['directory', 'null']
2021
2423
 
2022
2424
    @display_command
2023
 
    def run(self, null=False):
2024
 
        wt = WorkingTree.open_containing(u'.')[0]
2025
 
        wt.lock_read()
2026
 
        self.add_cleanup(wt.unlock)
 
2425
    def run(self, null=False, directory=u'.'):
 
2426
        wt = WorkingTree.open_containing(directory)[0]
 
2427
        self.add_cleanup(wt.lock_read().unlock)
2027
2428
        basis = wt.basis_tree()
2028
 
        basis.lock_read()
2029
 
        self.add_cleanup(basis.unlock)
2030
 
        basis_inv = basis.inventory
2031
 
        inv = wt.inventory
2032
 
        for file_id in inv:
2033
 
            if file_id in basis_inv:
2034
 
                continue
2035
 
            if inv.is_root(file_id) and len(basis_inv) == 0:
2036
 
                continue
2037
 
            path = inv.id2path(file_id)
2038
 
            if not os.access(osutils.abspath(path), os.F_OK):
 
2429
        self.add_cleanup(basis.lock_read().unlock)
 
2430
        root_id = wt.get_root_id()
 
2431
        for file_id in wt.all_file_ids():
 
2432
            if basis.has_id(file_id):
 
2433
                continue
 
2434
            if root_id == file_id:
 
2435
                continue
 
2436
            path = wt.id2path(file_id)
 
2437
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
2039
2438
                continue
2040
2439
            if null:
2041
2440
                self.outf.write(path + '\0')
2044
2443
 
2045
2444
 
2046
2445
class cmd_root(Command):
2047
 
    """Show the tree root directory.
 
2446
    __doc__ = """Show the tree root directory.
2048
2447
 
2049
2448
    The root is the nearest enclosing directory with a .bzr control
2050
2449
    directory."""
2061
2460
    try:
2062
2461
        return int(limitstring)
2063
2462
    except ValueError:
2064
 
        msg = "The limit argument must be an integer."
 
2463
        msg = gettext("The limit argument must be an integer.")
2065
2464
        raise errors.BzrCommandError(msg)
2066
2465
 
2067
2466
 
2069
2468
    try:
2070
2469
        return int(s)
2071
2470
    except ValueError:
2072
 
        msg = "The levels argument must be an integer."
 
2471
        msg = gettext("The levels argument must be an integer.")
2073
2472
        raise errors.BzrCommandError(msg)
2074
2473
 
2075
2474
 
2076
2475
class cmd_log(Command):
2077
 
    """Show historical log for a branch or subset of a branch.
 
2476
    __doc__ = """Show historical log for a branch or subset of a branch.
2078
2477
 
2079
2478
    log is bzr's default tool for exploring the history of a branch.
2080
2479
    The branch to use is taken from the first parameter. If no parameters
2185
2584
 
2186
2585
    :Other filtering:
2187
2586
 
2188
 
      The --message option can be used for finding revisions that match a
2189
 
      regular expression in a commit message.
 
2587
      The --match option can be used for finding revisions that match a
 
2588
      regular expression in a commit message, committer, author or bug.
 
2589
      Specifying the option several times will match any of the supplied
 
2590
      expressions. --match-author, --match-bugs, --match-committer and
 
2591
      --match-message can be used to only match a specific field.
2190
2592
 
2191
2593
    :Tips & tricks:
2192
2594
 
2193
2595
      GUI tools and IDEs are often better at exploring history than command
2194
 
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
2195
 
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
2196
 
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
2197
 
 
2198
 
      Web interfaces are often better at exploring history than command line
2199
 
      tools, particularly for branches on servers. You may prefer Loggerhead
2200
 
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2596
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2597
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2598
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2599
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
2201
2600
 
2202
2601
      You may find it useful to add the aliases below to ``bazaar.conf``::
2203
2602
 
2244
2643
                   help='Show just the specified revision.'
2245
2644
                   ' See also "help revisionspec".'),
2246
2645
            'log-format',
 
2646
            RegistryOption('authors',
 
2647
                'What names to list as authors - first, all or committer.',
 
2648
                title='Authors',
 
2649
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2650
            ),
2247
2651
            Option('levels',
2248
2652
                   short_name='n',
2249
2653
                   help='Number of levels to display - 0 for all, 1 for flat.',
2250
2654
                   argname='N',
2251
2655
                   type=_parse_levels),
2252
2656
            Option('message',
2253
 
                   short_name='m',
2254
2657
                   help='Show revisions whose message matches this '
2255
2658
                        'regular expression.',
2256
 
                   type=str),
 
2659
                   type=str,
 
2660
                   hidden=True),
2257
2661
            Option('limit',
2258
2662
                   short_name='l',
2259
2663
                   help='Limit the output to the first N revisions.',
2262
2666
            Option('show-diff',
2263
2667
                   short_name='p',
2264
2668
                   help='Show changes made in each revision as a patch.'),
2265
 
            Option('include-merges',
 
2669
            Option('include-merged',
2266
2670
                   help='Show merged revisions like --levels 0 does.'),
 
2671
            Option('include-merges', hidden=True,
 
2672
                   help='Historical alias for --include-merged.'),
 
2673
            Option('omit-merges',
 
2674
                   help='Do not report commits with more than one parent.'),
 
2675
            Option('exclude-common-ancestry',
 
2676
                   help='Display only the revisions that are not part'
 
2677
                   ' of both ancestries (require -rX..Y).'
 
2678
                   ),
 
2679
            Option('signatures',
 
2680
                   help='Show digital signature validity.'),
 
2681
            ListOption('match',
 
2682
                short_name='m',
 
2683
                help='Show revisions whose properties match this '
 
2684
                'expression.',
 
2685
                type=str),
 
2686
            ListOption('match-message',
 
2687
                   help='Show revisions whose message matches this '
 
2688
                   'expression.',
 
2689
                type=str),
 
2690
            ListOption('match-committer',
 
2691
                   help='Show revisions whose committer matches this '
 
2692
                   'expression.',
 
2693
                type=str),
 
2694
            ListOption('match-author',
 
2695
                   help='Show revisions whose authors match this '
 
2696
                   'expression.',
 
2697
                type=str),
 
2698
            ListOption('match-bugs',
 
2699
                   help='Show revisions whose bugs match this '
 
2700
                   'expression.',
 
2701
                type=str)
2267
2702
            ]
2268
2703
    encoding_type = 'replace'
2269
2704
 
2279
2714
            message=None,
2280
2715
            limit=None,
2281
2716
            show_diff=False,
2282
 
            include_merges=False):
 
2717
            include_merged=None,
 
2718
            authors=None,
 
2719
            exclude_common_ancestry=False,
 
2720
            signatures=False,
 
2721
            match=None,
 
2722
            match_message=None,
 
2723
            match_committer=None,
 
2724
            match_author=None,
 
2725
            match_bugs=None,
 
2726
            omit_merges=False,
 
2727
            include_merges=symbol_versioning.DEPRECATED_PARAMETER,
 
2728
            ):
2283
2729
        from bzrlib.log import (
2284
2730
            Logger,
2285
2731
            make_log_request_dict,
2286
2732
            _get_info_for_log_files,
2287
2733
            )
2288
2734
        direction = (forward and 'forward') or 'reverse'
2289
 
        if include_merges:
 
2735
        if symbol_versioning.deprecated_passed(include_merges):
 
2736
            ui.ui_factory.show_user_warning(
 
2737
                'deprecated_command_option',
 
2738
                deprecated_name='--include-merges',
 
2739
                recommended_name='--include-merged',
 
2740
                deprecated_in_version='2.5',
 
2741
                command=self.invoked_as)
 
2742
            if include_merged is None:
 
2743
                include_merged = include_merges
 
2744
            else:
 
2745
                raise errors.BzrCommandError(gettext(
 
2746
                    '{0} and {1} are mutually exclusive').format(
 
2747
                    '--include-merges', '--include-merged'))
 
2748
        if include_merged is None:
 
2749
            include_merged = False
 
2750
        if (exclude_common_ancestry
 
2751
            and (revision is None or len(revision) != 2)):
 
2752
            raise errors.BzrCommandError(gettext(
 
2753
                '--exclude-common-ancestry requires -r with two revisions'))
 
2754
        if include_merged:
2290
2755
            if levels is None:
2291
2756
                levels = 0
2292
2757
            else:
2293
 
                raise errors.BzrCommandError(
2294
 
                    '--levels and --include-merges are mutually exclusive')
 
2758
                raise errors.BzrCommandError(gettext(
 
2759
                    '{0} and {1} are mutually exclusive').format(
 
2760
                    '--levels', '--include-merged'))
2295
2761
 
2296
2762
        if change is not None:
2297
2763
            if len(change) > 1:
2298
2764
                raise errors.RangeInChangeOption()
2299
2765
            if revision is not None:
2300
 
                raise errors.BzrCommandError(
2301
 
                    '--revision and --change are mutually exclusive')
 
2766
                raise errors.BzrCommandError(gettext(
 
2767
                    '{0} and {1} are mutually exclusive').format(
 
2768
                    '--revision', '--change'))
2302
2769
            else:
2303
2770
                revision = change
2304
2771
 
2307
2774
        if file_list:
2308
2775
            # find the file ids to log and check for directory filtering
2309
2776
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
2310
 
                revision, file_list)
2311
 
            self.add_cleanup(b.unlock)
 
2777
                revision, file_list, self.add_cleanup)
2312
2778
            for relpath, file_id, kind in file_info_list:
2313
2779
                if file_id is None:
2314
 
                    raise errors.BzrCommandError(
2315
 
                        "Path unknown at end or start of revision range: %s" %
 
2780
                    raise errors.BzrCommandError(gettext(
 
2781
                        "Path unknown at end or start of revision range: %s") %
2316
2782
                        relpath)
2317
2783
                # If the relpath is the top of the tree, we log everything
2318
2784
                if relpath == '':
2330
2796
                location = revision[0].get_branch()
2331
2797
            else:
2332
2798
                location = '.'
2333
 
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2799
            dir, relpath = controldir.ControlDir.open_containing(location)
2334
2800
            b = dir.open_branch()
2335
 
            b.lock_read()
2336
 
            self.add_cleanup(b.unlock)
 
2801
            self.add_cleanup(b.lock_read().unlock)
2337
2802
            rev1, rev2 = _get_revision_range(revision, b, self.name())
2338
2803
 
 
2804
        if b.get_config_stack().get('validate_signatures_in_log'):
 
2805
            signatures = True
 
2806
 
 
2807
        if signatures:
 
2808
            if not gpg.GPGStrategy.verify_signatures_available():
 
2809
                raise errors.GpgmeNotInstalled(None)
 
2810
 
2339
2811
        # Decide on the type of delta & diff filtering to use
2340
2812
        # TODO: add an --all-files option to make this configurable & consistent
2341
2813
        if not verbose:
2359
2831
                        show_timezone=timezone,
2360
2832
                        delta_format=get_verbosity_level(),
2361
2833
                        levels=levels,
2362
 
                        show_advice=levels is None)
 
2834
                        show_advice=levels is None,
 
2835
                        author_list_handler=authors)
2363
2836
 
2364
2837
        # Choose the algorithm for doing the logging. It's annoying
2365
2838
        # having multiple code paths like this but necessary until
2377
2850
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
2378
2851
            or delta_type or partial_history)
2379
2852
 
 
2853
        match_dict = {}
 
2854
        if match:
 
2855
            match_dict[''] = match
 
2856
        if match_message:
 
2857
            match_dict['message'] = match_message
 
2858
        if match_committer:
 
2859
            match_dict['committer'] = match_committer
 
2860
        if match_author:
 
2861
            match_dict['author'] = match_author
 
2862
        if match_bugs:
 
2863
            match_dict['bugs'] = match_bugs
 
2864
 
2380
2865
        # Build the LogRequest and execute it
2381
2866
        if len(file_ids) == 0:
2382
2867
            file_ids = None
2384
2869
            direction=direction, specific_fileids=file_ids,
2385
2870
            start_revision=rev1, end_revision=rev2, limit=limit,
2386
2871
            message_search=message, delta_type=delta_type,
2387
 
            diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2872
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2873
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2874
            signature=signatures, omit_merges=omit_merges,
 
2875
            )
2388
2876
        Logger(b, rqst).show(lf)
2389
2877
 
2390
2878
 
2406
2894
            # b is taken from revision[0].get_branch(), and
2407
2895
            # show_log will use its revision_history. Having
2408
2896
            # different branches will lead to weird behaviors.
2409
 
            raise errors.BzrCommandError(
 
2897
            raise errors.BzrCommandError(gettext(
2410
2898
                "bzr %s doesn't accept two revisions in different"
2411
 
                " branches." % command_name)
2412
 
        rev1 = start_spec.in_history(branch)
 
2899
                " branches.") % command_name)
 
2900
        if start_spec.spec is None:
 
2901
            # Avoid loading all the history.
 
2902
            rev1 = RevisionInfo(branch, None, None)
 
2903
        else:
 
2904
            rev1 = start_spec.in_history(branch)
2413
2905
        # Avoid loading all of history when we know a missing
2414
2906
        # end of range means the last revision ...
2415
2907
        if end_spec.spec is None:
2418
2910
        else:
2419
2911
            rev2 = end_spec.in_history(branch)
2420
2912
    else:
2421
 
        raise errors.BzrCommandError(
2422
 
            'bzr %s --revision takes one or two values.' % command_name)
 
2913
        raise errors.BzrCommandError(gettext(
 
2914
            'bzr %s --revision takes one or two values.') % command_name)
2423
2915
    return rev1, rev2
2424
2916
 
2425
2917
 
2444
2936
 
2445
2937
 
2446
2938
class cmd_touching_revisions(Command):
2447
 
    """Return revision-ids which affected a particular file.
 
2939
    __doc__ = """Return revision-ids which affected a particular file.
2448
2940
 
2449
2941
    A more user-friendly interface is "bzr log FILE".
2450
2942
    """
2457
2949
        tree, relpath = WorkingTree.open_containing(filename)
2458
2950
        file_id = tree.path2id(relpath)
2459
2951
        b = tree.branch
2460
 
        b.lock_read()
2461
 
        self.add_cleanup(b.unlock)
 
2952
        self.add_cleanup(b.lock_read().unlock)
2462
2953
        touching_revs = log.find_touching_revisions(b, file_id)
2463
2954
        for revno, revision_id, what in touching_revs:
2464
2955
            self.outf.write("%6d %s\n" % (revno, what))
2465
2956
 
2466
2957
 
2467
2958
class cmd_ls(Command):
2468
 
    """List files in a tree.
 
2959
    __doc__ = """List files in a tree.
2469
2960
    """
2470
2961
 
2471
2962
    _see_also = ['status', 'cat']
2477
2968
                   help='Recurse into subdirectories.'),
2478
2969
            Option('from-root',
2479
2970
                   help='Print paths relative to the root of the branch.'),
2480
 
            Option('unknown', help='Print unknown files.'),
 
2971
            Option('unknown', short_name='u',
 
2972
                help='Print unknown files.'),
2481
2973
            Option('versioned', help='Print versioned files.',
2482
2974
                   short_name='V'),
2483
 
            Option('ignored', help='Print ignored files.'),
2484
 
            Option('null',
2485
 
                   help='Write an ascii NUL (\\0) separator '
2486
 
                   'between files rather than a newline.'),
2487
 
            Option('kind',
 
2975
            Option('ignored', short_name='i',
 
2976
                help='Print ignored files.'),
 
2977
            Option('kind', short_name='k',
2488
2978
                   help='List entries of a particular kind: file, directory, symlink.',
2489
2979
                   type=unicode),
 
2980
            'null',
2490
2981
            'show-ids',
 
2982
            'directory',
2491
2983
            ]
2492
2984
    @display_command
2493
2985
    def run(self, revision=None, verbose=False,
2494
2986
            recursive=False, from_root=False,
2495
2987
            unknown=False, versioned=False, ignored=False,
2496
 
            null=False, kind=None, show_ids=False, path=None):
 
2988
            null=False, kind=None, show_ids=False, path=None, directory=None):
2497
2989
 
2498
2990
        if kind and kind not in ('file', 'directory', 'symlink'):
2499
 
            raise errors.BzrCommandError('invalid kind specified')
 
2991
            raise errors.BzrCommandError(gettext('invalid kind specified'))
2500
2992
 
2501
2993
        if verbose and null:
2502
 
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2994
            raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
2503
2995
        all = not (unknown or versioned or ignored)
2504
2996
 
2505
2997
        selection = {'I':ignored, '?':unknown, 'V':versioned}
2508
3000
            fs_path = '.'
2509
3001
        else:
2510
3002
            if from_root:
2511
 
                raise errors.BzrCommandError('cannot specify both --from-root'
2512
 
                                             ' and PATH')
 
3003
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
 
3004
                                             ' and PATH'))
2513
3005
            fs_path = path
2514
 
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
2515
 
            fs_path)
 
3006
        tree, branch, relpath = \
 
3007
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
2516
3008
 
2517
3009
        # Calculate the prefix to use
2518
3010
        prefix = None
2531
3023
            if view_files:
2532
3024
                apply_view = True
2533
3025
                view_str = views.view_display_str(view_files)
2534
 
                note("Ignoring files outside view. View is %s" % view_str)
 
3026
                note(gettext("Ignoring files outside view. View is %s") % view_str)
2535
3027
 
2536
 
        tree.lock_read()
2537
 
        self.add_cleanup(tree.unlock)
 
3028
        self.add_cleanup(tree.lock_read().unlock)
2538
3029
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
2539
3030
            from_dir=relpath, recursive=recursive):
2540
3031
            # Apply additional masking
2582
3073
 
2583
3074
 
2584
3075
class cmd_unknowns(Command):
2585
 
    """List unknown files.
 
3076
    __doc__ = """List unknown files.
2586
3077
    """
2587
3078
 
2588
3079
    hidden = True
2589
3080
    _see_also = ['ls']
 
3081
    takes_options = ['directory']
2590
3082
 
2591
3083
    @display_command
2592
 
    def run(self):
2593
 
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
3084
    def run(self, directory=u'.'):
 
3085
        for f in WorkingTree.open_containing(directory)[0].unknowns():
2594
3086
            self.outf.write(osutils.quotefn(f) + '\n')
2595
3087
 
2596
3088
 
2597
3089
class cmd_ignore(Command):
2598
 
    """Ignore specified files or patterns.
 
3090
    __doc__ = """Ignore specified files or patterns.
2599
3091
 
2600
3092
    See ``bzr help patterns`` for details on the syntax of patterns.
2601
3093
 
2609
3101
    After adding, editing or deleting that file either indirectly by
2610
3102
    using this command or directly by using an editor, be sure to commit
2611
3103
    it.
2612
 
 
2613
 
    Note: ignore patterns containing shell wildcards must be quoted from
2614
 
    the shell on Unix.
 
3104
    
 
3105
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
3106
    the global ignore file can be found in the application data directory as
 
3107
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
3108
    Global ignores are not touched by this command. The global ignore file
 
3109
    can be edited directly using an editor.
 
3110
 
 
3111
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
3112
    precedence over regular ignores.  Such exceptions are used to specify
 
3113
    files that should be versioned which would otherwise be ignored.
 
3114
    
 
3115
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
3116
    precedence over the '!' exception patterns.
 
3117
 
 
3118
    :Notes: 
 
3119
        
 
3120
    * Ignore patterns containing shell wildcards must be quoted from
 
3121
      the shell on Unix.
 
3122
 
 
3123
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
3124
      To ignore patterns that begin with that character, use the "RE:" prefix.
2615
3125
 
2616
3126
    :Examples:
2617
3127
        Ignore the top level Makefile::
2618
3128
 
2619
3129
            bzr ignore ./Makefile
2620
3130
 
2621
 
        Ignore class files in all directories::
 
3131
        Ignore .class files in all directories...::
2622
3132
 
2623
3133
            bzr ignore "*.class"
2624
3134
 
 
3135
        ...but do not ignore "special.class"::
 
3136
 
 
3137
            bzr ignore "!special.class"
 
3138
 
 
3139
        Ignore files whose name begins with the "#" character::
 
3140
 
 
3141
            bzr ignore "RE:^#"
 
3142
 
2625
3143
        Ignore .o files under the lib directory::
2626
3144
 
2627
3145
            bzr ignore "lib/**/*.o"
2633
3151
        Ignore everything but the "debian" toplevel directory::
2634
3152
 
2635
3153
            bzr ignore "RE:(?!debian/).*"
 
3154
        
 
3155
        Ignore everything except the "local" toplevel directory,
 
3156
        but always ignore autosave files ending in ~, even under local/::
 
3157
        
 
3158
            bzr ignore "*"
 
3159
            bzr ignore "!./local"
 
3160
            bzr ignore "!!*~"
2636
3161
    """
2637
3162
 
2638
3163
    _see_also = ['status', 'ignored', 'patterns']
2639
3164
    takes_args = ['name_pattern*']
2640
 
    takes_options = [
2641
 
        Option('old-default-rules',
2642
 
               help='Write out the ignore rules bzr < 0.9 always used.')
 
3165
    takes_options = ['directory',
 
3166
        Option('default-rules',
 
3167
               help='Display the default ignore rules that bzr uses.')
2643
3168
        ]
2644
3169
 
2645
 
    def run(self, name_pattern_list=None, old_default_rules=None):
 
3170
    def run(self, name_pattern_list=None, default_rules=None,
 
3171
            directory=u'.'):
2646
3172
        from bzrlib import ignores
2647
 
        if old_default_rules is not None:
2648
 
            # dump the rules and exit
2649
 
            for pattern in ignores.OLD_DEFAULTS:
2650
 
                print pattern
 
3173
        if default_rules is not None:
 
3174
            # dump the default rules and exit
 
3175
            for pattern in ignores.USER_DEFAULTS:
 
3176
                self.outf.write("%s\n" % pattern)
2651
3177
            return
2652
3178
        if not name_pattern_list:
2653
 
            raise errors.BzrCommandError("ignore requires at least one "
2654
 
                                  "NAME_PATTERN or --old-default-rules")
 
3179
            raise errors.BzrCommandError(gettext("ignore requires at least one "
 
3180
                "NAME_PATTERN or --default-rules."))
2655
3181
        name_pattern_list = [globbing.normalize_pattern(p)
2656
3182
                             for p in name_pattern_list]
 
3183
        bad_patterns = ''
 
3184
        bad_patterns_count = 0
 
3185
        for p in name_pattern_list:
 
3186
            if not globbing.Globster.is_pattern_valid(p):
 
3187
                bad_patterns_count += 1
 
3188
                bad_patterns += ('\n  %s' % p)
 
3189
        if bad_patterns:
 
3190
            msg = (ngettext('Invalid ignore pattern found. %s', 
 
3191
                            'Invalid ignore patterns found. %s',
 
3192
                            bad_patterns_count) % bad_patterns)
 
3193
            ui.ui_factory.show_error(msg)
 
3194
            raise errors.InvalidPattern('')
2657
3195
        for name_pattern in name_pattern_list:
2658
3196
            if (name_pattern[0] == '/' or
2659
3197
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2660
 
                raise errors.BzrCommandError(
2661
 
                    "NAME_PATTERN should not be an absolute path")
2662
 
        tree, relpath = WorkingTree.open_containing(u'.')
 
3198
                raise errors.BzrCommandError(gettext(
 
3199
                    "NAME_PATTERN should not be an absolute path"))
 
3200
        tree, relpath = WorkingTree.open_containing(directory)
2663
3201
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
2664
3202
        ignored = globbing.Globster(name_pattern_list)
2665
3203
        matches = []
2666
 
        tree.lock_read()
 
3204
        self.add_cleanup(tree.lock_read().unlock)
2667
3205
        for entry in tree.list_files():
2668
3206
            id = entry[3]
2669
3207
            if id is not None:
2670
3208
                filename = entry[0]
2671
3209
                if ignored.match(filename):
2672
 
                    matches.append(filename.encode('utf-8'))
2673
 
        tree.unlock()
 
3210
                    matches.append(filename)
2674
3211
        if len(matches) > 0:
2675
 
            print "Warning: the following files are version controlled and" \
2676
 
                  " match your ignore pattern:\n%s" \
2677
 
                  "\nThese files will continue to be version controlled" \
2678
 
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
3212
            self.outf.write(gettext("Warning: the following files are version "
 
3213
                  "controlled and match your ignore pattern:\n%s"
 
3214
                  "\nThese files will continue to be version controlled"
 
3215
                  " unless you 'bzr remove' them.\n") % ("\n".join(matches),))
2679
3216
 
2680
3217
 
2681
3218
class cmd_ignored(Command):
2682
 
    """List ignored files and the patterns that matched them.
 
3219
    __doc__ = """List ignored files and the patterns that matched them.
2683
3220
 
2684
3221
    List all the ignored files and the ignore pattern that caused the file to
2685
3222
    be ignored.
2691
3228
 
2692
3229
    encoding_type = 'replace'
2693
3230
    _see_also = ['ignore', 'ls']
 
3231
    takes_options = ['directory']
2694
3232
 
2695
3233
    @display_command
2696
 
    def run(self):
2697
 
        tree = WorkingTree.open_containing(u'.')[0]
2698
 
        tree.lock_read()
2699
 
        self.add_cleanup(tree.unlock)
 
3234
    def run(self, directory=u'.'):
 
3235
        tree = WorkingTree.open_containing(directory)[0]
 
3236
        self.add_cleanup(tree.lock_read().unlock)
2700
3237
        for path, file_class, kind, file_id, entry in tree.list_files():
2701
3238
            if file_class != 'I':
2702
3239
                continue
2706
3243
 
2707
3244
 
2708
3245
class cmd_lookup_revision(Command):
2709
 
    """Lookup the revision-id from a revision-number
 
3246
    __doc__ = """Lookup the revision-id from a revision-number
2710
3247
 
2711
3248
    :Examples:
2712
3249
        bzr lookup-revision 33
2713
3250
    """
2714
3251
    hidden = True
2715
3252
    takes_args = ['revno']
 
3253
    takes_options = ['directory']
2716
3254
 
2717
3255
    @display_command
2718
 
    def run(self, revno):
 
3256
    def run(self, revno, directory=u'.'):
2719
3257
        try:
2720
3258
            revno = int(revno)
2721
3259
        except ValueError:
2722
 
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
2723
 
 
2724
 
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
3260
            raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
 
3261
                                         % revno)
 
3262
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
3263
        self.outf.write("%s\n" % revid)
2725
3264
 
2726
3265
 
2727
3266
class cmd_export(Command):
2728
 
    """Export current or past revision to a destination directory or archive.
 
3267
    __doc__ = """Export current or past revision to a destination directory or archive.
2729
3268
 
2730
3269
    If no revision is specified this exports the last committed revision.
2731
3270
 
2752
3291
         zip                          .zip
2753
3292
      =================       =========================
2754
3293
    """
 
3294
    encoding = 'exact'
2755
3295
    takes_args = ['dest', 'branch_or_subdir?']
2756
 
    takes_options = [
 
3296
    takes_options = ['directory',
2757
3297
        Option('format',
2758
3298
               help="Type of file to export to.",
2759
3299
               type=unicode),
2763
3303
        Option('root',
2764
3304
               type=str,
2765
3305
               help="Name of the root directory inside the exported file."),
 
3306
        Option('per-file-timestamps',
 
3307
               help='Set modification time of files to that of the last '
 
3308
                    'revision in which it was changed.'),
 
3309
        Option('uncommitted',
 
3310
               help='Export the working tree contents rather than that of the '
 
3311
                    'last revision.'),
2766
3312
        ]
2767
3313
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2768
 
        root=None, filters=False):
 
3314
        root=None, filters=False, per_file_timestamps=False, uncommitted=False,
 
3315
        directory=u'.'):
2769
3316
        from bzrlib.export import export
2770
3317
 
2771
3318
        if branch_or_subdir is None:
2772
 
            tree = WorkingTree.open_containing(u'.')[0]
2773
 
            b = tree.branch
2774
 
            subdir = None
 
3319
            branch_or_subdir = directory
 
3320
 
 
3321
        (tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
 
3322
            branch_or_subdir)
 
3323
        if tree is not None:
 
3324
            self.add_cleanup(tree.lock_read().unlock)
 
3325
 
 
3326
        if uncommitted:
 
3327
            if tree is None:
 
3328
                raise errors.BzrCommandError(
 
3329
                    gettext("--uncommitted requires a working tree"))
 
3330
            export_tree = tree
2775
3331
        else:
2776
 
            b, subdir = Branch.open_containing(branch_or_subdir)
2777
 
            tree = None
2778
 
 
2779
 
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
3332
            export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
2780
3333
        try:
2781
 
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
3334
            export(export_tree, dest, format, root, subdir, filtered=filters,
 
3335
                   per_file_timestamps=per_file_timestamps)
2782
3336
        except errors.NoSuchExportFormat, e:
2783
 
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
3337
            raise errors.BzrCommandError(
 
3338
                gettext('Unsupported export format: %s') % e.format)
2784
3339
 
2785
3340
 
2786
3341
class cmd_cat(Command):
2787
 
    """Write the contents of a file as of a given revision to standard output.
 
3342
    __doc__ = """Write the contents of a file as of a given revision to standard output.
2788
3343
 
2789
3344
    If no revision is nominated, the last revision is used.
2790
3345
 
2793
3348
    """
2794
3349
 
2795
3350
    _see_also = ['ls']
2796
 
    takes_options = [
 
3351
    takes_options = ['directory',
2797
3352
        Option('name-from-revision', help='The path name in the old tree.'),
2798
3353
        Option('filters', help='Apply content filters to display the '
2799
3354
                'convenience form.'),
2804
3359
 
2805
3360
    @display_command
2806
3361
    def run(self, filename, revision=None, name_from_revision=False,
2807
 
            filters=False):
 
3362
            filters=False, directory=None):
2808
3363
        if revision is not None and len(revision) != 1:
2809
 
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2810
 
                                         " one revision specifier")
 
3364
            raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
 
3365
                                         " one revision specifier"))
2811
3366
        tree, branch, relpath = \
2812
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
2813
 
        branch.lock_read()
2814
 
        self.add_cleanup(branch.unlock)
 
3367
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3368
        self.add_cleanup(branch.lock_read().unlock)
2815
3369
        return self._run(tree, branch, relpath, filename, revision,
2816
3370
                         name_from_revision, filters)
2817
3371
 
2820
3374
        if tree is None:
2821
3375
            tree = b.basis_tree()
2822
3376
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2823
 
        rev_tree.lock_read()
2824
 
        self.add_cleanup(rev_tree.unlock)
 
3377
        self.add_cleanup(rev_tree.lock_read().unlock)
2825
3378
 
2826
3379
        old_file_id = rev_tree.path2id(relpath)
2827
3380
 
 
3381
        # TODO: Split out this code to something that generically finds the
 
3382
        # best id for a path across one or more trees; it's like
 
3383
        # find_ids_across_trees but restricted to find just one. -- mbp
 
3384
        # 20110705.
2828
3385
        if name_from_revision:
2829
3386
            # Try in revision if requested
2830
3387
            if old_file_id is None:
2831
 
                raise errors.BzrCommandError(
2832
 
                    "%r is not present in revision %s" % (
 
3388
                raise errors.BzrCommandError(gettext(
 
3389
                    "{0!r} is not present in revision {1}").format(
2833
3390
                        filename, rev_tree.get_revision_id()))
2834
3391
            else:
2835
 
                content = rev_tree.get_file_text(old_file_id)
 
3392
                actual_file_id = old_file_id
2836
3393
        else:
2837
3394
            cur_file_id = tree.path2id(relpath)
2838
 
            found = False
2839
 
            if cur_file_id is not None:
2840
 
                # Then try with the actual file id
2841
 
                try:
2842
 
                    content = rev_tree.get_file_text(cur_file_id)
2843
 
                    found = True
2844
 
                except errors.NoSuchId:
2845
 
                    # The actual file id didn't exist at that time
2846
 
                    pass
2847
 
            if not found and old_file_id is not None:
2848
 
                # Finally try with the old file id
2849
 
                content = rev_tree.get_file_text(old_file_id)
2850
 
                found = True
2851
 
            if not found:
2852
 
                # Can't be found anywhere
2853
 
                raise errors.BzrCommandError(
2854
 
                    "%r is not present in revision %s" % (
 
3395
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
 
3396
                actual_file_id = cur_file_id
 
3397
            elif old_file_id is not None:
 
3398
                actual_file_id = old_file_id
 
3399
            else:
 
3400
                raise errors.BzrCommandError(gettext(
 
3401
                    "{0!r} is not present in revision {1}").format(
2855
3402
                        filename, rev_tree.get_revision_id()))
2856
3403
        if filtered:
2857
 
            from bzrlib.filters import (
2858
 
                ContentFilterContext,
2859
 
                filtered_output_bytes,
2860
 
                )
2861
 
            filters = rev_tree._content_filter_stack(relpath)
2862
 
            chunks = content.splitlines(True)
2863
 
            content = filtered_output_bytes(chunks, filters,
2864
 
                ContentFilterContext(relpath, rev_tree))
2865
 
            self.cleanup_now()
2866
 
            self.outf.writelines(content)
 
3404
            from bzrlib.filter_tree import ContentFilterTree
 
3405
            filter_tree = ContentFilterTree(rev_tree,
 
3406
                rev_tree._content_filter_stack)
 
3407
            content = filter_tree.get_file_text(actual_file_id)
2867
3408
        else:
2868
 
            self.cleanup_now()
2869
 
            self.outf.write(content)
 
3409
            content = rev_tree.get_file_text(actual_file_id)
 
3410
        self.cleanup_now()
 
3411
        self.outf.write(content)
2870
3412
 
2871
3413
 
2872
3414
class cmd_local_time_offset(Command):
2873
 
    """Show the offset in seconds from GMT to local time."""
 
3415
    __doc__ = """Show the offset in seconds from GMT to local time."""
2874
3416
    hidden = True
2875
3417
    @display_command
2876
3418
    def run(self):
2877
 
        print osutils.local_time_offset()
 
3419
        self.outf.write("%s\n" % osutils.local_time_offset())
2878
3420
 
2879
3421
 
2880
3422
 
2881
3423
class cmd_commit(Command):
2882
 
    """Commit changes into a new revision.
 
3424
    __doc__ = """Commit changes into a new revision.
2883
3425
 
2884
3426
    An explanatory message needs to be given for each commit. This is
2885
3427
    often done by using the --message option (getting the message from the
2933
3475
      to trigger updates to external systems like bug trackers. The --fixes
2934
3476
      option can be used to record the association between a revision and
2935
3477
      one or more bugs. See ``bzr help bugs`` for details.
2936
 
 
2937
 
      A selective commit may fail in some cases where the committed
2938
 
      tree would be invalid. Consider::
2939
 
  
2940
 
        bzr init foo
2941
 
        mkdir foo/bar
2942
 
        bzr add foo/bar
2943
 
        bzr commit foo -m "committing foo"
2944
 
        bzr mv foo/bar foo/baz
2945
 
        mkdir foo/bar
2946
 
        bzr add foo/bar
2947
 
        bzr commit foo/bar -m "committing bar but not baz"
2948
 
  
2949
 
      In the example above, the last commit will fail by design. This gives
2950
 
      the user the opportunity to decide whether they want to commit the
2951
 
      rename at the same time, separately first, or not at all. (As a general
2952
 
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
2953
3478
    """
2954
 
    # TODO: Run hooks on tree to-be-committed, and after commit.
2955
 
 
2956
 
    # TODO: Strict commit that fails if there are deleted files.
2957
 
    #       (what does "deleted files" mean ??)
2958
 
 
2959
 
    # TODO: Give better message for -s, --summary, used by tla people
2960
 
 
2961
 
    # XXX: verbose currently does nothing
2962
3479
 
2963
3480
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
2964
3481
    takes_args = ['selected*']
2993
3510
                         "the master branch until a normal commit "
2994
3511
                         "is performed."
2995
3512
                    ),
2996
 
             Option('show-diff',
 
3513
             Option('show-diff', short_name='p',
2997
3514
                    help='When no message is supplied, show the diff along'
2998
3515
                    ' with the status summary in the message editor.'),
 
3516
             Option('lossy', 
 
3517
                    help='When committing to a foreign version control '
 
3518
                    'system do not push data that can not be natively '
 
3519
                    'represented.'),
2999
3520
             ]
3000
3521
    aliases = ['ci', 'checkin']
3001
3522
 
3002
3523
    def _iter_bug_fix_urls(self, fixes, branch):
 
3524
        default_bugtracker  = None
3003
3525
        # Configure the properties for bug fixing attributes.
3004
3526
        for fixed_bug in fixes:
3005
3527
            tokens = fixed_bug.split(':')
3006
 
            if len(tokens) != 2:
3007
 
                raise errors.BzrCommandError(
 
3528
            if len(tokens) == 1:
 
3529
                if default_bugtracker is None:
 
3530
                    branch_config = branch.get_config_stack()
 
3531
                    default_bugtracker = branch_config.get(
 
3532
                        "bugtracker")
 
3533
                if default_bugtracker is None:
 
3534
                    raise errors.BzrCommandError(gettext(
 
3535
                        "No tracker specified for bug %s. Use the form "
 
3536
                        "'tracker:id' or specify a default bug tracker "
 
3537
                        "using the `bugtracker` option.\nSee "
 
3538
                        "\"bzr help bugs\" for more information on this "
 
3539
                        "feature. Commit refused.") % fixed_bug)
 
3540
                tag = default_bugtracker
 
3541
                bug_id = tokens[0]
 
3542
            elif len(tokens) != 2:
 
3543
                raise errors.BzrCommandError(gettext(
3008
3544
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
3009
3545
                    "See \"bzr help bugs\" for more information on this "
3010
 
                    "feature.\nCommit refused." % fixed_bug)
3011
 
            tag, bug_id = tokens
 
3546
                    "feature.\nCommit refused.") % fixed_bug)
 
3547
            else:
 
3548
                tag, bug_id = tokens
3012
3549
            try:
3013
3550
                yield bugtracker.get_bug_url(tag, branch, bug_id)
3014
3551
            except errors.UnknownBugTrackerAbbreviation:
3015
 
                raise errors.BzrCommandError(
3016
 
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
3552
                raise errors.BzrCommandError(gettext(
 
3553
                    'Unrecognized bug %s. Commit refused.') % fixed_bug)
3017
3554
            except errors.MalformedBugIdentifier, e:
3018
 
                raise errors.BzrCommandError(
3019
 
                    "%s\nCommit refused." % (str(e),))
 
3555
                raise errors.BzrCommandError(gettext(
 
3556
                    "%s\nCommit refused.") % (str(e),))
3020
3557
 
3021
3558
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3022
3559
            unchanged=False, strict=False, local=False, fixes=None,
3023
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
3560
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3561
            lossy=False):
3024
3562
        from bzrlib.errors import (
3025
3563
            PointlessCommit,
3026
3564
            ConflictsInTree,
3029
3567
        from bzrlib.msgeditor import (
3030
3568
            edit_commit_message_encoded,
3031
3569
            generate_commit_message_template,
3032
 
            make_commit_message_template_encoded
 
3570
            make_commit_message_template_encoded,
 
3571
            set_commit_message,
3033
3572
        )
3034
3573
 
3035
3574
        commit_stamp = offset = None
3037
3576
            try:
3038
3577
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
3039
3578
            except ValueError, e:
3040
 
                raise errors.BzrCommandError(
3041
 
                    "Could not parse --commit-time: " + str(e))
3042
 
 
3043
 
        # TODO: Need a blackbox test for invoking the external editor; may be
3044
 
        # slightly problematic to run this cross-platform.
3045
 
 
3046
 
        # TODO: do more checks that the commit will succeed before
3047
 
        # spending the user's valuable time typing a commit message.
 
3579
                raise errors.BzrCommandError(gettext(
 
3580
                    "Could not parse --commit-time: " + str(e)))
3048
3581
 
3049
3582
        properties = {}
3050
3583
 
3051
 
        tree, selected_list = tree_files(selected_list)
 
3584
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
3052
3585
        if selected_list == ['']:
3053
3586
            # workaround - commit of root of tree should be exactly the same
3054
3587
            # as just default commit in that tree, and succeed even though
3079
3612
                    '(use --file "%(f)s" to take commit message from that file)'
3080
3613
                    % { 'f': message })
3081
3614
                ui.ui_factory.show_warning(warning_msg)
 
3615
            if '\r' in message:
 
3616
                message = message.replace('\r\n', '\n')
 
3617
                message = message.replace('\r', '\n')
 
3618
            if file:
 
3619
                raise errors.BzrCommandError(gettext(
 
3620
                    "please specify either --message or --file"))
3082
3621
 
3083
3622
        def get_message(commit_obj):
3084
3623
            """Callback to get commit message"""
3085
 
            my_message = message
3086
 
            if my_message is not None and '\r' in my_message:
3087
 
                my_message = my_message.replace('\r\n', '\n')
3088
 
                my_message = my_message.replace('\r', '\n')
3089
 
            if my_message is None and not file:
3090
 
                t = make_commit_message_template_encoded(tree,
 
3624
            if file:
 
3625
                f = open(file)
 
3626
                try:
 
3627
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3628
                finally:
 
3629
                    f.close()
 
3630
            elif message is not None:
 
3631
                my_message = message
 
3632
            else:
 
3633
                # No message supplied: make one up.
 
3634
                # text is the status of the tree
 
3635
                text = make_commit_message_template_encoded(tree,
3091
3636
                        selected_list, diff=show_diff,
3092
3637
                        output_encoding=osutils.get_user_encoding())
3093
 
                start_message = generate_commit_message_template(commit_obj)
3094
 
                my_message = edit_commit_message_encoded(t,
3095
 
                    start_message=start_message)
3096
 
                if my_message is None:
3097
 
                    raise errors.BzrCommandError("please specify a commit"
3098
 
                        " message with either --message or --file")
3099
 
            elif my_message and file:
3100
 
                raise errors.BzrCommandError(
3101
 
                    "please specify either --message or --file")
3102
 
            if file:
3103
 
                my_message = codecs.open(file, 'rt',
3104
 
                                         osutils.get_user_encoding()).read()
3105
 
            if my_message == "":
3106
 
                raise errors.BzrCommandError("empty commit message specified")
 
3638
                # start_message is the template generated from hooks
 
3639
                # XXX: Warning - looks like hooks return unicode,
 
3640
                # make_commit_message_template_encoded returns user encoding.
 
3641
                # We probably want to be using edit_commit_message instead to
 
3642
                # avoid this.
 
3643
                my_message = set_commit_message(commit_obj)
 
3644
                if my_message is None:
 
3645
                    start_message = generate_commit_message_template(commit_obj)
 
3646
                    my_message = edit_commit_message_encoded(text,
 
3647
                        start_message=start_message)
 
3648
                if my_message is None:
 
3649
                    raise errors.BzrCommandError(gettext("please specify a commit"
 
3650
                        " message with either --message or --file"))
 
3651
                if my_message == "":
 
3652
                    raise errors.BzrCommandError(gettext("Empty commit message specified."
 
3653
                            " Please specify a commit message with either"
 
3654
                            " --message or --file or leave a blank message"
 
3655
                            " with --message \"\"."))
3107
3656
            return my_message
3108
3657
 
3109
3658
        # The API permits a commit with a filter of [] to mean 'select nothing'
3117
3666
                        reporter=None, verbose=verbose, revprops=properties,
3118
3667
                        authors=author, timestamp=commit_stamp,
3119
3668
                        timezone=offset,
3120
 
                        exclude=safe_relpath_files(tree, exclude))
 
3669
                        exclude=tree.safe_relpath_files(exclude),
 
3670
                        lossy=lossy)
3121
3671
        except PointlessCommit:
3122
 
            # FIXME: This should really happen before the file is read in;
3123
 
            # perhaps prepare the commit; get the message; then actually commit
3124
 
            raise errors.BzrCommandError("No changes to commit."
3125
 
                              " Use --unchanged to commit anyhow.")
 
3672
            raise errors.BzrCommandError(gettext("No changes to commit."
 
3673
                " Please 'bzr add' the files you want to commit, or use"
 
3674
                " --unchanged to force an empty commit."))
3126
3675
        except ConflictsInTree:
3127
 
            raise errors.BzrCommandError('Conflicts detected in working '
 
3676
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
3128
3677
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3129
 
                ' resolve.')
 
3678
                ' resolve.'))
3130
3679
        except StrictCommitFailed:
3131
 
            raise errors.BzrCommandError("Commit refused because there are"
3132
 
                              " unknown files in the working tree.")
 
3680
            raise errors.BzrCommandError(gettext("Commit refused because there are"
 
3681
                              " unknown files in the working tree."))
3133
3682
        except errors.BoundBranchOutOfDate, e:
3134
 
            raise errors.BzrCommandError(str(e) + "\n"
3135
 
            'To commit to master branch, run update and then commit.\n'
3136
 
            'You can also pass --local to commit to continue working '
3137
 
            'disconnected.')
 
3683
            e.extra_help = (gettext("\n"
 
3684
                'To commit to master branch, run update and then commit.\n'
 
3685
                'You can also pass --local to commit to continue working '
 
3686
                'disconnected.'))
 
3687
            raise
3138
3688
 
3139
3689
 
3140
3690
class cmd_check(Command):
3141
 
    """Validate working tree structure, branch consistency and repository history.
 
3691
    __doc__ = """Validate working tree structure, branch consistency and repository history.
3142
3692
 
3143
3693
    This command checks various invariants about branch and repository storage
3144
3694
    to detect data corruption or bzr bugs.
3208
3758
 
3209
3759
 
3210
3760
class cmd_upgrade(Command):
3211
 
    """Upgrade branch storage to current format.
3212
 
 
3213
 
    The check command or bzr developers may sometimes advise you to run
3214
 
    this command. When the default format has changed you may also be warned
3215
 
    during other operations to upgrade.
 
3761
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3762
 
 
3763
    When the default format has changed after a major new release of
 
3764
    Bazaar, you may be informed during certain operations that you
 
3765
    should upgrade. Upgrading to a newer format may improve performance
 
3766
    or make new features available. It may however limit interoperability
 
3767
    with older repositories or with older versions of Bazaar.
 
3768
 
 
3769
    If you wish to upgrade to a particular format rather than the
 
3770
    current default, that can be specified using the --format option.
 
3771
    As a consequence, you can use the upgrade command this way to
 
3772
    "downgrade" to an earlier format, though some conversions are
 
3773
    a one way process (e.g. changing from the 1.x default to the
 
3774
    2.x default) so downgrading is not always possible.
 
3775
 
 
3776
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3777
    process (where # is a number). By default, this is left there on
 
3778
    completion. If the conversion fails, delete the new .bzr directory
 
3779
    and rename this one back in its place. Use the --clean option to ask
 
3780
    for the backup.bzr directory to be removed on successful conversion.
 
3781
    Alternatively, you can delete it by hand if everything looks good
 
3782
    afterwards.
 
3783
 
 
3784
    If the location given is a shared repository, dependent branches
 
3785
    are also converted provided the repository converts successfully.
 
3786
    If the conversion of a branch fails, remaining branches are still
 
3787
    tried.
 
3788
 
 
3789
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3790
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
3216
3791
    """
3217
3792
 
3218
 
    _see_also = ['check']
 
3793
    _see_also = ['check', 'reconcile', 'formats']
3219
3794
    takes_args = ['url?']
3220
3795
    takes_options = [
3221
 
                    RegistryOption('format',
3222
 
                        help='Upgrade to a specific format.  See "bzr help'
3223
 
                             ' formats" for details.',
3224
 
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3225
 
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
3226
 
                        value_switches=True, title='Branch format'),
3227
 
                    ]
 
3796
        RegistryOption('format',
 
3797
            help='Upgrade to a specific format.  See "bzr help'
 
3798
                 ' formats" for details.',
 
3799
            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
3800
            converter=lambda name: controldir.format_registry.make_bzrdir(name),
 
3801
            value_switches=True, title='Branch format'),
 
3802
        Option('clean',
 
3803
            help='Remove the backup.bzr directory if successful.'),
 
3804
        Option('dry-run',
 
3805
            help="Show what would be done, but don't actually do anything."),
 
3806
    ]
3228
3807
 
3229
 
    def run(self, url='.', format=None):
 
3808
    def run(self, url='.', format=None, clean=False, dry_run=False):
3230
3809
        from bzrlib.upgrade import upgrade
3231
 
        upgrade(url, format)
 
3810
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3811
        if exceptions:
 
3812
            if len(exceptions) == 1:
 
3813
                # Compatibility with historical behavior
 
3814
                raise exceptions[0]
 
3815
            else:
 
3816
                return 3
3232
3817
 
3233
3818
 
3234
3819
class cmd_whoami(Command):
3235
 
    """Show or set bzr user id.
 
3820
    __doc__ = """Show or set bzr user id.
3236
3821
 
3237
3822
    :Examples:
3238
3823
        Show the email of the current user::
3243
3828
 
3244
3829
            bzr whoami "Frank Chu <fchu@example.com>"
3245
3830
    """
3246
 
    takes_options = [ Option('email',
 
3831
    takes_options = [ 'directory',
 
3832
                      Option('email',
3247
3833
                             help='Display email address only.'),
3248
3834
                      Option('branch',
3249
3835
                             help='Set identity for the current branch instead of '
3253
3839
    encoding_type = 'replace'
3254
3840
 
3255
3841
    @display_command
3256
 
    def run(self, email=False, branch=False, name=None):
 
3842
    def run(self, email=False, branch=False, name=None, directory=None):
3257
3843
        if name is None:
3258
 
            # use branch if we're inside one; otherwise global config
3259
 
            try:
3260
 
                c = Branch.open_containing('.')[0].get_config()
3261
 
            except errors.NotBranchError:
3262
 
                c = config.GlobalConfig()
 
3844
            if directory is None:
 
3845
                # use branch if we're inside one; otherwise global config
 
3846
                try:
 
3847
                    c = Branch.open_containing(u'.')[0].get_config_stack()
 
3848
                except errors.NotBranchError:
 
3849
                    c = _mod_config.GlobalStack()
 
3850
            else:
 
3851
                c = Branch.open(directory).get_config_stack()
 
3852
            identity = c.get('email')
3263
3853
            if email:
3264
 
                self.outf.write(c.user_email() + '\n')
 
3854
                self.outf.write(_mod_config.extract_email_address(identity)
 
3855
                                + '\n')
3265
3856
            else:
3266
 
                self.outf.write(c.username() + '\n')
 
3857
                self.outf.write(identity + '\n')
3267
3858
            return
3268
3859
 
 
3860
        if email:
 
3861
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
 
3862
                                         "identity"))
 
3863
 
3269
3864
        # display a warning if an email address isn't included in the given name.
3270
3865
        try:
3271
 
            config.extract_email_address(name)
 
3866
            _mod_config.extract_email_address(name)
3272
3867
        except errors.NoEmailInUsername, e:
3273
3868
            warning('"%s" does not seem to contain an email address.  '
3274
3869
                    'This is allowed, but not recommended.', name)
3275
3870
 
3276
3871
        # use global config unless --branch given
3277
3872
        if branch:
3278
 
            c = Branch.open_containing('.')[0].get_config()
 
3873
            if directory is None:
 
3874
                c = Branch.open_containing(u'.')[0].get_config_stack()
 
3875
            else:
 
3876
                b = Branch.open(directory)
 
3877
                self.add_cleanup(b.lock_write().unlock)
 
3878
                c = b.get_config_stack()
3279
3879
        else:
3280
 
            c = config.GlobalConfig()
3281
 
        c.set_user_option('email', name)
 
3880
            c = _mod_config.GlobalStack()
 
3881
        c.set('email', name)
3282
3882
 
3283
3883
 
3284
3884
class cmd_nick(Command):
3285
 
    """Print or set the branch nickname.
 
3885
    __doc__ = """Print or set the branch nickname.
3286
3886
 
3287
 
    If unset, the tree root directory name is used as the nickname.
3288
 
    To print the current nickname, execute with no argument.
 
3887
    If unset, the colocated branch name is used for colocated branches, and
 
3888
    the branch directory name is used for other branches.  To print the
 
3889
    current nickname, execute with no argument.
3289
3890
 
3290
3891
    Bound branches use the nickname of its master branch unless it is set
3291
3892
    locally.
3293
3894
 
3294
3895
    _see_also = ['info']
3295
3896
    takes_args = ['nickname?']
3296
 
    def run(self, nickname=None):
3297
 
        branch = Branch.open_containing(u'.')[0]
 
3897
    takes_options = ['directory']
 
3898
    def run(self, nickname=None, directory=u'.'):
 
3899
        branch = Branch.open_containing(directory)[0]
3298
3900
        if nickname is None:
3299
3901
            self.printme(branch)
3300
3902
        else:
3302
3904
 
3303
3905
    @display_command
3304
3906
    def printme(self, branch):
3305
 
        print branch.nick
 
3907
        self.outf.write('%s\n' % branch.nick)
3306
3908
 
3307
3909
 
3308
3910
class cmd_alias(Command):
3309
 
    """Set/unset and display aliases.
 
3911
    __doc__ = """Set/unset and display aliases.
3310
3912
 
3311
3913
    :Examples:
3312
3914
        Show the current aliases::
3345
3947
 
3346
3948
    def remove_alias(self, alias_name):
3347
3949
        if alias_name is None:
3348
 
            raise errors.BzrCommandError(
3349
 
                'bzr alias --remove expects an alias to remove.')
 
3950
            raise errors.BzrCommandError(gettext(
 
3951
                'bzr alias --remove expects an alias to remove.'))
3350
3952
        # If alias is not found, print something like:
3351
3953
        # unalias: foo: not found
3352
 
        c = config.GlobalConfig()
 
3954
        c = _mod_config.GlobalConfig()
3353
3955
        c.unset_alias(alias_name)
3354
3956
 
3355
3957
    @display_command
3356
3958
    def print_aliases(self):
3357
3959
        """Print out the defined aliases in a similar format to bash."""
3358
 
        aliases = config.GlobalConfig().get_aliases()
 
3960
        aliases = _mod_config.GlobalConfig().get_aliases()
3359
3961
        for key, value in sorted(aliases.iteritems()):
3360
3962
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
3361
3963
 
3371
3973
 
3372
3974
    def set_alias(self, alias_name, alias_command):
3373
3975
        """Save the alias in the global config."""
3374
 
        c = config.GlobalConfig()
 
3976
        c = _mod_config.GlobalConfig()
3375
3977
        c.set_alias(alias_name, alias_command)
3376
3978
 
3377
3979
 
3378
3980
class cmd_selftest(Command):
3379
 
    """Run internal test suite.
 
3981
    __doc__ = """Run internal test suite.
3380
3982
 
3381
3983
    If arguments are given, they are regular expressions that say which tests
3382
3984
    should run.  Tests matching any expression are run, and other tests are
3412
4014
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3413
4015
    into a pdb postmortem session.
3414
4016
 
 
4017
    The --coverage=DIRNAME global option produces a report with covered code
 
4018
    indicated.
 
4019
 
3415
4020
    :Examples:
3416
4021
        Run only tests relating to 'ignore'::
3417
4022
 
3426
4031
    def get_transport_type(typestring):
3427
4032
        """Parse and return a transport specifier."""
3428
4033
        if typestring == "sftp":
3429
 
            from bzrlib.transport.sftp import SFTPAbsoluteServer
3430
 
            return SFTPAbsoluteServer
3431
 
        if typestring == "memory":
3432
 
            from bzrlib.transport.memory import MemoryServer
3433
 
            return MemoryServer
3434
 
        if typestring == "fakenfs":
3435
 
            from bzrlib.transport.fakenfs import FakeNFSServer
3436
 
            return FakeNFSServer
 
4034
            from bzrlib.tests import stub_sftp
 
4035
            return stub_sftp.SFTPAbsoluteServer
 
4036
        elif typestring == "memory":
 
4037
            from bzrlib.tests import test_server
 
4038
            return memory.MemoryServer
 
4039
        elif typestring == "fakenfs":
 
4040
            from bzrlib.tests import test_server
 
4041
            return test_server.FakeNFSServer
3437
4042
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3438
4043
            (typestring)
3439
4044
        raise errors.BzrCommandError(msg)
3450
4055
                                 'throughout the test suite.',
3451
4056
                            type=get_transport_type),
3452
4057
                     Option('benchmark',
3453
 
                            help='Run the benchmarks rather than selftests.'),
 
4058
                            help='Run the benchmarks rather than selftests.',
 
4059
                            hidden=True),
3454
4060
                     Option('lsprof-timed',
3455
4061
                            help='Generate lsprof output for benchmarked'
3456
4062
                                 ' sections of code.'),
3457
4063
                     Option('lsprof-tests',
3458
4064
                            help='Generate lsprof output for each test.'),
3459
 
                     Option('cache-dir', type=str,
3460
 
                            help='Cache intermediate benchmark output in this '
3461
 
                                 'directory.'),
3462
4065
                     Option('first',
3463
4066
                            help='Run all tests, but run specified tests first.',
3464
4067
                            short_name='f',
3473
4076
                     Option('randomize', type=str, argname="SEED",
3474
4077
                            help='Randomize the order of tests using the given'
3475
4078
                                 ' seed or "now" for the current time.'),
3476
 
                     Option('exclude', type=str, argname="PATTERN",
3477
 
                            short_name='x',
3478
 
                            help='Exclude tests that match this regular'
3479
 
                                 ' expression.'),
 
4079
                     ListOption('exclude', type=str, argname="PATTERN",
 
4080
                                short_name='x',
 
4081
                                help='Exclude tests that match this regular'
 
4082
                                ' expression.'),
3480
4083
                     Option('subunit',
3481
4084
                        help='Output test progress via subunit.'),
3482
4085
                     Option('strict', help='Fail on missing dependencies or '
3489
4092
                                param_name='starting_with', short_name='s',
3490
4093
                                help=
3491
4094
                                'Load only the tests starting with TESTID.'),
 
4095
                     Option('sync',
 
4096
                            help="By default we disable fsync and fdatasync"
 
4097
                                 " while running the test suite.")
3492
4098
                     ]
3493
4099
    encoding_type = 'replace'
3494
4100
 
3498
4104
 
3499
4105
    def run(self, testspecs_list=None, verbose=False, one=False,
3500
4106
            transport=None, benchmark=None,
3501
 
            lsprof_timed=None, cache_dir=None,
 
4107
            lsprof_timed=None,
3502
4108
            first=False, list_only=False,
3503
4109
            randomize=None, exclude=None, strict=False,
3504
4110
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3505
 
            parallel=None, lsprof_tests=False):
3506
 
        from bzrlib.tests import selftest
3507
 
        import bzrlib.benchmarks as benchmarks
3508
 
        from bzrlib.benchmarks import tree_creator
3509
 
 
3510
 
        # Make deprecation warnings visible, unless -Werror is set
3511
 
        symbol_versioning.activate_deprecation_warnings(override=False)
3512
 
 
3513
 
        if cache_dir is not None:
3514
 
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
4111
            parallel=None, lsprof_tests=False,
 
4112
            sync=False):
 
4113
 
 
4114
        # During selftest, disallow proxying, as it can cause severe
 
4115
        # performance penalties and is only needed for thread
 
4116
        # safety. The selftest command is assumed to not use threads
 
4117
        # too heavily. The call should be as early as possible, as
 
4118
        # error reporting for past duplicate imports won't have useful
 
4119
        # backtraces.
 
4120
        lazy_import.disallow_proxying()
 
4121
 
 
4122
        from bzrlib import tests
 
4123
 
3515
4124
        if testspecs_list is not None:
3516
4125
            pattern = '|'.join(testspecs_list)
3517
4126
        else:
3520
4129
            try:
3521
4130
                from bzrlib.tests import SubUnitBzrRunner
3522
4131
            except ImportError:
3523
 
                raise errors.BzrCommandError("subunit not available. subunit "
3524
 
                    "needs to be installed to use --subunit.")
 
4132
                raise errors.BzrCommandError(gettext("subunit not available. subunit "
 
4133
                    "needs to be installed to use --subunit."))
3525
4134
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
4135
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
4136
            # stdout, which would corrupt the subunit stream. 
 
4137
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
4138
            # following code can be deleted when it's sufficiently deployed
 
4139
            # -- vila/mgz 20100514
 
4140
            if (sys.platform == "win32"
 
4141
                and getattr(sys.stdout, 'fileno', None) is not None):
 
4142
                import msvcrt
 
4143
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
3526
4144
        if parallel:
3527
4145
            self.additional_selftest_args.setdefault(
3528
4146
                'suite_decorators', []).append(parallel)
3529
4147
        if benchmark:
3530
 
            test_suite_factory = benchmarks.test_suite
3531
 
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3532
 
            verbose = not is_quiet()
3533
 
            # TODO: should possibly lock the history file...
3534
 
            benchfile = open(".perf_history", "at", buffering=1)
3535
 
            self.add_cleanup(benchfile.close)
 
4148
            raise errors.BzrCommandError(gettext(
 
4149
                "--benchmark is no longer supported from bzr 2.2; "
 
4150
                "use bzr-usertest instead"))
 
4151
        test_suite_factory = None
 
4152
        if not exclude:
 
4153
            exclude_pattern = None
3536
4154
        else:
3537
 
            test_suite_factory = None
3538
 
            benchfile = None
 
4155
            exclude_pattern = '(' + '|'.join(exclude) + ')'
 
4156
        if not sync:
 
4157
            self._disable_fsync()
3539
4158
        selftest_kwargs = {"verbose": verbose,
3540
4159
                          "pattern": pattern,
3541
4160
                          "stop_on_failure": one,
3543
4162
                          "test_suite_factory": test_suite_factory,
3544
4163
                          "lsprof_timed": lsprof_timed,
3545
4164
                          "lsprof_tests": lsprof_tests,
3546
 
                          "bench_history": benchfile,
3547
4165
                          "matching_tests_first": first,
3548
4166
                          "list_only": list_only,
3549
4167
                          "random_seed": randomize,
3550
 
                          "exclude_pattern": exclude,
 
4168
                          "exclude_pattern": exclude_pattern,
3551
4169
                          "strict": strict,
3552
4170
                          "load_list": load_list,
3553
4171
                          "debug_flags": debugflag,
3554
4172
                          "starting_with": starting_with
3555
4173
                          }
3556
4174
        selftest_kwargs.update(self.additional_selftest_args)
3557
 
        result = selftest(**selftest_kwargs)
 
4175
 
 
4176
        # Make deprecation warnings visible, unless -Werror is set
 
4177
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
4178
            override=False)
 
4179
        try:
 
4180
            result = tests.selftest(**selftest_kwargs)
 
4181
        finally:
 
4182
            cleanup()
3558
4183
        return int(not result)
3559
4184
 
 
4185
    def _disable_fsync(self):
 
4186
        """Change the 'os' functionality to not synchronize."""
 
4187
        self._orig_fsync = getattr(os, 'fsync', None)
 
4188
        if self._orig_fsync is not None:
 
4189
            os.fsync = lambda filedes: None
 
4190
        self._orig_fdatasync = getattr(os, 'fdatasync', None)
 
4191
        if self._orig_fdatasync is not None:
 
4192
            os.fdatasync = lambda filedes: None
 
4193
 
3560
4194
 
3561
4195
class cmd_version(Command):
3562
 
    """Show version of bzr."""
 
4196
    __doc__ = """Show version of bzr."""
3563
4197
 
3564
4198
    encoding_type = 'replace'
3565
4199
    takes_options = [
3576
4210
 
3577
4211
 
3578
4212
class cmd_rocks(Command):
3579
 
    """Statement of optimism."""
 
4213
    __doc__ = """Statement of optimism."""
3580
4214
 
3581
4215
    hidden = True
3582
4216
 
3583
4217
    @display_command
3584
4218
    def run(self):
3585
 
        print "It sure does!"
 
4219
        self.outf.write(gettext("It sure does!\n"))
3586
4220
 
3587
4221
 
3588
4222
class cmd_find_merge_base(Command):
3589
 
    """Find and print a base revision for merging two branches."""
 
4223
    __doc__ = """Find and print a base revision for merging two branches."""
3590
4224
    # TODO: Options to specify revisions on either side, as if
3591
4225
    #       merging only part of the history.
3592
4226
    takes_args = ['branch', 'other']
3598
4232
 
3599
4233
        branch1 = Branch.open_containing(branch)[0]
3600
4234
        branch2 = Branch.open_containing(other)[0]
3601
 
        branch1.lock_read()
3602
 
        self.add_cleanup(branch1.unlock)
3603
 
        branch2.lock_read()
3604
 
        self.add_cleanup(branch2.unlock)
 
4235
        self.add_cleanup(branch1.lock_read().unlock)
 
4236
        self.add_cleanup(branch2.lock_read().unlock)
3605
4237
        last1 = ensure_null(branch1.last_revision())
3606
4238
        last2 = ensure_null(branch2.last_revision())
3607
4239
 
3608
4240
        graph = branch1.repository.get_graph(branch2.repository)
3609
4241
        base_rev_id = graph.find_unique_lca(last1, last2)
3610
4242
 
3611
 
        print 'merge base is revision %s' % base_rev_id
 
4243
        self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
3612
4244
 
3613
4245
 
3614
4246
class cmd_merge(Command):
3615
 
    """Perform a three-way merge.
 
4247
    __doc__ = """Perform a three-way merge.
3616
4248
 
3617
4249
    The source of the merge can be specified either in the form of a branch,
3618
4250
    or in the form of a path to a file containing a merge directive generated
3619
4251
    with bzr send. If neither is specified, the default is the upstream branch
3620
 
    or the branch most recently merged using --remember.
3621
 
 
3622
 
    When merging a branch, by default the tip will be merged. To pick a different
3623
 
    revision, pass --revision. If you specify two values, the first will be used as
3624
 
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
3625
 
    available revisions, like this is commonly referred to as "cherrypicking".
3626
 
 
3627
 
    Revision numbers are always relative to the branch being merged.
3628
 
 
3629
 
    By default, bzr will try to merge in all new work from the other
3630
 
    branch, automatically determining an appropriate base.  If this
3631
 
    fails, you may need to give an explicit base.
 
4252
    or the branch most recently merged using --remember.  The source of the
 
4253
    merge may also be specified in the form of a path to a file in another
 
4254
    branch:  in this case, only the modifications to that file are merged into
 
4255
    the current working tree.
 
4256
 
 
4257
    When merging from a branch, by default bzr will try to merge in all new
 
4258
    work from the other branch, automatically determining an appropriate base
 
4259
    revision.  If this fails, you may need to give an explicit base.
 
4260
 
 
4261
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
4262
    try to merge in all new work up to and including revision OTHER.
 
4263
 
 
4264
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
4265
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
4266
    causes some revisions to be skipped, i.e. if the destination branch does
 
4267
    not already contain revision BASE, such a merge is commonly referred to as
 
4268
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
4269
    cherrypicks. The changes look like a normal commit, and the history of the
 
4270
    changes from the other branch is not stored in the commit.
 
4271
 
 
4272
    Revision numbers are always relative to the source branch.
3632
4273
 
3633
4274
    Merge will do its best to combine the changes in two branches, but there
3634
4275
    are some kinds of problems only a human can fix.  When it encounters those,
3635
4276
    it will mark a conflict.  A conflict means that you need to fix something,
3636
 
    before you should commit.
 
4277
    before you can commit.
3637
4278
 
3638
4279
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
3639
4280
 
3640
 
    If there is no default branch set, the first merge will set it. After
3641
 
    that, you can omit the branch to use the default.  To change the
3642
 
    default, use --remember. The value will only be saved if the remote
3643
 
    location can be accessed.
 
4281
    If there is no default branch set, the first merge will set it (use
 
4282
    --no-remember to avoid setting it). After that, you can omit the branch
 
4283
    to use the default.  To change the default, use --remember. The value will
 
4284
    only be saved if the remote location can be accessed.
3644
4285
 
3645
4286
    The results of the merge are placed into the destination working
3646
4287
    directory, where they can be reviewed (with bzr diff), tested, and then
3647
4288
    committed to record the result of the merge.
3648
4289
 
3649
4290
    merge refuses to run if there are any uncommitted changes, unless
3650
 
    --force is given.
 
4291
    --force is given.  If --force is given, then the changes from the source 
 
4292
    will be merged with the current working tree, including any uncommitted
 
4293
    changes in the tree.  The --force option can also be used to create a
 
4294
    merge revision which has more than two parents.
 
4295
 
 
4296
    If one would like to merge changes from the working tree of the other
 
4297
    branch without merging any committed revisions, the --uncommitted option
 
4298
    can be given.
3651
4299
 
3652
4300
    To select only some changes to merge, use "merge -i", which will prompt
3653
4301
    you to apply each diff hunk and file change, similar to "shelve".
3654
4302
 
3655
4303
    :Examples:
3656
 
        To merge the latest revision from bzr.dev::
 
4304
        To merge all new revisions from bzr.dev::
3657
4305
 
3658
4306
            bzr merge ../bzr.dev
3659
4307
 
3668
4316
        To apply a merge directive contained in /tmp/merge::
3669
4317
 
3670
4318
            bzr merge /tmp/merge
 
4319
 
 
4320
        To create a merge revision with three parents from two branches
 
4321
        feature1a and feature1b:
 
4322
 
 
4323
            bzr merge ../feature1a
 
4324
            bzr merge ../feature1b --force
 
4325
            bzr commit -m 'revision with three parents'
3671
4326
    """
3672
4327
 
3673
4328
    encoding_type = 'exact'
3689
4344
                ' completely merged into the source, pull from the'
3690
4345
                ' source rather than merging.  When this happens,'
3691
4346
                ' you do not need to commit the result.'),
3692
 
        Option('directory',
 
4347
        custom_help('directory',
3693
4348
               help='Branch to merge into, '
3694
 
                    'rather than the one containing the working directory.',
3695
 
               short_name='d',
3696
 
               type=unicode,
3697
 
               ),
 
4349
                    'rather than the one containing the working directory.'),
3698
4350
        Option('preview', help='Instead of merging, show a diff of the'
3699
4351
               ' merge.'),
3700
4352
        Option('interactive', help='Select changes interactively.',
3702
4354
    ]
3703
4355
 
3704
4356
    def run(self, location=None, revision=None, force=False,
3705
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
4357
            merge_type=None, show_base=False, reprocess=None, remember=None,
3706
4358
            uncommitted=False, pull=False,
3707
4359
            directory=None,
3708
4360
            preview=False,
3716
4368
        merger = None
3717
4369
        allow_pending = True
3718
4370
        verified = 'inapplicable'
 
4371
 
3719
4372
        tree = WorkingTree.open_containing(directory)[0]
 
4373
        if tree.branch.revno() == 0:
 
4374
            raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
 
4375
                                         'https://bugs.launchpad.net/bzr/+bug/308562'))
3720
4376
 
3721
4377
        try:
3722
4378
            basis_tree = tree.revision_tree(tree.last_revision())
3733
4389
            unversioned_filter=tree.is_ignored, view_info=view_info)
3734
4390
        pb = ui.ui_factory.nested_progress_bar()
3735
4391
        self.add_cleanup(pb.finished)
3736
 
        tree.lock_write()
3737
 
        self.add_cleanup(tree.unlock)
 
4392
        self.add_cleanup(tree.lock_write().unlock)
3738
4393
        if location is not None:
3739
4394
            try:
3740
4395
                mergeable = bundle.read_mergeable_from_url(location,
3743
4398
                mergeable = None
3744
4399
            else:
3745
4400
                if uncommitted:
3746
 
                    raise errors.BzrCommandError('Cannot use --uncommitted'
3747
 
                        ' with bundles or merge directives.')
 
4401
                    raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
 
4402
                        ' with bundles or merge directives.'))
3748
4403
 
3749
4404
                if revision is not None:
3750
 
                    raise errors.BzrCommandError(
3751
 
                        'Cannot use -r with merge directives or bundles')
 
4405
                    raise errors.BzrCommandError(gettext(
 
4406
                        'Cannot use -r with merge directives or bundles'))
3752
4407
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
3753
 
                   mergeable, pb)
 
4408
                   mergeable, None)
3754
4409
 
3755
4410
        if merger is None and uncommitted:
3756
4411
            if revision is not None and len(revision) > 0:
3757
 
                raise errors.BzrCommandError('Cannot use --uncommitted and'
3758
 
                    ' --revision at the same time.')
3759
 
            merger = self.get_merger_from_uncommitted(tree, location, pb)
 
4412
                raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
 
4413
                    ' --revision at the same time.'))
 
4414
            merger = self.get_merger_from_uncommitted(tree, location, None)
3760
4415
            allow_pending = False
3761
4416
 
3762
4417
        if merger is None:
3763
4418
            merger, allow_pending = self._get_merger_from_branch(tree,
3764
 
                location, revision, remember, possible_transports, pb)
 
4419
                location, revision, remember, possible_transports, None)
3765
4420
 
3766
4421
        merger.merge_type = merge_type
3767
4422
        merger.reprocess = reprocess
3769
4424
        self.sanity_check_merger(merger)
3770
4425
        if (merger.base_rev_id == merger.other_rev_id and
3771
4426
            merger.other_rev_id is not None):
3772
 
            note('Nothing to do.')
 
4427
            # check if location is a nonexistent file (and not a branch) to
 
4428
            # disambiguate the 'Nothing to do'
 
4429
            if merger.interesting_files:
 
4430
                if not merger.other_tree.has_filename(
 
4431
                    merger.interesting_files[0]):
 
4432
                    note(gettext("merger: ") + str(merger))
 
4433
                    raise errors.PathsDoNotExist([location])
 
4434
            note(gettext('Nothing to do.'))
3773
4435
            return 0
3774
 
        if pull:
 
4436
        if pull and not preview:
3775
4437
            if merger.interesting_files is not None:
3776
 
                raise errors.BzrCommandError('Cannot pull individual files')
 
4438
                raise errors.BzrCommandError(gettext('Cannot pull individual files'))
3777
4439
            if (merger.base_rev_id == tree.last_revision()):
3778
4440
                result = tree.pull(merger.other_branch, False,
3779
4441
                                   merger.other_rev_id)
3780
4442
                result.report(self.outf)
3781
4443
                return 0
3782
4444
        if merger.this_basis is None:
3783
 
            raise errors.BzrCommandError(
 
4445
            raise errors.BzrCommandError(gettext(
3784
4446
                "This branch has no commits."
3785
 
                " (perhaps you would prefer 'bzr pull')")
 
4447
                " (perhaps you would prefer 'bzr pull')"))
3786
4448
        if preview:
3787
4449
            return self._do_preview(merger)
3788
4450
        elif interactive:
3801
4463
    def _do_preview(self, merger):
3802
4464
        from bzrlib.diff import show_diff_trees
3803
4465
        result_tree = self._get_preview(merger)
 
4466
        path_encoding = osutils.get_diff_header_encoding()
3804
4467
        show_diff_trees(merger.this_tree, result_tree, self.outf,
3805
 
                        old_label='', new_label='')
 
4468
                        old_label='', new_label='',
 
4469
                        path_encoding=path_encoding)
3806
4470
 
3807
4471
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3808
4472
        merger.change_reporter = change_reporter
3837
4501
    def sanity_check_merger(self, merger):
3838
4502
        if (merger.show_base and
3839
4503
            not merger.merge_type is _mod_merge.Merge3Merger):
3840
 
            raise errors.BzrCommandError("Show-base is not supported for this"
3841
 
                                         " merge type. %s" % merger.merge_type)
 
4504
            raise errors.BzrCommandError(gettext("Show-base is not supported for this"
 
4505
                                         " merge type. %s") % merger.merge_type)
3842
4506
        if merger.reprocess is None:
3843
4507
            if merger.show_base:
3844
4508
                merger.reprocess = False
3846
4510
                # Use reprocess if the merger supports it
3847
4511
                merger.reprocess = merger.merge_type.supports_reprocess
3848
4512
        if merger.reprocess and not merger.merge_type.supports_reprocess:
3849
 
            raise errors.BzrCommandError("Conflict reduction is not supported"
3850
 
                                         " for merge type %s." %
 
4513
            raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
 
4514
                                         " for merge type %s.") %
3851
4515
                                         merger.merge_type)
3852
4516
        if merger.reprocess and merger.show_base:
3853
 
            raise errors.BzrCommandError("Cannot do conflict reduction and"
3854
 
                                         " show base.")
 
4517
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
 
4518
                                         " show base."))
3855
4519
 
3856
4520
    def _get_merger_from_branch(self, tree, location, revision, remember,
3857
4521
                                possible_transports, pb):
3884
4548
        if other_revision_id is None:
3885
4549
            other_revision_id = _mod_revision.ensure_null(
3886
4550
                other_branch.last_revision())
3887
 
        # Remember where we merge from
3888
 
        if ((remember or tree.branch.get_submit_branch() is None) and
3889
 
             user_location is not None):
 
4551
        # Remember where we merge from. We need to remember if:
 
4552
        # - user specify a location (and we don't merge from the parent
 
4553
        #   branch)
 
4554
        # - user ask to remember or there is no previous location set to merge
 
4555
        #   from and user didn't ask to *not* remember
 
4556
        if (user_location is not None
 
4557
            and ((remember
 
4558
                  or (remember is None
 
4559
                      and tree.branch.get_submit_branch() is None)))):
3890
4560
            tree.branch.set_submit_branch(other_branch.base)
3891
 
        _merge_tags_if_possible(other_branch, tree.branch)
 
4561
        # Merge tags (but don't set them in the master branch yet, the user
 
4562
        # might revert this merge).  Commit will propagate them.
 
4563
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
3892
4564
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
3893
4565
            other_revision_id, base_revision_id, other_branch, base_branch)
3894
4566
        if other_path != '':
3953
4625
            stored_location_type = "parent"
3954
4626
        mutter("%s", stored_location)
3955
4627
        if stored_location is None:
3956
 
            raise errors.BzrCommandError("No location specified or remembered")
 
4628
            raise errors.BzrCommandError(gettext("No location specified or remembered"))
3957
4629
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
3958
 
        note(u"%s remembered %s location %s", verb_string,
3959
 
                stored_location_type, display_url)
 
4630
        note(gettext("{0} remembered {1} location {2}").format(verb_string,
 
4631
                stored_location_type, display_url))
3960
4632
        return stored_location
3961
4633
 
3962
4634
 
3963
4635
class cmd_remerge(Command):
3964
 
    """Redo a merge.
 
4636
    __doc__ = """Redo a merge.
3965
4637
 
3966
4638
    Use this if you want to try a different merge technique while resolving
3967
4639
    conflicts.  Some merge techniques are better than others, and remerge
3992
4664
 
3993
4665
    def run(self, file_list=None, merge_type=None, show_base=False,
3994
4666
            reprocess=False):
 
4667
        from bzrlib.conflicts import restore
3995
4668
        if merge_type is None:
3996
4669
            merge_type = _mod_merge.Merge3Merger
3997
 
        tree, file_list = tree_files(file_list)
3998
 
        tree.lock_write()
3999
 
        self.add_cleanup(tree.unlock)
 
4670
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4671
        self.add_cleanup(tree.lock_write().unlock)
4000
4672
        parents = tree.get_parent_ids()
4001
4673
        if len(parents) != 2:
4002
 
            raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
4674
            raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
4003
4675
                                         " merges.  Not cherrypicking or"
4004
 
                                         " multi-merges.")
 
4676
                                         " multi-merges."))
4005
4677
        repository = tree.branch.repository
4006
4678
        interesting_ids = None
4007
4679
        new_conflicts = []
4016
4688
                if tree.kind(file_id) != "directory":
4017
4689
                    continue
4018
4690
 
4019
 
                for name, ie in tree.inventory.iter_entries(file_id):
 
4691
                # FIXME: Support nested trees
 
4692
                for name, ie in tree.root_inventory.iter_entries(file_id):
4020
4693
                    interesting_ids.add(ie.file_id)
4021
4694
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
4022
4695
        else:
4038
4711
        # list, we imply that the working tree text has seen and rejected
4039
4712
        # all the changes from the other tree, when in fact those changes
4040
4713
        # have not yet been seen.
4041
 
        pb = ui.ui_factory.nested_progress_bar()
4042
4714
        tree.set_parent_ids(parents[:1])
4043
4715
        try:
4044
 
            merger = _mod_merge.Merger.from_revision_ids(pb,
4045
 
                                                         tree, parents[1])
 
4716
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
4046
4717
            merger.interesting_ids = interesting_ids
4047
4718
            merger.merge_type = merge_type
4048
4719
            merger.show_base = show_base
4050
4721
            conflicts = merger.do_merge()
4051
4722
        finally:
4052
4723
            tree.set_parent_ids(parents)
4053
 
            pb.finished()
4054
4724
        if conflicts > 0:
4055
4725
            return 1
4056
4726
        else:
4058
4728
 
4059
4729
 
4060
4730
class cmd_revert(Command):
4061
 
    """Revert files to a previous revision.
 
4731
    __doc__ = """Revert files to a previous revision.
4062
4732
 
4063
4733
    Giving a list of files will revert only those files.  Otherwise, all files
4064
4734
    will be reverted.  If the revision is not specified with '--revision', the
4065
4735
    last committed revision is used.
4066
4736
 
4067
4737
    To remove only some changes, without reverting to a prior version, use
4068
 
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4069
 
    changes introduced by -2, without affecting the changes introduced by -1.
4070
 
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
4738
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4739
    will remove the changes introduced by the second last commit (-2), without
 
4740
    affecting the changes introduced by the last commit (-1).  To remove
 
4741
    certain changes on a hunk-by-hunk basis, see the shelve command.
4071
4742
 
4072
4743
    By default, any files that have been manually changed will be backed up
4073
4744
    first.  (Files changed only by merge are not backed up.)  Backup files have
4083
4754
    created as above.  Directories containing unknown files will not be
4084
4755
    deleted.
4085
4756
 
4086
 
    The working tree contains a list of pending merged revisions, which will
4087
 
    be included as parents in the next commit.  Normally, revert clears that
4088
 
    list as well as reverting the files.  If any files are specified, revert
4089
 
    leaves the pending merge list alone and reverts only the files.  Use "bzr
4090
 
    revert ." in the tree root to revert all files but keep the merge record,
4091
 
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4757
    The working tree contains a list of revisions that have been merged but
 
4758
    not yet committed. These revisions will be included as additional parents
 
4759
    of the next commit.  Normally, using revert clears that list as well as
 
4760
    reverting the files.  If any files are specified, revert leaves the list
 
4761
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4762
    .`` in the tree root to revert all files but keep the recorded merges,
 
4763
    and ``bzr revert --forget-merges`` to clear the pending merge list without
4092
4764
    reverting any files.
4093
4765
 
4094
 
    Using "bzr revert --forget-merges", it is possible to apply the changes
4095
 
    from an arbitrary merge as a single revision.  To do this, perform the
4096
 
    merge as desired.  Then doing revert with the "--forget-merges" option will
4097
 
    keep the content of the tree as it was, but it will clear the list of
4098
 
    pending merges.  The next commit will then contain all of the changes that
4099
 
    would have been in the merge, but without any mention of the other parent
4100
 
    revisions.  Because this technique forgets where these changes originated,
4101
 
    it may cause additional conflicts on later merges involving the source and
 
4766
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4767
    changes from a branch in a single revision.  To do this, perform the merge
 
4768
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4769
    the content of the tree as it was, but it will clear the list of pending
 
4770
    merges.  The next commit will then contain all of the changes that are
 
4771
    present in the other branch, but without any other parent revisions.
 
4772
    Because this technique forgets where these changes originated, it may
 
4773
    cause additional conflicts on later merges involving the same source and
4102
4774
    target branches.
4103
4775
    """
4104
4776
 
4105
 
    _see_also = ['cat', 'export']
 
4777
    _see_also = ['cat', 'export', 'merge', 'shelve']
4106
4778
    takes_options = [
4107
4779
        'revision',
4108
4780
        Option('no-backup', "Do not save backups of reverted files."),
4113
4785
 
4114
4786
    def run(self, revision=None, no_backup=False, file_list=None,
4115
4787
            forget_merges=None):
4116
 
        tree, file_list = tree_files(file_list)
4117
 
        tree.lock_write()
4118
 
        self.add_cleanup(tree.unlock)
 
4788
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4789
        self.add_cleanup(tree.lock_tree_write().unlock)
4119
4790
        if forget_merges:
4120
4791
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4121
4792
        else:
4124
4795
    @staticmethod
4125
4796
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
4126
4797
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
4127
 
        pb = ui.ui_factory.nested_progress_bar()
4128
 
        try:
4129
 
            tree.revert(file_list, rev_tree, not no_backup, pb,
4130
 
                report_changes=True)
4131
 
        finally:
4132
 
            pb.finished()
 
4798
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4799
            report_changes=True)
4133
4800
 
4134
4801
 
4135
4802
class cmd_assert_fail(Command):
4136
 
    """Test reporting of assertion failures"""
 
4803
    __doc__ = """Test reporting of assertion failures"""
4137
4804
    # intended just for use in testing
4138
4805
 
4139
4806
    hidden = True
4143
4810
 
4144
4811
 
4145
4812
class cmd_help(Command):
4146
 
    """Show help on a command or other topic.
 
4813
    __doc__ = """Show help on a command or other topic.
4147
4814
    """
4148
4815
 
4149
4816
    _see_also = ['topics']
4162
4829
 
4163
4830
 
4164
4831
class cmd_shell_complete(Command):
4165
 
    """Show appropriate completions for context.
 
4832
    __doc__ = """Show appropriate completions for context.
4166
4833
 
4167
4834
    For a list of all available commands, say 'bzr shell-complete'.
4168
4835
    """
4172
4839
 
4173
4840
    @display_command
4174
4841
    def run(self, context=None):
4175
 
        import shellcomplete
 
4842
        from bzrlib import shellcomplete
4176
4843
        shellcomplete.shellcomplete(context)
4177
4844
 
4178
4845
 
4179
4846
class cmd_missing(Command):
4180
 
    """Show unmerged/unpulled revisions between two branches.
 
4847
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4181
4848
 
4182
4849
    OTHER_BRANCH may be local or remote.
4183
4850
 
4214
4881
    _see_also = ['merge', 'pull']
4215
4882
    takes_args = ['other_branch?']
4216
4883
    takes_options = [
 
4884
        'directory',
4217
4885
        Option('reverse', 'Reverse the order of revisions.'),
4218
4886
        Option('mine-only',
4219
4887
               'Display changes in the local branch only.'),
4231
4899
            type=_parse_revision_str,
4232
4900
            help='Filter on local branch revisions (inclusive). '
4233
4901
                'See "help revisionspec" for details.'),
4234
 
        Option('include-merges',
 
4902
        Option('include-merged',
4235
4903
               'Show all revisions in addition to the mainline ones.'),
 
4904
        Option('include-merges', hidden=True,
 
4905
               help='Historical alias for --include-merged.'),
4236
4906
        ]
4237
4907
    encoding_type = 'replace'
4238
4908
 
4241
4911
            theirs_only=False,
4242
4912
            log_format=None, long=False, short=False, line=False,
4243
4913
            show_ids=False, verbose=False, this=False, other=False,
4244
 
            include_merges=False, revision=None, my_revision=None):
 
4914
            include_merged=None, revision=None, my_revision=None,
 
4915
            directory=u'.',
 
4916
            include_merges=symbol_versioning.DEPRECATED_PARAMETER):
4245
4917
        from bzrlib.missing import find_unmerged, iter_log_revisions
4246
4918
        def message(s):
4247
4919
            if not is_quiet():
4248
4920
                self.outf.write(s)
4249
4921
 
 
4922
        if symbol_versioning.deprecated_passed(include_merges):
 
4923
            ui.ui_factory.show_user_warning(
 
4924
                'deprecated_command_option',
 
4925
                deprecated_name='--include-merges',
 
4926
                recommended_name='--include-merged',
 
4927
                deprecated_in_version='2.5',
 
4928
                command=self.invoked_as)
 
4929
            if include_merged is None:
 
4930
                include_merged = include_merges
 
4931
            else:
 
4932
                raise errors.BzrCommandError(gettext(
 
4933
                    '{0} and {1} are mutually exclusive').format(
 
4934
                    '--include-merges', '--include-merged'))
 
4935
        if include_merged is None:
 
4936
            include_merged = False
4250
4937
        if this:
4251
4938
            mine_only = this
4252
4939
        if other:
4260
4947
        elif theirs_only:
4261
4948
            restrict = 'remote'
4262
4949
 
4263
 
        local_branch = Branch.open_containing(u".")[0]
 
4950
        local_branch = Branch.open_containing(directory)[0]
 
4951
        self.add_cleanup(local_branch.lock_read().unlock)
 
4952
 
4264
4953
        parent = local_branch.get_parent()
4265
4954
        if other_branch is None:
4266
4955
            other_branch = parent
4267
4956
            if other_branch is None:
4268
 
                raise errors.BzrCommandError("No peer location known"
4269
 
                                             " or specified.")
 
4957
                raise errors.BzrCommandError(gettext("No peer location known"
 
4958
                                             " or specified."))
4270
4959
            display_url = urlutils.unescape_for_display(parent,
4271
4960
                                                        self.outf.encoding)
4272
 
            message("Using saved parent location: "
4273
 
                    + display_url + "\n")
 
4961
            message(gettext("Using saved parent location: {0}\n").format(
 
4962
                    display_url))
4274
4963
 
4275
4964
        remote_branch = Branch.open(other_branch)
4276
4965
        if remote_branch.base == local_branch.base:
4277
4966
            remote_branch = local_branch
 
4967
        else:
 
4968
            self.add_cleanup(remote_branch.lock_read().unlock)
4278
4969
 
4279
 
        local_branch.lock_read()
4280
 
        self.add_cleanup(local_branch.unlock)
4281
4970
        local_revid_range = _revision_range_to_revid_range(
4282
4971
            _get_revision_range(my_revision, local_branch,
4283
4972
                self.name()))
4284
4973
 
4285
 
        remote_branch.lock_read()
4286
 
        self.add_cleanup(remote_branch.unlock)
4287
4974
        remote_revid_range = _revision_range_to_revid_range(
4288
4975
            _get_revision_range(revision,
4289
4976
                remote_branch, self.name()))
4291
4978
        local_extra, remote_extra = find_unmerged(
4292
4979
            local_branch, remote_branch, restrict,
4293
4980
            backward=not reverse,
4294
 
            include_merges=include_merges,
 
4981
            include_merged=include_merged,
4295
4982
            local_revid_range=local_revid_range,
4296
4983
            remote_revid_range=remote_revid_range)
4297
4984
 
4304
4991
 
4305
4992
        status_code = 0
4306
4993
        if local_extra and not theirs_only:
4307
 
            message("You have %d extra revision(s):\n" %
 
4994
            message(ngettext("You have %d extra revision:\n",
 
4995
                             "You have %d extra revisions:\n", 
 
4996
                             len(local_extra)) %
4308
4997
                len(local_extra))
4309
4998
            for revision in iter_log_revisions(local_extra,
4310
4999
                                local_branch.repository,
4318
5007
        if remote_extra and not mine_only:
4319
5008
            if printed_local is True:
4320
5009
                message("\n\n\n")
4321
 
            message("You are missing %d revision(s):\n" %
 
5010
            message(ngettext("You are missing %d revision:\n",
 
5011
                             "You are missing %d revisions:\n",
 
5012
                             len(remote_extra)) %
4322
5013
                len(remote_extra))
4323
5014
            for revision in iter_log_revisions(remote_extra,
4324
5015
                                remote_branch.repository,
4328
5019
 
4329
5020
        if mine_only and not local_extra:
4330
5021
            # We checked local, and found nothing extra
4331
 
            message('This branch is up to date.\n')
 
5022
            message(gettext('This branch has no new revisions.\n'))
4332
5023
        elif theirs_only and not remote_extra:
4333
5024
            # We checked remote, and found nothing extra
4334
 
            message('Other branch is up to date.\n')
 
5025
            message(gettext('Other branch has no new revisions.\n'))
4335
5026
        elif not (mine_only or theirs_only or local_extra or
4336
5027
                  remote_extra):
4337
5028
            # We checked both branches, and neither one had extra
4338
5029
            # revisions
4339
 
            message("Branches are up to date.\n")
 
5030
            message(gettext("Branches are up to date.\n"))
4340
5031
        self.cleanup_now()
4341
5032
        if not status_code and parent is None and other_branch is not None:
4342
 
            local_branch.lock_write()
4343
 
            self.add_cleanup(local_branch.unlock)
 
5033
            self.add_cleanup(local_branch.lock_write().unlock)
4344
5034
            # handle race conditions - a parent might be set while we run.
4345
5035
            if local_branch.get_parent() is None:
4346
5036
                local_branch.set_parent(remote_branch.base)
4348
5038
 
4349
5039
 
4350
5040
class cmd_pack(Command):
4351
 
    """Compress the data within a repository."""
 
5041
    __doc__ = """Compress the data within a repository.
 
5042
 
 
5043
    This operation compresses the data within a bazaar repository. As
 
5044
    bazaar supports automatic packing of repository, this operation is
 
5045
    normally not required to be done manually.
 
5046
 
 
5047
    During the pack operation, bazaar takes a backup of existing repository
 
5048
    data, i.e. pack files. This backup is eventually removed by bazaar
 
5049
    automatically when it is safe to do so. To save disk space by removing
 
5050
    the backed up pack files, the --clean-obsolete-packs option may be
 
5051
    used.
 
5052
 
 
5053
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
5054
    during or immediately after repacking, you may be left with a state
 
5055
    where the deletion has been written to disk but the new packs have not
 
5056
    been. In this case the repository may be unusable.
 
5057
    """
4352
5058
 
4353
5059
    _see_also = ['repositories']
4354
5060
    takes_args = ['branch_or_repo?']
 
5061
    takes_options = [
 
5062
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
5063
        ]
4355
5064
 
4356
 
    def run(self, branch_or_repo='.'):
4357
 
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
5065
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
5066
        dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
4358
5067
        try:
4359
5068
            branch = dir.open_branch()
4360
5069
            repository = branch.repository
4361
5070
        except errors.NotBranchError:
4362
5071
            repository = dir.open_repository()
4363
 
        repository.pack()
 
5072
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
4364
5073
 
4365
5074
 
4366
5075
class cmd_plugins(Command):
4367
 
    """List the installed plugins.
 
5076
    __doc__ = """List the installed plugins.
4368
5077
 
4369
5078
    This command displays the list of installed plugins including
4370
5079
    version of plugin and a short description of each.
4377
5086
    adding new commands, providing additional network transports and
4378
5087
    customizing log output.
4379
5088
 
4380
 
    See the Bazaar web site, http://bazaar-vcs.org, for further
4381
 
    information on plugins including where to find them and how to
4382
 
    install them. Instructions are also provided there on how to
4383
 
    write new plugins using the Python programming language.
 
5089
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
5090
    for further information on plugins including where to find them and how to
 
5091
    install them. Instructions are also provided there on how to write new
 
5092
    plugins using the Python programming language.
4384
5093
    """
4385
5094
    takes_options = ['verbose']
4386
5095
 
4387
5096
    @display_command
4388
5097
    def run(self, verbose=False):
4389
 
        import bzrlib.plugin
4390
 
        from inspect import getdoc
4391
 
        result = []
4392
 
        for name, plugin in bzrlib.plugin.plugins().items():
4393
 
            version = plugin.__version__
4394
 
            if version == 'unknown':
4395
 
                version = ''
4396
 
            name_ver = '%s %s' % (name, version)
4397
 
            d = getdoc(plugin.module)
4398
 
            if d:
4399
 
                doc = d.split('\n')[0]
4400
 
            else:
4401
 
                doc = '(no description)'
4402
 
            result.append((name_ver, doc, plugin.path()))
4403
 
        for name_ver, doc, path in sorted(result):
4404
 
            print name_ver
4405
 
            print '   ', doc
4406
 
            if verbose:
4407
 
                print '   ', path
4408
 
            print
 
5098
        from bzrlib import plugin
 
5099
        # Don't give writelines a generator as some codecs don't like that
 
5100
        self.outf.writelines(
 
5101
            list(plugin.describe_plugins(show_paths=verbose)))
4409
5102
 
4410
5103
 
4411
5104
class cmd_testament(Command):
4412
 
    """Show testament (signing-form) of a revision."""
 
5105
    __doc__ = """Show testament (signing-form) of a revision."""
4413
5106
    takes_options = [
4414
5107
            'revision',
4415
5108
            Option('long', help='Produce long-format testament.'),
4427
5120
            b = Branch.open_containing(branch)[0]
4428
5121
        else:
4429
5122
            b = Branch.open(branch)
4430
 
        b.lock_read()
4431
 
        self.add_cleanup(b.unlock)
 
5123
        self.add_cleanup(b.lock_read().unlock)
4432
5124
        if revision is None:
4433
5125
            rev_id = b.last_revision()
4434
5126
        else:
4441
5133
 
4442
5134
 
4443
5135
class cmd_annotate(Command):
4444
 
    """Show the origin of each line in a file.
 
5136
    __doc__ = """Show the origin of each line in a file.
4445
5137
 
4446
5138
    This prints out the given file with an annotation on the left side
4447
5139
    indicating which revision, author and date introduced the change.
4458
5150
                     Option('long', help='Show commit date in annotations.'),
4459
5151
                     'revision',
4460
5152
                     'show-ids',
 
5153
                     'directory',
4461
5154
                     ]
4462
5155
    encoding_type = 'exact'
4463
5156
 
4464
5157
    @display_command
4465
5158
    def run(self, filename, all=False, long=False, revision=None,
4466
 
            show_ids=False):
4467
 
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
5159
            show_ids=False, directory=None):
 
5160
        from bzrlib.annotate import (
 
5161
            annotate_file_tree,
 
5162
            )
4468
5163
        wt, branch, relpath = \
4469
 
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
5164
            _open_directory_or_containing_tree_or_branch(filename, directory)
4470
5165
        if wt is not None:
4471
 
            wt.lock_read()
4472
 
            self.add_cleanup(wt.unlock)
 
5166
            self.add_cleanup(wt.lock_read().unlock)
4473
5167
        else:
4474
 
            branch.lock_read()
4475
 
            self.add_cleanup(branch.unlock)
 
5168
            self.add_cleanup(branch.lock_read().unlock)
4476
5169
        tree = _get_one_revision_tree('annotate', revision, branch=branch)
4477
 
        tree.lock_read()
4478
 
        self.add_cleanup(tree.unlock)
4479
 
        if wt is not None:
 
5170
        self.add_cleanup(tree.lock_read().unlock)
 
5171
        if wt is not None and revision is None:
4480
5172
            file_id = wt.path2id(relpath)
4481
5173
        else:
4482
5174
            file_id = tree.path2id(relpath)
4483
5175
        if file_id is None:
4484
5176
            raise errors.NotVersionedError(filename)
4485
 
        file_version = tree.inventory[file_id].revision
4486
5177
        if wt is not None and revision is None:
4487
5178
            # If there is a tree and we're not annotating historical
4488
5179
            # versions, annotate the working tree's content.
4489
5180
            annotate_file_tree(wt, file_id, self.outf, long, all,
4490
5181
                show_ids=show_ids)
4491
5182
        else:
4492
 
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4493
 
                          show_ids=show_ids)
 
5183
            annotate_file_tree(tree, file_id, self.outf, long, all,
 
5184
                show_ids=show_ids, branch=branch)
4494
5185
 
4495
5186
 
4496
5187
class cmd_re_sign(Command):
4497
 
    """Create a digital signature for an existing revision."""
 
5188
    __doc__ = """Create a digital signature for an existing revision."""
4498
5189
    # TODO be able to replace existing ones.
4499
5190
 
4500
5191
    hidden = True # is this right ?
4501
5192
    takes_args = ['revision_id*']
4502
 
    takes_options = ['revision']
 
5193
    takes_options = ['directory', 'revision']
4503
5194
 
4504
 
    def run(self, revision_id_list=None, revision=None):
 
5195
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
4505
5196
        if revision_id_list is not None and revision is not None:
4506
 
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
5197
            raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
4507
5198
        if revision_id_list is None and revision is None:
4508
 
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
4509
 
        b = WorkingTree.open_containing(u'.')[0].branch
4510
 
        b.lock_write()
4511
 
        self.add_cleanup(b.unlock)
 
5199
            raise errors.BzrCommandError(gettext('You must supply either --revision or a revision_id'))
 
5200
        b = WorkingTree.open_containing(directory)[0].branch
 
5201
        self.add_cleanup(b.lock_write().unlock)
4512
5202
        return self._run(b, revision_id_list, revision)
4513
5203
 
4514
5204
    def _run(self, b, revision_id_list, revision):
4515
5205
        import bzrlib.gpg as gpg
4516
 
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
5206
        gpg_strategy = gpg.GPGStrategy(b.get_config_stack())
4517
5207
        if revision_id_list is not None:
4518
5208
            b.repository.start_write_group()
4519
5209
            try:
4544
5234
                if to_revid is None:
4545
5235
                    to_revno = b.revno()
4546
5236
                if from_revno is None or to_revno is None:
4547
 
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
5237
                    raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
4548
5238
                b.repository.start_write_group()
4549
5239
                try:
4550
5240
                    for revno in range(from_revno, to_revno + 1):
4556
5246
                else:
4557
5247
                    b.repository.commit_write_group()
4558
5248
            else:
4559
 
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
5249
                raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
4560
5250
 
4561
5251
 
4562
5252
class cmd_bind(Command):
4563
 
    """Convert the current branch into a checkout of the supplied branch.
 
5253
    __doc__ = """Convert the current branch into a checkout of the supplied branch.
 
5254
    If no branch is supplied, rebind to the last bound location.
4564
5255
 
4565
5256
    Once converted into a checkout, commits must succeed on the master branch
4566
5257
    before they will be applied to the local branch.
4572
5263
 
4573
5264
    _see_also = ['checkouts', 'unbind']
4574
5265
    takes_args = ['location?']
4575
 
    takes_options = []
 
5266
    takes_options = ['directory']
4576
5267
 
4577
 
    def run(self, location=None):
4578
 
        b, relpath = Branch.open_containing(u'.')
 
5268
    def run(self, location=None, directory=u'.'):
 
5269
        b, relpath = Branch.open_containing(directory)
4579
5270
        if location is None:
4580
5271
            try:
4581
5272
                location = b.get_old_bound_location()
4582
5273
            except errors.UpgradeRequired:
4583
 
                raise errors.BzrCommandError('No location supplied.  '
4584
 
                    'This format does not remember old locations.')
 
5274
                raise errors.BzrCommandError(gettext('No location supplied.  '
 
5275
                    'This format does not remember old locations.'))
4585
5276
            else:
4586
5277
                if location is None:
4587
 
                    raise errors.BzrCommandError('No location supplied and no '
4588
 
                        'previous location known')
 
5278
                    if b.get_bound_location() is not None:
 
5279
                        raise errors.BzrCommandError(
 
5280
                            gettext('Branch is already bound'))
 
5281
                    else:
 
5282
                        raise errors.BzrCommandError(
 
5283
                            gettext('No location supplied'
 
5284
                                    ' and no previous location known'))
4589
5285
        b_other = Branch.open(location)
4590
5286
        try:
4591
5287
            b.bind(b_other)
4592
5288
        except errors.DivergedBranches:
4593
 
            raise errors.BzrCommandError('These branches have diverged.'
4594
 
                                         ' Try merging, and then bind again.')
 
5289
            raise errors.BzrCommandError(gettext('These branches have diverged.'
 
5290
                                         ' Try merging, and then bind again.'))
4595
5291
        if b.get_config().has_explicit_nickname():
4596
5292
            b.nick = b_other.nick
4597
5293
 
4598
5294
 
4599
5295
class cmd_unbind(Command):
4600
 
    """Convert the current checkout into a regular branch.
 
5296
    __doc__ = """Convert the current checkout into a regular branch.
4601
5297
 
4602
5298
    After unbinding, the local branch is considered independent and subsequent
4603
5299
    commits will be local only.
4605
5301
 
4606
5302
    _see_also = ['checkouts', 'bind']
4607
5303
    takes_args = []
4608
 
    takes_options = []
 
5304
    takes_options = ['directory']
4609
5305
 
4610
 
    def run(self):
4611
 
        b, relpath = Branch.open_containing(u'.')
 
5306
    def run(self, directory=u'.'):
 
5307
        b, relpath = Branch.open_containing(directory)
4612
5308
        if not b.unbind():
4613
 
            raise errors.BzrCommandError('Local branch is not bound')
 
5309
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
4614
5310
 
4615
5311
 
4616
5312
class cmd_uncommit(Command):
4617
 
    """Remove the last committed revision.
 
5313
    __doc__ = """Remove the last committed revision.
4618
5314
 
4619
5315
    --verbose will print out what is being removed.
4620
5316
    --dry-run will go through all the motions, but not actually
4637
5333
    takes_options = ['verbose', 'revision',
4638
5334
                    Option('dry-run', help='Don\'t actually make changes.'),
4639
5335
                    Option('force', help='Say yes to all questions.'),
 
5336
                    Option('keep-tags',
 
5337
                           help='Keep tags that point to removed revisions.'),
4640
5338
                    Option('local',
4641
5339
                           help="Only remove the commits from the local branch"
4642
5340
                                " when in a checkout."
4646
5344
    aliases = []
4647
5345
    encoding_type = 'replace'
4648
5346
 
4649
 
    def run(self, location=None,
4650
 
            dry_run=False, verbose=False,
4651
 
            revision=None, force=False, local=False):
 
5347
    def run(self, location=None, dry_run=False, verbose=False,
 
5348
            revision=None, force=False, local=False, keep_tags=False):
4652
5349
        if location is None:
4653
5350
            location = u'.'
4654
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
5351
        control, relpath = controldir.ControlDir.open_containing(location)
4655
5352
        try:
4656
5353
            tree = control.open_workingtree()
4657
5354
            b = tree.branch
4660
5357
            b = control.open_branch()
4661
5358
 
4662
5359
        if tree is not None:
4663
 
            tree.lock_write()
4664
 
            self.add_cleanup(tree.unlock)
 
5360
            self.add_cleanup(tree.lock_write().unlock)
4665
5361
        else:
4666
 
            b.lock_write()
4667
 
            self.add_cleanup(b.unlock)
4668
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
5362
            self.add_cleanup(b.lock_write().unlock)
 
5363
        return self._run(b, tree, dry_run, verbose, revision, force,
 
5364
                         local, keep_tags)
4669
5365
 
4670
 
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
5366
    def _run(self, b, tree, dry_run, verbose, revision, force, local,
 
5367
             keep_tags):
4671
5368
        from bzrlib.log import log_formatter, show_log
4672
5369
        from bzrlib.uncommit import uncommit
4673
5370
 
4688
5385
                rev_id = b.get_rev_id(revno)
4689
5386
 
4690
5387
        if rev_id is None or _mod_revision.is_null(rev_id):
4691
 
            self.outf.write('No revisions to uncommit.\n')
 
5388
            self.outf.write(gettext('No revisions to uncommit.\n'))
4692
5389
            return 1
4693
5390
 
4694
5391
        lf = log_formatter('short',
4703
5400
                 end_revision=last_revno)
4704
5401
 
4705
5402
        if dry_run:
4706
 
            print 'Dry-run, pretending to remove the above revisions.'
4707
 
            if not force:
4708
 
                val = raw_input('Press <enter> to continue')
 
5403
            self.outf.write(gettext('Dry-run, pretending to remove'
 
5404
                            ' the above revisions.\n'))
4709
5405
        else:
4710
 
            print 'The above revision(s) will be removed.'
4711
 
            if not force:
4712
 
                val = raw_input('Are you sure [y/N]? ')
4713
 
                if val.lower() not in ('y', 'yes'):
4714
 
                    print 'Canceled'
4715
 
                    return 0
 
5406
            self.outf.write(gettext('The above revision(s) will be removed.\n'))
 
5407
 
 
5408
        if not force:
 
5409
            if not ui.ui_factory.confirm_action(
 
5410
                    gettext(u'Uncommit these revisions'),
 
5411
                    'bzrlib.builtins.uncommit',
 
5412
                    {}):
 
5413
                self.outf.write(gettext('Canceled\n'))
 
5414
                return 0
4716
5415
 
4717
5416
        mutter('Uncommitting from {%s} to {%s}',
4718
5417
               last_rev_id, rev_id)
4719
5418
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4720
 
                 revno=revno, local=local)
4721
 
        note('You can restore the old tip by running:\n'
4722
 
             '  bzr pull . -r revid:%s', last_rev_id)
 
5419
                 revno=revno, local=local, keep_tags=keep_tags)
 
5420
        self.outf.write(gettext('You can restore the old tip by running:\n'
 
5421
             '  bzr pull . -r revid:%s\n') % last_rev_id)
4723
5422
 
4724
5423
 
4725
5424
class cmd_break_lock(Command):
4726
 
    """Break a dead lock on a repository, branch or working directory.
 
5425
    __doc__ = """Break a dead lock.
 
5426
 
 
5427
    This command breaks a lock on a repository, branch, working directory or
 
5428
    config file.
4727
5429
 
4728
5430
    CAUTION: Locks should only be broken when you are sure that the process
4729
5431
    holding the lock has been stopped.
4734
5436
    :Examples:
4735
5437
        bzr break-lock
4736
5438
        bzr break-lock bzr+ssh://example.com/bzr/foo
 
5439
        bzr break-lock --conf ~/.bazaar
4737
5440
    """
 
5441
 
4738
5442
    takes_args = ['location?']
 
5443
    takes_options = [
 
5444
        Option('config',
 
5445
               help='LOCATION is the directory where the config lock is.'),
 
5446
        Option('force',
 
5447
            help='Do not ask for confirmation before breaking the lock.'),
 
5448
        ]
4739
5449
 
4740
 
    def run(self, location=None, show=False):
 
5450
    def run(self, location=None, config=False, force=False):
4741
5451
        if location is None:
4742
5452
            location = u'.'
4743
 
        control, relpath = bzrdir.BzrDir.open_containing(location)
4744
 
        try:
4745
 
            control.break_lock()
4746
 
        except NotImplementedError:
4747
 
            pass
 
5453
        if force:
 
5454
            ui.ui_factory = ui.ConfirmationUserInterfacePolicy(ui.ui_factory,
 
5455
                None,
 
5456
                {'bzrlib.lockdir.break': True})
 
5457
        if config:
 
5458
            conf = _mod_config.LockableConfig(file_name=location)
 
5459
            conf.break_lock()
 
5460
        else:
 
5461
            control, relpath = controldir.ControlDir.open_containing(location)
 
5462
            try:
 
5463
                control.break_lock()
 
5464
            except NotImplementedError:
 
5465
                pass
4748
5466
 
4749
5467
 
4750
5468
class cmd_wait_until_signalled(Command):
4751
 
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
5469
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4752
5470
 
4753
5471
    This just prints a line to signal when it is ready, then blocks on stdin.
4754
5472
    """
4762
5480
 
4763
5481
 
4764
5482
class cmd_serve(Command):
4765
 
    """Run the bzr server."""
 
5483
    __doc__ = """Run the bzr server."""
4766
5484
 
4767
5485
    aliases = ['server']
4768
5486
 
4773
5491
               help="Protocol to serve.",
4774
5492
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
4775
5493
               value_switches=True),
 
5494
        Option('listen',
 
5495
               help='Listen for connections on nominated address.', type=str),
4776
5496
        Option('port',
4777
 
               help='Listen for connections on nominated port of the form '
4778
 
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4779
 
                    'result in a dynamically allocated port.  The default port '
4780
 
                    'depends on the protocol.',
4781
 
               type=str),
4782
 
        Option('directory',
4783
 
               help='Serve contents of this directory.',
4784
 
               type=unicode),
 
5497
               help='Listen for connections on nominated port.  Passing 0 as '
 
5498
                    'the port number will result in a dynamically allocated '
 
5499
                    'port.  The default port depends on the protocol.',
 
5500
               type=int),
 
5501
        custom_help('directory',
 
5502
               help='Serve contents of this directory.'),
4785
5503
        Option('allow-writes',
4786
5504
               help='By default the server is a readonly server.  Supplying '
4787
5505
                    '--allow-writes enables write access to the contents of '
4791
5509
                    'option leads to global uncontrolled write access to your '
4792
5510
                    'file system.'
4793
5511
                ),
 
5512
        Option('client-timeout', type=float,
 
5513
               help='Override the default idle client timeout (5min).'),
4794
5514
        ]
4795
5515
 
4796
 
    def get_host_and_port(self, port):
4797
 
        """Return the host and port to run the smart server on.
4798
 
 
4799
 
        If 'port' is None, None will be returned for the host and port.
4800
 
 
4801
 
        If 'port' has a colon in it, the string before the colon will be
4802
 
        interpreted as the host.
4803
 
 
4804
 
        :param port: A string of the port to run the server on.
4805
 
        :return: A tuple of (host, port), where 'host' is a host name or IP,
4806
 
            and port is an integer TCP/IP port.
4807
 
        """
4808
 
        host = None
4809
 
        if port is not None:
4810
 
            if ':' in port:
4811
 
                host, port = port.split(':')
4812
 
            port = int(port)
4813
 
        return host, port
4814
 
 
4815
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
4816
 
            protocol=None):
4817
 
        from bzrlib.transport import get_transport, transport_server_registry
 
5516
    def run(self, listen=None, port=None, inet=False, directory=None,
 
5517
            allow_writes=False, protocol=None, client_timeout=None):
 
5518
        from bzrlib import transport
4818
5519
        if directory is None:
4819
5520
            directory = os.getcwd()
4820
5521
        if protocol is None:
4821
 
            protocol = transport_server_registry.get()
4822
 
        host, port = self.get_host_and_port(port)
4823
 
        url = urlutils.local_path_to_url(directory)
 
5522
            protocol = transport.transport_server_registry.get()
 
5523
        url = transport.location_to_url(directory)
4824
5524
        if not allow_writes:
4825
5525
            url = 'readonly+' + url
4826
 
        transport = get_transport(url)
4827
 
        protocol(transport, host, port, inet)
 
5526
        t = transport.get_transport_from_url(url)
 
5527
        protocol(t, listen, port, inet, client_timeout)
4828
5528
 
4829
5529
 
4830
5530
class cmd_join(Command):
4831
 
    """Combine a tree into its containing tree.
 
5531
    __doc__ = """Combine a tree into its containing tree.
4832
5532
 
4833
5533
    This command requires the target tree to be in a rich-root format.
4834
5534
 
4836
5536
    not part of it.  (Such trees can be produced by "bzr split", but also by
4837
5537
    running "bzr branch" with the target inside a tree.)
4838
5538
 
4839
 
    The result is a combined tree, with the subtree no longer an independant
 
5539
    The result is a combined tree, with the subtree no longer an independent
4840
5540
    part.  This is marked as a merge of the subtree into the containing tree,
4841
5541
    and all history is preserved.
4842
5542
    """
4853
5553
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
4854
5554
        repo = containing_tree.branch.repository
4855
5555
        if not repo.supports_rich_root():
4856
 
            raise errors.BzrCommandError(
 
5556
            raise errors.BzrCommandError(gettext(
4857
5557
                "Can't join trees because %s doesn't support rich root data.\n"
4858
 
                "You can use bzr upgrade on the repository."
 
5558
                "You can use bzr upgrade on the repository.")
4859
5559
                % (repo,))
4860
5560
        if reference:
4861
5561
            try:
4863
5563
            except errors.BadReferenceTarget, e:
4864
5564
                # XXX: Would be better to just raise a nicely printable
4865
5565
                # exception from the real origin.  Also below.  mbp 20070306
4866
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
4867
 
                                             (tree, e.reason))
 
5566
                raise errors.BzrCommandError(
 
5567
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
4868
5568
        else:
4869
5569
            try:
4870
5570
                containing_tree.subsume(sub_tree)
4871
5571
            except errors.BadSubsumeSource, e:
4872
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
4873
 
                                             (tree, e.reason))
 
5572
                raise errors.BzrCommandError(
 
5573
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
4874
5574
 
4875
5575
 
4876
5576
class cmd_split(Command):
4877
 
    """Split a subdirectory of a tree into a separate tree.
 
5577
    __doc__ = """Split a subdirectory of a tree into a separate tree.
4878
5578
 
4879
5579
    This command will produce a target tree in a format that supports
4880
5580
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4900
5600
 
4901
5601
 
4902
5602
class cmd_merge_directive(Command):
4903
 
    """Generate a merge directive for auto-merge tools.
 
5603
    __doc__ = """Generate a merge directive for auto-merge tools.
4904
5604
 
4905
5605
    A directive requests a merge to be performed, and also provides all the
4906
5606
    information necessary to do so.  This means it must either include a
4923
5623
    _see_also = ['send']
4924
5624
 
4925
5625
    takes_options = [
 
5626
        'directory',
4926
5627
        RegistryOption.from_kwargs('patch-type',
4927
5628
            'The type of patch to include in the directive.',
4928
5629
            title='Patch type',
4941
5642
    encoding_type = 'exact'
4942
5643
 
4943
5644
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
4944
 
            sign=False, revision=None, mail_to=None, message=None):
 
5645
            sign=False, revision=None, mail_to=None, message=None,
 
5646
            directory=u'.'):
4945
5647
        from bzrlib.revision import ensure_null, NULL_REVISION
4946
5648
        include_patch, include_bundle = {
4947
5649
            'plain': (False, False),
4948
5650
            'diff': (True, False),
4949
5651
            'bundle': (True, True),
4950
5652
            }[patch_type]
4951
 
        branch = Branch.open('.')
 
5653
        branch = Branch.open(directory)
4952
5654
        stored_submit_branch = branch.get_submit_branch()
4953
5655
        if submit_branch is None:
4954
5656
            submit_branch = stored_submit_branch
4958
5660
        if submit_branch is None:
4959
5661
            submit_branch = branch.get_parent()
4960
5662
        if submit_branch is None:
4961
 
            raise errors.BzrCommandError('No submit branch specified or known')
 
5663
            raise errors.BzrCommandError(gettext('No submit branch specified or known'))
4962
5664
 
4963
5665
        stored_public_branch = branch.get_public_branch()
4964
5666
        if public_branch is None:
4965
5667
            public_branch = stored_public_branch
4966
5668
        elif stored_public_branch is None:
 
5669
            # FIXME: Should be done only if we succeed ? -- vila 2012-01-03
4967
5670
            branch.set_public_branch(public_branch)
4968
5671
        if not include_bundle and public_branch is None:
4969
 
            raise errors.BzrCommandError('No public branch specified or'
4970
 
                                         ' known')
 
5672
            raise errors.BzrCommandError(gettext('No public branch specified or'
 
5673
                                         ' known'))
4971
5674
        base_revision_id = None
4972
5675
        if revision is not None:
4973
5676
            if len(revision) > 2:
4974
 
                raise errors.BzrCommandError('bzr merge-directive takes '
4975
 
                    'at most two one revision identifiers')
 
5677
                raise errors.BzrCommandError(gettext('bzr merge-directive takes '
 
5678
                    'at most two one revision identifiers'))
4976
5679
            revision_id = revision[-1].as_revision_id(branch)
4977
5680
            if len(revision) == 2:
4978
5681
                base_revision_id = revision[0].as_revision_id(branch)
4980
5683
            revision_id = branch.last_revision()
4981
5684
        revision_id = ensure_null(revision_id)
4982
5685
        if revision_id == NULL_REVISION:
4983
 
            raise errors.BzrCommandError('No revisions to bundle.')
 
5686
            raise errors.BzrCommandError(gettext('No revisions to bundle.'))
4984
5687
        directive = merge_directive.MergeDirective2.from_objects(
4985
5688
            branch.repository, revision_id, time.time(),
4986
5689
            osutils.local_time_offset(), submit_branch,
4994
5697
                self.outf.writelines(directive.to_lines())
4995
5698
        else:
4996
5699
            message = directive.to_email(mail_to, branch, sign)
4997
 
            s = SMTPConnection(branch.get_config())
 
5700
            s = SMTPConnection(branch.get_config_stack())
4998
5701
            s.send_email(message)
4999
5702
 
5000
5703
 
5001
5704
class cmd_send(Command):
5002
 
    """Mail or create a merge-directive for submitting changes.
 
5705
    __doc__ = """Mail or create a merge-directive for submitting changes.
5003
5706
 
5004
5707
    A merge directive provides many things needed for requesting merges:
5005
5708
 
5030
5733
    source branch defaults to that containing the working directory, but can
5031
5734
    be changed using --from.
5032
5735
 
 
5736
    Both the submit branch and the public branch follow the usual behavior with
 
5737
    respect to --remember: If there is no default location set, the first send
 
5738
    will set it (use --no-remember to avoid setting it). After that, you can
 
5739
    omit the location to use the default.  To change the default, use
 
5740
    --remember. The value will only be saved if the location can be accessed.
 
5741
 
5033
5742
    In order to calculate those changes, bzr must analyse the submit branch.
5034
5743
    Therefore it is most efficient for the submit branch to be a local mirror.
5035
5744
    If a public location is known for the submit_branch, that location is used
5039
5748
    given, in which case it is sent to a file.
5040
5749
 
5041
5750
    Mail is sent using your preferred mail program.  This should be transparent
5042
 
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
5751
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
5043
5752
    If the preferred client can't be found (or used), your editor will be used.
5044
5753
 
5045
5754
    To use a specific mail program, set the mail_client configuration option.
5087
5796
               short_name='f',
5088
5797
               type=unicode),
5089
5798
        Option('output', short_name='o',
5090
 
               help='Write merge directive to this file; '
 
5799
               help='Write merge directive to this file or directory; '
5091
5800
                    'use - for stdout.',
5092
5801
               type=unicode),
5093
5802
        Option('strict',
5104
5813
        ]
5105
5814
 
5106
5815
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5107
 
            no_patch=False, revision=None, remember=False, output=None,
 
5816
            no_patch=False, revision=None, remember=None, output=None,
5108
5817
            format=None, mail_to=None, message=None, body=None,
5109
5818
            strict=None, **kwargs):
5110
5819
        from bzrlib.send import send
5116
5825
 
5117
5826
 
5118
5827
class cmd_bundle_revisions(cmd_send):
5119
 
    """Create a merge-directive for submitting changes.
 
5828
    __doc__ = """Create a merge-directive for submitting changes.
5120
5829
 
5121
5830
    A merge directive provides many things needed for requesting merges:
5122
5831
 
5189
5898
 
5190
5899
 
5191
5900
class cmd_tag(Command):
5192
 
    """Create, remove or modify a tag naming a revision.
 
5901
    __doc__ = """Create, remove or modify a tag naming a revision.
5193
5902
 
5194
5903
    Tags give human-meaningful names to revisions.  Commands that take a -r
5195
5904
    (--revision) option can be given -rtag:X, where X is any previously
5203
5912
 
5204
5913
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5205
5914
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5915
 
 
5916
    If no tag name is specified it will be determined through the 
 
5917
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
 
5918
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
 
5919
    details.
5206
5920
    """
5207
5921
 
5208
5922
    _see_also = ['commit', 'tags']
5209
 
    takes_args = ['tag_name']
 
5923
    takes_args = ['tag_name?']
5210
5924
    takes_options = [
5211
5925
        Option('delete',
5212
5926
            help='Delete this tag rather than placing it.',
5213
5927
            ),
5214
 
        Option('directory',
5215
 
            help='Branch in which to place the tag.',
5216
 
            short_name='d',
5217
 
            type=unicode,
5218
 
            ),
 
5928
        custom_help('directory',
 
5929
            help='Branch in which to place the tag.'),
5219
5930
        Option('force',
5220
5931
            help='Replace existing tags.',
5221
5932
            ),
5222
5933
        'revision',
5223
5934
        ]
5224
5935
 
5225
 
    def run(self, tag_name,
 
5936
    def run(self, tag_name=None,
5226
5937
            delete=None,
5227
5938
            directory='.',
5228
5939
            force=None,
5229
5940
            revision=None,
5230
5941
            ):
5231
5942
        branch, relpath = Branch.open_containing(directory)
5232
 
        branch.lock_write()
5233
 
        self.add_cleanup(branch.unlock)
 
5943
        self.add_cleanup(branch.lock_write().unlock)
5234
5944
        if delete:
 
5945
            if tag_name is None:
 
5946
                raise errors.BzrCommandError(gettext("No tag specified to delete."))
5235
5947
            branch.tags.delete_tag(tag_name)
5236
 
            self.outf.write('Deleted tag %s.\n' % tag_name)
 
5948
            note(gettext('Deleted tag %s.') % tag_name)
5237
5949
        else:
5238
5950
            if revision:
5239
5951
                if len(revision) != 1:
5240
 
                    raise errors.BzrCommandError(
 
5952
                    raise errors.BzrCommandError(gettext(
5241
5953
                        "Tags can only be placed on a single revision, "
5242
 
                        "not on a range")
 
5954
                        "not on a range"))
5243
5955
                revision_id = revision[0].as_revision_id(branch)
5244
5956
            else:
5245
5957
                revision_id = branch.last_revision()
5246
 
            if (not force) and branch.tags.has_tag(tag_name):
 
5958
            if tag_name is None:
 
5959
                tag_name = branch.automatic_tag_name(revision_id)
 
5960
                if tag_name is None:
 
5961
                    raise errors.BzrCommandError(gettext(
 
5962
                        "Please specify a tag name."))
 
5963
            try:
 
5964
                existing_target = branch.tags.lookup_tag(tag_name)
 
5965
            except errors.NoSuchTag:
 
5966
                existing_target = None
 
5967
            if not force and existing_target not in (None, revision_id):
5247
5968
                raise errors.TagAlreadyExists(tag_name)
5248
 
            branch.tags.set_tag(tag_name, revision_id)
5249
 
            self.outf.write('Created tag %s.\n' % tag_name)
 
5969
            if existing_target == revision_id:
 
5970
                note(gettext('Tag %s already exists for that revision.') % tag_name)
 
5971
            else:
 
5972
                branch.tags.set_tag(tag_name, revision_id)
 
5973
                if existing_target is None:
 
5974
                    note(gettext('Created tag %s.') % tag_name)
 
5975
                else:
 
5976
                    note(gettext('Updated tag %s.') % tag_name)
5250
5977
 
5251
5978
 
5252
5979
class cmd_tags(Command):
5253
 
    """List tags.
 
5980
    __doc__ = """List tags.
5254
5981
 
5255
5982
    This command shows a table of tag names and the revisions they reference.
5256
5983
    """
5257
5984
 
5258
5985
    _see_also = ['tag']
5259
5986
    takes_options = [
5260
 
        Option('directory',
5261
 
            help='Branch whose tags should be displayed.',
5262
 
            short_name='d',
5263
 
            type=unicode,
5264
 
            ),
5265
 
        RegistryOption.from_kwargs('sort',
 
5987
        custom_help('directory',
 
5988
            help='Branch whose tags should be displayed.'),
 
5989
        RegistryOption('sort',
5266
5990
            'Sort tags by different criteria.', title='Sorting',
5267
 
            alpha='Sort tags lexicographically (default).',
5268
 
            time='Sort tags chronologically.',
 
5991
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
5269
5992
            ),
5270
5993
        'show-ids',
5271
5994
        'revision',
5272
5995
    ]
5273
5996
 
5274
5997
    @display_command
5275
 
    def run(self,
5276
 
            directory='.',
5277
 
            sort='alpha',
5278
 
            show_ids=False,
5279
 
            revision=None,
5280
 
            ):
 
5998
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
 
5999
        from bzrlib.tag import tag_sort_methods
5281
6000
        branch, relpath = Branch.open_containing(directory)
5282
6001
 
5283
6002
        tags = branch.tags.get_tag_dict().items()
5284
6003
        if not tags:
5285
6004
            return
5286
6005
 
5287
 
        branch.lock_read()
5288
 
        self.add_cleanup(branch.unlock)
 
6006
        self.add_cleanup(branch.lock_read().unlock)
5289
6007
        if revision:
5290
 
            graph = branch.repository.get_graph()
5291
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5292
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5293
 
            # only show revisions between revid1 and revid2 (inclusive)
5294
 
            tags = [(tag, revid) for tag, revid in tags if
5295
 
                graph.is_between(revid, revid1, revid2)]
5296
 
        if sort == 'alpha':
5297
 
            tags.sort()
5298
 
        elif sort == 'time':
5299
 
            timestamps = {}
5300
 
            for tag, revid in tags:
5301
 
                try:
5302
 
                    revobj = branch.repository.get_revision(revid)
5303
 
                except errors.NoSuchRevision:
5304
 
                    timestamp = sys.maxint # place them at the end
5305
 
                else:
5306
 
                    timestamp = revobj.timestamp
5307
 
                timestamps[revid] = timestamp
5308
 
            tags.sort(key=lambda x: timestamps[x[1]])
 
6008
            # Restrict to the specified range
 
6009
            tags = self._tags_for_range(branch, revision)
 
6010
        if sort is None:
 
6011
            sort = tag_sort_methods.get()
 
6012
        sort(branch, tags)
5309
6013
        if not show_ids:
5310
6014
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5311
6015
            for index, (tag, revid) in enumerate(tags):
5313
6017
                    revno = branch.revision_id_to_dotted_revno(revid)
5314
6018
                    if isinstance(revno, tuple):
5315
6019
                        revno = '.'.join(map(str, revno))
5316
 
                except errors.NoSuchRevision:
 
6020
                except (errors.NoSuchRevision,
 
6021
                        errors.GhostRevisionsHaveNoRevno,
 
6022
                        errors.UnsupportedOperation):
5317
6023
                    # Bad tag data/merges can lead to tagged revisions
5318
6024
                    # which are not in this branch. Fail gracefully ...
5319
6025
                    revno = '?'
5322
6028
        for tag, revspec in tags:
5323
6029
            self.outf.write('%-20s %s\n' % (tag, revspec))
5324
6030
 
 
6031
    def _tags_for_range(self, branch, revision):
 
6032
        range_valid = True
 
6033
        rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
6034
        revid1, revid2 = rev1.rev_id, rev2.rev_id
 
6035
        # _get_revision_range will always set revid2 if it's not specified.
 
6036
        # If revid1 is None, it means we want to start from the branch
 
6037
        # origin which is always a valid ancestor. If revid1 == revid2, the
 
6038
        # ancestry check is useless.
 
6039
        if revid1 and revid1 != revid2:
 
6040
            # FIXME: We really want to use the same graph than
 
6041
            # branch.iter_merge_sorted_revisions below, but this is not
 
6042
            # easily available -- vila 2011-09-23
 
6043
            if branch.repository.get_graph().is_ancestor(revid2, revid1):
 
6044
                # We don't want to output anything in this case...
 
6045
                return []
 
6046
        # only show revisions between revid1 and revid2 (inclusive)
 
6047
        tagged_revids = branch.tags.get_reverse_tag_dict()
 
6048
        found = []
 
6049
        for r in branch.iter_merge_sorted_revisions(
 
6050
            start_revision_id=revid2, stop_revision_id=revid1,
 
6051
            stop_rule='include'):
 
6052
            revid_tags = tagged_revids.get(r[0], None)
 
6053
            if revid_tags:
 
6054
                found.extend([(tag, r[0]) for tag in revid_tags])
 
6055
        return found
 
6056
 
5325
6057
 
5326
6058
class cmd_reconfigure(Command):
5327
 
    """Reconfigure the type of a bzr directory.
 
6059
    __doc__ = """Reconfigure the type of a bzr directory.
5328
6060
 
5329
6061
    A target configuration must be specified.
5330
6062
 
5341
6073
    takes_args = ['location?']
5342
6074
    takes_options = [
5343
6075
        RegistryOption.from_kwargs(
5344
 
            'target_type',
5345
 
            title='Target type',
5346
 
            help='The type to reconfigure the directory to.',
 
6076
            'tree_type',
 
6077
            title='Tree type',
 
6078
            help='The relation between branch and tree.',
5347
6079
            value_switches=True, enum_switch=False,
5348
6080
            branch='Reconfigure to be an unbound branch with no working tree.',
5349
6081
            tree='Reconfigure to be an unbound branch with a working tree.',
5350
6082
            checkout='Reconfigure to be a bound branch with a working tree.',
5351
6083
            lightweight_checkout='Reconfigure to be a lightweight'
5352
6084
                ' checkout (with no local history).',
 
6085
            ),
 
6086
        RegistryOption.from_kwargs(
 
6087
            'repository_type',
 
6088
            title='Repository type',
 
6089
            help='Location fo the repository.',
 
6090
            value_switches=True, enum_switch=False,
5353
6091
            standalone='Reconfigure to be a standalone branch '
5354
6092
                '(i.e. stop using shared repository).',
5355
6093
            use_shared='Reconfigure to use a shared repository.',
 
6094
            ),
 
6095
        RegistryOption.from_kwargs(
 
6096
            'repository_trees',
 
6097
            title='Trees in Repository',
 
6098
            help='Whether new branches in the repository have trees.',
 
6099
            value_switches=True, enum_switch=False,
5356
6100
            with_trees='Reconfigure repository to create '
5357
6101
                'working trees on branches by default.',
5358
6102
            with_no_trees='Reconfigure repository to not create '
5372
6116
            ),
5373
6117
        ]
5374
6118
 
5375
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5376
 
            stacked_on=None,
5377
 
            unstacked=None):
5378
 
        directory = bzrdir.BzrDir.open(location)
 
6119
    def run(self, location=None, bind_to=None, force=False,
 
6120
            tree_type=None, repository_type=None, repository_trees=None,
 
6121
            stacked_on=None, unstacked=None):
 
6122
        directory = controldir.ControlDir.open(location)
5379
6123
        if stacked_on and unstacked:
5380
 
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
6124
            raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
5381
6125
        elif stacked_on is not None:
5382
6126
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5383
6127
        elif unstacked:
5385
6129
        # At the moment you can use --stacked-on and a different
5386
6130
        # reconfiguration shape at the same time; there seems no good reason
5387
6131
        # to ban it.
5388
 
        if target_type is None:
 
6132
        if (tree_type is None and
 
6133
            repository_type is None and
 
6134
            repository_trees is None):
5389
6135
            if stacked_on or unstacked:
5390
6136
                return
5391
6137
            else:
5392
 
                raise errors.BzrCommandError('No target configuration '
5393
 
                    'specified')
5394
 
        elif target_type == 'branch':
 
6138
                raise errors.BzrCommandError(gettext('No target configuration '
 
6139
                    'specified'))
 
6140
        reconfiguration = None
 
6141
        if tree_type == 'branch':
5395
6142
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5396
 
        elif target_type == 'tree':
 
6143
        elif tree_type == 'tree':
5397
6144
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5398
 
        elif target_type == 'checkout':
 
6145
        elif tree_type == 'checkout':
5399
6146
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5400
6147
                directory, bind_to)
5401
 
        elif target_type == 'lightweight-checkout':
 
6148
        elif tree_type == 'lightweight-checkout':
5402
6149
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5403
6150
                directory, bind_to)
5404
 
        elif target_type == 'use-shared':
 
6151
        if reconfiguration:
 
6152
            reconfiguration.apply(force)
 
6153
            reconfiguration = None
 
6154
        if repository_type == 'use-shared':
5405
6155
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5406
 
        elif target_type == 'standalone':
 
6156
        elif repository_type == 'standalone':
5407
6157
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5408
 
        elif target_type == 'with-trees':
 
6158
        if reconfiguration:
 
6159
            reconfiguration.apply(force)
 
6160
            reconfiguration = None
 
6161
        if repository_trees == 'with-trees':
5409
6162
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5410
6163
                directory, True)
5411
 
        elif target_type == 'with-no-trees':
 
6164
        elif repository_trees == 'with-no-trees':
5412
6165
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5413
6166
                directory, False)
5414
 
        reconfiguration.apply(force)
 
6167
        if reconfiguration:
 
6168
            reconfiguration.apply(force)
 
6169
            reconfiguration = None
5415
6170
 
5416
6171
 
5417
6172
class cmd_switch(Command):
5418
 
    """Set the branch of a checkout and update.
 
6173
    __doc__ = """Set the branch of a checkout and update.
5419
6174
 
5420
6175
    For lightweight checkouts, this changes the branch being referenced.
5421
6176
    For heavyweight checkouts, this checks that there are no local commits
5438
6193
    """
5439
6194
 
5440
6195
    takes_args = ['to_location?']
5441
 
    takes_options = [Option('force',
 
6196
    takes_options = ['directory',
 
6197
                     Option('force',
5442
6198
                        help='Switch even if local commits will be lost.'),
5443
6199
                     'revision',
5444
6200
                     Option('create-branch', short_name='b',
5447
6203
                    ]
5448
6204
 
5449
6205
    def run(self, to_location=None, force=False, create_branch=False,
5450
 
            revision=None):
 
6206
            revision=None, directory=u'.'):
5451
6207
        from bzrlib import switch
5452
 
        tree_location = '.'
 
6208
        tree_location = directory
5453
6209
        revision = _get_one_revision('switch', revision)
5454
 
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
6210
        possible_transports = []
 
6211
        control_dir = controldir.ControlDir.open_containing(tree_location,
 
6212
            possible_transports=possible_transports)[0]
5455
6213
        if to_location is None:
5456
6214
            if revision is None:
5457
 
                raise errors.BzrCommandError('You must supply either a'
5458
 
                                             ' revision or a location')
5459
 
            to_location = '.'
 
6215
                raise errors.BzrCommandError(gettext('You must supply either a'
 
6216
                                             ' revision or a location'))
 
6217
            to_location = tree_location
5460
6218
        try:
5461
 
            branch = control_dir.open_branch()
 
6219
            branch = control_dir.open_branch(
 
6220
                possible_transports=possible_transports)
5462
6221
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5463
6222
        except errors.NotBranchError:
5464
6223
            branch = None
5465
6224
            had_explicit_nick = False
5466
6225
        if create_branch:
5467
6226
            if branch is None:
5468
 
                raise errors.BzrCommandError('cannot create branch without'
5469
 
                                             ' source branch')
5470
 
            to_location = directory_service.directories.dereference(
5471
 
                              to_location)
5472
 
            if '/' not in to_location and '\\' not in to_location:
5473
 
                # This path is meant to be relative to the existing branch
5474
 
                this_url = self._get_branch_location(control_dir)
5475
 
                to_location = urlutils.join(this_url, '..', to_location)
 
6227
                raise errors.BzrCommandError(
 
6228
                    gettext('cannot create branch without source branch'))
 
6229
            to_location = lookup_new_sibling_branch(control_dir, to_location,
 
6230
                 possible_transports=possible_transports)
5476
6231
            to_branch = branch.bzrdir.sprout(to_location,
5477
 
                                 possible_transports=[branch.bzrdir.root_transport],
5478
 
                                 source_branch=branch).open_branch()
 
6232
                 possible_transports=possible_transports,
 
6233
                 source_branch=branch).open_branch()
5479
6234
        else:
5480
6235
            try:
5481
 
                to_branch = Branch.open(to_location)
 
6236
                to_branch = Branch.open(to_location,
 
6237
                    possible_transports=possible_transports)
5482
6238
            except errors.NotBranchError:
5483
 
                this_url = self._get_branch_location(control_dir)
5484
 
                to_branch = Branch.open(
5485
 
                    urlutils.join(this_url, '..', to_location))
 
6239
                to_branch = open_sibling_branch(control_dir, to_location,
 
6240
                    possible_transports=possible_transports)
5486
6241
        if revision is not None:
5487
6242
            revision = revision.as_revision_id(to_branch)
5488
6243
        switch.switch(control_dir, to_branch, force, revision_id=revision)
5489
6244
        if had_explicit_nick:
5490
6245
            branch = control_dir.open_branch() #get the new branch!
5491
6246
            branch.nick = to_branch.nick
5492
 
        note('Switched to branch: %s',
 
6247
        note(gettext('Switched to branch: %s'),
5493
6248
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5494
6249
 
5495
 
    def _get_branch_location(self, control_dir):
5496
 
        """Return location of branch for this control dir."""
5497
 
        try:
5498
 
            this_branch = control_dir.open_branch()
5499
 
            # This may be a heavy checkout, where we want the master branch
5500
 
            master_location = this_branch.get_bound_location()
5501
 
            if master_location is not None:
5502
 
                return master_location
5503
 
            # If not, use a local sibling
5504
 
            return this_branch.base
5505
 
        except errors.NotBranchError:
5506
 
            format = control_dir.find_branch_format()
5507
 
            if getattr(format, 'get_reference', None) is not None:
5508
 
                return format.get_reference(control_dir)
5509
 
            else:
5510
 
                return control_dir.root_transport.base
5511
6250
 
5512
6251
 
5513
6252
class cmd_view(Command):
5514
 
    """Manage filtered views.
 
6253
    __doc__ = """Manage filtered views.
5515
6254
 
5516
6255
    Views provide a mask over the tree so that users can focus on
5517
6256
    a subset of a tree when doing their work. After creating a view,
5597
6336
            name=None,
5598
6337
            switch=None,
5599
6338
            ):
5600
 
        tree, file_list = tree_files(file_list, apply_view=False)
 
6339
        tree, file_list = WorkingTree.open_containing_paths(file_list,
 
6340
            apply_view=False)
5601
6341
        current_view, view_dict = tree.views.get_view_info()
5602
6342
        if name is None:
5603
6343
            name = current_view
5604
6344
        if delete:
5605
6345
            if file_list:
5606
 
                raise errors.BzrCommandError(
5607
 
                    "Both --delete and a file list specified")
 
6346
                raise errors.BzrCommandError(gettext(
 
6347
                    "Both --delete and a file list specified"))
5608
6348
            elif switch:
5609
 
                raise errors.BzrCommandError(
5610
 
                    "Both --delete and --switch specified")
 
6349
                raise errors.BzrCommandError(gettext(
 
6350
                    "Both --delete and --switch specified"))
5611
6351
            elif all:
5612
6352
                tree.views.set_view_info(None, {})
5613
 
                self.outf.write("Deleted all views.\n")
 
6353
                self.outf.write(gettext("Deleted all views.\n"))
5614
6354
            elif name is None:
5615
 
                raise errors.BzrCommandError("No current view to delete")
 
6355
                raise errors.BzrCommandError(gettext("No current view to delete"))
5616
6356
            else:
5617
6357
                tree.views.delete_view(name)
5618
 
                self.outf.write("Deleted '%s' view.\n" % name)
 
6358
                self.outf.write(gettext("Deleted '%s' view.\n") % name)
5619
6359
        elif switch:
5620
6360
            if file_list:
5621
 
                raise errors.BzrCommandError(
5622
 
                    "Both --switch and a file list specified")
 
6361
                raise errors.BzrCommandError(gettext(
 
6362
                    "Both --switch and a file list specified"))
5623
6363
            elif all:
5624
 
                raise errors.BzrCommandError(
5625
 
                    "Both --switch and --all specified")
 
6364
                raise errors.BzrCommandError(gettext(
 
6365
                    "Both --switch and --all specified"))
5626
6366
            elif switch == 'off':
5627
6367
                if current_view is None:
5628
 
                    raise errors.BzrCommandError("No current view to disable")
 
6368
                    raise errors.BzrCommandError(gettext("No current view to disable"))
5629
6369
                tree.views.set_view_info(None, view_dict)
5630
 
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
6370
                self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
5631
6371
            else:
5632
6372
                tree.views.set_view_info(switch, view_dict)
5633
6373
                view_str = views.view_display_str(tree.views.lookup_view())
5634
 
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
6374
                self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
5635
6375
        elif all:
5636
6376
            if view_dict:
5637
 
                self.outf.write('Views defined:\n')
 
6377
                self.outf.write(gettext('Views defined:\n'))
5638
6378
                for view in sorted(view_dict):
5639
6379
                    if view == current_view:
5640
6380
                        active = "=>"
5643
6383
                    view_str = views.view_display_str(view_dict[view])
5644
6384
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
5645
6385
            else:
5646
 
                self.outf.write('No views defined.\n')
 
6386
                self.outf.write(gettext('No views defined.\n'))
5647
6387
        elif file_list:
5648
6388
            if name is None:
5649
6389
                # No name given and no current view set
5650
6390
                name = 'my'
5651
6391
            elif name == 'off':
5652
 
                raise errors.BzrCommandError(
5653
 
                    "Cannot change the 'off' pseudo view")
 
6392
                raise errors.BzrCommandError(gettext(
 
6393
                    "Cannot change the 'off' pseudo view"))
5654
6394
            tree.views.set_view(name, sorted(file_list))
5655
6395
            view_str = views.view_display_str(tree.views.lookup_view())
5656
 
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
6396
            self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
5657
6397
        else:
5658
6398
            # list the files
5659
6399
            if name is None:
5660
6400
                # No name given and no current view set
5661
 
                self.outf.write('No current view.\n')
 
6401
                self.outf.write(gettext('No current view.\n'))
5662
6402
            else:
5663
6403
                view_str = views.view_display_str(tree.views.lookup_view(name))
5664
 
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
6404
                self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
5665
6405
 
5666
6406
 
5667
6407
class cmd_hooks(Command):
5668
 
    """Show hooks."""
 
6408
    __doc__ = """Show hooks."""
5669
6409
 
5670
6410
    hidden = True
5671
6411
 
5681
6421
                        self.outf.write("    %s\n" %
5682
6422
                                        (some_hooks.get_hook_name(hook),))
5683
6423
                else:
5684
 
                    self.outf.write("    <no hooks installed>\n")
 
6424
                    self.outf.write(gettext("    <no hooks installed>\n"))
 
6425
 
 
6426
 
 
6427
class cmd_remove_branch(Command):
 
6428
    __doc__ = """Remove a branch.
 
6429
 
 
6430
    This will remove the branch from the specified location but 
 
6431
    will keep any working tree or repository in place.
 
6432
 
 
6433
    :Examples:
 
6434
 
 
6435
      Remove the branch at repo/trunk::
 
6436
 
 
6437
        bzr remove-branch repo/trunk
 
6438
 
 
6439
    """
 
6440
 
 
6441
    takes_args = ["location?"]
 
6442
 
 
6443
    takes_options = ['directory',
 
6444
        Option('force', help='Remove branch even if it is the active branch.')]
 
6445
 
 
6446
    aliases = ["rmbranch"]
 
6447
 
 
6448
    def run(self, directory=None, location=None, force=False):
 
6449
        br = open_nearby_branch(near=directory, location=location)
 
6450
        if not force and br.bzrdir.has_workingtree():
 
6451
            try:
 
6452
                active_branch = br.bzrdir.open_branch(name="")
 
6453
            except errors.NotBranchError:
 
6454
                active_branch = None
 
6455
            if (active_branch is not None and
 
6456
                br.control_url == active_branch.control_url):
 
6457
                raise errors.BzrCommandError(
 
6458
                    gettext("Branch is active. Use --force to remove it."))
 
6459
        br.bzrdir.destroy_branch(br.name)
5685
6460
 
5686
6461
 
5687
6462
class cmd_shelve(Command):
5688
 
    """Temporarily set aside some changes from the current tree.
 
6463
    __doc__ = """Temporarily set aside some changes from the current tree.
5689
6464
 
5690
6465
    Shelve allows you to temporarily put changes you've made "on the shelf",
5691
6466
    ie. out of the way, until a later time when you can bring them back from
5707
6482
 
5708
6483
    You can put multiple items on the shelf, and by default, 'unshelve' will
5709
6484
    restore the most recently shelved changes.
 
6485
 
 
6486
    For complicated changes, it is possible to edit the changes in a separate
 
6487
    editor program to decide what the file remaining in the working copy
 
6488
    should look like.  To do this, add the configuration option
 
6489
 
 
6490
        change_editor = PROGRAM @new_path @old_path
 
6491
 
 
6492
    where @new_path is replaced with the path of the new version of the 
 
6493
    file and @old_path is replaced with the path of the old version of 
 
6494
    the file.  The PROGRAM should save the new file with the desired 
 
6495
    contents of the file in the working tree.
 
6496
        
5710
6497
    """
5711
6498
 
5712
6499
    takes_args = ['file*']
5713
6500
 
5714
6501
    takes_options = [
 
6502
        'directory',
5715
6503
        'revision',
5716
6504
        Option('all', help='Shelve all changes.'),
5717
6505
        'message',
5723
6511
        Option('destroy',
5724
6512
               help='Destroy removed changes instead of shelving them.'),
5725
6513
    ]
5726
 
    _see_also = ['unshelve']
 
6514
    _see_also = ['unshelve', 'configuration']
5727
6515
 
5728
6516
    def run(self, revision=None, all=False, file_list=None, message=None,
5729
 
            writer=None, list=False, destroy=False):
 
6517
            writer=None, list=False, destroy=False, directory=None):
5730
6518
        if list:
5731
 
            return self.run_for_list()
 
6519
            return self.run_for_list(directory=directory)
5732
6520
        from bzrlib.shelf_ui import Shelver
5733
6521
        if writer is None:
5734
6522
            writer = bzrlib.option.diff_writer_registry.get()
5735
6523
        try:
5736
6524
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
5737
 
                file_list, message, destroy=destroy)
 
6525
                file_list, message, destroy=destroy, directory=directory)
5738
6526
            try:
5739
6527
                shelver.run()
5740
6528
            finally:
5742
6530
        except errors.UserAbort:
5743
6531
            return 0
5744
6532
 
5745
 
    def run_for_list(self):
5746
 
        tree = WorkingTree.open_containing('.')[0]
5747
 
        tree.lock_read()
5748
 
        self.add_cleanup(tree.unlock)
 
6533
    def run_for_list(self, directory=None):
 
6534
        if directory is None:
 
6535
            directory = u'.'
 
6536
        tree = WorkingTree.open_containing(directory)[0]
 
6537
        self.add_cleanup(tree.lock_read().unlock)
5749
6538
        manager = tree.get_shelf_manager()
5750
6539
        shelves = manager.active_shelves()
5751
6540
        if len(shelves) == 0:
5752
 
            note('No shelved changes.')
 
6541
            note(gettext('No shelved changes.'))
5753
6542
            return 0
5754
6543
        for shelf_id in reversed(shelves):
5755
6544
            message = manager.get_metadata(shelf_id).get('message')
5760
6549
 
5761
6550
 
5762
6551
class cmd_unshelve(Command):
5763
 
    """Restore shelved changes.
 
6552
    __doc__ = """Restore shelved changes.
5764
6553
 
5765
6554
    By default, the most recently shelved changes are restored. However if you
5766
6555
    specify a shelf by id those changes will be restored instead.  This works
5769
6558
 
5770
6559
    takes_args = ['shelf_id?']
5771
6560
    takes_options = [
 
6561
        'directory',
5772
6562
        RegistryOption.from_kwargs(
5773
6563
            'action', help="The action to perform.",
5774
6564
            enum_switch=False, value_switches=True,
5782
6572
    ]
5783
6573
    _see_also = ['shelve']
5784
6574
 
5785
 
    def run(self, shelf_id=None, action='apply'):
 
6575
    def run(self, shelf_id=None, action='apply', directory=u'.'):
5786
6576
        from bzrlib.shelf_ui import Unshelver
5787
 
        unshelver = Unshelver.from_args(shelf_id, action)
 
6577
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
5788
6578
        try:
5789
6579
            unshelver.run()
5790
6580
        finally:
5792
6582
 
5793
6583
 
5794
6584
class cmd_clean_tree(Command):
5795
 
    """Remove unwanted files from working tree.
 
6585
    __doc__ = """Remove unwanted files from working tree.
5796
6586
 
5797
6587
    By default, only unknown files, not ignored files, are deleted.  Versioned
5798
6588
    files are never deleted.
5806
6596
 
5807
6597
    To check what clean-tree will do, use --dry-run.
5808
6598
    """
5809
 
    takes_options = [Option('ignored', help='Delete all ignored files.'),
5810
 
                     Option('detritus', help='Delete conflict files, merge'
 
6599
    takes_options = ['directory',
 
6600
                     Option('ignored', help='Delete all ignored files.'),
 
6601
                     Option('detritus', help='Delete conflict files, merge and revert'
5811
6602
                            ' backups, and failed selftest dirs.'),
5812
6603
                     Option('unknown',
5813
6604
                            help='Delete files unknown to bzr (default).'),
5815
6606
                            ' deleting them.'),
5816
6607
                     Option('force', help='Do not prompt before deleting.')]
5817
6608
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
5818
 
            force=False):
 
6609
            force=False, directory=u'.'):
5819
6610
        from bzrlib.clean_tree import clean_tree
5820
6611
        if not (unknown or ignored or detritus):
5821
6612
            unknown = True
5822
6613
        if dry_run:
5823
6614
            force = True
5824
 
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
5825
 
                   dry_run=dry_run, no_prompt=force)
 
6615
        clean_tree(directory, unknown=unknown, ignored=ignored,
 
6616
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
5826
6617
 
5827
6618
 
5828
6619
class cmd_reference(Command):
5829
 
    """list, view and set branch locations for nested trees.
 
6620
    __doc__ = """list, view and set branch locations for nested trees.
5830
6621
 
5831
6622
    If no arguments are provided, lists the branch locations for nested trees.
5832
6623
    If one argument is provided, display the branch location for that tree.
5842
6633
        if path is not None:
5843
6634
            branchdir = path
5844
6635
        tree, branch, relpath =(
5845
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
6636
            controldir.ControlDir.open_containing_tree_or_branch(branchdir))
5846
6637
        if path is not None:
5847
6638
            path = relpath
5848
6639
        if tree is None:
5872
6663
            self.outf.write('%s %s\n' % (path, location))
5873
6664
 
5874
6665
 
5875
 
# these get imported and then picked up by the scan for cmd_*
5876
 
# TODO: Some more consistent way to split command definitions across files;
5877
 
# we do need to load at least some information about them to know of
5878
 
# aliases.  ideally we would avoid loading the implementation until the
5879
 
# details were needed.
5880
 
from bzrlib.cmd_version_info import cmd_version_info
5881
 
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
5882
 
from bzrlib.bundle.commands import (
5883
 
    cmd_bundle_info,
5884
 
    )
5885
 
from bzrlib.foreign import cmd_dpush
5886
 
from bzrlib.sign_my_commits import cmd_sign_my_commits
5887
 
from bzrlib.weave_commands import cmd_versionedfile_list, \
5888
 
        cmd_weave_plan_merge, cmd_weave_merge_text
 
6666
class cmd_export_pot(Command):
 
6667
    __doc__ = """Export command helps and error messages in po format."""
 
6668
 
 
6669
    hidden = True
 
6670
    takes_options = [Option('plugin', 
 
6671
                            help='Export help text from named command '\
 
6672
                                 '(defaults to all built in commands).',
 
6673
                            type=str),
 
6674
                     Option('include-duplicates',
 
6675
                            help='Output multiple copies of the same msgid '
 
6676
                                 'string if it appears more than once.'),
 
6677
                            ]
 
6678
 
 
6679
    def run(self, plugin=None, include_duplicates=False):
 
6680
        from bzrlib.export_pot import export_pot
 
6681
        export_pot(self.outf, plugin, include_duplicates)
 
6682
 
 
6683
 
 
6684
def _register_lazy_builtins():
 
6685
    # register lazy builtins from other modules; called at startup and should
 
6686
    # be only called once.
 
6687
    for (name, aliases, module_name) in [
 
6688
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
 
6689
        ('cmd_config', [], 'bzrlib.config'),
 
6690
        ('cmd_dpush', [], 'bzrlib.foreign'),
 
6691
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
 
6692
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
 
6693
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
 
6694
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
 
6695
        ('cmd_verify_signatures', [], 'bzrlib.commit_signature_commands'),
 
6696
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
 
6697
        ]:
 
6698
        builtin_command_registry.register_lazy(name, aliases, module_name)