← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Tarmac
  • Author(s): Vincent Ladeuil
  • Date: 2017-01-30 14:42:05 UTC
  • mfrom: (6620.1.1 trunk)
  • Revision ID: tarmac-20170130144205-r8fh2xpmiuxyozpv
Merge  2.7 into trunk including fix for bug #1657238 [r=vila]

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2004, 2005 by Canonical Ltd
2
 
 
 
1
# Copyright (C) 2005-2012 Canonical Ltd
 
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
5
5
# the Free Software Foundation; either version 2 of the License, or
6
6
# (at your option) any later version.
7
 
 
 
7
#
8
8
# This program is distributed in the hope that it will be useful,
9
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
10
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
11
11
# GNU General Public License for more details.
12
 
 
 
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
 
 
17
 
 
 
15
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
from __future__ import absolute_import
 
20
 
 
21
import os
 
22
 
 
23
import bzrlib.bzrdir
 
24
 
 
25
from bzrlib import lazy_import
 
26
lazy_import.lazy_import(globals(), """
 
27
import cStringIO
 
28
import errno
18
29
import sys
19
 
import os
 
30
import time
20
31
 
21
32
import bzrlib
22
 
import bzrlib.trace
23
 
from bzrlib.trace import mutter, note, log_error, warning
24
 
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
25
 
from bzrlib.branch import find_branch
26
 
from bzrlib import BZRDIR
27
 
from bzrlib.commands import Command
28
 
 
 
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
    )
 
59
from bzrlib.branch import Branch
 
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
 
64
from bzrlib.workingtree import WorkingTree
 
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)
 
306
 
 
307
 
 
308
# TODO: Make sure no commands unconditionally use the working directory as a
 
309
# branch.  If a filename argument is used, the first of them should be used to
 
310
# specify the branch.  (Perhaps this can be factored out into some kind of
 
311
# Argument class, representing a file in a branch, where the first occurrence
 
312
# opens the branch?)
29
313
 
30
314
class cmd_status(Command):
31
 
    """Display status summary.
 
315
    __doc__ = """Display status summary.
32
316
 
33
317
    This reports on versioned and unknown files, reporting them
34
318
    grouped by state.  Possible states are:
48
332
    modified
49
333
        Text has changed since the previous revision.
50
334
 
51
 
    unchanged
52
 
        Nothing about this file has changed since the previous revision.
53
 
        Only shown with --all.
 
335
    kind changed
 
336
        File kind has been changed (e.g. from file to directory).
54
337
 
55
338
    unknown
56
339
        Not versioned and not matching an ignore pattern.
57
340
 
58
 
    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
59
347
    changes to file texts, use 'bzr diff'.
60
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
 
61
353
    If no arguments are specified, the status of the entire working
62
354
    directory is shown.  Otherwise, only the status of the specified
63
355
    files or directories is reported.  If a directory is given, status
64
356
    is reported for everything inside that directory.
65
357
 
66
 
    If a revision is specified, the changes since that revision are shown.
 
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'.
67
369
    """
 
370
 
 
371
    # TODO: --no-recurse/-N, --recurse options
 
372
 
68
373
    takes_args = ['file*']
69
 
    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
                     ]
70
385
    aliases = ['st', 'stat']
71
 
    
72
 
    def run(self, all=False, show_ids=False, file_list=None):
73
 
        if file_list:
74
 
            b = find_branch(file_list[0])
75
 
            file_list = [b.relpath(x) for x in file_list]
76
 
            # special case: only one path was given and it's the root
77
 
            # of the branch
78
 
            if file_list == ['']:
79
 
                file_list = None
80
 
        else:
81
 
            b = find_branch('.')
82
 
            
83
 
        from bzrlib.status import show_status
84
 
        show_status(b, show_unchanged=all, show_ids=show_ids,
85
 
                    specific_files=file_list)
 
386
 
 
387
    encoding_type = 'replace'
 
388
    _see_also = ['diff', 'revert', 'status-flags']
 
389
 
 
390
    @display_command
 
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):
 
394
        from bzrlib.status import show_tree_status
 
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)
86
415
 
87
416
 
88
417
class cmd_cat_revision(Command):
89
 
    """Write out metadata for a revision."""
90
 
 
91
 
    hidden = True
92
 
    takes_args = ['revision_id']
93
 
    
94
 
    def run(self, revision_id):
95
 
        b = find_branch('.')
96
 
        sys.stdout.write(b.get_revision_xml_file(revision_id).read())
 
418
    __doc__ = """Write out metadata for a revision.
 
419
 
 
420
    The revision to print can either be specified by a specific
 
421
    revision identifier, or you can use --revision.
 
422
    """
 
423
 
 
424
    hidden = True
 
425
    takes_args = ['revision_id?']
 
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
 
 
438
    @display_command
 
439
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
440
        if revision_id is not None and revision is not None:
 
441
            raise errors.BzrCommandError(gettext('You can only supply one of'
 
442
                                         ' revision_id or --revision'))
 
443
        if revision_id is None and revision is None:
 
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))
97
653
 
98
654
 
99
655
class cmd_revno(Command):
100
 
    """Show current revision number.
101
 
 
102
 
    This is equal to the number of revisions on this branch."""
103
 
    def run(self):
104
 
        print find_branch('.').revno()
 
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']
 
662
    takes_args = ['location?']
 
663
    takes_options = [
 
664
        Option('tree', help='Show revno of working tree.'),
 
665
        'revision',
 
666
        ]
 
667
 
 
668
    @display_command
 
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
                        "Revision numbers only make sense for single "
 
689
                        "revisions, not ranges"))
 
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')
105
700
 
106
701
 
107
702
class cmd_revision_info(Command):
108
 
    """Show revision number and revision id for a given revision identifier.
 
703
    __doc__ = """Show revision number and revision id for a given revision identifier.
109
704
    """
110
705
    hidden = True
111
706
    takes_args = ['revision_info*']
112
 
    takes_options = ['revision']
113
 
    def run(self, revision=None, revision_info_list=None):
114
 
        from bzrlib.branch import find_branch
115
 
 
116
 
        revs = []
 
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
 
 
715
    @display_command
 
716
    def run(self, revision=None, directory=u'.', tree=False,
 
717
            revision_info_list=[]):
 
718
 
 
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 = []
117
728
        if revision is not None:
118
 
            revs.extend(revision)
 
729
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
119
730
        if revision_info_list is not None:
120
 
            revs.extend(revision_info_list)
121
 
        if len(revs) == 0:
122
 
            raise BzrCommandError('You must supply a revision identifier')
123
 
 
124
 
        b = find_branch('.')
125
 
 
126
 
        for rev in revs:
127
 
            print '%4d %s' % b.get_revision_info(rev)
128
 
 
129
 
    
 
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())
 
740
            else:
 
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
 
130
759
class cmd_add(Command):
131
 
    """Add specified files or directories.
 
760
    __doc__ = """Add specified files or directories.
132
761
 
133
762
    In non-recursive mode, all the named items are added, regardless
134
763
    of whether they were previously ignored.  A warning is given if
142
771
    are added.  This search proceeds recursively into versioned
143
772
    directories.  If no names are given '.' is assumed.
144
773
 
 
774
    A warning will be printed when nested trees are encountered,
 
775
    unless they are explicitly ignored.
 
776
 
145
777
    Therefore simply saying 'bzr add' will version all files that
146
778
    are currently unknown.
147
779
 
148
 
    TODO: Perhaps adding a file whose directly is not versioned should
149
 
    recursively add that parent, rather than giving an error?
 
780
    Adding a file whose parent directory is not versioned will
 
781
    implicitly add the parent, and so on up to the root. This means
 
782
    you should never need to explicitly add a directory, they'll just
 
783
    get added when you add a file in the directory.
 
784
 
 
785
    --dry-run will show which files would be added, but not actually
 
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.
150
802
    """
151
803
    takes_args = ['file*']
152
 
    takes_options = ['verbose', 'no-recurse']
153
 
    
154
 
    def run(self, file_list, verbose=False, no_recurse=False):
155
 
        # verbose currently has no effect
156
 
        from bzrlib.add import smart_add, add_reporter_print
157
 
        smart_add(file_list, not no_recurse, add_reporter_print)
158
 
 
 
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']
 
817
 
 
818
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
 
819
            file_ids_from=None):
 
820
        import bzrlib.add
 
821
 
 
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()))
 
834
        else:
 
835
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
 
836
                should_print=(not is_quiet()))
 
837
 
 
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()
 
844
        if len(ignored) > 0:
 
845
            if verbose:
 
846
                for glob in sorted(ignored.keys()):
 
847
                    for path in ignored[glob]:
 
848
                        self.outf.write(
 
849
                         gettext("ignored {0} matching \"{1}\"\n").format(
 
850
                         path, glob))
159
851
 
160
852
 
161
853
class cmd_mkdir(Command):
162
 
    """Create a new versioned directory.
 
854
    __doc__ = """Create a new versioned directory.
163
855
 
164
856
    This is equivalent to creating the directory and then adding it.
165
857
    """
 
858
 
166
859
    takes_args = ['dir+']
167
 
 
168
 
    def run(self, dir_list):
169
 
        b = None
170
 
        
171
 
        for d in dir_list:
172
 
            os.mkdir(d)
173
 
            if not b:
174
 
                b = find_branch(d)
175
 
            b.add([d])
176
 
            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)
177
898
 
178
899
 
179
900
class cmd_relpath(Command):
180
 
    """Show path of a file relative to root"""
 
901
    __doc__ = """Show path of a file relative to root"""
 
902
 
181
903
    takes_args = ['filename']
182
904
    hidden = True
183
 
    
 
905
 
 
906
    @display_command
184
907
    def run(self, filename):
185
 
        print find_branch(filename).relpath(filename)
186
 
 
 
908
        # TODO: jam 20050106 Can relpath return a munged path if
 
909
        #       sys.stdout encoding cannot represent it?
 
910
        tree, relpath = WorkingTree.open_containing(filename)
 
911
        self.outf.write(relpath)
 
912
        self.outf.write('\n')
187
913
 
188
914
 
189
915
class cmd_inventory(Command):
190
 
    """Show inventory of the current working copy or a revision."""
191
 
    takes_options = ['revision', 'show-ids']
192
 
    
193
 
    def run(self, revision=None, show_ids=False):
194
 
        b = find_branch('.')
195
 
        if revision == None:
196
 
            inv = b.read_working_inventory()
197
 
        else:
198
 
            if len(revision) > 1:
199
 
                raise BzrCommandError('bzr inventory --revision takes'
200
 
                    ' exactly one revision identifier')
201
 
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
202
 
 
203
 
        for path, entry in inv.entries():
 
916
    __doc__ = """Show inventory of the current working copy or a revision.
 
917
 
 
918
    It is possible to limit the output to a particular entry
 
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
 
923
    """
 
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
 
 
936
    @display_command
 
937
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
 
938
        if kind and kind not in ['file', 'directory', 'symlink']:
 
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):
 
964
            if kind and kind != entry.kind:
 
965
                continue
 
966
            if path == "":
 
967
                continue
204
968
            if show_ids:
205
 
                print '%-50s %s' % (path, entry.file_id)
 
969
                self.outf.write('%-50s %s\n' % (path, entry.file_id))
206
970
            else:
207
 
                print path
208
 
 
209
 
 
210
 
class cmd_move(Command):
211
 
    """Move files to a different directory.
212
 
 
213
 
    examples:
214
 
        bzr move *.txt doc
215
 
 
216
 
    The destination must be a versioned directory in the same branch.
217
 
    """
218
 
    takes_args = ['source$', 'dest']
219
 
    def run(self, source_list, dest):
220
 
        b = find_branch('.')
221
 
 
222
 
        # TODO: glob expansion on windows?
223
 
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
224
 
 
225
 
 
226
 
class cmd_rename(Command):
227
 
    """Change the name of an entry.
228
 
 
229
 
    examples:
230
 
      bzr rename frob.c frobber.c
231
 
      bzr rename src/frob.c lib/frob.c
232
 
 
233
 
    It is an error if the destination name exists.
234
 
 
235
 
    See also the 'move' command, which moves files into a different
236
 
    directory without changing their name.
237
 
 
238
 
    TODO: Some way to rename multiple files without invoking bzr for each
239
 
    one?"""
240
 
    takes_args = ['from_name', 'to_name']
241
 
    
242
 
    def run(self, from_name, to_name):
243
 
        b = find_branch('.')
244
 
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
245
 
 
 
971
                self.outf.write(path)
 
972
                self.outf.write('\n')
246
973
 
247
974
 
248
975
class cmd_mv(Command):
249
 
    """Move or rename a file.
 
976
    __doc__ = """Move or rename a file.
250
977
 
251
 
    usage:
 
978
    :Usage:
252
979
        bzr mv OLDNAME NEWNAME
 
980
 
253
981
        bzr mv SOURCE... DESTINATION
254
982
 
255
983
    If the last argument is a versioned directory, all the other names
256
984
    are moved into it.  Otherwise, there must be exactly two arguments
257
 
    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.
258
992
 
259
993
    Files cannot be moved between branches.
260
994
    """
 
995
 
261
996
    takes_args = ['names*']
262
 
    def run(self, names_list):
 
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
        ]
 
1002
    aliases = ['move', 'rename']
 
1003
    encoding_type = 'replace'
 
1004
 
 
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 = []
263
1012
        if len(names_list) < 2:
264
 
            raise BzrCommandError("missing file argument")
265
 
        b = find_branch(names_list[0])
266
 
 
267
 
        rel_names = [b.relpath(x) for x in names_list]
268
 
        
269
 
        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:
270
1053
            # move into existing directory
271
 
            for pair in b.move(rel_names[:-1], rel_names[-1]):
272
 
                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))
273
1060
        else:
274
1061
            if len(names_list) != 2:
275
 
                raise BzrCommandError('to mv multiple files the destination '
276
 
                                      'must be a versioned directory')
277
 
            for pair in b.move(rel_names[0], rel_names[1]):
278
 
                print "%s => %s" % pair
279
 
            
280
 
    
 
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))
281
1111
 
282
1112
 
283
1113
class cmd_pull(Command):
284
 
    """Pull any changes from another branch into the current one.
285
 
 
286
 
    If the location is omitted, the last-used location will be used.
287
 
    Both the revision history and the working directory will be
288
 
    updated.
 
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
 
1122
    from one into the other.  Once one branch has merged, the other should
 
1123
    be able to pull it again.
 
1124
 
 
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.
 
1141
    """
 
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
        ]
 
1160
    takes_args = ['location?']
 
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 = []
 
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'.'
 
1179
        try:
 
1180
            tree_to = WorkingTree.open_containing(directory)[0]
 
1181
            branch_to = tree_to.branch
 
1182
            self.add_cleanup(tree_to.lock_write().unlock)
 
1183
        except errors.NoWorkingTree:
 
1184
            tree_to = None
 
1185
            branch_to = Branch.open_containing(directory)[0]
 
1186
            self.add_cleanup(branch_to.lock_write().unlock)
 
1187
            if show_base:
 
1188
                warning(gettext("No working tree, ignoring --show-base"))
 
1189
 
 
1190
        if local and not branch_to.get_bound_location():
 
1191
            raise errors.LocalRequiresBoundBranch()
 
1192
 
 
1193
        possible_transports = []
 
1194
        if location is not None:
 
1195
            try:
 
1196
                mergeable = bundle.read_mergeable_from_url(location,
 
1197
                    possible_transports=possible_transports)
 
1198
            except errors.NotABundle:
 
1199
                mergeable = None
 
1200
 
 
1201
        stored_loc = branch_to.get_parent()
 
1202
        if location is None:
 
1203
            if stored_loc is None:
 
1204
                raise errors.BzrCommandError(gettext("No pull location known or"
 
1205
                                             " specified."))
 
1206
            else:
 
1207
                display_url = urlutils.unescape_for_display(stored_loc,
 
1208
                        self.outf.encoding)
 
1209
                if not is_quiet():
 
1210
                    self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
 
1211
                location = stored_loc
 
1212
 
 
1213
        revision = _get_one_revision('pull', revision)
 
1214
        if mergeable is not None:
 
1215
            if revision is not None:
 
1216
                raise errors.BzrCommandError(gettext(
 
1217
                    'Cannot use -r with merge directives or bundles'))
 
1218
            mergeable.install_revisions(branch_to.repository)
 
1219
            base_revision_id, revision_id, verified = \
 
1220
                mergeable.get_merge_request(branch_to.repository)
 
1221
            branch_from = branch_to
 
1222
        else:
 
1223
            branch_from = Branch.open(location,
 
1224
                possible_transports=possible_transports)
 
1225
            self.add_cleanup(branch_from.lock_read().unlock)
 
1226
            # Remembers if asked explicitly or no previous location is set
 
1227
            if (remember
 
1228
                or (remember is None and branch_to.get_parent() is None)):
 
1229
                # FIXME: This shouldn't be done before the pull
 
1230
                # succeeds... -- vila 2012-01-02
 
1231
                branch_to.set_parent(branch_from.base)
 
1232
 
 
1233
        if revision is not None:
 
1234
            revision_id = revision.as_revision_id(branch_from)
 
1235
 
 
1236
        if tree_to is not None:
 
1237
            view_info = _get_view_info_for_change_reporter(tree_to)
 
1238
            change_reporter = delta._ChangeReporter(
 
1239
                unversioned_filter=tree_to.is_ignored,
 
1240
                view_info=view_info)
 
1241
            result = tree_to.pull(
 
1242
                branch_from, overwrite, revision_id, change_reporter,
 
1243
                local=local, show_base=show_base)
 
1244
        else:
 
1245
            result = branch_to.pull(
 
1246
                branch_from, overwrite, revision_id, local=local)
 
1247
 
 
1248
        result.report(self.outf)
 
1249
        if verbose and result.old_revid != result.new_revid:
 
1250
            log.show_branch_change(
 
1251
                branch_to, self.outf, result.old_revno,
 
1252
                result.old_revid)
 
1253
        if getattr(result, 'tag_conflicts', None):
 
1254
            return 1
 
1255
        else:
 
1256
            return 0
 
1257
 
 
1258
 
 
1259
class cmd_push(Command):
 
1260
    __doc__ = """Update a mirror of this branch.
 
1261
 
 
1262
    The target branch will not have its working tree populated because this
 
1263
    is both expensive, and is not supported on remote file systems.
 
1264
 
 
1265
    Some smart servers or protocols *may* put the working tree in place in
 
1266
    the future.
289
1267
 
290
1268
    This command only works on branches that have not diverged.  Branches are
291
 
    considered diverged if both branches have had commits without first
292
 
    pulling from the other.
293
 
 
294
 
    If branches have diverged, you can use 'bzr merge' to pull the text changes
295
 
    from one into the other.
 
1269
    considered diverged if the destination branch's most recent commit is one
 
1270
    that has not been merged (directly or indirectly) by the source branch.
 
1271
 
 
1272
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
1273
    the other branch completely, discarding its unmerged changes.
 
1274
 
 
1275
    If you want to ensure you have the different changes in the other branch,
 
1276
    do a merge (see bzr help merge) from the other branch, and commit that.
 
1277
    After that you will be able to do a push without '--overwrite'.
 
1278
 
 
1279
    If there is no default push location set, the first push will set it (use
 
1280
    --no-remember to avoid setting it).  After that, you can omit the
 
1281
    location to use the default.  To change the default, use --remember. The
 
1282
    value will only be saved if the remote location can be accessed.
 
1283
 
 
1284
    The --verbose option will display the revisions pushed using the log_format
 
1285
    configuration option. You can use a different format by overriding it with
 
1286
    -Olog_format=<other_format>.
296
1287
    """
 
1288
 
 
1289
    _see_also = ['pull', 'update', 'working-trees']
 
1290
    takes_options = ['remember', 'overwrite', 'verbose', 'revision',
 
1291
        Option('create-prefix',
 
1292
               help='Create the path leading up to the branch '
 
1293
                    'if it does not already exist.'),
 
1294
        custom_help('directory',
 
1295
            help='Branch to push from, '
 
1296
                 'rather than the one containing the working directory.'),
 
1297
        Option('use-existing-dir',
 
1298
               help='By default push will fail if the target'
 
1299
                    ' directory exists, but does not already'
 
1300
                    ' have a control directory.  This flag will'
 
1301
                    ' allow push to proceed.'),
 
1302
        Option('stacked',
 
1303
            help='Create a stacked branch that references the public location '
 
1304
                'of the parent branch.'),
 
1305
        Option('stacked-on',
 
1306
            help='Create a stacked branch that refers to another branch '
 
1307
                'for the commit history. Only the work not present in the '
 
1308
                'referenced branch is included in the branch created.',
 
1309
            type=unicode),
 
1310
        Option('strict',
 
1311
               help='Refuse to push if there are uncommitted changes in'
 
1312
               ' the working tree, --no-strict disables the check.'),
 
1313
        Option('no-tree',
 
1314
               help="Don't populate the working tree, even for protocols"
 
1315
               " that support it."),
 
1316
        Option('overwrite-tags',
 
1317
              help="Overwrite tags only."),
 
1318
        ]
297
1319
    takes_args = ['location?']
298
 
 
299
 
    def run(self, location=None):
300
 
        from bzrlib.merge import merge
301
 
        import tempfile
302
 
        from shutil import rmtree
303
 
        import errno
304
 
        from bzrlib.branch import pull_loc
305
 
        
306
 
        br_to = find_branch('.')
307
 
        stored_loc = None
308
 
        try:
309
 
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
310
 
        except IOError, e:
311
 
            if e.errno != errno.ENOENT:
312
 
                raise
 
1320
    encoding_type = 'replace'
 
1321
 
 
1322
    def run(self, location=None, remember=None, overwrite=False,
 
1323
        create_prefix=False, verbose=False, revision=None,
 
1324
        use_existing_dir=False, directory=None, stacked_on=None,
 
1325
        stacked=False, strict=None, no_tree=False,
 
1326
        overwrite_tags=False):
 
1327
        from bzrlib.push import _show_push_branch
 
1328
 
 
1329
        if overwrite:
 
1330
            overwrite = ["history", "tags"]
 
1331
        elif overwrite_tags:
 
1332
            overwrite = ["tags"]
 
1333
        else:
 
1334
            overwrite = []
 
1335
 
 
1336
        if directory is None:
 
1337
            directory = '.'
 
1338
        # Get the source branch
 
1339
        (tree, br_from,
 
1340
         _unused) = controldir.ControlDir.open_containing_tree_or_branch(directory)
 
1341
        # Get the tip's revision_id
 
1342
        revision = _get_one_revision('push', revision)
 
1343
        if revision is not None:
 
1344
            revision_id = revision.in_history(br_from).rev_id
 
1345
        else:
 
1346
            revision_id = None
 
1347
        if tree is not None and revision_id is None:
 
1348
            tree.check_changed_or_out_of_date(
 
1349
                strict, 'push_strict',
 
1350
                more_error='Use --no-strict to force the push.',
 
1351
                more_warning='Uncommitted changes will not be pushed.')
 
1352
        # Get the stacked_on branch, if any
 
1353
        if stacked_on is not None:
 
1354
            stacked_on = urlutils.normalize_url(stacked_on)
 
1355
        elif stacked:
 
1356
            parent_url = br_from.get_parent()
 
1357
            if parent_url:
 
1358
                parent = Branch.open(parent_url)
 
1359
                stacked_on = parent.get_public_branch()
 
1360
                if not stacked_on:
 
1361
                    # I considered excluding non-http url's here, thus forcing
 
1362
                    # 'public' branches only, but that only works for some
 
1363
                    # users, so it's best to just depend on the user spotting an
 
1364
                    # error by the feedback given to them. RBC 20080227.
 
1365
                    stacked_on = parent_url
 
1366
            if not stacked_on:
 
1367
                raise errors.BzrCommandError(gettext(
 
1368
                    "Could not determine branch to refer to."))
 
1369
 
 
1370
        # Get the destination location
313
1371
        if location is None:
 
1372
            stored_loc = br_from.get_push_location()
314
1373
            if stored_loc is None:
315
 
                raise BzrCommandError("No pull location known or specified.")
 
1374
                parent_loc = br_from.get_parent()
 
1375
                if parent_loc:
 
1376
                    raise errors.BzrCommandError(gettext(
 
1377
                        "No push location known or specified. To push to the "
 
1378
                        "parent branch (at %s), use 'bzr push :parent'." %
 
1379
                        urlutils.unescape_for_display(parent_loc,
 
1380
                            self.outf.encoding)))
 
1381
                else:
 
1382
                    raise errors.BzrCommandError(gettext(
 
1383
                        "No push location known or specified."))
316
1384
            else:
317
 
                print "Using last location: %s" % stored_loc
 
1385
                display_url = urlutils.unescape_for_display(stored_loc,
 
1386
                        self.outf.encoding)
 
1387
                note(gettext("Using saved push location: %s") % display_url)
318
1388
                location = stored_loc
319
 
        cache_root = tempfile.mkdtemp()
320
 
        from bzrlib.branch import DivergedBranches
321
 
        br_from = find_branch(location)
322
 
        location = pull_loc(br_from)
323
 
        old_revno = br_to.revno()
324
 
        try:
325
 
            from branch import find_cached_branch, DivergedBranches
326
 
            br_from = find_cached_branch(location, cache_root)
327
 
            location = pull_loc(br_from)
328
 
            old_revno = br_to.revno()
329
 
            try:
330
 
                br_to.update_revisions(br_from)
331
 
            except DivergedBranches:
332
 
                raise BzrCommandError("These branches have diverged."
333
 
                    "  Try merge.")
334
 
                
335
 
            merge(('.', -1), ('.', old_revno), check_clean=False)
336
 
            if location != stored_loc:
337
 
                br_to.controlfile("x-pull", "wb").write(location + "\n")
338
 
        finally:
339
 
            rmtree(cache_root)
340
1389
 
 
1390
        _show_push_branch(br_from, revision_id, location, self.outf,
 
1391
            verbose=verbose, overwrite=overwrite, remember=remember,
 
1392
            stacked_on=stacked_on, create_prefix=create_prefix,
 
1393
            use_existing_dir=use_existing_dir, no_tree=no_tree)
341
1394
 
342
1395
 
343
1396
class cmd_branch(Command):
344
 
    """Create a new copy of a branch.
 
1397
    __doc__ = """Create a new branch that is a copy of an existing branch.
345
1398
 
346
1399
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
347
1400
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
1401
    If the FROM_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1402
    is derived from the FROM_LOCATION by stripping a leading scheme or drive
 
1403
    identifier, if any. For example, "branch lp:foo-bar" will attempt to
 
1404
    create ./foo-bar.
348
1405
 
349
1406
    To retrieve the branch as of a particular revision, supply the --revision
350
1407
    parameter, as in "branch foo/bar -r 5".
 
1408
 
 
1409
    The synonyms 'clone' and 'get' for this command are deprecated.
