/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-02-18 21:42:57 UTC
  • mto: This revision was merged to the branch mainline in revision 6859.
  • Revision ID: jelmer@jelmer.uk-20180218214257-jpevutp1wa30tz3v
Update TODO to reference Breezy, not Bazaar.

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