/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2009-07-01 15:17:33 UTC
  • mto: (4498.2.2 integration)
  • mto: This revision was merged to the branch mainline in revision 4501.
  • Revision ID: v.ladeuil+lp@free.fr-20090701151733-i34hbbl7e2e1ta2o
Fixed as per John's review.

* bzrlib/tests/blackbox/test_send.py:
(load_tests): Delete spurious spaces in dict() definition.
(TestSendStrictWithChanges.setUp): Clarify the intent and mean of
the parametrization.

* bzrlib/send.py:
(send): Oops, fix the error messages.

Show diffs side-by-side

added added

removed removed

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