351
1410
    """
 
1411
 
 
1412
    _see_also = ['checkout']
352
1413
    takes_args = ['from_location', 'to_location?']
353
 
    takes_options = ['revision']
 
1414
    takes_options = ['revision',
 
1415
        Option('hardlink', help='Hard-link working tree files where possible.'),
 
1416
        Option('files-from', type=str,
 
1417
               help="Get file contents from this tree."),
 
1418
        Option('no-tree',
 
1419
            help="Create a branch without a working-tree."),
 
1420
        Option('switch',
 
1421
            help="Switch the checkout in the current directory "
 
1422
                 "to the new branch."),
 
1423
        Option('stacked',
 
1424
            help='Create a stacked branch referring to the source branch. '
 
1425
                'The new branch will depend on the availability of the source '
 
1426
                'branch for all operations.'),
 
1427
        Option('standalone',
 
1428
               help='Do not use a shared repository, even if available.'),
 
1429
        Option('use-existing-dir',
 
1430
               help='By default branch will fail if the target'
 
1431
                    ' directory exists, but does not already'
 
1432
                    ' have a control directory.  This flag will'
 
1433
                    ' allow branch to proceed.'),
 
1434
        Option('bind',
 
1435
            help="Bind new branch to from location."),
 
1436
        ]
354
1437
    aliases = ['get', 'clone']
355
1438
 
356
 
    def run(self, from_location, to_location=None, revision=None):
357
 
        from bzrlib.branch import copy_branch, find_cached_branch
358
 
        import tempfile
359
 
        import errno
360
 
        from shutil import rmtree
361
 
        cache_root = tempfile.mkdtemp()
362
 
        try:
363
 
            if revision is None:
364
 
                revision = [None]
365
 
            elif len(revision) > 1:
366
 
                raise BzrCommandError(
367
 
                    'bzr branch --revision takes exactly 1 revision value')
368
 
            try:
369
 
                br_from = find_cached_branch(from_location, cache_root)
370
 
            except OSError, e:
371
 
                if e.errno == errno.ENOENT:
372
 
                    raise BzrCommandError('Source location "%s" does not'
373
 
                                          ' exist.' % to_location)
374
 
                else:
375
 
                    raise
376
 
            if to_location is None:
377
 
                to_location = os.path.basename(from_location.rstrip("/\\"))
378
 
            try:
379
 
                os.mkdir(to_location)
380
 
            except OSError, e:
381
 
                if e.errno == errno.EEXIST:
382
 
                    raise BzrCommandError('Target directory "%s" already'
383
 
                                          ' exists.' % to_location)
384
 
                if e.errno == errno.ENOENT:
385
 
                    raise BzrCommandError('Parent of "%s" does not exist.' %
386
 
                                          to_location)
387
 
                else:
388
 
                    raise
389
 
            try:
390
 
                copy_branch(br_from, to_location, revision[0])
391
 
            except bzrlib.errors.NoSuchRevision:
392
 
                rmtree(to_location)
393
 
                msg = "The branch %s has no revision %d." % (from_location, revision[0])
394
 
                raise BzrCommandError(msg)
395
 
        finally:
396
 
            rmtree(cache_root)
 
1439
    def run(self, from_location, to_location=None, revision=None,
 
1440
            hardlink=False, stacked=False, standalone=False, no_tree=False,
 
1441
            use_existing_dir=False, switch=False, bind=False,
 
1442
            files_from=None):
 
1443
        from bzrlib import switch as _mod_switch
 
1444
        from bzrlib.tag import _merge_tags_if_possible
 
1445
        if self.invoked_as in ['get', 'clone']:
 
1446
            ui.ui_factory.show_user_warning(
 
1447
                'deprecated_command',
 
1448
                deprecated_name=self.invoked_as,
 
1449
                recommended_name='branch',
 
1450
                deprecated_in_version='2.4')
 
1451
        accelerator_tree, br_from = controldir.ControlDir.open_tree_or_branch(
 
1452
            from_location)
 
1453
        if not (hardlink or files_from):
 
1454
            # accelerator_tree is usually slower because you have to read N
 
1455
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1456
            # explicitly request it
 
1457
            accelerator_tree = None
 
1458
        if files_from is not None and files_from != from_location:
 
1459
            accelerator_tree = WorkingTree.open(files_from)
 
1460
        revision = _get_one_revision('branch', revision)
 
1461
        self.add_cleanup(br_from.lock_read().unlock)
 
1462
        if revision is not None:
 
1463
            revision_id = revision.as_revision_id(br_from)
 
1464
        else:
 
1465
            # FIXME - wt.last_revision, fallback to branch, fall back to
 
1466
            # None or perhaps NULL_REVISION to mean copy nothing
 
1467
            # RBC 20060209
 
1468
            revision_id = br_from.last_revision()
 
1469
        if to_location is None:
 
1470
            to_location = getattr(br_from, "name", None)
 
1471
            if not to_location:
 
1472
                to_location = urlutils.derive_to_location(from_location)
 
1473
        to_transport = transport.get_transport(to_location)
 
1474
        try:
 
1475
            to_transport.mkdir('.')
 
1476
        except errors.FileExists:
 
1477
            try:
 
1478
                to_dir = controldir.ControlDir.open_from_transport(
 
1479
                    to_transport)
 
1480
            except errors.NotBranchError:
 
1481
                if not use_existing_dir:
 
1482
                    raise errors.BzrCommandError(gettext('Target directory "%s" '
 
1483
                        'already exists.') % to_location)
 
1484
                else:
 
1485
                    to_dir = None
 
1486
            else:
 
1487
                try:
 
1488
                    to_dir.open_branch()
 
1489
                except errors.NotBranchError:
 
1490
                    pass
 
1491
                else:
 
1492
                    raise errors.AlreadyBranchError(to_location)
 
1493
        except errors.NoSuchFile:
 
1494
            raise errors.BzrCommandError(gettext('Parent of "%s" does not exist.')
 
1495
                                         % to_location)
 
1496
        else:
 
1497
            to_dir = None
 
1498
        if to_dir is None:
 
1499
            try:
 
1500
                # preserve whatever source format we have.
 
1501
                to_dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
1502
                                            possible_transports=[to_transport],
 
1503
                                            accelerator_tree=accelerator_tree,
 
1504
                                            hardlink=hardlink, stacked=stacked,
 
1505
                                            force_new_repo=standalone,
 
1506
                                            create_tree_if_local=not no_tree,
 
1507
                                            source_branch=br_from)
 
1508
                branch = to_dir.open_branch(
 
1509
                    possible_transports=[
 
1510
                        br_from.bzrdir.root_transport, to_transport])
 
1511
            except errors.NoSuchRevision:
 
1512
                to_transport.delete_tree('.')
 
1513
                msg = gettext("The branch {0} has no revision {1}.").format(
 
1514
                    from_location, revision)
 
1515
                raise errors.BzrCommandError(msg)
 
1516
        else:
 
1517
            try:
 
1518
                to_repo = to_dir.open_repository()
 
1519
            except errors.NoRepositoryPresent:
 
1520
                to_repo = to_dir.create_repository()
 
1521
            to_repo.fetch(br_from.repository, revision_id=revision_id)
 
1522
            branch = br_from.sprout(to_dir, revision_id=revision_id)
 
1523
        _merge_tags_if_possible(br_from, branch)
 
1524
        # If the source branch is stacked, the new branch may
 
1525
        # be stacked whether we asked for that explicitly or not.
 
1526
        # We therefore need a try/except here and not just 'if stacked:'
 
1527
        try:
 
1528
            note(gettext('Created new stacked branch referring to %s.') %
 
1529
                branch.get_stacked_on_url())
 
1530
        except (errors.NotStacked, errors.UnstackableBranchFormat,
 
1531
            errors.UnstackableRepositoryFormat), e:
 
1532
            note(ngettext('Branched %d revision.', 'Branched %d revisions.', branch.revno()) % branch.revno())
 
1533
        if bind:
 
1534
            # Bind to the parent
 
1535
            parent_branch = Branch.open(from_location)
 
1536
            branch.bind(parent_branch)
 
1537
            note(gettext('New branch bound to %s') % from_location)
 
1538
        if switch:
 
1539
            # Switch to the new branch
 
1540
            wt, _ = WorkingTree.open_containing('.')
 
1541
            _mod_switch.switch(wt.bzrdir, branch)
 
1542
            note(gettext('Switched to branch: %s'),
 
1543
                urlutils.unescape_for_display(branch.base, 'utf-8'))
 
1544
 
 
1545
 
 
1546
class cmd_branches(Command):
 
1547
    __doc__ = """List the branches available at the current location.
 
1548
 
 
1549
    This command will print the names of all the branches at the current
 
1550
    location.
 
1551
    """
 
1552
 
 
1553
    takes_args = ['location?']
 
1554
    takes_options = [
 
1555
                  Option('recursive', short_name='R',
 
1556
                         help='Recursively scan for branches rather than '
 
1557
                              'just looking in the specified location.')]
 
1558
 
 
1559
    def run(self, location=".", recursive=False):
 
1560
        if recursive:
 
1561
            t = transport.get_transport(location)
 
1562
            if not t.listable():
 
1563
                raise errors.BzrCommandError(
 
1564
                    "Can't scan this type of location.")
 
1565
            for b in controldir.ControlDir.find_branches(t):
 
1566
                self.outf.write("%s\n" % urlutils.unescape_for_display(
 
1567
                    urlutils.relative_url(t.base, b.base),
 
1568
                    self.outf.encoding).rstrip("/"))
 
1569
        else:
 
1570
            dir = controldir.ControlDir.open_containing(location)[0]
 
1571
            try:
 
1572
                active_branch = dir.open_branch(name="")
 
1573
            except errors.NotBranchError:
 
1574
                active_branch = None
 
1575
            names = {}
 
1576
            for name, branch in iter_sibling_branches(dir):
 
1577
                if name == "":
 
1578
                    continue
 
1579
                active = (active_branch is not None and
 
1580
                          active_branch.base == branch.base)
 
1581
                names[name] = active
 
1582
            # Only mention the current branch explicitly if it's not
 
1583
            # one of the colocated branches
 
1584
            if not any(names.values()) and active_branch is not None:
 
1585
                self.outf.write("* %s\n" % gettext("(default)"))
 
1586
            for name in sorted(names.keys()):
 
1587
                active = names[name]
 
1588
                if active:
 
1589
                    prefix = "*"
 
1590
                else:
 
1591
                    prefix = " "
 
1592
                self.outf.write("%s %s\n" % (
 
1593
                    prefix, name.encode(self.outf.encoding)))
 
1594
 
 
1595
 
 
1596
class cmd_checkout(Command):
 
1597
    __doc__ = """Create a new checkout of an existing branch.
 
1598
 
 
1599
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
1600
    the branch found in '.'. This is useful if you have removed the working tree
 
1601
    or if it was never created - i.e. if you pushed the branch to its current
 
1602
    location using SFTP.
 
1603
 
 
1604
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
1605
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
1606
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
 
1607
    is derived from the BRANCH_LOCATION by stripping a leading scheme or drive
 
1608
    identifier, if any. For example, "checkout lp:foo-bar" will attempt to
 
1609
    create ./foo-bar.
 
1610
 
 
1611
    To retrieve the branch as of a particular revision, supply the --revision
 
1612
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
1613
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
1614
    code.)
 
1615
    """
 
1616
 
 
1617
    _see_also = ['checkouts', 'branch', 'working-trees', 'remove-tree']
 
1618
    takes_args = ['branch_location?', 'to_location?']
 
1619
    takes_options = ['revision',
 
1620
                     Option('lightweight',
 
1621
                            help="Perform a lightweight checkout.  Lightweight "
 
1622
                                 "checkouts depend on access to the branch for "
 
1623
                                 "every operation.  Normal checkouts can perform "
 
1624
                                 "common operations like diff and status without "
 
1625
                                 "such access, and also support local commits."
 
1626
                            ),
 
1627
                     Option('files-from', type=str,
 
1628
                            help="Get file contents from this tree."),
 
1629
                     Option('hardlink',
 
1630
                            help='Hard-link working tree files where possible.'
 
1631
                            ),
 
1632
                     ]
 
1633
    aliases = ['co']
 
1634
 
 
1635
    def run(self, branch_location=None, to_location=None, revision=None,
 
1636
            lightweight=False, files_from=None, hardlink=False):
 
1637
        if branch_location is None:
 
1638
            branch_location = osutils.getcwd()
 
1639
            to_location = branch_location
 
1640
        accelerator_tree, source = controldir.ControlDir.open_tree_or_branch(
 
1641
            branch_location)
 
1642
        if not (hardlink or files_from):
 
1643
            # accelerator_tree is usually slower because you have to read N
 
1644
            # files (no readahead, lots of seeks, etc), but allow the user to
 
1645
            # explicitly request it
 
1646
            accelerator_tree = None
 
1647
        revision = _get_one_revision('checkout', revision)
 
1648
        if files_from is not None and files_from != branch_location:
 
1649
            accelerator_tree = WorkingTree.open(files_from)
 
1650
        if revision is not None:
 
1651
            revision_id = revision.as_revision_id(source)
 
1652
        else:
 
1653
            revision_id = None
 
1654
        if to_location is None:
 
1655
            to_location = urlutils.derive_to_location(branch_location)
 
1656
        # if the source and to_location are the same,
 
1657
        # and there is no working tree,
 
1658
        # then reconstitute a branch
 
1659
        if (osutils.abspath(to_location) ==
 
1660
            osutils.abspath(branch_location)):
 
1661
            try:
 
1662
                source.bzrdir.open_workingtree()
 
1663
            except errors.NoWorkingTree:
 
1664
                source.bzrdir.create_workingtree(revision_id)
 
1665
                return
 
1666
        source.create_checkout(to_location, revision_id, lightweight,
 
1667
                               accelerator_tree, hardlink)
397
1668
 
398
1669
 
399
1670
class cmd_renames(Command):
400
 
    """Show list of renamed files.
401
 
 
402
 
    TODO: Option to show renames between two historical versions.
403
 
 
404
 
    TODO: Only show renames under dir, rather than in the whole branch.
 
1671
    __doc__ = """Show list of renamed files.
405
1672
    """
 
1673
    # TODO: Option to show renames between two historical versions.
 
1674
 
 
1675
    # TODO: Only show renames under dir, rather than in the whole branch.
 
1676
    _see_also = ['status']
406
1677
    takes_args = ['dir?']
407
1678
 
408
 
    def run(self, dir='.'):
409
 
        b = find_branch(dir)
410
 
        old_inv = b.basis_tree().inventory
411
 
        new_inv = b.read_working_inventory()
412
 
 
413
 
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
1679
    @display_command
 
1680
    def run(self, dir=u'.'):
 
1681
        tree = WorkingTree.open_containing(dir)[0]
 
1682
        self.add_cleanup(tree.lock_read().unlock)
 
1683
        old_tree = tree.basis_tree()
 
1684
        self.add_cleanup(old_tree.lock_read().unlock)
 
1685
        renames = []
 
1686
        iterator = tree.iter_changes(old_tree, include_unchanged=True)
 
1687
        for f, paths, c, v, p, n, k, e in iterator:
 
1688
            if paths[0] == paths[1]:
 
1689
                continue
 
1690
            if None in (paths):
 
1691
                continue
 
1692
            renames.append(paths)
414
1693
        renames.sort()
415
1694
        for old_name, new_name in renames:
416
 
            print "%s => %s" % (old_name, new_name)        
 
1695
            self.outf.write("%s => %s\n" % (old_name, new_name))
 
1696
 
 
1697
 
 
1698
class cmd_update(Command):
 
1699
    __doc__ = """Update a working tree to a new revision.
 
1700
 
 
1701
    This will perform a merge of the destination revision (the tip of the
 
1702
    branch, or the specified revision) into the working tree, and then make
 
1703
    that revision the basis revision for the working tree.  
 
1704
 
 
1705
    You can use this to visit an older revision, or to update a working tree
 
1706
    that is out of date from its branch.
 
1707
    
 
1708
    If there are any uncommitted changes in the tree, they will be carried
 
1709
    across and remain as uncommitted changes after the update.  To discard
 
1710
    these changes, use 'bzr revert'.  The uncommitted changes may conflict
 
1711
    with the changes brought in by the change in basis revision.
 
1712
 
 
1713
    If the tree's branch is bound to a master branch, bzr will also update
 
1714
    the branch from the master.
 
1715
 
 
1716
    You cannot update just a single file or directory, because each Bazaar
 
1717
    working tree has just a single basis revision.  If you want to restore a
 
1718
    file that has been removed locally, use 'bzr revert' instead of 'bzr
 
1719
    update'.  If you want to restore a file to its state in a previous
 
1720
    revision, use 'bzr revert' with a '-r' option, or use 'bzr cat' to write
 
1721
    out the old content of that file to a new location.
 
1722
 
 
1723
    The 'dir' argument, if given, must be the location of the root of a
 
1724
    working tree to update.  By default, the working tree that contains the 
 
1725
    current working directory is used.
 
1726
    """
 
1727
 
 
1728
    _see_also = ['pull', 'working-trees', 'status-flags']
 
1729
    takes_args = ['dir?']
 
1730
    takes_options = ['revision',
 
1731
                     Option('show-base',
 
1732
                            help="Show base revision text in conflicts."),
 
1733
                     ]
 
1734
    aliases = ['up']
 
1735
 
 
1736
    def run(self, dir=None, revision=None, show_base=None):
 
1737
        if revision is not None and len(revision) != 1:
 
1738
            raise errors.BzrCommandError(gettext(
 
1739
                "bzr update --revision takes exactly one revision"))
 
1740
        if dir is None:
 
1741
            tree = WorkingTree.open_containing('.')[0]
 
1742
        else:
 
1743
            tree, relpath = WorkingTree.open_containing(dir)
 
1744
            if relpath:
 
1745
                # See bug 557886.
 
1746
                raise errors.BzrCommandError(gettext(
 
1747
                    "bzr update can only update a whole tree, "
 
1748
                    "not a file or subdirectory"))
 
1749
        branch = tree.branch
 
1750
        possible_transports = []
 
1751
        master = branch.get_master_branch(
 
1752
            possible_transports=possible_transports)
 
1753
        if master is not None:
 
1754
            branch_location = master.base
 
1755
            tree.lock_write()
 
1756
        else:
 
1757
            branch_location = tree.branch.base
 
1758
            tree.lock_tree_write()
 
1759
        self.add_cleanup(tree.unlock)
 
1760
        # get rid of the final '/' and be ready for display
 
1761
        branch_location = urlutils.unescape_for_display(
 
1762
            branch_location.rstrip('/'),
 
1763
            self.outf.encoding)
 
1764
        existing_pending_merges = tree.get_parent_ids()[1:]
 
1765
        if master is None:
 
1766
            old_tip = None
 
1767
        else:
 
1768
            # may need to fetch data into a heavyweight checkout
 
1769
            # XXX: this may take some time, maybe we should display a
 
1770
            # message
 
1771
            old_tip = branch.update(possible_transports)
 
1772
        if revision is not None:
 
1773
            revision_id = revision[0].as_revision_id(branch)
 
1774
        else:
 
1775
            revision_id = branch.last_revision()
 
1776
        if revision_id == _mod_revision.ensure_null(tree.last_revision()):
 
1777
            revno = branch.revision_id_to_dotted_revno(revision_id)
 
1778
            note(gettext("Tree is up to date at revision {0} of branch {1}"
 
1779
                        ).format('.'.join(map(str, revno)), branch_location))
 
1780
            return 0
 
1781
        view_info = _get_view_info_for_change_reporter(tree)
 
1782
        change_reporter = delta._ChangeReporter(
 
1783
            unversioned_filter=tree.is_ignored,
 
1784
            view_info=view_info)
 
1785
        try:
 
1786
            conflicts = tree.update(
 
1787
                change_reporter,
 
1788
                possible_transports=possible_transports,
 
1789
                revision=revision_id,
 
1790
                old_tip=old_tip,
 
1791
                show_base=show_base)
 
1792
        except errors.NoSuchRevision, e:
 
1793
            raise errors.BzrCommandError(gettext(
 
1794
                                  "branch has no revision %s\n"
 
1795
                                  "bzr update --revision only works"
 
1796
                                  " for a revision in the branch history")
 
1797
                                  % (e.revision))
 
1798
        revno = tree.branch.revision_id_to_dotted_revno(
 
1799
            _mod_revision.ensure_null(tree.last_revision()))
 
1800
        note(gettext('Updated to revision {0} of branch {1}').format(
 
1801
             '.'.join(map(str, revno)), branch_location))
 
1802
        parent_ids = tree.get_parent_ids()
 
1803
        if parent_ids[1:] and parent_ids[1:] != existing_pending_merges:
 
1804
            note(gettext('Your local commits will now show as pending merges with '
 
1805
                 "'bzr status', and can be committed with 'bzr commit'."))
 
1806
        if conflicts != 0:
 
1807
            return 1
 
1808
        else:
 
1809
            return 0
417
1810
 
418
1811
 
419
1812
class cmd_info(Command):
420
 
    """Show statistical information about a branch."""
421
 
    takes_args = ['branch?']
422
 
    
423
 
    def run(self, branch=None):
424
 
        import info
425
 
 
426
 
        b = find_branch(branch)
427
 
        info.show_info(b)
 
1813
    __doc__ = """Show information about a working tree, branch or repository.
 
1814
 
 
1815
    This command will show all known locations and formats associated to the
 
1816
    tree, branch or repository.
 
1817
 
 
1818
    In verbose mode, statistical information is included with each report.
 
1819
    To see extended statistic information, use a verbosity level of 2 or
 
1820
    higher by specifying the verbose option multiple times, e.g. -vv.
 
1821
 
 
1822
    Branches and working trees will also report any missing revisions.
 
1823
 
 
1824
    :Examples:
 
1825
 
 
1826
      Display information on the format and related locations:
 
1827
 
 
1828
        bzr info
 
1829
 
 
1830
      Display the above together with extended format information and
 
1831
      basic statistics (like the number of files in the working tree and
 
1832
      number of revisions in the branch and repository):
 
1833
 
 
1834
        bzr info -v
 
1835
 
 
1836
      Display the above together with number of committers to the branch:
 
1837
 
 
1838
        bzr info -vv
 
1839
    """
 
1840
    _see_also = ['revno', 'working-trees', 'repositories']
 
1841
    takes_args = ['location?']
 
1842
    takes_options = ['verbose']
 
1843
    encoding_type = 'replace'
 
1844
 
 
1845
    @display_command
 
1846
    def run(self, location=None, verbose=False):
 
1847
        if verbose:
 
1848
            noise_level = get_verbosity_level()
 
1849
        else:
 
1850
            noise_level = 0
 
1851
        from bzrlib.info import show_bzrdir_info
 
1852
        show_bzrdir_info(controldir.ControlDir.open_containing(location)[0],
 
1853
                         verbose=noise_level, outfile=self.outf)
428
1854
 
429
1855
 
430
1856
class cmd_remove(Command):
431
 
    """Make a file unversioned.
 
1857
    __doc__ = """Remove files or directories.
432
1858
 
433
 
    This makes bzr stop tracking changes to a versioned file.  It does
434
 
    not delete the working copy.
 
1859
    This makes Bazaar stop tracking changes to the specified files. Bazaar will
 
1860
    delete them if they can easily be recovered using revert otherwise they
 
