/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

Make --parallel=fork compatible with --subunit.

* bzrlib/tests/__init__.py:
(BzrAutoTimingTestResultDecorator): Defines our own specialized
decorator to address bug #419776 until subunit provides native
support.

Show diffs side-by-side

added added

removed removed

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