/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 TestCase.make_branch_builder to make a branch in the specified format.  Also add an interrepo test scenario for KnitPack1 -> KnitPack6RichRoot, which fails.

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