1861
    will be backed up (adding an extension of the form .~#~). If no options or
 
1862
    parameters are given Bazaar will scan for files that are being tracked by
 
1863
    Bazaar but missing in your tree and stop tracking them for you.
435
1864
    """
436
 
    takes_args = ['file+']
437
 
    takes_options = ['verbose']
438
 
    
439
 
    def run(self, file_list, verbose=False):
440
 
        b = find_branch(file_list[0])
441
 
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
1865
    takes_args = ['file*']
 
1866
    takes_options = ['verbose',
 
1867
        Option('new', help='Only remove files that have never been committed.'),
 
1868
        RegistryOption.from_kwargs('file-deletion-strategy',
 
1869
            'The file deletion mode to be used.',
 
1870
            title='Deletion Strategy', value_switches=True, enum_switch=False,
 
1871
            safe='Backup changed files (default).',
 
1872
            keep='Delete from bzr but leave the working copy.',
 
1873
            no_backup='Don\'t backup changed files.'),
 
1874
        ]
 
1875
    aliases = ['rm', 'del']
 
1876
    encoding_type = 'replace'
 
1877
 
 
1878
    def run(self, file_list, verbose=False, new=False,
 
1879
        file_deletion_strategy='safe'):
 
1880
 
 
1881
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
1882
 
 
1883
        if file_list is not None:
 
1884
            file_list = [f for f in file_list]
 
1885
 
 
1886
        self.add_cleanup(tree.lock_write().unlock)
 
1887
        # Heuristics should probably all move into tree.remove_smart or
 
1888
        # some such?
 
1889
        if new:
 
1890
            added = tree.changes_from(tree.basis_tree(),
 
1891
                specific_files=file_list).added
 
1892
            file_list = sorted([f[0] for f in added], reverse=True)
 
1893
            if len(file_list) == 0:
 
1894
                raise errors.BzrCommandError(gettext('No matching files.'))
 
1895
        elif file_list is None:
 
1896
            # missing files show up in iter_changes(basis) as
 
1897
            # versioned-with-no-kind.
 
1898
            missing = []
 
1899
            for change in tree.iter_changes(tree.basis_tree()):
 
1900
                # Find paths in the working tree that have no kind:
 
1901
                if change[1][1] is not None and change[6][1] is None:
 
1902
                    missing.append(change[1][1])
 
1903
            file_list = sorted(missing, reverse=True)
 
1904
            file_deletion_strategy = 'keep'
 
1905
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
 
1906
            keep_files=file_deletion_strategy=='keep',
 
1907
            force=(file_deletion_strategy=='no-backup'))
442
1908
 
443
1909
 
444
1910
class cmd_file_id(Command):
445
 
    """Print file_id of a particular file or directory.
 
1911
    __doc__ = """Print file_id of a particular file or directory.
446
1912
 
447
1913
    The file_id is assigned when the file is first added and remains the
448
1914
    same through all revisions where the file exists, even when it is
449
1915
    moved or renamed.
450
1916
    """
 
1917
 
451
1918
    hidden = True
 
1919
    _see_also = ['inventory', 'ls']
452
1920
    takes_args = ['filename']
 
1921
 
 
1922
    @display_command
453
1923
    def run(self, filename):
454
 
        b = find_branch(filename)
455
 
        i = b.inventory.path2id(b.relpath(filename))
456
 
        if i == None:
457
 
            raise BzrError("%r is not a versioned file" % filename)
 
1924
        tree, relpath = WorkingTree.open_containing(filename)
 
1925
        i = tree.path2id(relpath)
 
1926
        if i is None:
 
1927
            raise errors.NotVersionedError(filename)
458
1928
        else:
459
 
            print i
 
1929
            self.outf.write(i + '\n')
460
1930
 
461
1931
 
462
1932
class cmd_file_path(Command):
463
 
    """Print path of file_ids to a file or directory.
 
1933
    __doc__ = """Print path of file_ids to a file or directory.
464
1934
 
465
1935
    This prints one line for each directory down to the target,
466
 
    starting at the branch root."""
 
1936
    starting at the branch root.
 
1937
    """
 
1938
 
467
1939
    hidden = True
468
1940
    takes_args = ['filename']
 
1941
 
 
1942
    @display_command
469
1943
    def run(self, filename):
470
 
        b = find_branch(filename)
471
 
        inv = b.inventory
472
 
        fid = inv.path2id(b.relpath(filename))
473
 
        if fid == None:
474
 
            raise BzrError("%r is not a versioned file" % filename)
475
 
        for fip in inv.get_idpath(fid):
476
 
            print fip
 
1944
        tree, relpath = WorkingTree.open_containing(filename)
 
1945
        fid = tree.path2id(relpath)
 
1946
        if fid is None:
 
1947
            raise errors.NotVersionedError(filename)
 
1948
        segments = osutils.splitpath(relpath)
 
1949
        for pos in range(1, len(segments) + 1):
 
1950
            path = osutils.joinpath(segments[:pos])
 
1951
            self.outf.write("%s\n" % tree.path2id(path))
 
1952
 
 
1953
 
 
1954
class cmd_reconcile(Command):
 
1955
    __doc__ = """Reconcile bzr metadata in a branch.
 
1956
 
 
1957
    This can correct data mismatches that may have been caused by
 
1958
    previous ghost operations or bzr upgrades. You should only
 
1959
    need to run this command if 'bzr check' or a bzr developer
 
1960
    advises you to run it.
 
1961
 
 
1962
    If a second branch is provided, cross-branch reconciliation is
 
1963
    also attempted, which will check that data like the tree root
 
1964
    id which was not present in very early bzr versions is represented
 
1965
    correctly in both branches.
 
1966
 
 
1967
    At the same time it is run it may recompress data resulting in
 
1968
    a potential saving in disk space or performance gain.
 
1969
 
 
1970
    The branch *MUST* be on a listable system such as local disk or sftp.
 
1971
    """
 
1972
 
 
1973
    _see_also = ['check']
 
1974
    takes_args = ['branch?']
 
1975
    takes_options = [
 
1976
        Option('canonicalize-chks',
 
1977
               help='Make sure CHKs are in canonical form (repairs '
 
1978
                    'bug 522637).',
 
1979
               hidden=True),
 
1980
        ]
 
1981
 
 
1982
    def run(self, branch=".", canonicalize_chks=False):
 
1983
        from bzrlib.reconcile import reconcile
 
1984
        dir = controldir.ControlDir.open(branch)
 
1985
        reconcile(dir, canonicalize_chks=canonicalize_chks)
477
1986
 
478
1987
 
479
1988
class cmd_revision_history(Command):
480
 
    """Display list of revision ids on this branch."""
481
 
    hidden = True
482
 
    def run(self):
483
 
        for patchid in find_branch('.').revision_history():
484
 
            print patchid
485
 
 
486
 
 
487
 
class cmd_directories(Command):
488
 
    """Display list of versioned directories in this branch."""
489
 
    def run(self):
490
 
        for name, ie in find_branch('.').read_working_inventory().directories():
491
 
            if name == '':
492
 
                print '.'
493
 
            else:
494
 
                print name
 
1989
    __doc__ = """Display the list of revision ids on a branch."""
 
1990
 
 
1991
    _see_also = ['log']
 
1992
    takes_args = ['location?']
 
1993
 
 
1994
    hidden = True
 
1995
 
 
1996
    @display_command
 
1997
    def run(self, location="."):
 
1998
        branch = Branch.open_containing(location)[0]
 
1999
        self.add_cleanup(branch.lock_read().unlock)
 
2000
        graph = branch.repository.get_graph()
 
2001
        history = list(graph.iter_lefthand_ancestry(branch.last_revision(),
 
2002
            [_mod_revision.NULL_REVISION]))
 
2003
        for revid in reversed(history):
 
2004
            self.outf.write(revid)
 
2005
            self.outf.write('\n')
 
2006
 
 
2007
 
 
2008
class cmd_ancestry(Command):
 
2009
    __doc__ = """List all revisions merged into this branch."""
 
2010
 
 
2011
    _see_also = ['log', 'revision-history']
 
2012
    takes_args = ['location?']
 
2013
 
 
2014
    hidden = True
 
2015
 
 
2016
    @display_command
 
2017
    def run(self, location="."):
 
2018
        try:
 
2019
            wt = WorkingTree.open_containing(location)[0]
 
2020
        except errors.NoWorkingTree:
 
2021
            b = Branch.open(location)
 
2022
            last_revision = b.last_revision()
 
2023
        else:
 
2024
            b = wt.branch
 
2025
            last_revision = wt.last_revision()
 
2026
 
 
2027
        self.add_cleanup(b.repository.lock_read().unlock)
 
2028
        graph = b.repository.get_graph()
 
2029
        revisions = [revid for revid, parents in
 
2030
            graph.iter_ancestry([last_revision])]
 
2031
        for revision_id in reversed(revisions):
 
2032
            if _mod_revision.is_null(revision_id):
 
2033
                continue
 
2034
            self.outf.write(revision_id + '\n')
495
2035
 
496
2036
 
497
2037
class cmd_init(Command):
498
 
    """Make a directory into a versioned branch.
 
2038
    __doc__ = """Make a directory into a versioned branch.
499
2039
 
500
2040
    Use this to create an empty branch, or before importing an
501
2041
    existing project.
502
2042
 
503
 
    Recipe for importing a tree of files:
 
2043
    If there is a repository in a parent directory of the location, then
 
2044
    the history of the branch will be stored in the repository.  Otherwise
 
2045
    init creates a standalone branch which carries its own history
 
2046
    in the .bzr directory.
 
2047
 
 
2048
    If there is already a branch at the location but it has no working tree,
 
2049
    the tree can be populated with 'bzr checkout'.
 
2050
 
 
2051
    Recipe for importing a tree of files::
 
2052
 
504
2053
        cd ~/project
505
2054
        bzr init
506
 
        bzr add -v .
 
2055
        bzr add .
507
2056
        bzr status
508
 
        bzr commit -m 'imported project'
509
 
    """
510
 
    def run(self):
511
 
        from bzrlib.branch import Branch
512
 
        Branch('.', init=True)
 
2057
        bzr commit -m "imported project"
 
2058
    """
 
2059
 
 
2060
    _see_also = ['init-repository', 'branch', 'checkout']
 
2061
    takes_args = ['location?']
 
2062
    takes_options = [
 
2063
        Option('create-prefix',
 
2064
               help='Create the path leading up to the branch '
 
2065
                    'if it does not already exist.'),
 
2066
         RegistryOption('format',
 
2067
                help='Specify a format for this branch. '
 
2068
                'See "help formats".',
 
2069
                lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2070
                converter=lambda name: controldir.format_registry.make_bzrdir(name),
 
2071
                value_switches=True,
 
2072
                title="Branch format",
 
2073
                ),
 
2074
         Option('append-revisions-only',
 
2075
                help='Never change revnos or the existing log.'
 
2076
                '  Append revisions to it only.'),
 
2077
         Option('no-tree',
 
2078
                'Create a branch without a working tree.')
 
2079
         ]
 
2080
    def run(self, location=None, format=None, append_revisions_only=False,
 
2081
            create_prefix=False, no_tree=False):
 
2082
        if format is None:
 
2083
            format = controldir.format_registry.make_bzrdir('default')
 
2084
        if location is None:
 
2085
            location = u'.'
 
2086
 
 
2087
        to_transport = transport.get_transport(location)
 
2088
 
 
2089
        # The path has to exist to initialize a
 
2090
        # branch inside of it.
 
2091
        # Just using os.mkdir, since I don't
 
2092
        # believe that we want to create a bunch of
 
2093
        # locations if the user supplies an extended path
 
2094
        try:
 
2095
            to_transport.ensure_base()
 
2096
        except errors.NoSuchFile:
 
2097
            if not create_prefix:
 
2098
                raise errors.BzrCommandError(gettext("Parent directory of %s"
 
2099
                    " does not exist."
 
2100
                    "\nYou may supply --create-prefix to create all"
 
2101
                    " leading parent directories.")
 
2102
                    % location)
 
2103
            to_transport.create_prefix()
 
2104
 
 
2105
        try:
 
2106
            a_bzrdir = controldir.ControlDir.open_from_transport(to_transport)
 
2107
        except errors.NotBranchError:
 
2108
            # really a NotBzrDir error...
 
2109
            create_branch = controldir.ControlDir.create_branch_convenience
 
2110
            if no_tree:
 
2111
                force_new_tree = False
 
2112
            else:
 
2113
                force_new_tree = None
 
2114
            branch = create_branch(to_transport.base, format=format,
 
2115
                                   possible_transports=[to_transport],
 
2116
                                   force_new_tree=force_new_tree)
 
2117
            a_bzrdir = branch.bzrdir
 
2118
        else:
 
2119
            from bzrlib.transport.local import LocalTransport
 
2120
            if a_bzrdir.has_branch():
 
2121
                if (isinstance(to_transport, LocalTransport)
 
2122
                    and not a_bzrdir.has_workingtree()):
 
2123
                        raise errors.BranchExistsWithoutWorkingTree(location)
 
2124
                raise errors.AlreadyBranchError(location)
 
2125
            branch = a_bzrdir.create_branch()
 
2126
            if not no_tree and not a_bzrdir.has_workingtree():
 
2127
                a_bzrdir.create_workingtree()
 
2128
        if append_revisions_only:
 
2129
            try:
 
2130
                branch.set_append_revisions_only(True)
 
2131
            except errors.UpgradeRequired:
 
2132
                raise errors.BzrCommandError(gettext('This branch format cannot be set'
 
2133
                    ' to append-revisions-only.  Try --default.'))
 
2134
        if not is_quiet():
 
2135
            from bzrlib.info import describe_layout, describe_format
 
2136
            try:
 
2137
                tree = a_bzrdir.open_workingtree(recommend_upgrade=False)
 
2138
            except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2139
                tree = None
 
2140
            repository = branch.repository
 
2141
            layout = describe_layout(repository, branch, tree).lower()
 
2142
            format = describe_format(a_bzrdir, repository, branch, tree)
 
2143
            self.outf.write(gettext("Created a {0} (format: {1})\n").format(
 
2144
                  layout, format))
 
2145
            if repository.is_shared():
 
2146
                #XXX: maybe this can be refactored into transport.path_or_url()
 
2147
                url = repository.bzrdir.root_transport.external_url()
 
2148
                try:
 
2149
                    url = urlutils.local_path_from_url(url)
 
2150
                except errors.InvalidURL:
 
2151
                    pass
 
2152
                self.outf.write(gettext("Using shared repository: %s\n") % url)
 
2153
 
 
2154
 
 
2155
class cmd_init_repository(Command):
 
2156
    __doc__ = """Create a shared repository for branches to share storage space.
 
2157
 
 
2158
    New branches created under the repository directory will store their
 
2159
    revisions in the repository, not in the branch directory.  For branches
 
2160
    with shared history, this reduces the amount of storage needed and 
 
2161
    speeds up the creation of new branches.
 
2162
 
 
2163
    If the --no-trees option is given then the branches in the repository
 
2164
    will not have working trees by default.  They will still exist as 
 
2165
    directories on disk, but they will not have separate copies of the 
 
2166
    files at a certain revision.  This can be useful for repositories that
 
2167
    store branches which are interacted with through checkouts or remote
 
2168
    branches, such as on a server.
 
2169
 
 
2170
    :Examples:
 
2171
        Create a shared repository holding just branches::
 
2172
 
 
2173
            bzr init-repo --no-trees repo
 
2174
            bzr init repo/trunk
 
2175
 
 
2176
        Make a lightweight checkout elsewhere::
 
2177
 
 
2178
            bzr checkout --lightweight repo/trunk trunk-checkout
 
2179
            cd trunk-checkout
 
2180
            (add files here)
 
2181
    """
 
2182
 
 
2183
    _see_also = ['init', 'branch', 'checkout', 'repositories']
 
2184
    takes_args = ["location"]
 
2185
    takes_options = [RegistryOption('format',
 
2186
                            help='Specify a format for this repository. See'
 
2187
                                 ' "bzr help formats" for details.',
 
2188
                            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
2189
                            converter=lambda name: controldir.format_registry.make_bzrdir(name),
 
2190
                            value_switches=True, title='Repository format'),
 
2191
                     Option('no-trees',
 
2192
                             help='Branches in the repository will default to'
 
2193
                                  ' not having a working tree.'),
 
2194
                    ]
 
2195
    aliases = ["init-repo"]
 
2196
 
 
2197
    def run(self, location, format=None, no_trees=False):
 
2198
        if format is None:
 
2199
            format = controldir.format_registry.make_bzrdir('default')
 
2200
 
 
2201
        if location is None:
 
2202
            location = '.'
 
2203
 
 
2204
        to_transport = transport.get_transport(location)
 
2205
 
 
2206
        (repo, newdir, require_stacking, repository_policy) = (
 
2207
            format.initialize_on_transport_ex(to_transport,
 
2208
            create_prefix=True, make_working_trees=not no_trees,
 
2209
            shared_repo=True, force_new_repo=True,
 
2210
            use_existing_dir=True,
 
2211
            repo_format_name=format.repository_format.get_format_string()))
 
2212
        if not is_quiet():
 
2213
            from bzrlib.info import show_bzrdir_info
 
2214
            show_bzrdir_info(newdir, verbose=0, outfile=self.outf)
513
2215
 
514
2216
 
515
2217
class cmd_diff(Command):
516
 
    """Show differences in working tree.
517
 
    
518
 
    If files are listed, only the changes in those files are listed.
519
 
    Otherwise, all changes for the tree are listed.
520
 
 
521
 
    TODO: Allow diff across branches.
522
 
 
523
 
    TODO: Option to use external diff command; could be GNU diff, wdiff,
524
 
          or a graphical diff.
525
 
 
526
 
    TODO: Python difflib is not exactly the same as unidiff; should
527
 
          either fix it up or prefer to use an external diff.
528
 
 
529
 
    TODO: If a directory is given, diff everything under that.
530
 
 
531
 
    TODO: Selected-file diff is inefficient and doesn't show you
532
 
          deleted files.
533
 
 
534
 
    TODO: This probably handles non-Unix newlines poorly.
535
 
 
536
 
    examples:
537
 
        bzr diff
538
 
        bzr diff -r1
539
 
        bzr diff -r1:2
 
2218
    __doc__ = """Show differences in the working tree, between revisions or branches.
 
2219
 
 
2220
    If no arguments are given, all changes for the current tree are listed.
 
2221
    If files are given, only the changes in those files are listed.
 
2222
    Remote and multiple branches can be compared by using the --old and
 
2223
    --new options. If not provided, the default for both is derived from
 
2224
    the first argument, if any, or the current tree if no arguments are
 
2225
    given.
 
2226
 
 
2227
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
2228
    produces patches suitable for "patch -p1".
 
2229
 
 
2230
    Note that when using the -r argument with a range of revisions, the
 
2231
    differences are computed between the two specified revisions.  That
 
2232
    is, the command does not show the changes introduced by the first 
 
2233
    revision in the range.  This differs from the interpretation of 
 
2234
    revision ranges used by "bzr log" which includes the first revision
 
2235
    in the range.
 
2236
 
 
2237
    :Exit values:
 
2238
        1 - changed
 
2239
        2 - unrepresentable changes
 
2240
        3 - error
 
2241
        0 - no change
 
2242
 
 
2243
    :Examples:
 
2244
        Shows the difference in the working tree versus the last commit::
 
2245
 
 
2246
            bzr diff
 
2247
 
 
2248
        Difference between the working tree and revision 1::
 
2249
 
 
2250
            bzr diff -r1
 
2251
 
 
2252
        Difference between revision 3 and revision 1::
 
2253
 
 
2254
            bzr diff -r1..3
 
2255
 
 
2256
        Difference between revision 3 and revision 1 for branch xxx::
 
2257
 
 
2258
            bzr diff -r1..3 xxx
 
2259
 
 
2260
        The changes introduced by revision 2 (equivalent to -r1..2)::
 
2261
 
 
2262
            bzr diff -c2
 
2263
 
 
2264
        To see the changes introduced by revision X::
 
2265
        
 
2266
            bzr diff -cX
 
2267
 
 
2268
        Note that in the case of a merge, the -c option shows the changes
 
2269
        compared to the left hand parent. To see the changes against
 
2270
        another parent, use::
 
2271
 
 
2272
            bzr diff -r<chosen_parent>..X
 
2273
 
 
2274
        The changes between the current revision and the previous revision
 
2275
        (equivalent to -c-1 and -r-2..-1)
 
2276
 
 
2277
            bzr diff -r-2..
 
2278
 
 
2279
        Show just the differences for file NEWS::
 
2280
 
 
2281
            bzr diff NEWS
 
2282
 
 
2283
        Show the differences in working tree xxx for file NEWS::
 
2284
 
 
2285
            bzr diff xxx/NEWS
 
2286
 
 
2287
        Show the differences from branch xxx to this working tree:
 
2288
 
 
2289
            bzr diff --old xxx
 
2290
 
 
2291
        Show the differences between two branches for file NEWS::
 
2292
 
 
2293
            bzr diff --old xxx --new yyy NEWS
 
2294
 
 
2295
        Same as 'bzr diff' but prefix paths with old/ and new/::
 
2296
 
 
2297
            bzr diff --prefix old/:new/
 
2298
            
 
2299
        Show the differences using a custom diff program with options::
 
2300
        
 
2301
            bzr diff --using /usr/bin/diff --diff-options -wu
540
2302
    """
541
 
    
 
2303
    _see_also = ['status']
542
2304
    takes_args = ['file*']
543
 
    takes_options = ['revision', 'diff-options']
 
2305
    takes_options = [
 
2306
        Option('diff-options', type=str,
 
2307
               help='Pass these options to the external diff program.'),
 
2308
        Option('prefix', type=str,
 
2309
               short_name='p',
 
2310
               help='Set prefixes added to old and new filenames, as '
 
2311
                    'two values separated by a colon. (eg "old/:new/").'),
 
2312
        Option('old',
 
2313
            help='Branch/tree to compare from.',
 
2314
            type=unicode,
 
2315
            ),
 
2316
        Option('new',
 
2317
            help='Branch/tree to compare to.',
 
2318
            type=unicode,
 
2319
            ),
 
2320
        'revision',
 
2321
        'change',
 
2322
        Option('using',
 
2323
            help='Use this command to compare files.',
 
2324
            type=unicode,
 
2325
            ),
 
2326
        RegistryOption('format',
 
2327
            short_name='F',
 
2328
            help='Diff format to use.',
 
2329
            lazy_registry=('bzrlib.diff', 'format_registry'),
 
2330
            title='Diff format'),
 
2331
        Option('context',
 
2332
            help='How many lines of context to show.',
 
2333
            type=int,
 
2334
            ),
 
2335
        ]
544
2336
    aliases = ['di', 'dif']
545
 
 
546
 
    def run(self, revision=None, file_list=None, diff_options=None):
547
 
        from bzrlib.diff import show_diff
548
 
 
549
 
        if file_list:
550
 
            b = find_branch(file_list[0])
551
 
            file_list = [b.relpath(f) for f in file_list]
552
 
            if file_list == ['']:
553
 
                # just pointing to top-of-tree
554
 
                file_list = None
555
 
        else:
556
 
            b = find_branch('.')
557
 
 
558
 
        if revision is not None:
559
 
            if len(revision) == 1:
560
 
                show_diff(b, revision[0], specific_files=file_list,
561
 
                          external_diff_options=diff_options)
562
 
            elif len(revision) == 2:
563
 
                show_diff(b, revision[0], specific_files=file_list,
564
 
                          external_diff_options=diff_options,
565
 
                          revision2=revision[1])
566
 
            else:
567
 
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
568
 
        else:
569
 
            show_diff(b, None, specific_files=file_list,
570
 
                      external_diff_options=diff_options)
571
 
 
572
 
        
 
2337
    encoding_type = 'exact'
 
2338
 
 
2339
    @display_command
 
2340
    def run(self, revision=None, file_list=None, diff_options=None,
 
2341
            prefix=None, old=None, new=None, using=None, format=None, 
 
2342
            context=None):
 
2343
        from bzrlib.diff import (get_trees_and_branches_to_diff_locked,
 
2344
            show_diff_trees)
 
2345
 
 
2346
        if (prefix is None) or (prefix == '0'):
 
2347
            # diff -p0 format
 
2348
            old_label = ''
 
2349
            new_label = ''
 
2350
        elif prefix == '1':
 
2351
            old_label = 'old/'
 
2352
            new_label = 'new/'
 
2353
        elif ':' in prefix:
 
2354
            old_label, new_label = prefix.split(":")
 
2355
        else:
 
2356
            raise errors.BzrCommandError(gettext(
 
2357
                '--prefix expects two values separated by a colon'
 
2358
                ' (eg "old/:new/")'))
 
2359
 
 
2360
        if revision and len(revision) > 2:
 
2361
            raise errors.BzrCommandError(gettext('bzr diff --revision takes exactly'
 
2362
                                         ' one or two revision specifiers'))
 
2363
 
 
2364
        if using is not None and format is not None:
 
2365
            raise errors.BzrCommandError(gettext(
 
2366
                '{0} and {1} are mutually exclusive').format(
 
2367
                '--using', '--format'))
 
2368
 
 
2369
        (old_tree, new_tree,
 
2370
         old_branch, new_branch,
 
2371
         specific_files, extra_trees) = get_trees_and_branches_to_diff_locked(
 
2372
            file_list, revision, old, new, self.add_cleanup, apply_view=True)
 
2373
        # GNU diff on Windows uses ANSI encoding for filenames
 
2374
        path_encoding = osutils.get_diff_header_encoding()
 
2375
        return show_diff_trees(old_tree, new_tree, sys.stdout,
 
2376
                               specific_files=specific_files,
 
2377
                               external_diff_options=diff_options,
 
2378
                               old_label=old_label, new_label=new_label,
 
2379
                               extra_trees=extra_trees,
 
2380
                               path_encoding=path_encoding,
 
2381
                               using=using, context=context,
 
2382
                               format_cls=format)
573
2383
 
574
2384
 
575
2385
class cmd_deleted(Command):
576
 
    """List files deleted in the working tree.
577
 
 
578
 
    TODO: Show files deleted since a previous revision, or between two revisions.
 
2386
    __doc__ = """List files deleted in the working tree.
579
2387
    """
580
 
    def run(self, show_ids=False):
581
 
        b = find_branch('.')
582
 
        old = b.basis_tree()
583
 
        new = b.working_tree()
584
 
 
585
 
        ## TODO: Much more efficient way to do this: read in new
586
 
        ## directories with readdir, rather than stating each one.  Same
587
 
        ## level of effort but possibly much less IO.  (Or possibly not,
588
 
        ## if the directories are very large...)
589
 
 
590
 
        for path, ie in old.inventory.iter_entries():
591
 
            if not new.has_id(ie.file_id):
 
2388
    # TODO: Show files deleted since a previous revision, or
 
2389
    # between two revisions.
 
2390
    # TODO: Much more efficient way to do this: read in new
 
2391
    # directories with readdir, rather than stating each one.  Same
 
2392
    # level of effort but possibly much less IO.  (Or possibly not,
 
2393
    # if the directories are very large...)
 
2394
    _see_also = ['status', 'ls']
 
2395
    takes_options = ['directory', 'show-ids']
 
2396
 
 
2397
    @display_command
 
2398
    def run(self, show_ids=False, directory=u'.'):
 
2399
        tree = WorkingTree.open_containing(directory)[0]
 
2400
        self.add_cleanup(tree.lock_read().unlock)
 
2401
        old = tree.basis_tree()
 
2402
        self.add_cleanup(old.lock_read().unlock)
 
2403
        for path, ie in old.iter_entries_by_dir():
 
2404
            if not tree.has_id(ie.file_id):
 
2405
                self.outf.write(path)
592
2406
                if show_ids:
593
 
                    print '%-50s %s' % (path, ie.file_id)
594
 
                else:
595
 
                    print path
 
2407
                    self.outf.write(' ')
 
2408
                    self.outf.write(ie.file_id)
 
2409
                self.outf.write('\n')
596
2410
 
597
2411
 
598
2412
class cmd_modified(Command):
599
 
    """List files modified in working tree."""
 
2413
    __doc__ = """List files modified in working tree.
 
2414
    """
 
2415
 
600
2416
    hidden = True
601
 
    def run(self):
602
 
        from bzrlib.delta import compare_trees
603
 
 
604
 
        b = find_branch('.')
605
 
        td = compare_trees(b.basis_tree(), b.working_tree())
606
 
 
607
 
        for path, id, kind in td.modified:
608
 
            print path
609
 
 
 
2417
    _see_also = ['status', 'ls']
 
2418
    takes_options = ['directory', 'null']
 
2419
 
 
2420
    @display_command
 
2421
    def run(self, null=False, directory=u'.'):
 
2422
        tree = WorkingTree.open_containing(directory)[0]
 
2423
        self.add_cleanup(tree.lock_read().unlock)
 
2424
        td = tree.changes_from(tree.basis_tree())
 
2425
        self.cleanup_now()
 
2426
        for path, id, kind, text_modified, meta_modified in td.modified:
 
2427
            if null:
 
2428
                self.outf.write(path + '\0')
 
2429
            else:
 
2430
                self.outf.write(osutils.quotefn(path) + '\n')
610
2431
 
611
2432
 
612
2433
class cmd_added(Command):
613
 
    """List files added in working tree."""
 
2434
    __doc__ = """List files added in working tree.
 
2435
    """
 
2436
 
614
2437
    hidden = True
615
 
    def run(self):
616
 
        b = find_branch('.')
617
 
        wt = b.working_tree()
618
 
        basis_inv = b.basis_tree().inventory
619
 
        inv = wt.inventory
620
 
        for file_id in inv:
621
 
            if file_id in basis_inv:
622
 
                continue
623
 
            path = inv.id2path(file_id)
624
 
            if not os.access(b.abspath(path), os.F_OK):
625
 
                continue
626
 
            print path
627
 
                
628
 
        
 
2438
    _see_also = ['status', 'ls']
 
2439
    takes_options = ['directory', 'null']
 
2440
 
 
2441
    @display_command
 
2442
    def run(self, null=False, directory=u'.'):
 
2443
        wt = WorkingTree.open_containing(directory)[0]
 
2444
        self.add_cleanup(wt.lock_read().unlock)
 
2445
        basis = wt.basis_tree()
 
2446
        self.add_cleanup(basis.lock_read().unlock)
 
2447
        root_id = wt.get_root_id()
 
2448
        for file_id in wt.all_file_ids():
 
2449
            if basis.has_id(file_id):
 
2450
                continue
 
2451
            if root_id == file_id:
 
2452
                continue
 
2453
            path = wt.id2path(file_id)
 
2454
            if not os.access(osutils.pathjoin(wt.basedir, path), os.F_OK):
 
2455
                continue
 
2456
            if null:
 
2457
                self.outf.write(path + '\0')
 
2458
            else:
 
2459
                self.outf.write(osutils.quotefn(path) + '\n')
 
2460
 
629
2461
 
630
2462
class cmd_root(Command):
631
 
    """Show the tree root directory.
 
2463
    __doc__ = """Show the tree root directory.
632
2464
 
633
2465
    The root is the nearest enclosing directory with a .bzr control
634
2466
    directory."""
 
2467
 
635
2468
    takes_args = ['filename?']
 
2469
    @display_command
636
2470
    def run(self, filename=None):
637
2471
        """Print the branch root."""
638
 
        b = find_branch(filename)
639
 
        print getattr(b, 'base', None) or getattr(b, 'baseurl')
 
2472
        tree = WorkingTree.open_containing(filename)[0]
 
2473
        self.outf.write(tree.basedir + '\n')
 
2474
 
 
2475
 
 
2476
def _parse_limit(limitstring):
 
2477
    try:
 
2478
        return int(limitstring)
 
2479
    except ValueError:
 
2480
        msg = gettext("The limit argument must be an integer.")
 
2481
        raise errors.BzrCommandError(msg)
 
2482
 
 
2483
 
 
2484
def _parse_levels(s):
 
2485
    try:
 
2486
        return int(s)
 
2487
    except ValueError:
 
2488
        msg = gettext("The levels argument must be an integer.")
 
2489
        raise errors.BzrCommandError(msg)
640
2490
 
641
2491
 
642
2492
class cmd_log(Command):
643
 
    """Show log of this branch.
644
 
 
645
 
    To request a range of logs, you can use the command -r begin:end
646
 
    -r revision requests a specific revision, -r :end or -r begin: are
647
 
    also valid.
648
 
 
649
 
    --message allows you to give a regular expression, which will be evaluated
650
 
    so that only matching entries will be displayed.
651
 
 
652
 
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
653
 
  
 
2493
    __doc__ = """Show historical log for a branch or subset of a branch.
 
2494
 
 
2495
    log is bzr's default tool for exploring the history of a branch.
 
2496
    The branch to use is taken from the first parameter. If no parameters
 
2497
    are given, the branch containing the working directory is logged.
 
2498
    Here are some simple examples::
 
2499
 
 
2500
      bzr log                       log the current branch
 
2501
      bzr log foo.py                log a file in its branch
 
2502
      bzr log http://server/branch  log a branch on a server
 
2503
 
 
2504
    The filtering, ordering and information shown for each revision can
 
2505
    be controlled as explained below. By default, all revisions are
 
2506
    shown sorted (topologically) so that newer revisions appear before
 
2507
    older ones and descendants always appear before ancestors. If displayed,
 
2508
    merged revisions are shown indented under the revision in which they
 
2509
    were merged.
 
2510
 
 
2511
    :Output control:
 
2512
 
 
2513
      The log format controls how information about each revision is
 
2514
      displayed. The standard log formats are called ``long``, ``short``
 
2515
      and ``line``. The default is long. See ``bzr help log-formats``
 
2516
      for more details on log formats.
 
2517
 
 
2518
      The following options can be used to control what information is
 
2519
      displayed::
 
2520
 
 
2521
        -l N        display a maximum of N revisions
 
2522
        -n N        display N levels of revisions (0 for all, 1 for collapsed)
 
2523
        -v          display a status summary (delta) for each revision
 
2524
        -p          display a diff (patch) for each revision
 
2525
        --show-ids  display revision-ids (and file-ids), not just revnos
 
2526
 
 
2527
      Note that the default number of levels to display is a function of the
 
2528
      log format. If the -n option is not used, the standard log formats show
 
2529
      just the top level (mainline).
 
2530
 
 
2531
      Status summaries are shown using status flags like A, M, etc. To see
 
2532
      the changes explained using words like ``added`` and ``modified``
 
2533
      instead, use the -vv option.
 
2534
 
 
2535
    :Ordering control:
 
2536
 
 
2537
      To display revisions from oldest to newest, use the --forward option.
 
2538
      In most cases, using this option will have little impact on the total
 
2539
      time taken to produce a log, though --forward does not incrementally
 
2540
      display revisions like --reverse does when it can.
 
2541
 
 
2542
    :Revision filtering:
 
2543
 
 
2544
      The -r option can be used to specify what revision or range of revisions
 
2545
      to filter against. The various forms are shown below::
 
2546
 
 
2547
        -rX      display revision X
 
2548
        -rX..    display revision X and later
 
2549
        -r..Y    display up to and including revision Y
 
2550
        -rX..Y   display from X to Y inclusive
 
2551
 
 
2552
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
2553
      Some common examples are given below::
 
2554
 
 
2555
        -r-1                show just the tip
 
2556
        -r-10..             show the last 10 mainline revisions
 
2557
        -rsubmit:..         show what's new on this branch
 
2558
        -rancestor:path..   show changes since the common ancestor of this
 
2559
                            branch and the one at location path
 
2560
        -rdate:yesterday..  show changes since yesterday
 
2561
 
 
2562
      When logging a range of revisions using -rX..Y, log starts at
 
2563
      revision Y and searches back in history through the primary
 
2564
      ("left-hand") parents until it finds X. When logging just the
 
2565
      top level (using -n1), an error is reported if X is not found
 
2566
      along the way. If multi-level logging is used (-n0), X may be
 
2567
      a nested merge revision and the log will be truncated accordingly.
 
2568
 
 
2569
    :Path filtering:
 
2570
 
 
2571
      If parameters are given and the first one is not a branch, the log
 
2572
      will be filtered to show only those revisions that changed the
 
2573
      nominated files or directories.
 
2574
 
 
2575
      Filenames are interpreted within their historical context. To log a
 
2576
      deleted file, specify a revision range so that the file existed at
 
2577
      the end or start of the range.
 
2578
 
 
2579
      Historical context is also important when interpreting pathnames of
 
2580
      renamed files/directories. Consider the following example:
 
2581
 
 
2582
      * revision 1: add tutorial.txt
 
2583
      * revision 2: modify tutorial.txt
 
2584
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
2585
 
 
2586
      In this case:
 
2587
 
 
2588
      * ``bzr log guide.txt`` will log the file added in revision 1
 
2589
 
 
2590
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
2591
 
 
2592
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
2593
        the original file in revision 2.
 
2594
 
 
2595
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
2596
        was no file called guide.txt in revision 2.
 
2597
 
 
2598
      Renames are always followed by log. By design, there is no need to
 
2599
      explicitly ask for this (and no way to stop logging a file back
 
2600
      until it was last renamed).
 
2601
 
 
2602
    :Other filtering:
 
2603
 
 
2604
      The --match option can be used for finding revisions that match a
 
2605
      regular expression in a commit message, committer, author or bug.
 
2606
      Specifying the option several times will match any of the supplied
 
2607
      expressions. --match-author, --match-bugs, --match-committer and
 
2608
      --match-message can be used to only match a specific field.
 
2609
 
 
2610
    :Tips & tricks:
 
2611
 
 
2612
      GUI tools and IDEs are often better at exploring history than command
 
2613
      line tools: you may prefer qlog or viz from qbzr or bzr-gtk, the
 
2614
      bzr-explorer shell, or the Loggerhead web interface.  See the Plugin
 
2615
      Guide <http://doc.bazaar.canonical.com/plugins/en/> and
 
2616
      <http://wiki.bazaar.canonical.com/IDEIntegration>.  
 
2617
 
 
2618
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
2619
 
 
2620
        [ALIASES]
 
2621
        tip = log -r-1
 
2622
        top = log -l10 --line
 
2623
        show = log -v -p
 
2624
 
 
2625
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
2626
      will show the last 10 mainline revisions. To see the details of a
 
2627
      particular revision X,  ``bzr show -rX``.
 
2628
 
 
2629
      If you are interested in looking deeper into a particular merge X,
 
2630
      use ``bzr log -n0 -rX``.
 
2631
 
 
2632
      ``bzr log -v`` on a branch with lots of history is currently
 
2633
      very slow. A fix for this issue is currently under development.
 
2634
      With or without that fix, it is recommended that a revision range
 
2635
      be given when using the -v option.
 
2636
 
 
2637
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
2638
      used to find revisions matching user names, commit messages, etc.
 
2639
      Among other features, this plugin can find all revisions containing
 
2640
      a list of words but not others.
 
2641
 
 
2642
      When exploring non-mainline history on large projects with deep
 
2643
      history, the performance of log can be greatly improved by installing
 
2644
      the historycache plugin. This plugin buffers historical information
 
2645
      trading disk space for faster speed.
654
2646
    """
 
2647
    takes_args = ['file*']
 
2648
    _see_also = ['log-formats', 'revisionspec']
 
2649
    takes_options = [
 
2650
            Option('forward',
 
2651
                   help='Show from oldest to newest.'),
 
2652
            'timezone',
 
2653
            custom_help('verbose',
 
2654
                   help='Show files changed in each revision.'),
 
2655
            'show-ids',
 
2656
            'revision',
 
2657
            Option('change',
 
2658
                   type=bzrlib.option._parse_revision_str,
 
2659
                   short_name='c',
 
2660
                   help='Show just the specified revision.'
 
2661
                   ' See also "help revisionspec".'),
 
2662
            'log-format',
 
2663
            RegistryOption('authors',
 
2664
                'What names to list as authors - first, all or committer.',
 
2665
                title='Authors',
 
2666
                lazy_registry=('bzrlib.log', 'author_list_registry'),
 
2667
            ),
 
2668
            Option('levels',
 
2669
                   short_name='n',
 
2670
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2671
                   argname='N',
 
2672
                   type=_parse_levels),
 
2673
            Option('message',
 
2674
                   help='Show revisions whose message matches this '
 
2675
                        'regular expression.',
 
2676
                   type=str,
 
2677
                   hidden=True),
 
2678
            Option('limit',
 
2679
                   short_name='l',
 
2680
                   help='Limit the output to the first N revisions.',
 
2681
                   argname='N',
 
2682
                   type=_parse_limit),
 
2683
            Option('show-diff',
 
2684
                   short_name='p',
 
2685
                   help='Show changes made in each revision as a patch.'),
 
2686
            Option('include-merged',
 
2687
                   help='Show merged revisions like --levels 0 does.'),
 
2688
            Option('include-merges', hidden=True,
 
2689
                   help='Historical alias for --include-merged.'),
 
2690
            Option('omit-merges',
 
2691
                   help='Do not report commits with more than one parent.'),
 
2692
            Option('exclude-common-ancestry',
 
2693
                   help='Display only the revisions that are not part'
 
2694
                   ' of both ancestries (require -rX..Y).'
 
2695
                   ),
 
2696
            Option('signatures',
 
2697
                   help='Show digital signature validity.'),
 
2698
            ListOption('match',
 
2699
                short_name='m',
 
2700
                help='Show revisions whose properties match this '
 
2701
                'expression.',
 
2702
                type=str),
 
2703
            ListOption('match-message',
 
2704
                   help='Show revisions whose message matches this '
 
2705
                   'expression.',
 
2706
                type=str),
 
2707
            ListOption('match-committer',
 
2708
                   help='Show revisions whose committer matches this '
 
2709
                   'expression.',
 
2710
                type=str),
 
2711
            ListOption('match-author',
 
2712
                   help='Show revisions whose authors match this '
 
2713
                   'expression.',
 
2714
                type=str),
 
2715
            ListOption('match-bugs',
 
2716
                   help='Show revisions whose bugs match this '
 
2717
                   'expression.',
 
2718
                type=str)
 
2719
            ]
 
2720
    encoding_type = 'replace'
655
2721
 
656
 
    takes_args = ['filename?']
657
 
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
658
 
                     'long', 'message', 'short',]
