← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2012-01-27 19:05:43 UTC
  • mto: This revision was merged to the branch mainline in revision 6450.
  • Revision ID: jelmer@samba.org-20120127190543-vk350mv4a0c7aug2
Fix weave test.

Show diffs side-by-side

added added

removed removed

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