← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2009-07-13 06:58:49 UTC
  • mto: (4527.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4529.
  • Revision ID: ian.clatworthy@canonical.com-20090713065849-n7g2rsjyl6dt1mgv
Apply review feedback

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