659
 
    
660
 
    def run(self, filename=None, timezone='original',
 
2722
    @display_command
 
2723
    def run(self, file_list=None, timezone='original',
661
2724
            verbose=False,
662
2725
            show_ids=False,
663
2726
            forward=False,
664
2727
            revision=None,
 
2728
            change=None,
 
2729
            log_format=None,
 
2730
            levels=None,
665
2731
            message=None,
666
 
            long=False,
667
 
            short=False):
668
 
        from bzrlib.log import log_formatter, show_log
669
 
        import codecs
670
 
 
 
2732
            limit=None,
 
2733
            show_diff=False,
 
2734
            include_merged=None,
 
2735
            authors=None,
 
2736
            exclude_common_ancestry=False,
 
2737
            signatures=False,
 
2738
            match=None,
 
2739
            match_message=None,
 
2740
            match_committer=None,
 
2741
            match_author=None,
 
2742
            match_bugs=None,
 
2743
            omit_merges=False,
 
2744
            include_merges=symbol_versioning.DEPRECATED_PARAMETER,
 
2745
            ):
 
2746
        from bzrlib.log import (
 
2747
            Logger,
 
2748
            make_log_request_dict,
 
2749
            _get_info_for_log_files,
 
2750
            )
671
2751
        direction = (forward and 'forward') or 'reverse'
672
 
        
673
 
        if filename:
674
 
            b = find_branch(filename)
675
 
            fp = b.relpath(filename)
676
 
            if fp:
677
 
                file_id = b.read_working_inventory().path2id(fp)
678
 
            else:
679
 
                file_id = None  # points to branch root
680
 
        else:
681
 
            b = find_branch('.')
682
 
            file_id = None
683
 
 
684
 
        if revision is None:
685
 
            rev1 = None
686
 
            rev2 = None
687
 
        elif len(revision) == 1:
688
 
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
689
 
        elif len(revision) == 2:
690
 
            rev1 = b.get_revision_info(revision[0])[0]
691
 
            rev2 = b.get_revision_info(revision[1])[0]
692
 
        else:
693
 
            raise BzrCommandError('bzr log --revision takes one or two values.')
694
 
 
695
 
        if rev1 == 0:
696
 
            rev1 = None
697
 
        if rev2 == 0:
698
 
            rev2 = None
699
 
 
700
 
        mutter('encoding log as %r' % bzrlib.user_encoding)
701
 
 
702
 
        # use 'replace' so that we don't abort if trying to write out
703
 
        # in e.g. the default C locale.
704
 
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
705
 
 
706
 
        if not short:
707
 
            log_format = 'long'
708
 
        else:
709
 
            log_format = 'short'
710
 
        lf = log_formatter(log_format,
711
 
                           show_ids=show_ids,
712
 
                           to_file=outf,
713
 
                           show_timezone=timezone)
714
 
 
715
 
        show_log(b,
716
 
                 lf,
717
 
                 file_id,
718
 
                 verbose=verbose,
719
 
                 direction=direction,
720
 
                 start_revision=rev1,
721
 
                 end_revision=rev2,
722
 
                 search=message)
723
 
 
 
2752
        if symbol_versioning.deprecated_passed(include_merges):
 
2753
            ui.ui_factory.show_user_warning(
 
2754
                'deprecated_command_option',
 
2755
                deprecated_name='--include-merges',
 
2756
                recommended_name='--include-merged',
 
2757
                deprecated_in_version='2.5',
 
2758
                command=self.invoked_as)
 
2759
            if include_merged is None:
 
2760
                include_merged = include_merges
 
2761
            else:
 
2762
                raise errors.BzrCommandError(gettext(
 
2763
                    '{0} and {1} are mutually exclusive').format(
 
2764
                    '--include-merges', '--include-merged'))
 
2765
        if include_merged is None:
 
2766
            include_merged = False
 
2767
        if (exclude_common_ancestry
 
2768
            and (revision is None or len(revision) != 2)):
 
2769
            raise errors.BzrCommandError(gettext(
 
2770
                '--exclude-common-ancestry requires -r with two revisions'))
 
2771
        if include_merged:
 
2772
            if levels is None:
 
2773
                levels = 0
 
2774
            else:
 
2775
                raise errors.BzrCommandError(gettext(
 
2776
                    '{0} and {1} are mutually exclusive').format(
 
2777
                    '--levels', '--include-merged'))
 
2778
 
 
2779
        if change is not None:
 
2780
            if len(change) > 1:
 
2781
                raise errors.RangeInChangeOption()
 
2782
            if revision is not None:
 
2783
                raise errors.BzrCommandError(gettext(
 
2784
                    '{0} and {1} are mutually exclusive').format(
 
2785
                    '--revision', '--change'))
 
2786
            else:
 
2787
                revision = change
 
2788
 
 
2789
        file_ids = []
 
2790
        filter_by_dir = False
 
2791
        if file_list:
 
2792
            # find the file ids to log and check for directory filtering
 
2793
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(
 
2794
                revision, file_list, self.add_cleanup)
 
2795
            for relpath, file_id, kind in file_info_list:
 
2796
                if file_id is None:
 
2797
                    raise errors.BzrCommandError(gettext(
 
2798
                        "Path unknown at end or start of revision range: %s") %
 
2799
                        relpath)
 
2800
                # If the relpath is the top of the tree, we log everything
 
2801
                if relpath == '':
 
2802
                    file_ids = []
 
2803
                    break
 
2804
                else:
 
2805
                    file_ids.append(file_id)
 
2806
                filter_by_dir = filter_by_dir or (
 
2807
                    kind in ['directory', 'tree-reference'])
 
2808
        else:
 
2809
            # log everything
 
2810
            # FIXME ? log the current subdir only RBC 20060203
 
2811
            if revision is not None \
 
2812
                    and len(revision) > 0 and revision[0].get_branch():
 
2813
                location = revision[0].get_branch()
 
2814
            else:
 
2815
                location = '.'
 
2816
            dir, relpath = controldir.ControlDir.open_containing(location)
 
2817
            b = dir.open_branch()
 
2818
            self.add_cleanup(b.lock_read().unlock)
 
2819
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2820
 
 
2821
        if b.get_config_stack().get('validate_signatures_in_log'):
 
2822
            signatures = True
 
2823
 
 
2824
        if signatures:
 
2825
            if not gpg.GPGStrategy.verify_signatures_available():
 
2826
                raise errors.GpgmeNotInstalled(None)
 
2827
 
 
2828
        # Decide on the type of delta & diff filtering to use
 
2829
        # TODO: add an --all-files option to make this configurable & consistent
 
2830
        if not verbose:
 
2831
            delta_type = None
 
2832
        else:
 
2833
            delta_type = 'full'
 
2834
        if not show_diff:
 
2835
            diff_type = None
 
2836
        elif file_ids:
 
2837
            diff_type = 'partial'
 
2838
        else:
 
2839
            diff_type = 'full'
 
2840
 
 
2841
        # Build the log formatter
 
2842
        if log_format is None:
 
2843
            log_format = log.log_formatter_registry.get_default(b)
 
2844
        # Make a non-encoding output to include the diffs - bug 328007
 
2845
        unencoded_output = ui.ui_factory.make_output_stream(encoding_type='exact')
 
2846
        lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2847
                        to_exact_file=unencoded_output,
 
2848
                        show_timezone=timezone,
 
2849
                        delta_format=get_verbosity_level(),
 
2850
                        levels=levels,
 
2851
                        show_advice=levels is None,
 
2852
                        author_list_handler=authors)
 
2853
 
 
2854
        # Choose the algorithm for doing the logging. It's annoying
 
2855
        # having multiple code paths like this but necessary until
 
2856
        # the underlying repository format is faster at generating
 
2857
        # deltas or can provide everything we need from the indices.
 
2858
        # The default algorithm - match-using-deltas - works for
 
2859
        # multiple files and directories and is faster for small
 
2860
        # amounts of history (200 revisions say). However, it's too
 
2861
        # slow for logging a single file in a repository with deep
 
2862
        # history, i.e. > 10K revisions. In the spirit of "do no
 
2863
        # evil when adding features", we continue to use the
 
2864
        # original algorithm - per-file-graph - for the "single
 
2865
        # file that isn't a directory without showing a delta" case.
 
2866
        partial_history = revision and b.repository._format.supports_chks
 
2867
        match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2868
            or delta_type or partial_history)
 
2869
 
 
2870
        match_dict = {}
 
2871
        if match:
 
2872
            match_dict[''] = match
 
2873
        if match_message:
 
2874
            match_dict['message'] = match_message
 
2875
        if match_committer:
 
2876
            match_dict['committer'] = match_committer
 
2877
        if match_author:
 
2878
            match_dict['author'] = match_author
 
2879
        if match_bugs:
 
2880
            match_dict['bugs'] = match_bugs
 
2881
 
 
2882
        # Build the LogRequest and execute it
 
2883
        if len(file_ids) == 0:
 
2884
            file_ids = None
 
2885
        rqst = make_log_request_dict(
 
2886
            direction=direction, specific_fileids=file_ids,
 
2887
            start_revision=rev1, end_revision=rev2, limit=limit,
 
2888
            message_search=message, delta_type=delta_type,
 
2889
            diff_type=diff_type, _match_using_deltas=match_using_deltas,
 
2890
            exclude_common_ancestry=exclude_common_ancestry, match=match_dict,
 
2891
            signature=signatures, omit_merges=omit_merges,
 
2892
            )
 
2893
        Logger(b, rqst).show(lf)
 
2894
 
 
2895
 
 
2896
def _get_revision_range(revisionspec_list, branch, command_name):
 
2897
    """Take the input of a revision option and turn it into a revision range.
 
2898
 
 
2899
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2900
    of the desired revisions. It does some user input validations.
 
2901
    """
 
2902
    if revisionspec_list is None:
 
2903
        rev1 = None
 
2904
        rev2 = None
 
2905
    elif len(revisionspec_list) == 1:
 
2906
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2907
    elif len(revisionspec_list) == 2:
 
2908
        start_spec = revisionspec_list[0]
 
2909
        end_spec = revisionspec_list[1]
 
2910
        if end_spec.get_branch() != start_spec.get_branch():
 
2911
            # b is taken from revision[0].get_branch(), and
 
2912
            # show_log will use its revision_history. Having
 
2913
            # different branches will lead to weird behaviors.
 
2914
            raise errors.BzrCommandError(gettext(
 
2915
                "bzr %s doesn't accept two revisions in different"
 
2916
                " branches.") % command_name)
 
2917
        if start_spec.spec is None:
 
2918
            # Avoid loading all the history.
 
2919
            rev1 = RevisionInfo(branch, None, None)
 
2920
        else:
 
2921
            rev1 = start_spec.in_history(branch)
 
2922
        # Avoid loading all of history when we know a missing
 
2923
        # end of range means the last revision ...
 
2924
        if end_spec.spec is None:
 
2925
            last_revno, last_revision_id = branch.last_revision_info()
 
2926
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2927
        else:
 
2928
            rev2 = end_spec.in_history(branch)
 
2929
    else:
 
2930
        raise errors.BzrCommandError(gettext(
 
2931
            'bzr %s --revision takes one or two values.') % command_name)
 
2932
    return rev1, rev2
 
2933
 
 
2934
 
 
2935
def _revision_range_to_revid_range(revision_range):
 
2936
    rev_id1 = None
 
2937
    rev_id2 = None
 
2938
    if revision_range[0] is not None:
 
2939
        rev_id1 = revision_range[0].rev_id
 
2940
    if revision_range[1] is not None:
 
2941
        rev_id2 = revision_range[1].rev_id
 
2942
    return rev_id1, rev_id2
 
2943
 
 
2944
def get_log_format(long=False, short=False, line=False, default='long'):
 
2945
    log_format = default
 
2946
    if long:
 
2947
        log_format = 'long'
 
2948
    if short:
 
2949
        log_format = 'short'
 
2950
    if line:
 
2951
        log_format = 'line'
 
2952
    return log_format
724
2953
 
725
2954
 
726
2955
class cmd_touching_revisions(Command):
727
 
    """Return revision-ids which affected a particular file.
728
 
 
729
 
    A more user-friendly interface is "bzr log FILE"."""
 
2956
    __doc__ = """Return revision-ids which affected a particular file.
 
2957
 
 
2958
    A more user-friendly interface is "bzr log FILE".
 
2959
    """
 
2960
 
730
2961
    hidden = True
731
2962
    takes_args = ["filename"]
 
2963
 
 
2964
    @display_command
732
2965
    def run(self, filename):
733
 
        b = find_branch(filename)
734
 
        inv = b.read_working_inventory()
735
 
        file_id = inv.path2id(b.relpath(filename))
736
 
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
737
 
            print "%6d %s" % (revno, what)
 
2966
        tree, relpath = WorkingTree.open_containing(filename)
 
2967
        file_id = tree.path2id(relpath)
 
2968
        b = tree.branch
 
2969
        self.add_cleanup(b.lock_read().unlock)
 
2970
        touching_revs = log.find_touching_revisions(b, file_id)
 
2971
        for revno, revision_id, what in touching_revs:
 
2972
            self.outf.write("%6d %s\n" % (revno, what))
738
2973
 
739
2974
 
740
2975
class cmd_ls(Command):
741
 
    """List files in a tree.
742
 
 
743
 
    TODO: Take a revision or remote path and list that tree instead.
 
2976
    __doc__ = """List files in a tree.
744
2977
    """
745
 
    hidden = True
746
 
    def run(self, revision=None, verbose=False):
747
 
        b = find_branch('.')
748
 
        if revision == None:
749
 
            tree = b.working_tree()
 
2978
 
 
2979
    _see_also = ['status', 'cat']
 
2980
    takes_args = ['path?']
 
2981
    takes_options = [
 
2982
            'verbose',
 
2983
            'revision',
 
2984
            Option('recursive', short_name='R',
 
2985
                   help='Recurse into subdirectories.'),
 
2986
            Option('from-root',
 
2987
                   help='Print paths relative to the root of the branch.'),
 
2988
            Option('unknown', short_name='u',
 
2989
                help='Print unknown files.'),
 
2990
            Option('versioned', help='Print versioned files.',
 
2991
                   short_name='V'),
 
2992
            Option('ignored', short_name='i',
 
2993
                help='Print ignored files.'),
 
2994
            Option('kind', short_name='k',
 
2995
                   help='List entries of a particular kind: file, directory, symlink.',
 
2996
                   type=unicode),
 
2997
            'null',
 
2998
            'show-ids',
 
2999
            'directory',
 
3000
            ]
 
3001
    @display_command
 
3002
    def run(self, revision=None, verbose=False,
 
3003
            recursive=False, from_root=False,
 
3004
            unknown=False, versioned=False, ignored=False,
 
3005
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
3006
 
 
3007
        if kind and kind not in ('file', 'directory', 'symlink'):
 
3008
            raise errors.BzrCommandError(gettext('invalid kind specified'))
 
3009
 
 
3010
        if verbose and null:
 
3011
            raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
 
3012
        all = not (unknown or versioned or ignored)
 
3013
 
 
3014
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
3015
 
 
3016
        if path is None:
 
3017
            fs_path = '.'
750
3018
        else:
751
 
            tree = b.revision_tree(b.lookup_revision(revision))
752
 
 
753
 
        for fp, fc, kind, fid in tree.list_files():
 
3019
            if from_root:
 
3020
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
 
3021
                                             ' and PATH'))
 
3022
            fs_path = path
 
3023
        tree, branch, relpath = \
 
3024
            _open_directory_or_containing_tree_or_branch(fs_path, directory)
 
3025
 
 
3026
        # Calculate the prefix to use
 
3027
        prefix = None
 
3028
        if from_root:
 
3029
            if relpath:
 
3030
                prefix = relpath + '/'
 
3031
        elif fs_path != '.' and not fs_path.endswith('/'):
 
3032
            prefix = fs_path + '/'
 
3033
 
 
3034
        if revision is not None or tree is None:
 
3035
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
3036
 
 
3037
        apply_view = False
 
3038
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
3039
            view_files = tree.views.lookup_view()
 
3040
            if view_files:
 
3041
                apply_view = True
 
3042
                view_str = views.view_display_str(view_files)
 
3043
                note(gettext("Ignoring files outside view. View is %s") % view_str)
 
3044
 
 
3045
        self.add_cleanup(tree.lock_read().unlock)
 
3046
        for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
3047
            from_dir=relpath, recursive=recursive):
 
3048
            # Apply additional masking
 
3049
            if not all and not selection[fc]:
 
3050
                continue
 
3051
            if kind is not None and fkind != kind:
 
3052
                continue
 
3053
            if apply_view:
 
3054
                try:
 
3055
                    if relpath:
 
3056
                        fullpath = osutils.pathjoin(relpath, fp)
 
3057
                    else:
 
3058
                        fullpath = fp
 
3059
                    views.check_path_in_view(tree, fullpath)
 
3060
                except errors.FileOutsideView:
 
3061
                    continue
 
3062
 
 
3063
            # Output the entry
 
3064
            if prefix:
 
3065
                fp = osutils.pathjoin(prefix, fp)
 
3066
            kindch = entry.kind_character()
 
3067
            outstring = fp + kindch
 
3068
            ui.ui_factory.clear_term()
754
3069
            if verbose:
755
 
                if kind == 'directory':
756
 
                    kindch = '/'
757
 
                elif kind == 'file':
758
 
                    kindch = ''
 
3070
                outstring = '%-8s %s' % (fc, outstring)
 
3071
                if show_ids and fid is not None:
 
3072
                    outstring = "%-50s %s" % (outstring, fid)
 
3073
                self.outf.write(outstring + '\n')
 
3074
            elif null:
 
3075
                self.outf.write(fp + '\0')
 
3076
                if show_ids:
 
3077
                    if fid is not None:
 
3078
                        self.outf.write(fid)
 
3079
                    self.outf.write('\0')
 
3080
                self.outf.flush()
 
3081
            else:
 
3082
                if show_ids:
 
3083
                    if fid is not None:
 
3084
                        my_id = fid
 
3085
                    else:
 
3086
                        my_id = ''
 
3087
                    self.outf.write('%-50s %s\n' % (outstring, my_id))
759
3088
                else:
760
 
                    kindch = '???'
761
 
 
762
 
                print '%-8s %s%s' % (fc, fp, kindch)
763
 
            else:
764
 
                print fp
765
 
 
 
3089
                    self.outf.write(outstring + '\n')
766
3090
 
767
3091
 
768
3092
class cmd_unknowns(Command):
769
 
    """List unknown files."""
770
 
    def run(self):
771
 
        from bzrlib.osutils import quotefn
772
 
        for f in find_branch('.').unknowns():
773
 
            print quotefn(f)
774
 
 
 
3093
    __doc__ = """List unknown files.
 
