/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: 2020-01-31 17:43:44 UTC
  • mto: This revision was merged to the branch mainline in revision 7478.
  • Revision ID: jelmer@jelmer.uk-20200131174344-qjhgqm7bdkuqj9sj
Default to running Python 3.

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