← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Packman
  • Date: 2012-02-01 13:24:42 UTC
  • mto: (6437.23.4 2.5)
  • mto: This revision was merged to the branch mainline in revision 6462.
  • Revision ID: martin.packman@canonical.com-20120201132442-ela7jc4mxv4b058o
https://launchpad.net/bugs/312841
Treat path for .bzr.log as unicode

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