3094
    """
 
3095
 
 
3096
    hidden = True
 
3097
    _see_also = ['ls']
 
3098
    takes_options = ['directory']
 
3099
 
 
3100
    @display_command
 
3101
    def run(self, directory=u'.'):
 
3102
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
3103
            self.outf.write(osutils.quotefn(f) + '\n')
775
3104
 
776
3105
 
777
3106
class cmd_ignore(Command):
778
 
    """Ignore a command or pattern.
 
3107
    __doc__ = """Ignore specified files or patterns.
 
3108
 
 
3109
    See ``bzr help patterns`` for details on the syntax of patterns.
 
3110
 
 
3111
    If a .bzrignore file does not exist, the ignore command
 
3112
    will create one and add the specified files or patterns to the newly
 
3113
    created file. The ignore command will also automatically add the 
 
3114
    .bzrignore file to be versioned. Creating a .bzrignore file without
 
3115
    the use of the ignore command will require an explicit add command.
779
3116
 
780
3117
    To remove patterns from the ignore list, edit the .bzrignore file.
781
 
 
782
 
    If the pattern contains a slash, it is compared to the whole path
783
 
    from the branch root.  Otherwise, it is comapred to only the last
784
 
    component of the path.
785
 
 
786
 
    Ignore patterns are case-insensitive on case-insensitive systems.
787
 
 
788
 
    Note: wildcards must be quoted from the shell on Unix.
789
 
 
790
 
    examples:
791
 
        bzr ignore ./Makefile
792
 
        bzr ignore '*.class'
 
3118
    After adding, editing or deleting that file either indirectly by
 
3119
    using this command or directly by using an editor, be sure to commit
 
3120
    it.
 
3121
    
 
3122
    Bazaar also supports a global ignore file ~/.bazaar/ignore. On Windows
 
3123
    the global ignore file can be found in the application data directory as
 
3124
    C:\\Documents and Settings\\<user>\\Application Data\\Bazaar\\2.0\\ignore.
 
3125
    Global ignores are not touched by this command. The global ignore file
 
3126
    can be edited directly using an editor.
 
3127
 
 
3128
    Patterns prefixed with '!' are exceptions to ignore patterns and take
 
3129
    precedence over regular ignores.  Such exceptions are used to specify
 
3130
    files that should be versioned which would otherwise be ignored.
 
3131
    
 
3132
    Patterns prefixed with '!!' act as regular ignore patterns, but have
 
3133
    precedence over the '!' exception patterns.
 
3134
 
 
3135
    :Notes: 
 
3136
        
 
3137
    * Ignore patterns containing shell wildcards must be quoted from
 
3138
      the shell on Unix.
 
3139
 
 
3140
    * Ignore patterns starting with "#" act as comments in the ignore file.
 
3141
      To ignore patterns that begin with that character, use the "RE:" prefix.
 
3142
 
 
3143
    :Examples:
 
3144
        Ignore the top level Makefile::
 
3145
 
 
3146
            bzr ignore ./Makefile
 
3147
 
 
3148
        Ignore .class files in all directories...::
 
3149
 
 
3150
            bzr ignore "*.class"
 
3151
 
 
3152
        ...but do not ignore "special.class"::
 
3153
 
 
3154
            bzr ignore "!special.class"
 
3155
 
 
3156
        Ignore files whose name begins with the "#" character::
 
3157
 
 
3158
            bzr ignore "RE:^#"
 
3159
 
 
3160
        Ignore .o files under the lib directory::
 
3161
 
 
3162
            bzr ignore "lib/**/*.o"
 
3163
 
 
3164
        Ignore .o files under the lib directory::
 
3165
 
 
3166
            bzr ignore "RE:lib/.*\.o"
 
3167
 
 
3168
        Ignore everything but the "debian" toplevel directory::
 
3169
 
 
3170
            bzr ignore "RE:(?!debian/).*"
 
3171
        
 
3172
        Ignore everything except the "local" toplevel directory,
 
3173
        but always ignore autosave files ending in ~, even under local/::
 
3174
        
 
3175
            bzr ignore "*"
 
3176
            bzr ignore "!./local"
 
3177
            bzr ignore "!!*~"
793
3178
    """
794
 
    takes_args = ['name_pattern']
795
 
    
796
 
    def run(self, name_pattern):
797
 
        from bzrlib.atomicfile import AtomicFile
798
 
        import os.path
799
 
 
800
 
        b = find_branch('.')
801
 
        ifn = b.abspath('.bzrignore')
802
 
 
803
 
        if os.path.exists(ifn):
804
 
            f = open(ifn, 'rt')
805
 
            try:
806
 
                igns = f.read().decode('utf-8')
807
 
            finally:
808
 
                f.close()
809
 
        else:
810
 
            igns = ''
811
 
 
812
 
        # TODO: If the file already uses crlf-style termination, maybe
813
 
        # we should use that for the newly added lines?
814
 
 
815
 
        if igns and igns[-1] != '\n':
816
 
            igns += '\n'
817
 
        igns += name_pattern + '\n'
818
 
 
819
 
        try:
820
 
            f = AtomicFile(ifn, 'wt')
821
 
            f.write(igns.encode('utf-8'))
822
 
            f.commit()
823
 
        finally:
824
 
            f.close()
825
 
 
826
 
        inv = b.working_tree().inventory
827
 
        if inv.path2id('.bzrignore'):
828
 
            mutter('.bzrignore is already versioned')
829
 
        else:
830
 
            mutter('need to make new .bzrignore file versioned')
831
 
            b.add(['.bzrignore'])
832
 
 
 
3179
 
 
3180
    _see_also = ['status', 'ignored', 'patterns']
 
3181
    takes_args = ['name_pattern*']
 
3182
    takes_options = ['directory',
 
3183
        Option('default-rules',
 
3184
               help='Display the default ignore rules that bzr uses.')
 
3185
        ]
 
3186
 
 
3187
    def run(self, name_pattern_list=None, default_rules=None,
 
3188
            directory=u'.'):
 
3189
        from bzrlib import ignores
 
3190
        if default_rules is not None:
 
3191
            # dump the default rules and exit
 
3192
            for pattern in ignores.USER_DEFAULTS:
 
3193
                self.outf.write("%s\n" % pattern)
 
3194
            return
 
3195
        if not name_pattern_list:
 
3196
            raise errors.BzrCommandError(gettext("ignore requires at least one "
 
3197
                "NAME_PATTERN or --default-rules."))
 
3198
        name_pattern_list = [globbing.normalize_pattern(p)
 
3199
                             for p in name_pattern_list]
 
3200
        bad_patterns = ''
 
3201
        bad_patterns_count = 0
 
3202
        for p in name_pattern_list:
 
3203
            if not globbing.Globster.is_pattern_valid(p):
 
3204
                bad_patterns_count += 1
 
3205
                bad_patterns += ('\n  %s' % p)
 
3206
        if bad_patterns:
 
3207
            msg = (ngettext('Invalid ignore pattern found. %s', 
 
3208
                            'Invalid ignore patterns found. %s',
 
3209
                            bad_patterns_count) % bad_patterns)
 
3210
            ui.ui_factory.show_error(msg)
 
3211
            raise errors.InvalidPattern('')
 
3212
        for name_pattern in name_pattern_list:
 
3213
            if (name_pattern[0] == '/' or
 
3214
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
3215
                raise errors.BzrCommandError(gettext(
 
3216
                    "NAME_PATTERN should not be an absolute path"))
 
3217
        tree, relpath = WorkingTree.open_containing(directory)
 
3218
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
3219
        ignored = globbing.Globster(name_pattern_list)
 
3220
        matches = []
 
3221
        self.add_cleanup(tree.lock_read().unlock)
 
3222
        for entry in tree.list_files():
 
3223
            id = entry[3]
 
3224
            if id is not None:
 
3225
                filename = entry[0]
 
3226
                if ignored.match(filename):
 
3227
                    matches.append(filename)
 
3228
        if len(matches) > 0:
 
3229
            self.outf.write(gettext("Warning: the following files are version "
 
3230
                  "controlled and match your ignore pattern:\n%s"
 
3231
                  "\nThese files will continue to be version controlled"
 
3232
                  " unless you 'bzr remove' them.\n") % ("\n".join(matches),))
833
3233
 
834
3234
 
835
3235
class cmd_ignored(Command):
836
 
    """List ignored files and the patterns that matched them.
837
 
 
838
 
    See also: bzr ignore"""
839
 
    def run(self):
840
 
        tree = find_branch('.').working_tree()
841
 
        for path, file_class, kind, file_id in tree.list_files():
 
3236
    __doc__ = """List ignored files and the patterns that matched them.
 
3237
 
 
3238
    List all the ignored files and the ignore pattern that caused the file to
 
3239
    be ignored.
 
3240
 
 
3241
    Alternatively, to list just the files::
 
3242
 
 
3243
        bzr ls --ignored
 
3244
    """
 
3245
 
 
3246
    encoding_type = 'replace'
 
3247
    _see_also = ['ignore', 'ls']
 
3248
    takes_options = ['directory']
 
3249
 
 
3250
    @display_command
 
3251
    def run(self, directory=u'.'):
 
3252
        tree = WorkingTree.open_containing(directory)[0]
 
3253
        self.add_cleanup(tree.lock_read().unlock)
 
3254
        for path, file_class, kind, file_id, entry in tree.list_files():
842
3255
            if file_class != 'I':
843
3256
                continue
844
3257
            ## XXX: Slightly inefficient since this was already calculated
845
3258
            pat = tree.is_ignored(path)
846
 
            print '%-50s %s' % (path, pat)
 
3259
            self.outf.write('%-50s %s\n' % (path, pat))
847
3260
 
848
3261
 
849
3262
class cmd_lookup_revision(Command):
850
 
    """Lookup the revision-id from a revision-number
 
3263
    __doc__ = """Lookup the revision-id from a revision-number
851
3264
 
852
 
    example:
 
3265
    :Examples:
853
3266
        bzr lookup-revision 33
854
3267
    """
855
3268
    hidden = True
856
3269
    takes_args = ['revno']
857
 
    
858
 
    def run(self, revno):
 
3270
    takes_options = ['directory']
 
3271
 
 
3272
    @display_command
 
3273
    def run(self, revno, directory=u'.'):
859
3274
        try:
860
3275
            revno = int(revno)
861
3276
        except ValueError:
862
 
            raise BzrCommandError("not a valid revision-number: %r" % revno)
863
 
 
864
 
        print find_branch('.').lookup_revision(revno)
 
3277
            raise errors.BzrCommandError(gettext("not a valid revision-number: %r")
 
3278
                                         % revno)
 
3279
        revid = WorkingTree.open_containing(directory)[0].branch.get_rev_id(revno)
 
3280
        self.outf.write("%s\n" % revid)
865
3281
 
866
3282
 
867
3283
class cmd_export(Command):
868
 
    """Export past revision to destination directory.
 
3284
    __doc__ = """Export current or past revision to a destination directory or archive.
869
3285
 
870
3286
    If no revision is specified this exports the last committed revision.
871
3287
 
873
3289
    given, try to find the format with the extension. If no extension
874
3290
    is found exports to a directory (equivalent to --format=dir).
875
3291
 
876
 
    Root may be the top directory for tar, tgz and tbz2 formats. If none
877
 
    is given, the top directory will be the root name of the file."""
878
 
    # TODO: list known exporters
879
 
    takes_args = ['dest']
880
 
    takes_options = ['revision', 'format', 'root']
881
 
    def run(self, dest, revision=None, format=None, root=None):
882
 
        import os.path
883
 
        b = find_branch('.')
884
 
        if revision is None:
885
 
            rev_id = b.last_patch()
 
3292
    If root is supplied, it will be used as the root directory inside
 
3293
    container formats (tar, zip, etc). If it is not supplied it will default
 
3294
    to the exported filename. The root option has no effect for 'dir' format.
 
3295
 
 
3296
    If branch is omitted then the branch containing the current working
 
3297
    directory will be used.
 
3298
 
 
3299
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
3300
 
 
3301
      =================       =========================
 
3302
      Supported formats       Autodetected by extension
 
3303
      =================       =========================
 
3304
         dir                         (none)
 
3305
         tar                          .tar
 
3306
         tbz2                    .tar.bz2, .tbz2
 
3307
         tgz                      .tar.gz, .tgz
 
3308
         zip                          .zip
 
3309
      =================       =========================
 
3310
    """
 
3311
    encoding = 'exact'
 
3312
    takes_args = ['dest', 'branch_or_subdir?']
 
3313
    takes_options = ['directory',
 
3314
        Option('format',
 
3315
               help="Type of file to export to.",
 
3316
               type=unicode),
 
3317
        'revision',
 
3318
        Option('filters', help='Apply content filters to export the '
 
3319
                'convenient form.'),
 
3320
        Option('root',
 
3321
               type=str,
 
3322
               help="Name of the root directory inside the exported file."),
 
3323
        Option('per-file-timestamps',
 
3324
               help='Set modification time of files to that of the last '
 
3325
                    'revision in which it was changed.'),
 
3326
        Option('uncommitted',
 
3327
               help='Export the working tree contents rather than that of the '
 
3328
                    'last revision.'),
 
3329
        ]
 
3330
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
3331
        root=None, filters=False, per_file_timestamps=False, uncommitted=False,
 
3332
        directory=u'.'):
 
3333
        from bzrlib.export import export
 
3334
 
 
3335
        if branch_or_subdir is None:
 
3336
            branch_or_subdir = directory
 
3337
 
 
3338
        (tree, b, subdir) = controldir.ControlDir.open_containing_tree_or_branch(
 
3339
            branch_or_subdir)
 
3340
        if tree is not None:
 
3341
            self.add_cleanup(tree.lock_read().unlock)
 
3342
 
 
3343
        if uncommitted:
 
3344
            if tree is None:
 
3345
                raise errors.BzrCommandError(
 
3346
                    gettext("--uncommitted requires a working tree"))
 
3347
            export_tree = tree
886
3348
        else:
887
 
            if len(revision) != 1:
888
 
                raise BzrError('bzr export --revision takes exactly 1 argument')
889
 
            revno, rev_id = b.get_revision_info(revision[0])
890
 
        t = b.revision_tree(rev_id)
891
 
        root, ext = os.path.splitext(dest)
892
 
        if not format:
893
 
            if ext in (".tar",):
894
 
                format = "tar"
895
 
            elif ext in (".gz", ".tgz"):
896
 
                format = "tgz"
897
 
            elif ext in (".bz2", ".tbz2"):
898
 
                format = "tbz2"
899
 
            else:
900
 
                format = "dir"
901
 
        t.export(dest, format, root)
 
3349
            export_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
3350
        try:
 
3351
            export(export_tree, dest, format, root, subdir, filtered=filters,
 
3352
                   per_file_timestamps=per_file_timestamps)
 
3353
        except errors.NoSuchExportFormat, e:
 
3354
            raise errors.BzrCommandError(
 
3355
                gettext('Unsupported export format: %s') % e.format)
902
3356
 
903
3357
 
904
3358
class cmd_cat(Command):
905
 
    """Write a file's text from a previous revision."""
906
 
 
907
 
    takes_options = ['revision']
 
3359
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
3360
 
 
3361
    If no revision is nominated, the last revision is used.
 
3362
 
 
3363
    Note: Take care to redirect standard output when using this command on a
 
3364
    binary file.
 
3365
    """
 
3366
 
 
3367
    _see_also = ['ls']
 
3368
    takes_options = ['directory',
 
3369
        Option('name-from-revision', help='The path name in the old tree.'),
 
3370
        Option('filters', help='Apply content filters to display the '
 
3371
                'convenience form.'),
 
3372
        'revision',
 
3373
        ]
908
3374
    takes_args = ['filename']
909
 
 
910
 
    def run(self, filename, revision=None):
911
 
        if revision == None:
912
 
            raise BzrCommandError("bzr cat requires a revision number")
913
 
        elif len(revision) != 1:
914
 
            raise BzrCommandError("bzr cat --revision takes exactly one number")
915
 
        b = find_branch('.')
916
 
        b.print_file(b.relpath(filename), revision[0])
 
3375
    encoding_type = 'exact'
 
3376
 
 
3377
    @display_command
 
3378
    def run(self, filename, revision=None, name_from_revision=False,
 
3379
            filters=False, directory=None):
 
3380
        if revision is not None and len(revision) != 1:
 
3381
            raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
 
3382
                                         " one revision specifier"))
 
3383
        tree, branch, relpath = \
 
3384
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3385
        self.add_cleanup(branch.lock_read().unlock)
 
3386
        return self._run(tree, branch, relpath, filename, revision,
 
3387
                         name_from_revision, filters)
 
3388
 
 
3389
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
3390
        filtered):
 
3391
        if tree is None:
 
3392
            tree = b.basis_tree()
 
3393
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
3394
        self.add_cleanup(rev_tree.lock_read().unlock)
 
3395
 
 
3396
        old_file_id = rev_tree.path2id(relpath)
 
3397
 
 
3398
        # TODO: Split out this code to something that generically finds the
 
3399
        # best id for a path across one or more trees; it's like
 
3400
        # find_ids_across_trees but restricted to find just one. -- mbp
 
3401
        # 20110705.
 
3402
        if name_from_revision:
 
3403
            # Try in revision if requested
 
3404
            if old_file_id is None:
 
3405
                raise errors.BzrCommandError(gettext(
 
3406
                    "{0!r} is not present in revision {1}").format(
 
3407
                        filename, rev_tree.get_revision_id()))
 
3408
            else:
 
3409
                actual_file_id = old_file_id
 
3410
        else:
 
3411
            cur_file_id = tree.path2id(relpath)
 
3412
            if cur_file_id is not None and rev_tree.has_id(cur_file_id):
 
3413
                actual_file_id = cur_file_id
 
3414
            elif old_file_id is not None:
 
3415
                actual_file_id = old_file_id
 
3416
            else:
 
3417
                raise errors.BzrCommandError(gettext(
 
3418
                    "{0!r} is not present in revision {1}").format(
 
3419
                        filename, rev_tree.get_revision_id()))
 
3420
        if filtered:
 
3421
            from bzrlib.filter_tree import ContentFilterTree
 
3422
            filter_tree = ContentFilterTree(rev_tree,
 
3423
                rev_tree._content_filter_stack)
 
3424
            content = filter_tree.get_file_text(actual_file_id)
 
3425
        else:
 
3426
            content = rev_tree.get_file_text(actual_file_id)
 
3427
        self.cleanup_now()
 
3428
        self.outf.write(content)
917
3429
 
918
3430
 
919
3431
class cmd_local_time_offset(Command):
920
 
    """Show the offset in seconds from GMT to local time."""
921
 
    hidden = True    
 
3432
    __doc__ = """Show the offset in seconds from GMT to local time."""
 
3433
    hidden = True
 
3434
    @display_command
922
3435
    def run(self):
923
 
        print bzrlib.osutils.local_time_offset()
 
3436
        self.outf.write("%s\n" % osutils.local_time_offset())
924
3437
 
925
3438
 
926
3439
 
927
3440
class cmd_commit(Command):
928
 
    """Commit changes into a new revision.
929
 
    
930
 
    If no arguments are given, the entire tree is committed.
931
 
 
932
 
    If selected files are specified, only changes to those files are
933
 
    committed.  If a directory is specified then the directory and everything 
934
 
    within it is committed.
935
 
 
936
 
    A selected-file commit may fail in some cases where the committed
937
 
    tree would be invalid, such as trying to commit a file in a
938
 
    newly-added directory that is not itself committed.
939
 
 
940
 
    TODO: Run hooks on tree to-be-committed, and after commit.
941
 
 
942
 
    TODO: Strict commit that fails if there are unknown or deleted files.
 
3441
    __doc__ = """Commit changes into a new revision.
 
3442
 
 
3443
    An explanatory message needs to be given for each commit. This is
 
3444
    often done by using the --message option (getting the message from the
 
3445
    command line) or by using the --file option (getting the message from
 
3446
    a file). If neither of these options is given, an editor is opened for
 
3447
    the user to enter the message. To see the changed files in the
 
3448
    boilerplate text loaded into the editor, use the --show-diff option.
 
3449
 
 
3450
    By default, the entire tree is committed and the person doing the
 
3451
    commit is assumed to be the author. These defaults can be overridden
 
3452
    as explained below.
 
3453
 
 
3454
    :Selective commits:
 
3455
 
 
3456
      If selected files are specified, only changes to those files are
 
3457
      committed.  If a directory is specified then the directory and
 
3458
      everything within it is committed.
 
3459
  
 
3460
      When excludes are given, they take precedence over selected files.
 
3461
      For example, to commit only changes within foo, but not changes
 
3462
      within foo/bar::
 
3463
  
 
3464
        bzr commit foo -x foo/bar
 
3465
  
 
3466
      A selective commit after a merge is not yet supported.
 
3467
 
 
3468
    :Custom authors:
 
3469
 
 
3470
      If the author of the change is not the same person as the committer,
 
3471
      you can specify the author's name using the --author option. The
 
3472
      name should be in the same format as a committer-id, e.g.
 
3473
      "John Doe <jdoe@example.com>". If there is more than one author of
 
3474
      the change you can specify the option multiple times, once for each
 
3475
      author.
 
3476
  
 
3477
    :Checks:
 
3478
 
 
3479
      A common mistake is to forget to add a new file or directory before
 
3480
      running the commit command. The --strict option checks for unknown
 
3481
      files and aborts the commit if any are found. More advanced pre-commit
 
3482
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
3483
      for details.
 
3484
 
 
3485
    :Things to note:
 
3486
 
 
3487
      If you accidentially commit the wrong changes or make a spelling
 
3488
      mistake in the commit message say, you can use the uncommit command
 
3489
      to undo it. See ``bzr help uncommit`` for details.
 
3490
 
 
3491
      Hooks can also be configured to run after a commit. This allows you
 
3492
      to trigger updates to external systems like bug trackers. The --fixes
 
3493
      option can be used to record the association between a revision and
 
3494
      one or more bugs. See ``bzr help bugs`` for details.
943
3495
    """
 
3496
 
 
3497
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
944
3498
    takes_args = ['selected*']
945
 
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
3499
    takes_options = [
 
3500
            ListOption('exclude', type=str, short_name='x',
 
3501
                help="Do not consider changes made to a given path."),
 
3502
            Option('message', type=unicode,
 
3503
                   short_name='m',
 
3504
                   help="Description of the new revision."),
 
3505
            'verbose',
 
3506
             Option('unchanged',
 
3507
                    help='Commit even if nothing has changed.'),
 
3508
             Option('file', type=str,
 
3509
                    short_name='F',
 
3510
                    argname='msgfile',
 
3511
                    help='Take commit message from this file.'),
 
3512
             Option('strict',
 
3513
                    help="Refuse to commit if there are unknown "
 
3514
                    "files in the working tree."),
 
3515
             Option('commit-time', type=str,
 
3516
                    help="Manually set a commit time using commit date "
 
3517
                    "format, e.g. '2009-10-10 08:00:00 +0100'."),
 
3518
             ListOption('fixes', type=str,
 
3519
                    help="Mark a bug as being fixed by this revision "
 
3520
                         "(see \"bzr help bugs\")."),
 
3521
             ListOption('author', type=unicode,
 
3522
                    help="Set the author's name, if it's different "
 
3523
                         "from the committer."),
 
3524
             Option('local',
 
3525
                    help="Perform a local commit in a bound "
 
3526
                         "branch.  Local commits are not pushed to "
 
3527
                         "the master branch until a normal commit "
 
3528
                         "is performed."
 
3529
                    ),
 
3530
             Option('show-diff', short_name='p',
 
3531
                    help='When no message is supplied, show the diff along'
 
3532
                    ' with the status summary in the message editor.'),
 
3533
             Option('lossy', 
 
3534
                    help='When committing to a foreign version control '
 
3535
                    'system do not push data that can not be natively '
 
3536
                    'represented.'),
 
3537
             ]
946
3538
    aliases = ['ci', 'checkin']
947
3539
 
948
 
    # TODO: Give better message for -s, --summary, used by tla people
949
 
 
950
 
    # XXX: verbose currently does nothing
951
 
    
952
 
    def run(self, message=None, file=None, verbose=True, selected_list=None,
953
 
            unchanged=False):
954
 
        from bzrlib.errors import PointlessCommit
955
 
        from bzrlib.msgeditor import edit_commit_message
956
 
        from bzrlib.status import show_status
957
 
        from cStringIO import StringIO
958
 
 
959
 
        b = find_branch('.')
960
 
        if selected_list:
961
 
            selected_list = [b.relpath(s) for s in selected_list]
962
 
            
963
 
        if not message and not file:
964
 
            catcher = StringIO()
965
 
            show_status(b, specific_files=selected_list,
966
 
                        to_file=catcher)
967
 
            message = edit_commit_message(catcher.getvalue())
968
 
            
969
 
            if message is None:
970
 
                raise BzrCommandError("please specify a commit message"
971
 
                                      " with either --message or --file")
972
 
        elif message and file:
973
 
            raise BzrCommandError("please specify either --message or --file")
974
 
        
975
 
        if file:
976
 
            import codecs
977
 
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
978
 
 
 
3540
    def _iter_bug_fix_urls(self, fixes, branch):
 
3541
        default_bugtracker  = None
 
3542
        # Configure the properties for bug fixing attributes.
 
3543
        for fixed_bug in fixes:
 
3544
            tokens = fixed_bug.split(':')
 
3545
            if len(tokens) == 1:
 
3546
                if default_bugtracker is None:
 
3547
                    branch_config = branch.get_config_stack()
 
3548
                    default_bugtracker = branch_config.get(
 
3549
                        "bugtracker")
 
3550
                if default_bugtracker is None:
 
3551
                    raise errors.BzrCommandError(gettext(
 
3552
                        "No tracker specified for bug %s. Use the form "
 
3553
                        "'tracker:id' or specify a default bug tracker "
 
3554
                        "using the `bugtracker` option.\nSee "
 
3555
                        "\"bzr help bugs\" for more information on this "
 
3556
                        "feature. Commit refused.") % fixed_bug)
 
3557
                tag = default_bugtracker
 
3558
                bug_id = tokens[0]
 
3559
            elif len(tokens) != 2:
 
3560
                raise errors.BzrCommandError(gettext(
 
3561
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
3562
                    "See \"bzr help bugs\" for more information on this "
 
3563
                    "feature.\nCommit refused.") % fixed_bug)
 
3564
            else:
 
3565
                tag, bug_id = tokens
 
3566
            try:
 
3567
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
3568
            except errors.UnknownBugTrackerAbbreviation:
 
3569
                raise errors.BzrCommandError(gettext(
 
3570
                    'Unrecognized bug %s. Commit refused.') % fixed_bug)
 
3571
            except errors.MalformedBugIdentifier, e:
 
3572
                raise errors.BzrCommandError(gettext(
 
3573
                    "%s\nCommit refused.") % (str(e),))
 
3574
 
 
3575
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
3576
            unchanged=False, strict=False, local=False, fixes=None,
 
3577
            author=None, show_diff=False, exclude=None, commit_time=None,
 
3578
            lossy=False):
 
3579
        from bzrlib.errors import (
 
3580
            PointlessCommit,
 
3581
            ConflictsInTree,
 
3582
            StrictCommitFailed
 
3583
        )
 
3584
        from bzrlib.msgeditor import (
 
3585
            edit_commit_message_encoded,
 
3586
            generate_commit_message_template,
 
3587
            make_commit_message_template_encoded,
 
3588
            set_commit_message,
 
3589
        )
 
3590
 
 
3591
        commit_stamp = offset = None
 
3592
        if commit_time is not None:
 
3593
            try:
 
3594
                commit_stamp, offset = timestamp.parse_patch_date(commit_time)
 
3595
            except ValueError, e:
 
3596
                raise errors.BzrCommandError(gettext(
 
3597
                    "Could not parse --commit-time: " + str(e)))
 
