/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: 2018-05-07 15:27:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6958.
  • Revision ID: jelmer@jelmer.uk-20180507152739-fuv9z9r0yzi7ln3t
Specify source in .coveragerc.

Show diffs side-by-side

added added

removed removed

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