← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

(vila) Calling super() instead of mentioning the base class in setUp avoid
 mistakes. (Vincent Ladeuil)

Show diffs side-by-side

added added

removed removed

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