3598
 
 
3599
        properties = {}
 
3600
 
 
3601
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
3602
        if selected_list == ['']:
 
3603
            # workaround - commit of root of tree should be exactly the same
 
3604
            # as just default commit in that tree, and succeed even though
 
3605
            # selected-file merge commit is not done yet
 
3606
            selected_list = []
 
3607
 
 
3608
        if fixes is None:
 
3609
            fixes = []
 
3610
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3611
            self._iter_bug_fix_urls(fixes, tree.branch))
 
3612
        if bug_property:
 
3613
            properties['bugs'] = bug_property
 
3614
 
 
3615
        if local and not tree.branch.get_bound_location():
 
3616
            raise errors.LocalRequiresBoundBranch()
 
3617
 
 
3618
        if message is not None:
 
3619
            try:
 
3620
                file_exists = osutils.lexists(message)
 
3621
            except UnicodeError:
 
3622
                # The commit message contains unicode characters that can't be
 
3623
                # represented in the filesystem encoding, so that can't be a
 
3624
                # file.
 
3625
                file_exists = False
 
3626
            if file_exists:
 
3627
                warning_msg = (
 
3628
                    'The commit message is a file name: "%(f)s".\n'
 
3629
                    '(use --file "%(f)s" to take commit message from that file)'
 
3630
                    % { 'f': message })
 
3631
                ui.ui_factory.show_warning(warning_msg)
 
3632
            if '\r' in message:
 
3633
                message = message.replace('\r\n', '\n')
 
3634
                message = message.replace('\r', '\n')
 
3635
            if file:
 
3636
                raise errors.BzrCommandError(gettext(
 
3637
                    "please specify either --message or --file"))
 
3638
 
 
3639
        def get_message(commit_obj):
 
3640
            """Callback to get commit message"""
 
3641
            if file:
 
3642
                f = open(file)
 
3643
                try:
 
3644
                    my_message = f.read().decode(osutils.get_user_encoding())
 
3645
                finally:
 
3646
                    f.close()
 
3647
            elif message is not None:
 
3648
                my_message = message
 
3649
            else:
 
3650
                # No message supplied: make one up.
 
3651
                # text is the status of the tree
 
3652
                text = make_commit_message_template_encoded(tree,
 
3653
                        selected_list, diff=show_diff,
 
3654
                        output_encoding=osutils.get_user_encoding())
 
3655
                # start_message is the template generated from hooks
 
3656
                # XXX: Warning - looks like hooks return unicode,
 
3657
                # make_commit_message_template_encoded returns user encoding.
 
3658
                # We probably want to be using edit_commit_message instead to
 
3659
                # avoid this.
 
3660
                my_message = set_commit_message(commit_obj)
 
3661
                if my_message is None:
 
3662
                    start_message = generate_commit_message_template(commit_obj)
 
3663
                    my_message = edit_commit_message_encoded(text,
 
3664
                        start_message=start_message)
 
3665
                if my_message is None:
 
3666
                    raise errors.BzrCommandError(gettext("please specify a commit"
 
3667
                        " message with either --message or --file"))
 
3668
                if my_message == "":
 
3669
                    raise errors.BzrCommandError(gettext("Empty commit message specified."
 
3670
                            " Please specify a commit message with either"
 
3671
                            " --message or --file or leave a blank message"
 
3672
                            " with --message \"\"."))
 
3673
            return my_message
 
3674
 
 
3675
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3676
        # but the command line should not do that.
 
3677
        if not selected_list:
 
3678
            selected_list = None
979
3679
        try:
980
 
            b.commit(message,
981
 
                     specific_files=selected_list,
982
 
                     allow_pointless=unchanged)
 
3680
            tree.commit(message_callback=get_message,
 
3681
                        specific_files=selected_list,
 
3682
                        allow_pointless=unchanged, strict=strict, local=local,
 
3683
                        reporter=None, verbose=verbose, revprops=properties,
 
3684
                        authors=author, timestamp=commit_stamp,
 
3685
                        timezone=offset,
 
3686
                        exclude=tree.safe_relpath_files(exclude),
 
3687
                        lossy=lossy)
983
3688
        except PointlessCommit:
984
 
            # FIXME: This should really happen before the file is read in;
985
 
            # perhaps prepare the commit; get the message; then actually commit
986
 
            raise BzrCommandError("no changes to commit",
987
 
                                  ["use --unchanged to commit anyhow"])
 
3689
            raise errors.BzrCommandError(gettext("No changes to commit."
 
3690
                " Please 'bzr add' the files you want to commit, or use"
 
3691
                " --unchanged to force an empty commit."))
 
3692
        except ConflictsInTree:
 
3693
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
 
3694
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
3695
                ' resolve.'))
 
3696
        except StrictCommitFailed:
 
3697
            raise errors.BzrCommandError(gettext("Commit refused because there are"
 
3698
                              " unknown files in the working tree."))
 
3699
        except errors.BoundBranchOutOfDate, e:
 
3700
            e.extra_help = (gettext("\n"
 
3701
                'To commit to master branch, run update and then commit.\n'
 
3702
                'You can also pass --local to commit to continue working '
 
3703
                'disconnected.'))
 
3704
            raise
988
3705
 
989
3706
 
990
3707
class cmd_check(Command):
991
 
    """Validate consistency of branch history.
992
 
 
993
 
    This command checks various invariants about the branch storage to
994
 
    detect data corruption or bzr bugs.
995
 
 
996
 
    If given the --update flag, it will update some optional fields
997
 
    to help ensure data consistency.
 
3708
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
3709
 
 
3710
    This command checks various invariants about branch and repository storage
 
3711
    to detect data corruption or bzr bugs.
 
3712
 
 
3713
    The working tree and branch checks will only give output if a problem is
 
3714
    detected. The output fields of the repository check are:
 
3715
 
 
3716
    revisions
 
3717
        This is just the number of revisions checked.  It doesn't
 
3718
        indicate a problem.
 
3719
 
 
3720
    versionedfiles
 
3721
        This is just the number of versionedfiles checked.  It
 
3722
        doesn't indicate a problem.
 
3723
 
 
3724
    unreferenced ancestors
 
3725
        Texts that are ancestors of other texts, but
 
3726
        are not properly referenced by the revision ancestry.  This is a
 
3727
        subtle problem that Bazaar can work around.
 
3728
 
 
3729
    unique file texts
 
3730
        This is the total number of unique file contents
 
3731
        seen in the checked revisions.  It does not indicate a problem.
 
3732
 
 
3733
    repeated file texts
 
3734
        This is the total number of repeated texts seen
 
3735
        in the checked revisions.  Texts can be repeated when their file
 
3736
        entries are modified, but the file contents are not.  It does not
 
3737
        indicate a problem.
 
3738
 
 
3739
    If no restrictions are specified, all Bazaar data that is found at the given
 
3740
    location will be checked.
 
3741
 
 
3742
    :Examples:
 
3743
 
 
3744
        Check the tree and branch at 'foo'::
 
3745
 
 
3746
            bzr check --tree --branch foo
 
3747
 
 
3748
        Check only the repository at 'bar'::
 
3749
 
 
3750
            bzr check --repo bar
 
3751
 
 
3752
        Check everything at 'baz'::
 
3753
 
 
3754
            bzr check baz
998
3755
    """
999
 
    takes_args = ['dir?']
1000
 
 
1001
 
    def run(self, dir='.'):
1002
 
        from bzrlib.check import check
1003
 
 
1004
 
        check(find_branch(dir))
1005
 
 
1006
 
 
1007
 
class cmd_scan_cache(Command):
1008
 
    hidden = True
1009
 
    def run(self):
1010
 
        from bzrlib.hashcache import HashCache
1011
 
 
1012
 
        c = HashCache('.')
1013
 
        c.read()
1014
 
        c.scan()
1015
 
            
1016
 
        print '%6d stats' % c.stat_count
1017
 
        print '%6d in hashcache' % len(c._cache)
1018
 
        print '%6d files removed from cache' % c.removed_count
1019
 
        print '%6d hashes updated' % c.update_count
1020
 
        print '%6d files changed too recently to cache' % c.danger_count
1021
 
 
1022
 
        if c.needs_write:
1023
 
            c.write()
1024
 
            
 
3756
 
 
3757
    _see_also = ['reconcile']
 
3758
    takes_args = ['path?']
 
3759
    takes_options = ['verbose',
 
3760
                     Option('branch', help="Check the branch related to the"
 
3761
                                           " current directory."),
 
3762
                     Option('repo', help="Check the repository related to the"
 
3763
                                         " current directory."),
 
3764
                     Option('tree', help="Check the working tree related to"
 
3765
                                         " the current directory.")]
 
3766
 
 
3767
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
3768
            tree=False):
 
3769
        from bzrlib.check import check_dwim
 
3770
        if path is None:
 
3771
            path = '.'
 
3772
        if not branch and not repo and not tree:
 
3773
            branch = repo = tree = True
 
3774
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
1025
3775
 
1026
3776
 
1027
3777
class cmd_upgrade(Command):
1028
 
    """Upgrade branch storage to current format.
1029
 
 
1030
 
    The check command or bzr developers may sometimes advise you to run
1031
 
    this command.
 
3778
    __doc__ = """Upgrade a repository, branch or working tree to a newer format.
 
3779
 
 
3780
    When the default format has changed after a major new release of
 
3781
    Bazaar, you may be informed during certain operations that you
 
3782
    should upgrade. Upgrading to a newer format may improve performance
 
3783
    or make new features available. It may however limit interoperability
 
3784
    with older repositories or with older versions of Bazaar.
 
3785
 
 
3786
    If you wish to upgrade to a particular format rather than the
 
3787
    current default, that can be specified using the --format option.
 
3788
    As a consequence, you can use the upgrade command this way to
 
3789
    "downgrade" to an earlier format, though some conversions are
 
3790
    a one way process (e.g. changing from the 1.x default to the
 
3791
    2.x default) so downgrading is not always possible.
 
3792
 
 
3793
    A backup.bzr.~#~ directory is created at the start of the conversion
 
