/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 bzrlib/builtins.py

Fix 1 more lock-related test failure.

* tests/test_rename_map.py:
(TestRenameMap.test_guess_renames_preserves_children): Add the
forgotten unlock.

Show diffs side-by-side

added added

removed removed

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