/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: John Arbash Meinel
  • Date: 2010-01-12 22:51:31 UTC
  • mto: This revision was merged to the branch mainline in revision 4955.
  • Revision ID: john@arbash-meinel.com-20100112225131-he8h411p6aeeb947
Delay grabbing an output stream until we actually go to show a diff.

This makes the test suite happy, but it also seems to be reasonable.
If we aren't going to write anything, we don't need to hold an
output stream open.

Show diffs side-by-side

added added

removed removed

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