3794
    process (where # is a number). By default, this is left there on
 
3795
    completion. If the conversion fails, delete the new .bzr directory
 
3796
    and rename this one back in its place. Use the --clean option to ask
 
3797
    for the backup.bzr directory to be removed on successful conversion.
 
3798
    Alternatively, you can delete it by hand if everything looks good
 
3799
    afterwards.
 
3800
 
 
3801
    If the location given is a shared repository, dependent branches
 
3802
    are also converted provided the repository converts successfully.
 
3803
    If the conversion of a branch fails, remaining branches are still
 
3804
    tried.
 
3805
 
 
3806
    For more information on upgrades, see the Bazaar Upgrade Guide,
 
3807
    http://doc.bazaar.canonical.com/latest/en/upgrade-guide/.
1032
3808
    """
1033
 
    takes_args = ['dir?']
1034
 
 
1035
 
    def run(self, dir='.'):
 
3809
 
 
3810
    _see_also = ['check', 'reconcile', 'formats']
 
3811
    takes_args = ['url?']
 
3812
    takes_options = [
 
3813
        RegistryOption('format',
 
3814
            help='Upgrade to a specific format.  See "bzr help'
 
3815
                 ' formats" for details.',
 
3816
            lazy_registry=('bzrlib.controldir', 'format_registry'),
 
3817
            converter=lambda name: controldir.format_registry.make_bzrdir(name),
 
3818
            value_switches=True, title='Branch format'),
 
3819
        Option('clean',
 
3820
            help='Remove the backup.bzr directory if successful.'),
 
3821
        Option('dry-run',
 
3822
            help="Show what would be done, but don't actually do anything."),
 
3823
    ]
 
3824
 
 
3825
    def run(self, url='.', format=None, clean=False, dry_run=False):
1036
3826
        from bzrlib.upgrade import upgrade
1037
 
        upgrade(find_branch(dir))
1038
 
 
 
3827
        exceptions = upgrade(url, format, clean_up=clean, dry_run=dry_run)
 
3828
        if exceptions:
 
3829
            if len(exceptions) == 1:
 
3830
                # Compatibility with historical behavior
 
3831
                raise exceptions[0]
 
3832
            else:
 
3833
                return 3
1039
3834
 
1040
3835
 
1041
3836
class cmd_whoami(Command):
1042
 
    """Show bzr user id."""
1043
 
    takes_options = ['email']
1044
 
    
1045
 
    def run(self, email=False):
1046
 
        try:
1047
 
            b = bzrlib.branch.find_branch('.')
1048
 
        except:
1049
 
            b = None
1050
 
        
 
3837
    __doc__ = """Show or set bzr user id.
 
3838
 
 
3839
    :Examples:
 
3840
        Show the email of the current user::
 
3841
 
 
3842
            bzr whoami --email
 
3843
 
 
3844
        Set the current user::
 
3845
 
 
3846
            bzr whoami "Frank Chu <fchu@example.com>"
 
3847
    """
 
3848
    takes_options = [ 'directory',
 
3849
                      Option('email',
 
3850
                             help='Display email address only.'),
 
3851
                      Option('branch',
 
3852
                             help='Set identity for the current branch instead of '
 
3853
                                  'globally.'),
 
3854
                    ]
 
3855
    takes_args = ['name?']
 
3856
    encoding_type = 'replace'
 
3857
 
 
3858
    @display_command
 
3859
    def run(self, email=False, branch=False, name=None, directory=None):
 
3860
        if name is None:
 
3861
            if directory is None:
 
3862
                # use branch if we're inside one; otherwise global config
 
3863
                try:
 
3864
                    c = Branch.open_containing(u'.')[0].get_config_stack()
 
3865
                except errors.NotBranchError:
 
3866
                    c = _mod_config.GlobalStack()
 
3867
            else:
 
3868
                c = Branch.open(directory).get_config_stack()
 
3869
            identity = c.get('email')
 
3870
            if email:
 
3871
                self.outf.write(_mod_config.extract_email_address(identity)
 
3872
                                + '\n')
 
3873
            else:
 
3874
                self.outf.write(identity + '\n')
 
3875
            return
 
3876
 
1051
3877
        if email:
1052
 
            print bzrlib.osutils.user_email(b)
1053
 
        else:
1054
 
            print bzrlib.osutils.username(b)
 
3878
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
 
3879
                                         "identity"))
 
3880
 
 
3881
        # display a warning if an email address isn't included in the given name.
 
3882
        try:
 
3883
            _mod_config.extract_email_address(name)
 
3884
        except errors.NoEmailInUsername, e:
 
3885
            warning('"%s" does not seem to contain an email address.  '
 
3886
                    'This is allowed, but not recommended.', name)
 
3887
 
 
3888
        # use global config unless --branch given
 
3889
        if branch:
 
3890
            if directory is None:
 
3891
                c = Branch.open_containing(u'.')[0].get_config_stack()
 
3892
            else:
 
3893
                b = Branch.open(directory)
 
3894
                self.add_cleanup(b.lock_write().unlock)
 
3895
                c = b.get_config_stack()
 
3896
        else:
 
3897
            c = _mod_config.GlobalStack()
 
3898
        c.set('email', name)
 
3899
 
 
3900
 
 
3901
class cmd_nick(Command):
 
3902
    __doc__ = """Print or set the branch nickname.
 
3903
 
 
3904
    If unset, the colocated branch name is used for colocated branches, and
 
3905
    the branch directory name is used for other branches.  To print the
 
3906
    current nickname, execute with no argument.
 
3907
 
 
3908
    Bound branches use the nickname of its master branch unless it is set
 
3909
    locally.
 
3910
    """
 
3911
 
 
3912
    _see_also = ['info']
 
3913
    takes_args = ['nickname?']
 
3914
    takes_options = ['directory']
 
3915
    def run(self, nickname=None, directory=u'.'):
 
3916
        branch = Branch.open_containing(directory)[0]
 
3917
        if nickname is None:
 
3918
            self.printme(branch)
 
3919
        else:
 
3920
            branch.nick = nickname
 
3921
 
 
3922
    @display_command
 
3923
    def printme(self, branch):
 
3924
        self.outf.write('%s\n' % branch.nick)
 
3925
 
 
3926
 
 
3927
class cmd_alias(Command):
 
3928
    __doc__ = """Set/unset and display aliases.
 
3929
 
 
3930
    :Examples:
 
3931
        Show the current aliases::
 
3932
 
 
3933
            bzr alias
 
3934
 
 
3935
        Show the alias specified for 'll'::
 
3936
 
 
3937
            bzr alias ll
 
3938
 
 
3939
        Set an alias for 'll'::
 
3940
 
 
3941
            bzr alias ll="log --line -r-10..-1"
 
3942
 
 
3943
        To remove an alias for 'll'::
 
3944
 
 
3945
            bzr alias --remove ll
 
3946
 
 
3947
    """
 
3948
    takes_args = ['name?']
 
3949
    takes_options = [
 
3950
        Option('remove', help='Remove the alias.'),
 
3951
        ]
 
3952
 
 
3953
    def run(self, name=None, remove=False):
 
3954
        if remove:
 
3955
            self.remove_alias(name)
 
3956
        elif name is None:
 
3957
            self.print_aliases()
 
3958
        else:
 
3959
            equal_pos = name.find('=')
 
3960
            if equal_pos == -1:
 
3961
                self.print_alias(name)
 
3962
            else:
 
3963
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3964
 
 
3965
    def remove_alias(self, alias_name):
 
3966
        if alias_name is None:
 
3967
            raise errors.BzrCommandError(gettext(
 
3968
                'bzr alias --remove expects an alias to remove.'))
 
3969
        # If alias is not found, print something like:
 
3970
        # unalias: foo: not found
 
3971
        c = _mod_config.GlobalConfig()
 
3972
        c.unset_alias(alias_name)
 
3973
 
 
3974
    @display_command
 
3975
    def print_aliases(self):
 
3976
        """Print out the defined aliases in a similar format to bash."""
 
3977
        aliases = _mod_config.GlobalConfig().get_aliases()
 
3978
        for key, value in sorted(aliases.iteritems()):
 
3979
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3980
 
 
3981
    @display_command
 
3982
    def print_alias(self, alias_name):
 
3983
        from bzrlib.commands import get_alias
 
3984
        alias = get_alias(alias_name)
 
3985
        if alias is None:
 
3986
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3987
        else:
 
3988
            self.outf.write(
 
3989
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3990
 
 
3991
    def set_alias(self, alias_name, alias_command):
 
3992
        """Save the alias in the global config."""
 
3993
        c = _mod_config.GlobalConfig()
 
3994
        c.set_alias(alias_name, alias_command)
1055
3995
 
1056
3996
 
1057
3997
class cmd_selftest(Command):
1058
 
    """Run internal test suite"""
 
3998
    __doc__ = """Run internal test suite.
 
3999
 
 
4000
    If arguments are given, they are regular expressions that say which tests
 
4001
    should run.  Tests matching any expression are run, and other tests are
 
4002
    not run.
 
4003
 
 
4004
    Alternatively if --first is given, matching tests are run first and then
 
4005
    all other tests are run.  This is useful if you have been working in a
 
4006
    particular area, but want to make sure nothing else was broken.
 
4007
 
 
4008
    If --exclude is given, tests that match that regular expression are
 
4009
    excluded, regardless of whether they match --first or not.
 
4010
 
 
4011
    To help catch accidential dependencies between tests, the --randomize
 
4012
    option is useful. In most cases, the argument used is the word 'now'.
 
4013
    Note that the seed used for the random number generator is displayed
 
4014
    when this option is used. The seed can be explicitly passed as the
 
4015
    argument to this option if required. This enables reproduction of the
 
4016
    actual ordering used if and when an order sensitive problem is encountered.
 
4017
 
 
4018
    If --list-only is given, the tests that would be run are listed. This is
 
4019
    useful when combined with --first, --exclude and/or --randomize to
 
4020
    understand their impact. The test harness reports "Listed nn tests in ..."
 
4021
    instead of "Ran nn tests in ..." when list mode is enabled.
 
4022
 
 
4023
    If the global option '--no-plugins' is given, plugins are not loaded
 
4024
    before running the selftests.  This has two effects: features provided or
 
4025
    modified by plugins will not be tested, and tests provided by plugins will
 
4026
    not be run.
 
4027
 
 
4028
    Tests that need working space on disk use a common temporary directory,
 
4029
    typically inside $TMPDIR or /tmp.
 
4030
 
 
4031
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
4032
    into a pdb postmortem session.
 
4033
 
 
4034
    The --coverage=DIRNAME global option produces a report with covered code
 
4035
    indicated.
 
4036
 
 
4037
    :Examples:
 
4038
        Run only tests relating to 'ignore'::
 
4039
 
 
4040
            bzr selftest ignore
 
4041
 
 
4042
        Disable plugins and list tests as they're run::
 
4043
 
 
4044
            bzr --no-plugins selftest -v
 
4045
    """
 
4046
    # NB: this is used from the class without creating an instance, which is
 
4047
    # why it does not have a self parameter.
 
4048
    def get_transport_type(typestring):
 
4049
        """Parse and return a transport specifier."""
 
4050
        if typestring == "sftp":
 
4051
            from bzrlib.tests import stub_sftp
 
4052
            return stub_sftp.SFTPAbsoluteServer
 
4053
        elif typestring == "memory":
 
4054
            from bzrlib.tests import test_server
 
4055
            return memory.MemoryServer
 
4056
        elif typestring == "fakenfs":
 
4057
            from bzrlib.tests import test_server
 
4058
            return test_server.FakeNFSServer
 
4059
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
4060
            (typestring)
 
4061
        raise errors.BzrCommandError(msg)
 
4062
 
1059
4063
    hidden = True
1060
 
    takes_options = ['verbose', 'pattern']
1061
 
    def run(self, verbose=False, pattern=".*"):
1062
 
        import bzrlib.ui
1063
 
        from bzrlib.selftest import selftest
1064
 
        # we don't want progress meters from the tests to go to the
1065
 
        # real output; and we don't want log messages cluttering up
1066
 
        # the real logs.
1067
 
        save_ui = bzrlib.ui.ui_factory
1068
 
        bzrlib.trace.info('running tests...')
 
4064
    takes_args = ['testspecs*']
 
4065
    takes_options = ['verbose',
 
4066
                     Option('one',
 
4067
                             help='Stop when one test fails.',
 
4068
                             short_name='1',
 
4069
                             ),
 
4070
                     Option('transport',
 
4071
                            help='Use a different transport by default '
 
4072
                                 'throughout the test suite.',
 
4073
                            type=get_transport_type),
 
4074
                     Option('benchmark',
 
4075
                            help='Run the benchmarks rather than selftests.',
 
4076
                            hidden=True),
 
4077
                     Option('lsprof-timed',
 
4078
                            help='Generate lsprof output for benchmarked'
 
4079
                                 ' sections of code.'),
 
4080
                     Option('lsprof-tests',
 
4081
                            help='Generate lsprof output for each test.'),
 
4082
                     Option('first',
 
4083
                            help='Run all tests, but run specified tests first.',
 
4084
                            short_name='f',
 
4085
                            ),
 
4086
                     Option('list-only',
 
4087
                            help='List the tests instead of running them.'),
 
4088
                     RegistryOption('parallel',
 
4089
                        help="Run the test suite in parallel.",
 
4090
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
4091
                        value_switches=False,
 
4092
                        ),
 
4093
                     Option('randomize', type=str, argname="SEED",
 
4094
                            help='Randomize the order of tests using the given'
 
4095
                                 ' seed or "now" for the current time.'),
 
4096
                     ListOption('exclude', type=str, argname="PATTERN",
 
4097
                                short_name='x',
 
4098
                                help='Exclude tests that match this regular'
 
4099
                                ' expression.'),
 
4100
                     Option('subunit',
 
4101
                        help='Output test progress via subunit.'),
 
4102
                     Option('strict', help='Fail on missing dependencies or '
 
4103
                            'known failures.'),
 
4104
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
4105
                            help='Load a test id list from a text file.'),
 
4106
                     ListOption('debugflag', type=str, short_name='E',
 
4107
                                help='Turn on a selftest debug flag.'),
 
4108
                     ListOption('starting-with', type=str, argname='TESTID',
 
4109
                                param_name='starting_with', short_name='s',
 
4110
                                help=
 
4111
                                'Load only the tests starting with TESTID.'),
 
4112
                     Option('sync',
 
4113
                            help="By default we disable fsync and fdatasync"
 
4114
                                 " while running the test suite.")
 
4115
                     ]
 
4116
    encoding_type = 'replace'
 
4117
 
 
4118
    def __init__(self):
 
4119
        Command.__init__(self)
 
4120
        self.additional_selftest_args = {}
 
4121
 
 
4122
    def run(self, testspecs_list=None, verbose=False, one=False,
 
4123
            transport=None, benchmark=None,
 
4124
            lsprof_timed=None,
 
4125
            first=False, list_only=False,
 
4126
            randomize=None, exclude=None, strict=False,
 
4127
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
4128
            parallel=None, lsprof_tests=False,
 
4129
            sync=False):
 
4130
 
 
4131
        # During selftest, disallow proxying, as it can cause severe
 
4132
        # performance penalties and is only needed for thread
 
4133
        # safety. The selftest command is assumed to not use threads
 
4134
        # too heavily. The call should be as early as possible, as
 
4135
        # error reporting for past duplicate imports won't have useful
 
4136
        # backtraces.
 
4137
        lazy_import.disallow_proxying()
 
4138
 
 
4139
        from bzrlib import tests
 
4140
 
 
4141
        if testspecs_list is not None:
 
4142
            pattern = '|'.join(testspecs_list)
 
4143
        else:
 
4144
            pattern = ".*"
 
4145
        if subunit:
 
4146
            try:
 
4147
                from bzrlib.tests import SubUnitBzrRunner
 
4148
            except ImportError:
 
4149
                raise errors.BzrCommandError(gettext("subunit not available. subunit "
 
4150
                    "needs to be installed to use --subunit."))
 
4151
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
4152
            # On Windows, disable automatic conversion of '\n' to '\r\n' in
 
4153
            # stdout, which would corrupt the subunit stream. 
 
4154
            # FIXME: This has been fixed in subunit trunk (>0.0.5) so the
 
4155
            # following code can be deleted when it's sufficiently deployed
 
4156
            # -- vila/mgz 20100514
 
4157
            if (sys.platform == "win32"
 
4158
                and getattr(sys.stdout, 'fileno', None) is not None):
 
4159
                import msvcrt
 
4160
                msvcrt.setmode(sys.stdout.fileno(), os.O_BINARY)
 
4161
        if parallel:
 
4162
            self.additional_selftest_args.setdefault(
 
4163
                'suite_decorators', []).append(parallel)
 
4164
        if benchmark:
 
4165
            raise errors.BzrCommandError(gettext(
 
4166
                "--benchmark is no longer supported from bzr 2.2; "
 
4167
                "use bzr-usertest instead"))
 
4168
        test_suite_factory = None
 
4169
        if not exclude:
 
4170
            exclude_pattern = None
 
4171
        else:
 
4172
            exclude_pattern = '(' + '|'.join(exclude) + ')'
 
4173
        if not sync:
 
4174
            self._disable_fsync()
 
4175
        selftest_kwargs = {"verbose": verbose,
 
4176
                          "pattern": pattern,
 
4177
                          "stop_on_failure": one,
 
4178
                          "transport": transport,
 
4179
                          "test_suite_factory": test_suite_factory,
 
4180
                          "lsprof_timed": lsprof_timed,
 
4181
                          "lsprof_tests": lsprof_tests,
 
4182
                          "matching_tests_first": first,
 
4183
                          "list_only": list_only,
 
4184
                          "random_seed": randomize,
 
4185
                          "exclude_pattern": exclude_pattern,
 
4186
                          "strict": strict,
 
4187
                          "load_list": load_list,
 
4188
                          "debug_flags": debugflag,
 
4189
                          "starting_with": starting_with
 
4190
                          }
 
4191
        selftest_kwargs.update(self.additional_selftest_args)
 
4192
 
 
4193
        # Make deprecation warnings visible, unless -Werror is set
 
4194
        cleanup = symbol_versioning.activate_deprecation_warnings(
 
4195
            override=False)
1069
4196
        try:
1070
 
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1071
 
            result = selftest(verbose=verbose, pattern=pattern)
1072
 
            if result:
1073
 
                bzrlib.trace.info('tests passed')
1074
 
            else:
1075
 
                bzrlib.trace.info('tests failed')
1076
 
            return int(not result)
 
4197
            result = tests.selftest(**selftest_kwargs)
1077
4198
        finally:
1078
 
            bzrlib.ui.ui_factory = save_ui
1079
 
 
1080
 
 
1081
 
def show_version():
1082
 
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
1083
 
    # is bzrlib itself in a branch?
1084
 
    bzrrev = bzrlib.get_bzr_revision()
1085
 
    if bzrrev:
1086
 
        print "  (bzr checkout, revision %d {%s})" % bzrrev
1087
 
    print bzrlib.__copyright__
1088
 
    print "http://bazaar-ng.org/"
1089
 
    print
1090
 
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
1091
 
    print "you may use, modify and redistribute it under the terms of the GNU"
1092
 
    print "General Public License version 2 or later."
 
4199
            cleanup()
 
4200
        return int(not result)
 
4201
 
 
4202
    def _disable_fsync(self):
 
4203
        """Change the 'os' functionality to not synchronize."""
 
4204
        self._orig_fsync = getattr(os, 'fsync', None)
 
4205
        if self._orig_fsync is not None:
 
4206
            os.fsync = lambda filedes: None
 
4207
        self._orig_fdatasync = getattr(os, 'fdatasync', None)
 
4208
        if self._orig_fdatasync is not None:
 
4209
            os.fdatasync = lambda filedes: None
1093
4210
 
1094
4211
 
1095
4212
class cmd_version(Command):
1096
 
    """Show version of bzr."""
1097
 
    def run(self):
1098
 
        show_version()
 
4213
    __doc__ = """Show version of bzr."""
 
4214
 
 
4215
    encoding_type = 'replace'
 
4216
    takes_options = [
 
4217
        Option("short", help="Print just the version number."),
 
4218
        ]
 
4219
 
 
4220
    @display_command
 
4221
    def run(self, short=False):
 
4222
        from bzrlib.version import show_version
 
4223
        if short:
 
4224
            self.outf.write(bzrlib.version_string + '\n')
 
4225
        else:
 
4226
            show_version(to_file=self.outf)
 
4227
 
1099
4228
 
1100
4229
class cmd_rocks(Command):
1101
 
    """Statement of optimism."""
 
4230
    __doc__ = """Statement of optimism."""
 
4231
 
1102
4232
    hidden = True
 
4233
 
 
4234
    @display_command
1103
4235
    def run(self):
1104
 
        print "it sure does!"
 
4236
        self.outf.write(gettext("It sure does!\n"))
1105
4237
 
1106
4238
 
1107
4239
class cmd_find_merge_base(Command):
1108
 
    """Find and print a base revision for merging two branches.
1109
 
 
1110
 
    TODO: Options to specify revisions on either side, as if
1111
 
          merging only part of the history.
1112
 
    """
 
4240
    __doc__ = """Find and print a base revision for merging two branches."""
 
4241
    # TODO: Options to specify revisions on either side, as if
 
4242
    #       merging only part of the history.
1113
4243
    takes_args = ['branch', 'other']
1114
4244
    hidden = True
1115
 
    
 
4245
 
 
4246
    @display_command
1116
4247
    def run(self, branch, other):
1117
 
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
1118
 
        
1119
 
        branch1 = find_branch(branch)
1120
 
        branch2 = find_branch(other)
1121
 
 
1122
 
        history_1 = branch1.revision_history()
1123
 
        history_2 = branch2.revision_history()
1124
 
 
1125
 
        last1 = branch1.last_patch()
1126
 
        last2 = branch2.last_patch()
1127
 
 
1128
 
        source = MultipleRevisionSources(branch1, branch2)
1129
 
        
1130
 
        base_rev_id = common_ancestor(last1, last2, source)
1131
 
 
1132
 
        print 'merge base is revision %s' % base_rev_id
1133
 
        
1134
 
        return
1135
 
 
1136
 
        if base_revno is None:
1137
 
            raise bzrlib.errors.UnrelatedBranches()
1138
 
 
1139
 
        print ' r%-6d in %s' % (base_revno, branch)
1140
 
 
1141
 
        other_revno = branch2.revision_id_to_revno(base_revid)
1142
 
        
1143
 
        print ' r%-6d in %s' % (other_revno, other)
1144
 
 
 
4248
        from bzrlib.revision import ensure_null
 
4249
 
 
4250
        branch1 = Branch.open_containing(branch)[0]
 
4251
        branch2 = Branch.open_containing(other)[0]
 
4252
        self.add_cleanup(branch1.lock_read().unlock)
 
4253
        self.add_cleanup(branch2.lock_read().unlock)
 
4254
        last1 = ensure_null(branch1.last_revision())
 
4255
        last2 = ensure_null(branch2.last_revision())
 
4256
 
 
4257
        graph = branch1.repository.get_graph(branch2.repository)
 
4258
        base_rev_id = graph.find_unique_lca(last1, last2)
 
4259
 
 
4260
        self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
1145
4261
 
1146
4262
 
1147
4263
class cmd_merge(Command):
1148
 
    """Perform a three-way merge.
1149
 
    
1150
 
    The branch is the branch you will merge from.  By default, it will
1151
 
    merge the latest revision.  If you specify a revision, that
1152
 
    revision will be merged.  If you specify two revisions, the first
1153
 
    will be used as a BASE, and the second one as OTHER.  Revision
1154
 
    numbers are always relative to the specified branch.
1155
 
 
1156
 
    By default bzr will try to merge in all new work from the other
1157
 
    branch, automatically determining an appropriate base.  If this
1158
 
    fails, you may need to give an explicit base.
1159
 
    
1160
 
    Examples:
1161
 
 
1162
 
    To merge the latest revision from bzr.dev
1163
 
    bzr merge ../bzr.dev
1164
 
 
1165
 
    To merge changes up to and including revision 82 from bzr.dev
1166
 
    bzr merge -r 82 ../bzr.dev
1167
 
 
1168
 
    To merge the changes introduced by 82, without previous changes:
1169
 
    bzr merge -r 81..82 ../bzr.dev
1170
 
    
 
4264
    __doc__ = """Perform a three-way merge.
 
4265
 
 
4266
    The source of the merge can be specified either in the form of a branch,
 
4267
    or in the form of a path to a file containing a merge directive generated
 
4268
    with bzr send. If neither is specified, the default is the upstream branch
 
4269
    or the branch most recently merged using --remember.  The source of the
 
4270
    merge may also be specified in the form of a path to a file in another
 
4271
    branch:  in this case, only the modifications to that file are merged into
 
4272
    the current working tree.
 
4273
 
 
4274
    When merging from a branch, by default bzr will try to merge in all new
 
4275
    work from the other branch, automatically determining an appropriate base
 
4276
    revision.  If this fails, you may need to give an explicit base.
 
4277
 
 
4278
    To pick a different ending revision, pass "--revision OTHER".  bzr will
 
4279
    try to merge in all new work up to and including revision OTHER.
 
4280
 
 
4281
    If you specify two values, "--revision BASE..OTHER", only revisions BASE
 
4282
    through OTHER, excluding BASE but including OTHER, will be merged.  If this
 
4283
    causes some revisions to be skipped, i.e. if the destination branch does
 
4284
    not already contain revision BASE, such a merge is commonly referred to as
 
4285
    a "cherrypick". Unlike a normal merge, Bazaar does not currently track
 
4286
    cherrypicks. The changes look like a normal commit, and the history of the
 
4287
    changes from the other branch is not stored in the commit.
 
4288
 
 
4289
    Revision numbers are always relative to the source branch.
 
4290
 
 
4291
    Merge will do its best to combine the changes in two branches, but there
 
4292
    are some kinds of problems only a human can fix.  When it encounters those,
 
4293
    it will mark a conflict.  A conflict means that you need to fix something,
 
4294
    before you can commit.
 
4295
 
 
4296
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
4297
 
 
4298
    If there is no default branch set, the first merge will set it (use
 
4299
    --no-remember to avoid setting it). After that, you can omit the branch
 
4300
    to use the default.  To change the default, use --remember. The value will
 
4301
    only be saved if the remote location can be accessed.
 
4302
 
 
4303
    The results of the merge are placed into the destination working
 
4304
    directory, where they can be reviewed (with bzr diff), tested, and then
 
4305
    committed to record the result of the merge.
 
4306
 
1171
4307
    merge refuses to run if there are any uncommitted changes, unless
1172
 
    --force is given.
1173
 
    """
1174
 
    takes_args = ['branch?']
1175
 
    takes_options = ['revision', 'force', 'merge-type']
1176
 
 
1177
 
    def run(self, branch='.', revision=None, force=False, 
1178
 
            merge_type=None):
1179
 
        from bzrlib.merge import merge
1180
 
        from bzrlib.merge_core import ApplyMerge3
1181
 
        if merge_type is None:
1182
 
            merge_type = ApplyMerge3
1183
 
 
1184
 
        if revision is None or len(revision) < 1:
1185
 
            base = [None, None]
1186
 
            other = [branch, -1]
1187
 
        else:
1188
 
            if len(revision) == 1:
1189
 
                other = [branch, revision[0]]
1190
 
                base = [None, None]
1191
 
            else:
1192
 
                assert len(revision) == 2
1193
 
                if None in revision:
1194
 
                    raise BzrCommandError(
1195
 
                        "Merge doesn't permit that revision specifier.")
1196
 
                base = [branch, revision[0]]
1197
 
                other = [branch, revision[1]]
1198
 
 
1199
 
        try:
1200
 
            merge(other, base, check_clean=(not force), merge_type=merge_type)
1201
 
        except bzrlib.errors.AmbiguousBase, e:
1202
 
            m = ("sorry, bzr can't determine the right merge base yet\n"
1203
 
                 "candidates are:\n  "
1204
 
                 + "\n  ".join(e.bases)
1205
 
                 + "\n"
1206
 
                 "please specify an explicit base with -r,\n"
1207
 
                 "and (if you want) report this to the bzr developers\n")
1208
 
            log_error(m)
 
4308
    --force is given.  If --force is given, then the changes from the source 
 
4309
    will be merged with the current working tree, including any uncommitted
 
4310
    changes in the tree.  The --force option can also be used to create a
 
4311
    merge revision which has more than two parents.
 
4312
 
 
4313
    If one would like to merge changes from the working tree of the other
 
4314
    branch without merging any committed revisions, the --uncommitted option
 
4315
    can be given.
 
4316
 
 
4317
    To select only some changes to merge, use "merge -i", which will prompt
 
4318
    you to apply each diff hunk and file change, similar to "shelve".
 
4319
 
 
4320
    :Examples:
 
4321
        To merge all new revisions from bzr.dev::
 
4322
 
 
4323
            bzr merge ../bzr.dev
 
4324
 
 
4325
        To merge changes up to and including revision 82 from bzr.dev::
 
4326
 
 
4327
            bzr merge -r 82 ../bzr.dev
 
4328
 
 
4329
        To merge the changes introduced by 82, without previous changes::
 
4330
 
 
4331
            bzr merge -r 81..82 ../bzr.dev
 
4332
 
 
4333
        To apply a merge directive contained in /tmp/merge::
 
4334
 
 
4335
            bzr merge /tmp/merge
 
4336
 
 
4337
        To create a merge revision with three parents from two branches
 
4338
        feature1a and feature1b:
 
4339
 
 
4340
            bzr merge ../feature1a
 
4341
            bzr merge ../feature1b --force
 
4342
            bzr commit -m 'revision with three parents'
 
4343
    """
 
4344
 
 
4345
    encoding_type = 'exact'
 
4346
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
4347
    takes_args = ['location?']
 
4348
    takes_options = [
 
4349
        'change',
 
4350
        'revision',
 
4351
        Option('force',
 
4352
               help='Merge even if the destination tree has uncommitted changes.'),
 
4353
        'merge-type',
 
4354
        'reprocess',
 
4355
        'remember',
 
4356
        Option('show-base', help="Show base revision text in "
 
4357
               "conflicts."),
 
4358
        Option('uncommitted', help='Apply uncommitted changes'
 
4359
               ' from a working copy, instead of branch changes.'),
 
4360
        Option('pull', help='If the destination is already'
 
4361
                ' completely merged into the source, pull from the'
 
4362
                ' source rather than merging.  When this happens,'
 
4363
                ' you do not need to commit the result.'),
 
4364
        custom_help('directory',
 
4365
               help='Branch to merge into, '
 
4366
                    'rather than the one containing the working directory.'),
 
4367
        Option('preview', help='Instead of merging, show a diff of the'
 
4368
               ' merge.'),
 
4369
        Option('interactive', help='Select changes interactively.',
 
4370
            short_name='i')
 
4371
    ]
 
4372
 
 
4373
    def run(self, location=None, revision=None, force=False,
 
4374
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
4375
            uncommitted=False, pull=False,
 
4376
            directory=None,
 
4377
            preview=False,
 
4378
            interactive=False,
 
4379
            ):
 
4380
        if merge_type is None:
 
4381
            merge_type = _mod_merge.Merge3Merger
 
4382
 
 
4383
        if directory is None: directory = u'.'
 
4384
        possible_transports = []
 
4385
        merger = None
 
4386
        allow_pending = True
 
4387
        verified = 'inapplicable'
 
4388
 
 
4389
        tree = WorkingTree.open_containing(directory)[0]
 
4390
        if tree.branch.revno() == 0:
 
4391
            raise errors.BzrCommandError(gettext('Merging into empty branches not currently supported, '
 
4392
                                         'https://bugs.launchpad.net/bzr/+bug/308562'))
 
4393
 
 
4394
        try:
 
4395
            basis_tree = tree.revision_tree(tree.last_revision())
 
4396
        except errors.NoSuchRevision:
 
4397
            basis_tree = tree.basis_tree()
 
4398
 
 
4399
        # die as quickly as possible if there are uncommitted changes
 
4400
        if not force:
 
4401
            if tree.has_changes():
 
4402
                raise errors.UncommittedChanges(tree)
 
4403
 
 
4404
        view_info = _get_view_info_for_change_reporter(tree)
 
4405
        change_reporter = delta._ChangeReporter(
 
4406
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
4407
        pb = ui.ui_factory.nested_progress_bar()
 
4408
        self.add_cleanup(pb.finished)
 
4409
        self.add_cleanup(tree.lock_write().unlock)
 
4410
        if location is not None:
 
4411
            try:
 
4412
                mergeable = bundle.read_mergeable_from_url(location,
 
4413
                    possible_transports=possible_transports)
 
4414
            except errors.NotABundle:
 
4415
                mergeable = None
 
4416
            else:
 
4417
                if uncommitted:
 
4418
                    raise errors.BzrCommandError(gettext('Cannot use --uncommitted'
 
4419
                        ' with bundles or merge directives.'))
 
4420
 
 
4421
                if revision is not None:
 
4422
                    raise errors.BzrCommandError(gettext(
 
4423
                        'Cannot use -r with merge directives or bundles'))
 
4424
                merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
4425
                   mergeable, None)
 
4426
 
 
4427
        if merger is None and uncommitted:
 
4428
            if revision is not None and len(revision) > 0:
 
4429
                raise errors.BzrCommandError(gettext('Cannot use --uncommitted and'
 
4430
                    ' --revision at the same time.'))
 
4431
            merger = self.get_merger_from_uncommitted(tree, location, None)
 
4432
            allow_pending = False
 
4433
 
 
4434
        if merger is None:
 
4435
            merger, allow_pending = self._get_merger_from_branch(tree,
 
4436
                location, revision, remember, possible_transports, None)
 
4437
 
 
4438
        merger.merge_type = merge_type
 
4439
        merger.reprocess = reprocess
 
4440
        merger.show_base = show_base
 
4441
        self.sanity_check_merger(merger)
 
4442
        if (merger.base_rev_id == merger.other_rev_id and
 
4443
            merger.other_rev_id is not None):
 
4444
            # check if location is a nonexistent file (and not a branch) to
 
4445
            # disambiguate the 'Nothing to do'
 
4446
            if merger.interesting_files:
 
4447
                if not merger.other_tree.has_filename(
 
4448
                    merger.interesting_files[0]):
 
4449
                    note(gettext("merger: ") + str(merger))
 
4450
                    raise errors.PathsDoNotExist([location])
 
4451
            note(gettext('Nothing to do.'))
 
4452
            return 0
 
4453
        if pull and not preview:
 
4454
            if merger.interesting_files is not None:
 
4455
                raise errors.BzrCommandError(gettext('Cannot pull individual files'))
 
4456
            if (merger.base_rev_id == tree.last_revision()):
 
4457
                result = tree.pull(merger.other_branch, False,
 
4458
                                   merger.other_rev_id)
 
4459
                result.report(self.outf)
 
4460
                return 0
 
4461
        if merger.this_basis is None:
 
4462
            raise errors.BzrCommandError(gettext(
 
4463
                "This branch has no commits."
 
4464
                " (perhaps you would prefer 'bzr pull')"))
 
4465
        if preview:
 
4466
            return self._do_preview(merger)
 
4467
        elif interactive:
 
4468
            return self._do_interactive(merger)
 
4469
        else:
 
4470
            return self._do_merge(merger, change_reporter, allow_pending,
 
4471
                                  verified)
 
4472
 
 
4473
    def _get_preview(self, merger):
 
4474
        tree_merger = merger.make_merger()
 
4475
        tt = tree_merger.make_preview_transform()
 
4476
        self.add_cleanup(tt.finalize)
 
4477
        result_tree = tt.get_preview_tree()
 
4478
        return result_tree
 
4479
 
 
4480
    def _do_preview(self, merger):
 
4481
        from bzrlib.diff import show_diff_trees
 
4482
        result_tree = self._get_preview(merger)
 
4483
        path_encoding = osutils.get_diff_header_encoding()
 
4484
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
4485
                        old_label='', new_label='',
 
4486
                        path_encoding=path_encoding)
 
4487
 
 
4488
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
4489
        merger.change_reporter = change_reporter
 
4490
        conflict_count = merger.do_merge()
 
4491
        if allow_pending:
 
4492
            merger.set_pending()
 
4493
        if verified == 'failed':
 
4494
            warning('Preview patch does not match changes')
 
4495
        if conflict_count != 0:
 
4496
            return 1
 
4497
        else:
 
4498
            return 0
 
4499
 
 
4500
    def _do_interactive(self, merger):
 
4501
        """Perform an interactive merge.
 
4502
 
 
4503
        This works by generating a preview tree of the merge, then using
 
4504
        Shelver to selectively remove the differences between the working tree
 
4505
        and the preview tree.
 
4506
        """
 
4507
        from bzrlib import shelf_ui
 
4508
        result_tree = self._get_preview(merger)
 
4509
        writer = bzrlib.option.diff_writer_registry.get()
 
4510
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
4511
                                   reporter=shelf_ui.ApplyReporter(),
 
4512
                                   diff_writer=writer(sys.stdout))
 
4513
        try:
 
4514
            shelver.run()
 
4515
        finally:
 
4516
            shelver.finalize()
 
4517
 
 
4518
    def sanity_check_merger(self, merger):
 
4519
        if (merger.show_base and
 
4520
            not merger.merge_type is _mod_merge.Merge3Merger):
 
4521
            raise errors.BzrCommandError(gettext("Show-base is not supported for this"
 
4522
                                         " merge type. %s") % merger.merge_type)
 
4523
        if merger.reprocess is None:
 
4524
            if merger.show_base:
 
4525
                merger.reprocess = False
 
4526
            else:
 
4527
                # Use reprocess if the merger supports it
 
4528
                merger.reprocess = merger.merge_type.supports_reprocess
 
4529
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
4530
            raise errors.BzrCommandError(gettext("Conflict reduction is not supported"
 
4531
                                         " for merge type %s.") %
 
4532
                                         merger.merge_type)
 
4533
        if merger.reprocess and merger.show_base:
 
4534
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
 
4535
                                         " show base."))
 
4536
 
 
4537
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
4538
                                possible_transports, pb):
 
4539
        """Produce a merger from a location, assuming it refers to a branch."""
 
4540
        from bzrlib.tag import _merge_tags_if_possible
 
4541
        # find the branch locations
 
4542
        other_loc, user_location = self._select_branch_location(tree, location,
 
4543
            revision, -1)
 
4544
        if revision is not None and len(revision) == 2:
 
4545
            base_loc, _unused = self._select_branch_location(tree,
 
4546
                location, revision, 0)
 
4547
        else:
 
4548
            base_loc = other_loc
 
4549
        # Open the branches
 
4550
        other_branch, other_path = Branch.open_containing(other_loc,
 
4551
            possible_transports)
 
4552
        if base_loc == other_loc:
 
4553
            base_branch = other_branch
 
4554
        else:
 
4555
            base_branch, base_path = Branch.open_containing(base_loc,
 
4556
                possible_transports)
 
4557
        # Find the revision ids
 
4558
        other_revision_id = None
 
4559
        base_revision_id = None
 
4560
        if revision is not None:
 
4561
            if len(revision) >= 1:
 
4562
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
4563
            if len(revision) == 2:
 
4564
                base_revision_id = revision[0].as_revision_id(base_branch)
 
4565
        if other_revision_id is None:
 
4566
            other_revision_id = _mod_revision.ensure_null(
 
4567
                other_branch.last_revision())
 
4568
        # Remember where we merge from. We need to remember if:
 
4569
        # - user specify a location (and we don't merge from the parent
 
4570
        #   branch)
 
4571
        # - user ask to remember or there is no previous location set to merge
 
4572
        #   from and user didn't ask to *not* remember
 
4573
        if (user_location is not None
 
4574
            and ((remember
 
4575
                  or (remember is None
 
4576
                      and tree.branch.get_submit_branch() is None)))):
 
4577
            tree.branch.set_submit_branch(other_branch.base)
 
4578
        # Merge tags (but don't set them in the master branch yet, the user
 
4579
        # might revert this merge).  Commit will propagate them.
 
4580
        _merge_tags_if_possible(other_branch, tree.branch, ignore_master=True)
 
4581
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
4582
            other_revision_id, base_revision_id, other_branch, base_branch)
 
4583
        if other_path != '':
 
4584
            allow_pending = False
 
4585
            merger.interesting_files = [other_path]
 
4586
        else:
 
4587
            allow_pending = True
 
4588
        return merger, allow_pending
 
4589
 
 
4590
    def get_merger_from_uncommitted(self, tree, location, pb):
 
4591
        """Get a merger for uncommitted changes.
 
4592
 
 
4593
        :param tree: The tree the merger should apply to.
 
4594
        :param location: The location containing uncommitted changes.
 
4595
        :param pb: The progress bar to use for showing progress.
 
4596
        """
 
4597
        location = self._select_branch_location(tree, location)[0]
 
4598
        other_tree, other_path = WorkingTree.open_containing(location)
 
4599
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
4600
        if other_path != '':
 
4601
            merger.interesting_files = [other_path]
 
4602
        return merger
 
4603
 
 
4604
    def _select_branch_location(self, tree, user_location, revision=None,
 
4605
                                index=None):
 
4606
        """Select a branch location, according to possible inputs.
 
4607
 
 
4608
        If provided, branches from ``revision`` are preferred.  (Both
 
4609
        ``revision`` and ``index`` must be supplied.)
 
4610
 
 
4611
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
4612
        ``submit`` or ``parent`` location is used, and a note is printed.
 
4613
 
 
4614
        :param tree: The working tree to select a branch for merging into
 
4615
        :param location: The location entered by the user
 
4616
        :param revision: The revision parameter to the command
 
4617
        :param index: The index to use for the revision parameter.  Negative
 
4618
            indices are permitted.
 
4619
        :return: (selected_location, user_location).  The default location
 
4620
            will be the user-entered location.
 
4621
        """
 
4622
        if (revision is not None and index is not None
 
4623
            and revision[index] is not None):
 
4624
            branch = revision[index].get_branch()
 
4625
            if branch is not None:
 
4626
                return branch, branch
 
4627
        if user_location is None:
 
4628
            location = self._get_remembered(tree, 'Merging from')
 
4629
        else:
 
4630
            location = user_location
 
4631
        return location, user_location
 
4632
 
 
4633
    def _get_remembered(self, tree, verb_string):
 
4634
        """Use tree.branch's parent if none was supplied.
 
4635
 
 
4636
        Report if the remembered location was used.
 
4637
        """
 
4638
        stored_location = tree.branch.get_submit_branch()
 
4639
        stored_location_type = "submit"
 
4640
        if stored_location is None:
 
4641
            stored_location = tree.branch.get_parent()
 
4642
            stored_location_type = "parent"
 
4643
        mutter("%s", stored_location)
 
4644
        if stored_location is None:
 
4645
            raise errors.BzrCommandError(gettext("No location specified or remembered"))
 
4646
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
4647
        note(gettext("{0} remembered {1} location {2}").format(verb_string,
 
4648
                stored_location_type, display_url))
 
4649
        return stored_location
 
4650
 
 
4651
 
 
4652
class cmd_remerge(Command):
 
4653
    __doc__ = """Redo a merge.
 
4654
 
 
4655
    Use this if you want to try a different merge technique while resolving
 
4656
    conflicts.  Some merge techniques are better than others, and remerge
 
4657
    lets you try different ones on different files.
 
4658
 
 
4659
    The options for remerge have the same meaning and defaults as the ones for
 
4660
    merge.  The difference is that remerge can (only) be run when there is a
 
4661
    pending merge, and it lets you specify particular files.
 
4662
 
 
4663
    :Examples:
 
4664
        Re-do the merge of all conflicted files, and show the base text in
 
4665
        conflict regions, in addition to the usual THIS and OTHER texts::
 
4666
 
 
4667
            bzr remerge --show-base
 
4668
 
 
4669
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
4670
        additional processing to reduce the size of conflict regions::
 
4671
 
 
4672
            bzr remerge --merge-type weave --reprocess foobar
 
4673
    """
 
4674
    takes_args = ['file*']
 
4675
    takes_options = [
 
4676
            'merge-type',
 
4677
            'reprocess',
 
4678
            Option('show-base',
 
4679
                   help="Show base revision text in conflicts."),
 
4680
            ]
 
4681
 
 
4682
    def run(self, file_list=None, merge_type=None, show_base=False,
 
4683
            reprocess=False):
 
4684
        from bzrlib.conflicts import restore
 
4685
        if merge_type is None:
 
4686
            merge_type = _mod_merge.Merge3Merger
 
4687
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4688
        self.add_cleanup(tree.lock_write().unlock)
 
4689
        parents = tree.get_parent_ids()
 
4690
        if len(parents) != 2:
 
4691
            raise errors.BzrCommandError(gettext("Sorry, remerge only works after normal"
 
4692
                                         " merges.  Not cherrypicking or"
 
4693
                                         " multi-merges."))
 
4694
        repository = tree.branch.repository
 
4695
        interesting_ids = None
 
4696
        new_conflicts = []
 
4697
        conflicts = tree.conflicts()
 
4698
        if file_list is not None:
 
4699
            interesting_ids = set()
 
4700
            for filename in file_list:
 
4701
                file_id = tree.path2id(filename)
 
4702
                if file_id is None:
 
4703
                    raise errors.NotVersionedError(filename)
 
4704
                interesting_ids.add(file_id)
 
4705
                if tree.kind(file_id) != "directory":
 
4706
                    continue
 
4707
 
 
4708
                # FIXME: Support nested trees
 
4709
                for name, ie in tree.root_inventory.iter_entries(file_id):
 
4710
                    interesting_ids.add(ie.file_id)
 
4711
            new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
4712
        else:
 
4713
            # Remerge only supports resolving contents conflicts
 
4714
            allowed_conflicts = ('text conflict', 'contents conflict')
 
4715
            restore_files = [c.path for c in conflicts
 
4716
                             if c.typestring in allowed_conflicts]
 
4717
        _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
4718
        tree.set_conflicts(ConflictList(new_conflicts))
 
4719
        if file_list is not None:
 
4720
            restore_files = file_list
 
4721
        for filename in restore_files:
 
4722
            try:
 
4723
                restore(tree.abspath(filename))
 
4724
            except errors.NotConflicted:
 
4725
                pass
 
4726
        # Disable pending merges, because the file texts we are remerging
 
4727
        # have not had those merges performed.  If we use the wrong parents
 
4728
        # list, we imply that the working tree text has seen and rejected
 
4729
        # all the changes from the other tree, when in fact those changes
 
4730
        # have not yet been seen.
 
4731
        tree.set_parent_ids(parents[:1])
 
4732
        try:
 
4733
            merger = _mod_merge.Merger.from_revision_ids(None, tree, parents[1])
 
4734
            merger.interesting_ids = interesting_ids
 
4735
            merger.merge_type = merge_type
 
4736
            merger.show_base = show_base
 
4737
            merger.reprocess = reprocess
 
4738
            conflicts = merger.do_merge()
 
4739
        finally:
 
4740
            tree.set_parent_ids(parents)
 
4741
        if conflicts > 0:
 
4742
            return 1
 
4743
        else:
 
4744
            return 0
1209
4745
 
1210
4746
 
1211
4747
class cmd_revert(Command):
1212
 
    """Reverse all changes since the last commit.
1213
 
 
1214
 
    Only versioned files are affected.  Specify filenames to revert only 
1215
 
    those files.  By default, any files that are changed will be backed up
1216
 
    first.  Backup files have a '~' appended to their name.
 
4748
    __doc__ = """\
 
4749
    Set files in the working tree back to the contents of a previous revision.
 
4750
 
 
4751
    Giving a list of files will revert only those files.  Otherwise, all files
 
4752
    will be reverted.  If the revision is not specified with '--revision', the
 
4753
    working tree basis revision is used. A revert operation affects only the
 
4754
    working tree, not any revision history like the branch and repository or
 
4755
    the working tree basis revision.
 
4756
 
 
4757
    To remove only some changes, without reverting to a prior version, use
 
4758
    merge instead.  For example, "merge . -r -2..-3" (don't forget the ".")
 
4759
    will remove the changes introduced by the second last commit (-2), without
 
4760
    affecting the changes introduced by the last commit (-1).  To remove
 
4761
    certain changes on a hunk-by-hunk basis, see the shelve command.
 
4762
    To update the branch to a specific revision or the latest revision and
 
4763
    update the working tree accordingly while preserving local changes, see the
 
4764
    update command.
 
4765
 
 
4766
    Uncommitted changes to files that are reverted will be discarded.
 
4767
    Howver, by default, any files that have been manually changed will be
 
4768
    backed up first.  (Files changed only by merge are not backed up.)  Backup
 
4769
    files have '.~#~' appended to their name, where # is a number.
 
4770
 
 
4771
    When you provide files, you can use their current pathname or the pathname
 
4772
    from the target revision.  So you can use revert to "undelete" a file by
 
4773
    name.  If you name a directory, all the contents of that directory will be
 
4774
    reverted.
 
4775
 
 
4776
    If you have newly added files since the target revision, they will be
 
4777
    removed.  If the files to be removed have been changed, backups will be
 
4778
    created as above.  Directories containing unknown files will not be
 
4779
    deleted.
 
4780
 
 
4781
    The working tree contains a list of revisions that have been merged but
 
4782
    not yet committed. These revisions will be included as additional parents
 
4783
    of the next commit.  Normally, using revert clears that list as well as
 
4784
    reverting the files.  If any files are specified, revert leaves the list
 
4785
    of uncommitted merges alone and reverts only the files.  Use ``bzr revert
 
4786
    .`` in the tree root to revert all files but keep the recorded merges,
 
4787
    and ``bzr revert --forget-merges`` to clear the pending merge list without
 
4788
    reverting any files.
 
4789
 
 
4790
    Using "bzr revert --forget-merges", it is possible to apply all of the
 
4791
    changes from a branch in a single revision.  To do this, perform the merge
 
4792
    as desired.  Then doing revert with the "--forget-merges" option will keep
 
4793
    the content of the tree as it was, but it will clear the list of pending
 
4794
    merges.  The next commit will then contain all of the changes that are
 
4795
    present in the other branch, but without any other parent revisions.
 
4796
    Because this technique forgets where these changes originated, it may
 
4797
    cause additional conflicts on later merges involving the same source and
 
4798
    target branches.
1217
4799
    """
1218
 
    takes_options = ['revision', 'no-backup']
 
4800
 
 
4801
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
4802
    takes_options = [
 
4803
        'revision',
 
4804
        Option('no-backup', "Do not save backups of reverted files."),
 
4805
        Option('forget-merges',
 
4806
               'Remove pending merge marker, without changing any files.'),
 
4807
        ]
1219
4808
    takes_args = ['file*']
1220
 
    aliases = ['merge-revert']
1221
 
 
1222
 
    def run(self, revision=None, no_backup=False, file_list=None):
1223
 
        from bzrlib.merge import merge
1224
 
        from bzrlib.branch import Branch
1225
 
        from bzrlib.commands import parse_spec
1226
 
 
1227
 
        if file_list is not None:
1228
 
            if len(file_list) == 0:
1229
 
                raise BzrCommandError("No files specified")
1230
 
        if revision is None:
1231
 
            revision = [-1]
1232
 
        elif len(revision) != 1:
1233
 
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
1234
 
        merge(('.', revision[0]), parse_spec('.'),
1235
 
              check_clean=False,
1236
 
              ignore_zero=True,
1237
 
              backup_files=not no_backup,
1238
 
              file_list=file_list)
1239
 
        if not file_list:
1240
 
            Branch('.').set_pending_merges([])
 
4809
 
 
4810
    def run(self, revision=None, no_backup=False, file_list=None,
 
4811
            forget_merges=None):
 
4812
        tree, file_list = WorkingTree.open_containing_paths(file_list)
 
4813
        self.add_cleanup(tree.lock_tree_write().unlock)
 
4814
        if forget_merges:
 
4815
            tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4816
        else:
 
4817
            self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4818
 
 
4819
    @staticmethod
 
4820
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
4821
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
4822
        tree.revert(file_list, rev_tree, not no_backup, None,
 
4823
            report_changes=True)
1241
4824
 
1242
4825
 
1243
4826
class cmd_assert_fail(Command):
1244
 
    """Test reporting of assertion failures"""
 
4827
    __doc__ = """Test reporting of assertion failures"""
 
4828
    # intended just for use in testing
 
4829
 
1245
4830
    hidden = True
 
4831
 
1246
4832
    def run(self):
1247
 
        assert False, "always fails"
 
4833
        raise AssertionError("always fails")
1248
4834
 
1249
4835
 
1250
4836
class cmd_help(Command):
1251
 
    """Show help on a command or other topic.
 
4837
    __doc__ = """Show help on a command or other topic.
 
4838
    """
1252
4839
 
1253
 
    For a list of all available commands, say 'bzr help commands'."""
1254
 
    takes_options = ['long']
 
4840
    _see_also = ['topics']
 
4841
    takes_options = [
 
4842
            Option('long', 'Show help on all commands.'),
 
4843
            ]
1255
4844
    takes_args = ['topic?']
1256
 
    aliases = ['?']
1257
 
    
 
4845
    aliases = ['?', '--help', '-?', '-h']
 
4846
 
 
4847
    @display_command
1258
4848
    def run(self, topic=None, long=False):
1259
 
        import help
 
4849
        import bzrlib.help
1260
4850
        if topic is None and long:
1261
4851
            topic = "commands"
1262
 
        help.help(topic)
 
4852
        bzrlib.help.help(topic)
1263
4853
 
1264
4854
 
1265
4855
class cmd_shell_complete(Command):
1266
 
    """Show appropriate completions for context.
 
4856
    __doc__ = """Show appropriate completions for context.
1267
4857
 
1268
 
    For a list of all available commands, say 'bzr shell-complete'."""
 
4858
    For a list of all available commands, say 'bzr shell-complete'.
 
4859
    """
1269
4860
    takes_args = ['context?']
1270
4861
    aliases = ['s-c']
1271
4862
    hidden = True
1272
 
    
 
4863
 
 
4864
    @display_command
1273
4865
    def run(self, context=None):
1274
 
        import shellcomplete
 
4866
        from bzrlib import shellcomplete
1275
4867
        shellcomplete.shellcomplete(context)
1276
4868
 
1277
4869
 
1278
4870
class cmd_missing(Command):
1279
 
    """What is missing in this branch relative to other branch.
 
4871
    __doc__ = """Show unmerged/unpulled revisions between two branches.
 
4872
 
 
4873
    OTHER_BRANCH may be local or remote.
 
4874
 
 
4875
    To filter on a range of revisions, you can use the command -r begin..end
 
4876
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
4877
    also valid.
 
4878
            
 
4879
    :Exit values:
 
4880
        1 - some missing revisions
 
4881
        0 - no missing revisions
 
4882
 
 
4883
    :Examples:
 
4884
 
 
4885
        Determine the missing revisions between this and the branch at the
 
4886
        remembered pull location::
 
4887
 
 
4888
            bzr missing
 
4889
 
 
4890
        Determine the missing revisions between this and another branch::
 
4891
 
 
4892
            bzr missing http://server/branch
 
4893
 
 
4894
        Determine the missing revisions up to a specific revision on the other
 
4895
        branch::
 
4896
 
 
4897
            bzr missing -r ..-10
 
4898
 
 
4899
        Determine the missing revisions up to a specific revision on this
 
4900
        branch::
 
4901
 
 
4902
            bzr missing --my-revision ..-10
1280
4903
    """
1281
 
    takes_args = ['remote?']
1282
 
    aliases = ['mis', 'miss']
1283
 
    # We don't have to add quiet to the list, because 
1284
 
    # unknown options are parsed as booleans
1285
 
    takes_options = ['verbose', 'quiet']
1286
 
 
1287
 
    def run(self, remote=None, verbose=False, quiet=False):
1288
 
        from bzrlib.errors import BzrCommandError
1289
 
        from bzrlib.missing import show_missing
1290
 
 
1291
 
        if verbose and quiet:
1292
 
            raise BzrCommandError('Cannot pass both quiet and verbose')
1293
 
 
1294
 
        b = find_branch('.')
1295
 
        parent = b.get_parent()
1296
 
        if remote is None:
1297
 
            if parent is None:
1298
 
                raise BzrCommandError("No missing location known or specified.")
 
4904
 
 
4905
    _see_also = ['merge', 'pull']
 
4906
    takes_args = ['other_branch?']
 
4907
    takes_options = [
 
4908
        'directory',
 
4909
        Option('reverse', 'Reverse the order of revisions.'),
 
4910
        Option('mine-only',
 
4911
               'Display changes in the local branch only.'),
 
4912
        Option('this' , 'Same as --mine-only.'),
 
4913
        Option('theirs-only',
 
4914
               'Display changes in the remote branch only.'),
 
4915
        Option('other', 'Same as --theirs-only.'),
 
4916
        'log-format',
 
4917
        'show-ids',
 
4918
        'verbose',
 
4919
        custom_help('revision',
 
4920
             help='Filter on other branch revisions (inclusive). '
 
4921
                'See "help revisionspec" for details.'),
 
4922
        Option('my-revision',
 
4923
            type=_parse_revision_str,
 
4924
            help='Filter on local branch revisions (inclusive). '
 
4925
                'See "help revisionspec" for details.'),
 
4926
        Option('include-merged',
 
4927
               'Show all revisions in addition to the mainline ones.'),
 
4928
        Option('include-merges', hidden=True,
 
4929
               help='Historical alias for --include-merged.'),
 
4930
        ]
 
4931
    encoding_type = 'replace'
 
4932
 
 
4933
    @display_command
 
4934
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
4935
            theirs_only=False,
 
4936
            log_format=None, long=False, short=False, line=False,
 
4937
            show_ids=False, verbose=False, this=False, other=False,
 
4938
            include_merged=None, revision=None, my_revision=None,
 
4939
            directory=u'.',
 
4940
            include_merges=symbol_versioning.DEPRECATED_PARAMETER):
 
4941
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
4942
        def message(s):
 
4943
            if not is_quiet():
 
4944
                self.outf.write(s)
 
4945
 
 
4946
        if symbol_versioning.deprecated_passed(include_merges):
 
4947
            ui.ui_factory.show_user_warning(
 
4948
                'deprecated_command_option',
 
4949
                deprecated_name='--include-merges',
 
4950
                recommended_name='--include-merged',
 
4951
                deprecated_in_version='2.5',
 
4952
                command=self.invoked_as)
 
4953
            if include_merged is None:
 
4954
                include_merged = include_merges
1299
4955
            else:
1300
 
                if not quiet:
1301
 
                    print "Using last location: %s" % parent
1302
 
                remote = parent
1303
 
        elif parent is None:
1304
 
            # We only update x-pull if it did not exist, missing should not change the parent
1305
 
            b.controlfile('x-pull', 'wb').write(remote + '\n')
1306
 
        br_remote = find_branch(remote)
1307
 
 
1308
 
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
1309
 
 
 
4956
                raise errors.BzrCommandError(gettext(
 
4957
                    '{0} and {1} are mutually exclusive').format(
 
4958
                    '--include-merges', '--include-merged'))
 
4959
        if include_merged is None:
 
4960
            include_merged = False
 
4961
        if this:
 
4962
            mine_only = this
 
4963
        if other:
 
4964
            theirs_only = other
 
4965
        # TODO: We should probably check that we don't have mine-only and
 
4966
        #       theirs-only set, but it gets complicated because we also have
 
4967
        #       this and other which could be used.
 
4968
        restrict = 'all'
 
4969
        if mine_only:
 
4970
            restrict = 'local'
 
4971
        elif theirs_only:
 
4972
            restrict = 'remote'
 
4973
 
 
4974
        local_branch = Branch.open_containing(directory)[0]
 
4975
        self.add_cleanup(local_branch.lock_read().unlock)
 
4976
 
 
4977
        parent = local_branch.get_parent()
 
4978
        if other_branch is None:
 
4979
            other_branch = parent
 
4980
            if other_branch is None:
 
4981
                raise errors.BzrCommandError(gettext("No peer location known"
 
4982
                                             " or specified."))
 
4983
            display_url = urlutils.unescape_for_display(parent,
 
4984
                                                        self.outf.encoding)
 
4985
            message(gettext("Using saved parent location: {0}\n").format(
 
4986
                    display_url))
 
4987
 
 
4988
        remote_branch = Branch.open(other_branch)
 
4989
        if remote_branch.base == local_branch.base:
 
4990
            remote_branch = local_branch
 
4991
        else:
 
4992
            self.add_cleanup(remote_branch.lock_read().unlock)
 
4993
 
 
4994
        local_revid_range = _revision_range_to_revid_range(
 
4995
            _get_revision_range(my_revision, local_branch,
 
4996
                self.name()))
 
4997
 
 
4998
        remote_revid_range = _revision_range_to_revid_range(
 
4999
            _get_revision_range(revision,
 
5000
                remote_branch, self.name()))
 
5001
 
 
5002
        local_extra, remote_extra = find_unmerged(
 
5003
            local_branch, remote_branch, restrict,
 
5004
            backward=not reverse,
 
5005
            include_merged=include_merged,
 
5006
            local_revid_range=local_revid_range,
 
5007
            remote_revid_range=remote_revid_range)
 
5008
 
 
5009
        if log_format is None:
 
5010
            registry = log.log_formatter_registry
 
5011
            log_format = registry.get_default(local_branch)
 
5012
        lf = log_format(to_file=self.outf,
 
5013
                        show_ids=show_ids,
 
5014
                        show_timezone='original')
 
5015
 
 
5016
        status_code = 0
 
5017
        if local_extra and not theirs_only:
 
5018
            message(ngettext("You have %d extra revision:\n",
 
5019
                             "You have %d extra revisions:\n", 
 
5020
                             len(local_extra)) %
 
5021
                len(local_extra))
 
5022
            rev_tag_dict = {}
 
5023
            if local_branch.supports_tags():
 
5024
                rev_tag_dict = local_branch.tags.get_reverse_tag_dict()
 
5025
            for revision in iter_log_revisions(local_extra,
 
5026
                                local_branch.repository,
 
5027
                                verbose,
 
5028
                                rev_tag_dict):
 
5029
                lf.log_revision(revision)
 
5030
            printed_local = True
 
5031
            status_code = 1
 
5032
        else:
 
5033
            printed_local = False
 
5034
 
 
5035
        if remote_extra and not mine_only:
 
5036
            if printed_local is True:
 
5037
                message("\n\n\n")
 
5038
            message(ngettext("You are missing %d revision:\n",
 
5039
                             "You are missing %d revisions:\n",
 
5040
                             len(remote_extra)) %
 
5041
                len(remote_extra))
 
5042
            if remote_branch.supports_tags():
 
5043
                rev_tag_dict = remote_branch.tags.get_reverse_tag_dict()
 
5044
            for revision in iter_log_revisions(remote_extra,
 
5045
                                remote_branch.repository,
 
5046
                                verbose,
 
5047
                                rev_tag_dict):
 
5048
                lf.log_revision(revision)
 
5049
            status_code = 1
 
5050
 
 
5051
        if mine_only and not local_extra:
 
5052
            # We checked local, and found nothing extra
 
5053
            message(gettext('This branch has no new revisions.\n'))
 
5054
        elif theirs_only and not remote_extra:
 
5055
            # We checked remote, and found nothing extra
 
5056
            message(gettext('Other branch has no new revisions.\n'))
 
5057
        elif not (mine_only or theirs_only or local_extra or
 
5058
                  remote_extra):
 
5059
            # We checked both branches, and neither one had extra
 
5060
            # revisions
 
5061
            message(gettext("Branches are up to date.\n"))
 
5062
        self.cleanup_now()
 
5063
        if not status_code and parent is None and other_branch is not None:
 
5064
            self.add_cleanup(local_branch.lock_write().unlock)
 
5065
            # handle race conditions - a parent might be set while we run.
 
5066
            if local_branch.get_parent() is None:
 
5067
                local_branch.set_parent(remote_branch.base)
 
5068
        return status_code
 
5069
 
 
5070
 
 
5071
class cmd_pack(Command):
 
5072
    __doc__ = """Compress the data within a repository.
 
5073
 
 
5074
    This operation compresses the data within a bazaar repository. As
 
5075
    bazaar supports automatic packing of repository, this operation is
 
5076
    normally not required to be done manually.
 
5077
 
 
5078
    During the pack operation, bazaar takes a backup of existing repository
 
5079
    data, i.e. pack files. This backup is eventually removed by bazaar
 
5080
    automatically when it is safe to do so. To save disk space by removing
 
5081
    the backed up pack files, the --clean-obsolete-packs option may be
 
5082
    used.
 
5083
 
 
5084
    Warning: If you use --clean-obsolete-packs and your machine crashes
 
5085
    during or immediately after repacking, you may be left with a state
 
5086
    where the deletion has been written to disk but the new packs have not
 
5087
    been. In this case the repository may be unusable.
 
5088
    """
 
5089
 
 
5090
    _see_also = ['repositories']
 
5091
    takes_args = ['branch_or_repo?']
 
5092
    takes_options = [
 
5093
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
 
5094
        ]
 
5095
 
 
5096
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
5097
        dir = controldir.ControlDir.open_containing(branch_or_repo)[0]
 
5098
        try:
 
5099
            branch = dir.open_branch()
 
5100
            repository = branch.repository
 
5101
        except errors.NotBranchError:
 
5102
            repository = dir.open_repository()
 
5103
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
1310
5104
 
1311
5105
 
1312
5106
class cmd_plugins(Command):
1313
 
    """List plugins"""
1314
 
    hidden = True
1315
 
    def run(self):
1316
 
        import bzrlib.plugin
1317
 
        from inspect import getdoc
1318
 
        for plugin in bzrlib.plugin.all_plugins:
1319
 
            if hasattr(plugin, '__path__'):
1320
 
                print plugin.__path__[0]
1321
 
            elif hasattr(plugin, '__file__'):
1322
 
                print plugin.__file__
1323
 
            else:
1324
 
                print `plugin`
1325
 
                
1326
 
            d = getdoc(plugin)
1327
 
            if d:
1328
 
                print '\t', d.split('\n')[0]
1329
 
 
1330
 
 
 
5107
    __doc__ = """List the installed plugins.
 
5108
 
 
5109
    This command displays the list of installed plugins including
 
5110
    version of plugin and a short description of each.
 
5111
 
 
5112
    --verbose shows the path where each plugin is located.
 
5113
 
 
5114
    A plugin is an external component for Bazaar that extends the
 
5115
    revision control system, by adding or replacing code in Bazaar.
 
5116
    Plugins can do a variety of things, including overriding commands,
 
5117
    adding new commands, providing additional network transports and
 
5118
    customizing log output.
 
5119
 
 
5120
    See the Bazaar Plugin Guide <http://doc.bazaar.canonical.com/plugins/en/>
 
5121
    for further information on plugins including where to find them and how to
 
5122
    install them. Instructions are also provided there on how to write new
 
5123
    plugins using the Python programming language.
 
5124
    """
 
5125
    takes_options = ['verbose']
 
5126
 
 
5127
    @display_command
 
5128
    def run(self, verbose=False):
 
5129
        from bzrlib import plugin
 
5130
        # Don't give writelines a generator as some codecs don't like that
 
5131
        self.outf.writelines(
 
5132
            list(plugin.describe_plugins(show_paths=verbose)))
 
5133
 
 
5134
 
 
5135
class cmd_testament(Command):
 
5136
    __doc__ = """Show testament (signing-form) of a revision."""
 
5137
    takes_options = [
 
5138
            'revision',
 
5139
            Option('long', help='Produce long-format testament.'),
 
5140
            Option('strict',
 
5141
                   help='Produce a strict-format testament.')]
 
5142
    takes_args = ['branch?']
 
5143
    encoding_type = 'exact'
 
5144
    @display_command
 
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
            self.outf.writelines(t.as_text_lines())
 
5163
        else:
 
5164
            self.outf.write(t.as_short_text())
 
5165
 
 
5166
 
 
5167
class cmd_annotate(Command):
 
5168
    __doc__ = """Show the origin of each line in a file.
 
5169
 
 
5170
    This prints out the given file with an annotation on the left side
 
5171
    indicating which revision, author and date introduced the change.
 
5172
 
 
5173
    If the origin is the same for a run of consecutive lines, it is
 
5174
    shown only at the top, unless the --all option is given.
 
5175
    """
 
5176
    # TODO: annotate directories; showing when each file was last changed
 
5177
    # TODO: if the working copy is modified, show annotations on that
 
5178
    #       with new uncommitted lines marked
 
5179
    aliases = ['ann', 'blame', 'praise']
 
5180
    takes_args = ['filename']
 
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',
 
5186
                     ]
 
5187
    encoding_type = 'exact'
 
5188
 
 
5189
    @display_command
 
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)
 
5217
 
 
5218
 
 
5219
class cmd_re_sign(Command):
 
5220
    __doc__ = """Create a digital signature for an existing revision."""
 
5221
    # TODO be able to replace existing ones.
 
5222
 
 
5223
    hidden = True # is this right ?
 
5224
    takes_args = ['revision_id*']
 
5225
    takes_options = ['directory', 'revision']
 
5226
 
 
5227
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
5228
        if revision_id_list is not None and revision is not None:
 
5229
            raise errors.BzrCommandError(gettext('You can only supply one of revision_id or --revision'))
 
5230
        if revision_id_list is None and revision is None:
 
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())
 
5239
        if revision_id_list is not None:
 
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()
 
5249
        elif revision is not None:
 
5250
            if len(revision) == 1:
 
5251
                revno, rev_id = revision[0].in_history(b)
 
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()
 
5260
            elif len(revision) == 2:
 
5261
                # are they both on rh- if so we can walk between them
 
5262
                # might be nice to have a range helper for arbitrary
 
5263
                # revision paths. hmm.
 
5264
                from_revno, from_revid = revision[0].in_history(b)
 
5265
                to_revno, to_revid = revision[1].in_history(b)
 
5266
                if to_revid is None:
 
5267
                    to_revno = b.revno()
 
5268
                if from_revno is None or to_revno is None:
 
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()
 
5280
            else:
 
5281
                raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
 
5282
 
 
5283
 
 
5284
class cmd_bind(Command):
 
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.
 
5294
    """
 
5295
 
 
5296
    _see_also = ['checkouts', 'unbind']
 
5297
    takes_args = ['location?']
 
5298
    takes_options = ['directory']
 
5299
 
 
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'))
 
5317
        b_other = Branch.open(location)
 
5318
        try:
 
5319
            b.bind(b_other)
 
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
 
5325
 
 
5326
 
 
5327
class cmd_unbind(Command):
 
5328
    __doc__ = """Convert the current checkout into a regular branch.
 
5329
 
 
5330
    After unbinding, the local branch is considered independent and subsequent
 
5331
    commits will be local only.
 
5332
    """
 
5333
 
 
5334
    _see_also = ['checkouts', 'bind']
 
5335
    takes_args = []
 
5336
    takes_options = ['directory']
 
5337
 
 
5338
    def run(self, directory=u'.'):
 
5339
        b, relpath = Branch.open_containing(directory)
 
5340
        if not b.unbind():
 
5341
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
 
5342
 
 
5343
 
 
5344
class cmd_uncommit(Command):
 
5345
    __doc__ = """Remove the last committed revision.
 
5346
 
 
5347
    --verbose will print out what is being removed.
 
5348
    --dry-run will go through all the motions, but not actually
 
5349
    remove anything.
 
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.
 
5358
    """
 
5359
 
 
5360
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
5361
    # unreferenced information in 'branch-as-repository' branches.
 
5362
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
5363
    # information in shared branches as well.
 
5364
    _see_also = ['commit']
 
5365
    takes_options = ['verbose', 'revision',
 
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
                    ]
 
5375
    takes_args = ['location?']
 
5376
    aliases = []
 
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):
 
