← 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-02-20 14:15:25 UTC
  • mto: (6471.1.4 iter-child-entries)
  • mto: This revision was merged to the branch mainline in revision 6472.
  • Revision ID: jelmer@samba.org-20120220141525-9azkfei62st8yc7w
Use inventories directly in fewer places.

Show diffs side-by-side

added added

removed removed

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