/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to breezy/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2017-11-11 12:51:45 UTC
  • mto: This revision was merged to the branch mainline in revision 6804.
  • Revision ID: jelmer@jelmer.uk-20171111125145-zw639zp14j8b2cin
Bunch of developer docs changes:

 * Move plans to plans/
 * Move performance analysis & planning docs to plans/performance/
 * Change Bazaar references to Breezy
 * Add branding guidelines

Show diffs side-by-side

added added

removed removed

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