5381
        if location is None:
 
5382
            location = u'.'
 
5383
        control, relpath = controldir.ControlDir.open_containing(location)
 
5384
        try:
 
5385
            tree = control.open_workingtree()
 
5386
            b = tree.branch
 
5387
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
5388
            tree = None
 
5389
            b = control.open_branch()
 
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
 
5406
        if revision is None:
 
5407
            revno = last_revno
 
5408
            rev_id = last_rev_id
 
5409
        else:
 
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)
 
5433
 
 
5434
        if dry_run:
 
5435
            self.outf.write(gettext('Dry-run, pretending to remove'
 
5436
                            ' the above revisions.\n'))
 
5437
        else:
 
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)
 
5450
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
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)
 
5454
 
 
5455
 
 
5456
class cmd_break_lock(Command):
 
5457
    __doc__ = """Break a dead lock.
 
5458
 
 
5459
    This command breaks a lock on a repository, branch, working directory or
 
5460
    config file.
 
5461
 
 
5462
    CAUTION: Locks should only be broken when you are sure that the process
 
5463
    holding the lock has been stopped.
 
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.'),
 
6238
                    ]
 
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_ping', [], 'bzrlib.smart.ping'),
 
6731
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
 
6732
        ('cmd_verify_signatures', [], 'bzrlib.commit_signature_commands'),
 
6733
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
 
6734
        ]:
 
6735
        builtin_command_registry.register_lazy(name, aliases, module_name)