/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2009-10-19 15:45:10 UTC
  • mto: This revision was merged to the branch mainline in revision 4758.
  • Revision ID: john@arbash-meinel.com-20091019154510-tr02ifha84pmo3zh
Add .clear_cache() members to GraphIndexBuilder and BTreeBuilder.

Update GroupCompressVersionedFiles.clear_cache() to clear the graph index's caches.

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
        if file_list:
 
2280
            # find the file ids to log and check for directory filtering
 
2281
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2282
                file_list)
 
2283
            for relpath, file_id, kind in file_info_list:
 
2284
                if file_id is None:
 
2285
                    raise errors.BzrCommandError(
 
2286
                        "Path unknown at end or start of revision range: %s" %
 
2287
                        relpath)
 
2288
                # If the relpath is the top of the tree, we log everything
 
2289
                if relpath == '':
 
2290
                    file_ids = []
 
2291
                    break
 
2292
                else:
 
2293
                    file_ids.append(file_id)
 
2294
                filter_by_dir = filter_by_dir or (
 
2295
                    kind in ['directory', 'tree-reference'])
 
2296
        else:
 
2297
            # log everything
 
2298
            # FIXME ? log the current subdir only RBC 20060203
 
2299
            if revision is not None \
 
2300
                    and len(revision) > 0 and revision[0].get_branch():
 
2301
                location = revision[0].get_branch()
 
2302
            else:
 
2303
                location = '.'
 
2304
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2305
            b = dir.open_branch()
 
2306
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2307
 
 
2308
        # Decide on the type of delta & diff filtering to use
 
2309
        # TODO: add an --all-files option to make this configurable & consistent
 
2310
        if not verbose:
 
2311
            delta_type = None
 
2312
        else:
 
2313
            delta_type = 'full'
 
2314
        if not show_diff:
 
2315
            diff_type = None
 
2316
        elif file_ids:
 
2317
            diff_type = 'partial'
 
2318
        else:
 
2319
            diff_type = 'full'
 
2320
 
 
2321
        b.lock_read()
 
2322
        try:
 
2323
            # Build the log formatter
 
2324
            if log_format is None:
 
2325
                log_format = log.log_formatter_registry.get_default(b)
 
2326
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2327
                            show_timezone=timezone,
 
2328
                            delta_format=get_verbosity_level(),
 
2329
                            levels=levels,
 
2330
                            show_advice=levels is None)
 
2331
 
 
2332
            # Choose the algorithm for doing the logging. It's annoying
 
2333
            # having multiple code paths like this but necessary until
 
2334
            # the underlying repository format is faster at generating
 
2335
            # deltas or can provide everything we need from the indices.
 
2336
            # The default algorithm - match-using-deltas - works for
 
2337
            # multiple files and directories and is faster for small
 
2338
            # amounts of history (200 revisions say). However, it's too
 
2339
            # slow for logging a single file in a repository with deep
 
2340
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2341
            # evil when adding features", we continue to use the
 
2342
            # original algorithm - per-file-graph - for the "single
 
2343
            # file that isn't a directory without showing a delta" case.
 
2344
            partial_history = revision and b.repository._format.supports_chks
 
2345
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2346
                or delta_type or partial_history)
 
2347
 
 
2348
            # Build the LogRequest and execute it
 
2349
            if len(file_ids) == 0:
 
2350
                file_ids = None
 
2351
            rqst = make_log_request_dict(
 
2352
                direction=direction, specific_fileids=file_ids,
 
2353
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2354
                message_search=message, delta_type=delta_type,
 
2355
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2356
            Logger(b, rqst).show(lf)
 
2357
        finally:
 
2358
            b.unlock()
 
2359
 
 
2360
 
 
2361
def _get_revision_range(revisionspec_list, branch, command_name):
 
2362
    """Take the input of a revision option and turn it into a revision range.
 
2363
 
 
2364
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2365
    of the desired revisions. It does some user input validations.
 
2366
    """
 
2367
    if revisionspec_list is None:
 
2368
        rev1 = None
 
2369
        rev2 = None
 
2370
    elif len(revisionspec_list) == 1:
 
2371
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2372
    elif len(revisionspec_list) == 2:
 
2373
        start_spec = revisionspec_list[0]
 
2374
        end_spec = revisionspec_list[1]
 
2375
        if end_spec.get_branch() != start_spec.get_branch():
 
2376
            # b is taken from revision[0].get_branch(), and
 
2377
            # show_log will use its revision_history. Having
 
2378
            # different branches will lead to weird behaviors.
 
2379
            raise errors.BzrCommandError(
 
2380
                "bzr %s doesn't accept two revisions in different"
 
2381
                " branches." % command_name)
 
2382
        rev1 = start_spec.in_history(branch)
 
2383
        # Avoid loading all of history when we know a missing
 
2384
        # end of range means the last revision ...
 
2385
        if end_spec.spec is None:
 
2386
            last_revno, last_revision_id = branch.last_revision_info()
 
2387
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2388
        else:
 
2389
            rev2 = end_spec.in_history(branch)
 
2390
    else:
 
2391
        raise errors.BzrCommandError(
 
2392
            'bzr %s --revision takes one or two values.' % command_name)
 
2393
    return rev1, rev2
 
2394
 
 
2395
 
 
2396
def _revision_range_to_revid_range(revision_range):
 
2397
    rev_id1 = None
 
2398
    rev_id2 = None
 
2399
    if revision_range[0] is not None:
 
2400
        rev_id1 = revision_range[0].rev_id
 
2401
    if revision_range[1] is not None:
 
2402
        rev_id2 = revision_range[1].rev_id
 
2403
    return rev_id1, rev_id2
 
2404
 
 
2405
def get_log_format(long=False, short=False, line=False, default='long'):
 
2406
    log_format = default
 
2407
    if long:
 
2408
        log_format = 'long'
 
2409
    if short:
 
2410
        log_format = 'short'
 
2411
    if line:
 
2412
        log_format = 'line'
 
2413
    return log_format
 
2414
 
 
2415
 
 
2416
class cmd_touching_revisions(Command):
 
2417
    """Return revision-ids which affected a particular file.
 
2418
 
 
2419
    A more user-friendly interface is "bzr log FILE".
 
2420
    """
 
2421
 
 
2422
    hidden = True
 
2423
    takes_args = ["filename"]
 
2424
 
 
2425
    @display_command
 
2426
    def run(self, filename):
 
2427
        tree, relpath = WorkingTree.open_containing(filename)
 
2428
        b = tree.branch
 
2429
        file_id = tree.path2id(relpath)
 
2430
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2431
            self.outf.write("%6d %s\n" % (revno, what))
 
2432
 
 
2433
 
 
2434
class cmd_ls(Command):
 
2435
    """List files in a tree.
 
2436
    """
 
2437
 
 
2438
    _see_also = ['status', 'cat']
 
2439
    takes_args = ['path?']
 
2440
    takes_options = [
 
2441
            'verbose',
 
2442
            'revision',
 
2443
            Option('recursive', short_name='R',
 
2444
                   help='Recurse into subdirectories.'),
 
2445
            Option('from-root',
 
2446
                   help='Print paths relative to the root of the branch.'),
 
2447
            Option('unknown', help='Print unknown files.'),
 
2448
            Option('versioned', help='Print versioned files.',
 
2449
                   short_name='V'),
 
2450
            Option('ignored', help='Print ignored files.'),
 
2451
            Option('null',
 
2452
                   help='Write an ascii NUL (\\0) separator '
 
2453
                   'between files rather than a newline.'),
 
2454
            Option('kind',
 
2455
                   help='List entries of a particular kind: file, directory, symlink.',
 
2456
                   type=unicode),
 
2457
            'show-ids',
 
2458
            ]
 
2459
    @display_command
 
2460
    def run(self, revision=None, verbose=False,
 
2461
            recursive=False, from_root=False,
 
2462
            unknown=False, versioned=False, ignored=False,
 
2463
            null=False, kind=None, show_ids=False, path=None):
 
2464
 
 
2465
        if kind and kind not in ('file', 'directory', 'symlink'):
 
2466
            raise errors.BzrCommandError('invalid kind specified')
 
2467
 
 
2468
        if verbose and null:
 
2469
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2470
        all = not (unknown or versioned or ignored)
 
2471
 
 
2472
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
2473
 
 
2474
        if path is None:
 
2475
            fs_path = '.'
 
2476
        else:
 
2477
            if from_root:
 
2478
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2479
                                             ' and PATH')
 
2480
            fs_path = path
 
2481
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2482
            fs_path)
 
2483
 
 
2484
        # Calculate the prefix to use
 
2485
        prefix = None
 
2486
        if from_root:
 
2487
            if relpath:
 
2488
                prefix = relpath + '/'
 
2489
        elif fs_path != '.':
 
2490
            prefix = fs_path + '/'
 
2491
 
 
2492
        if revision is not None or tree is None:
 
2493
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
2494
 
 
2495
        apply_view = False
 
2496
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
2497
            view_files = tree.views.lookup_view()
 
2498
            if view_files:
 
2499
                apply_view = True
 
2500
                view_str = views.view_display_str(view_files)
 
2501
                note("Ignoring files outside view. View is %s" % view_str)
 
2502
 
 
2503
        tree.lock_read()
 
2504
        try:
 
2505
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False,
 
2506
                from_dir=relpath, recursive=recursive):
 
2507
                # Apply additional masking
 
2508
                if not all and not selection[fc]:
 
2509
                    continue
 
2510
                if kind is not None and fkind != kind:
 
2511
                    continue
 
2512
                if apply_view:
 
2513
                    try:
 
2514
                        if relpath:
 
2515
                            fullpath = osutils.pathjoin(relpath, fp)
 
2516
                        else:
 
2517
                            fullpath = fp
 
2518
                        views.check_path_in_view(tree, fullpath)
 
2519
                    except errors.FileOutsideView:
 
2520
                        continue
 
2521
 
 
2522
                # Output the entry
 
2523
                if prefix:
 
2524
                    fp = osutils.pathjoin(prefix, fp)
 
2525
                kindch = entry.kind_character()
 
2526
                outstring = fp + kindch
 
2527
                ui.ui_factory.clear_term()
 
2528
                if verbose:
 
2529
                    outstring = '%-8s %s' % (fc, outstring)
 
2530
                    if show_ids and fid is not None:
 
2531
                        outstring = "%-50s %s" % (outstring, fid)
 
2532
                    self.outf.write(outstring + '\n')
 
2533
                elif null:
 
2534
                    self.outf.write(fp + '\0')
 
2535
                    if show_ids:
 
2536
                        if fid is not None:
 
2537
                            self.outf.write(fid)
 
2538
                        self.outf.write('\0')
 
2539
                    self.outf.flush()
 
2540
                else:
 
2541
                    if show_ids:
 
2542
                        if fid is not None:
 
2543
                            my_id = fid
 
2544
                        else:
 
2545
                            my_id = ''
 
2546
                        self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2547
                    else:
 
2548
                        self.outf.write(outstring + '\n')
 
2549
        finally:
 
2550
            tree.unlock()
 
2551
 
 
2552
 
 
2553
class cmd_unknowns(Command):
 
2554
    """List unknown files.
 
2555
    """
 
2556
 
 
2557
    hidden = True
 
2558
    _see_also = ['ls']
 
2559
 
 
2560
    @display_command
 
2561
    def run(self):
 
2562
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2563
            self.outf.write(osutils.quotefn(f) + '\n')
 
2564
 
 
2565
 
 
2566
class cmd_ignore(Command):
 
2567
    """Ignore specified files or patterns.
 
2568
 
 
2569
    See ``bzr help patterns`` for details on the syntax of patterns.
 
2570
 
 
2571
    To remove patterns from the ignore list, edit the .bzrignore file.
 
2572
    After adding, editing or deleting that file either indirectly by
 
2573
    using this command or directly by using an editor, be sure to commit
 
2574
    it.
 
2575
 
 
2576
    Note: ignore patterns containing shell wildcards must be quoted from
 
2577
    the shell on Unix.
 
2578
 
 
2579
    :Examples:
 
2580
        Ignore the top level Makefile::
 
2581
 
 
2582
            bzr ignore ./Makefile
 
2583
 
 
2584
        Ignore class files in all directories::
 
2585
 
 
2586
            bzr ignore "*.class"
 
2587
 
 
2588
        Ignore .o files under the lib directory::
 
2589
 
 
2590
            bzr ignore "lib/**/*.o"
 
2591
 
 
2592
        Ignore .o files under the lib directory::
 
2593
 
 
2594
            bzr ignore "RE:lib/.*\.o"
 
2595
 
 
2596
        Ignore everything but the "debian" toplevel directory::
 
2597
 
 
2598
            bzr ignore "RE:(?!debian/).*"
 
2599
    """
 
2600
 
 
2601
    _see_also = ['status', 'ignored', 'patterns']
 
2602
    takes_args = ['name_pattern*']
 
2603
    takes_options = [
 
2604
        Option('old-default-rules',
 
2605
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2606
        ]
 
2607
 
 
2608
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2609
        from bzrlib import ignores
 
2610
        if old_default_rules is not None:
 
2611
            # dump the rules and exit
 
2612
            for pattern in ignores.OLD_DEFAULTS:
 
2613
                print pattern
 
2614
            return
 
2615
        if not name_pattern_list:
 
2616
            raise errors.BzrCommandError("ignore requires at least one "
 
2617
                                  "NAME_PATTERN or --old-default-rules")
 
2618
        name_pattern_list = [globbing.normalize_pattern(p)
 
2619
                             for p in name_pattern_list]
 
2620
        for name_pattern in name_pattern_list:
 
2621
            if (name_pattern[0] == '/' or
 
2622
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2623
                raise errors.BzrCommandError(
 
2624
                    "NAME_PATTERN should not be an absolute path")
 
2625
        tree, relpath = WorkingTree.open_containing(u'.')
 
2626
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
2627
        ignored = globbing.Globster(name_pattern_list)
 
2628
        matches = []
 
2629
        tree.lock_read()
 
2630
        for entry in tree.list_files():
 
2631
            id = entry[3]
 
2632
            if id is not None:
 
2633
                filename = entry[0]
 
2634
                if ignored.match(filename):
 
2635
                    matches.append(filename.encode('utf-8'))
 
2636
        tree.unlock()
 
2637
        if len(matches) > 0:
 
2638
            print "Warning: the following files are version controlled and" \
 
2639
                  " match your ignore pattern:\n%s" \
 
2640
                  "\nThese files will continue to be version controlled" \
 
2641
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2642
 
 
2643
 
 
2644
class cmd_ignored(Command):
 
2645
    """List ignored files and the patterns that matched them.
 
2646
 
 
2647
    List all the ignored files and the ignore pattern that caused the file to
 
2648
    be ignored.
 
2649
 
 
2650
    Alternatively, to list just the files::
 
2651
 
 
2652
        bzr ls --ignored
 
2653
    """
 
2654
 
 
2655
    encoding_type = 'replace'
 
2656
    _see_also = ['ignore', 'ls']
 
2657
 
 
2658
    @display_command
 
2659
    def run(self):
 
2660
        tree = WorkingTree.open_containing(u'.')[0]
 
2661
        tree.lock_read()
 
2662
        try:
 
2663
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2664
                if file_class != 'I':
 
2665
                    continue
 
2666
                ## XXX: Slightly inefficient since this was already calculated
 
2667
                pat = tree.is_ignored(path)
 
2668
                self.outf.write('%-50s %s\n' % (path, pat))
 
2669
        finally:
 
2670
            tree.unlock()
 
2671
 
 
2672
 
 
2673
class cmd_lookup_revision(Command):
 
2674
    """Lookup the revision-id from a revision-number
 
2675
 
 
2676
    :Examples:
 
2677
        bzr lookup-revision 33
 
2678
    """
 
2679
    hidden = True
 
2680
    takes_args = ['revno']
 
2681
 
 
2682
    @display_command
 
2683
    def run(self, revno):
 
2684
        try:
 
2685
            revno = int(revno)
 
2686
        except ValueError:
 
2687
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2688
 
 
2689
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2690
 
 
2691
 
 
2692
class cmd_export(Command):
 
2693
    """Export current or past revision to a destination directory or archive.
 
2694
 
 
2695
    If no revision is specified this exports the last committed revision.
 
2696
 
 
2697
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2698
    given, try to find the format with the extension. If no extension
 
2699
    is found exports to a directory (equivalent to --format=dir).
 
2700
 
 
2701
    If root is supplied, it will be used as the root directory inside
 
2702
    container formats (tar, zip, etc). If it is not supplied it will default
 
2703
    to the exported filename. The root option has no effect for 'dir' format.
 
2704
 
 
2705
    If branch is omitted then the branch containing the current working
 
2706
    directory will be used.
 
2707
 
 
2708
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2709
 
 
2710
      =================       =========================
 
2711
      Supported formats       Autodetected by extension
 
2712
      =================       =========================
 
2713
         dir                         (none)
 
2714
         tar                          .tar
 
2715
         tbz2                    .tar.bz2, .tbz2
 
2716
         tgz                      .tar.gz, .tgz
 
2717
         zip                          .zip
 
2718
      =================       =========================
 
2719
    """
 
2720
    takes_args = ['dest', 'branch_or_subdir?']
 
2721
    takes_options = [
 
2722
        Option('format',
 
2723
               help="Type of file to export to.",
 
2724
               type=unicode),
 
2725
        'revision',
 
2726
        Option('filters', help='Apply content filters to export the '
 
2727
                'convenient form.'),
 
2728
        Option('root',
 
2729
               type=str,
 
2730
               help="Name of the root directory inside the exported file."),
 
2731
        ]
 
2732
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2733
        root=None, filters=False):
 
2734
        from bzrlib.export import export
 
2735
 
 
2736
        if branch_or_subdir is None:
 
2737
            tree = WorkingTree.open_containing(u'.')[0]
 
2738
            b = tree.branch
 
2739
            subdir = None
 
2740
        else:
 
2741
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2742
            tree = None
 
2743
 
 
2744
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
2745
        try:
 
2746
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2747
        except errors.NoSuchExportFormat, e:
 
2748
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2749
 
 
2750
 
 
2751
class cmd_cat(Command):
 
2752
    """Write the contents of a file as of a given revision to standard output.
 
2753
 
 
2754
    If no revision is nominated, the last revision is used.
 
2755
 
 
2756
    Note: Take care to redirect standard output when using this command on a
 
2757
    binary file.
 
2758
    """
 
2759
 
 
2760
    _see_also = ['ls']
 
2761
    takes_options = [
 
2762
        Option('name-from-revision', help='The path name in the old tree.'),
 
2763
        Option('filters', help='Apply content filters to display the '
 
2764
                'convenience form.'),
 
2765
        'revision',
 
2766
        ]
 
2767
    takes_args = ['filename']
 
2768
    encoding_type = 'exact'
 
2769
 
 
2770
    @display_command
 
2771
    def run(self, filename, revision=None, name_from_revision=False,
 
2772
            filters=False):
 
2773
        if revision is not None and len(revision) != 1:
 
2774
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2775
                                         " one revision specifier")
 
2776
        tree, branch, relpath = \
 
2777
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2778
        branch.lock_read()
 
2779
        try:
 
2780
            return self._run(tree, branch, relpath, filename, revision,
 
2781
                             name_from_revision, filters)
 
2782
        finally:
 
2783
            branch.unlock()
 
2784
 
 
2785
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
2786
        filtered):
 
2787
        if tree is None:
 
2788
            tree = b.basis_tree()
 
2789
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2790
 
 
2791
        old_file_id = rev_tree.path2id(relpath)
 
2792
 
 
2793
        if name_from_revision:
 
2794
            # Try in revision if requested
 
2795
            if old_file_id is None:
 
2796
                raise errors.BzrCommandError(
 
2797
                    "%r is not present in revision %s" % (
 
2798
                        filename, rev_tree.get_revision_id()))
 
2799
            else:
 
2800
                content = rev_tree.get_file_text(old_file_id)
 
2801
        else:
 
2802
            cur_file_id = tree.path2id(relpath)
 
2803
            found = False
 
2804
            if cur_file_id is not None:
 
2805
                # Then try with the actual file id
 
2806
                try:
 
2807
                    content = rev_tree.get_file_text(cur_file_id)
 
2808
                    found = True
 
2809
                except errors.NoSuchId:
 
2810
                    # The actual file id didn't exist at that time
 
2811
                    pass
 
2812
            if not found and old_file_id is not None:
 
2813
                # Finally try with the old file id
 
2814
                content = rev_tree.get_file_text(old_file_id)
 
2815
                found = True
 
2816
            if not found:
 
2817
                # Can't be found anywhere
 
2818
                raise errors.BzrCommandError(
 
2819
                    "%r is not present in revision %s" % (
 
2820
                        filename, rev_tree.get_revision_id()))
 
2821
        if filtered:
 
2822
            from bzrlib.filters import (
 
2823
                ContentFilterContext,
 
2824
                filtered_output_bytes,
 
2825
                )
 
2826
            filters = rev_tree._content_filter_stack(relpath)
 
2827
            chunks = content.splitlines(True)
 
2828
            content = filtered_output_bytes(chunks, filters,
 
2829
                ContentFilterContext(relpath, rev_tree))
 
2830
            self.outf.writelines(content)
 
2831
        else:
 
2832
            self.outf.write(content)
 
2833
 
 
2834
 
 
2835
class cmd_local_time_offset(Command):
 
2836
    """Show the offset in seconds from GMT to local time."""
 
2837
    hidden = True
 
2838
    @display_command
 
2839
    def run(self):
 
2840
        print osutils.local_time_offset()
 
2841
 
 
2842
 
 
2843
 
 
2844
class cmd_commit(Command):
 
2845
    """Commit changes into a new revision.
 
2846
 
 
2847
    An explanatory message needs to be given for each commit. This is
 
2848
    often done by using the --message option (getting the message from the
 
2849
    command line) or by using the --file option (getting the message from
 
2850
    a file). If neither of these options is given, an editor is opened for
 
2851
    the user to enter the message. To see the changed files in the
 
2852
    boilerplate text loaded into the editor, use the --show-diff option.
 
2853
 
 
2854
    By default, the entire tree is committed and the person doing the
 
2855
    commit is assumed to be the author. These defaults can be overridden
 
2856
    as explained below.
 
2857
 
 
2858
    :Selective commits:
 
2859
 
 
2860
      If selected files are specified, only changes to those files are
 
2861
      committed.  If a directory is specified then the directory and
 
2862
      everything within it is committed.
 
2863
  
 
2864
      When excludes are given, they take precedence over selected files.
 
2865
      For example, to commit only changes within foo, but not changes
 
2866
      within foo/bar::
 
2867
  
 
2868
        bzr commit foo -x foo/bar
 
2869
  
 
2870
      A selective commit after a merge is not yet supported.
 
2871
 
 
2872
    :Custom authors:
 
2873
 
 
2874
      If the author of the change is not the same person as the committer,
 
2875
      you can specify the author's name using the --author option. The
 
2876
      name should be in the same format as a committer-id, e.g.
 
2877
      "John Doe <jdoe@example.com>". If there is more than one author of
 
2878
      the change you can specify the option multiple times, once for each
 
2879
      author.
 
2880
  
 
2881
    :Checks:
 
2882
 
 
2883
      A common mistake is to forget to add a new file or directory before
 
2884
      running the commit command. The --strict option checks for unknown
 
2885
      files and aborts the commit if any are found. More advanced pre-commit
 
2886
      checks can be implemented by defining hooks. See ``bzr help hooks``
 
2887
      for details.
 
2888
 
 
2889
    :Things to note:
 
2890
 
 
2891
      If you accidentially commit the wrong changes or make a spelling
 
2892
      mistake in the commit message say, you can use the uncommit command
 
2893
      to undo it. See ``bzr help uncommit`` for details.
 
2894
 
 
2895
      Hooks can also be configured to run after a commit. This allows you
 
2896
      to trigger updates to external systems like bug trackers. The --fixes
 
2897
      option can be used to record the association between a revision and
 
2898
      one or more bugs. See ``bzr help bugs`` for details.
 
2899
 
 
2900
      A selective commit may fail in some cases where the committed
 
2901
      tree would be invalid. Consider::
 
2902
  
 
2903
        bzr init foo
 
2904
        mkdir foo/bar
 
2905
        bzr add foo/bar
 
2906
        bzr commit foo -m "committing foo"
 
2907
        bzr mv foo/bar foo/baz
 
2908
        mkdir foo/bar
 
2909
        bzr add foo/bar
 
2910
        bzr commit foo/bar -m "committing bar but not baz"
 
2911
  
 
2912
      In the example above, the last commit will fail by design. This gives
 
2913
      the user the opportunity to decide whether they want to commit the
 
2914
      rename at the same time, separately first, or not at all. (As a general
 
2915
      rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2916
    """
 
2917
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2918
 
 
2919
    # TODO: Strict commit that fails if there are deleted files.
 
2920
    #       (what does "deleted files" mean ??)
 
2921
 
 
2922
    # TODO: Give better message for -s, --summary, used by tla people
 
2923
 
 
2924
    # XXX: verbose currently does nothing
 
2925
 
 
2926
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2927
    takes_args = ['selected*']
 
2928
    takes_options = [
 
2929
            ListOption('exclude', type=str, short_name='x',
 
2930
                help="Do not consider changes made to a given path."),
 
2931
            Option('message', type=unicode,
 
2932
                   short_name='m',
 
2933
                   help="Description of the new revision."),
 
2934
            'verbose',
 
2935
             Option('unchanged',
 
2936
                    help='Commit even if nothing has changed.'),
 
2937
             Option('file', type=str,
 
2938
                    short_name='F',
 
2939
                    argname='msgfile',
 
2940
                    help='Take commit message from this file.'),
 
2941
             Option('strict',
 
2942
                    help="Refuse to commit if there are unknown "
 
2943
                    "files in the working tree."),
 
2944
             ListOption('fixes', type=str,
 
2945
                    help="Mark a bug as being fixed by this revision "
 
2946
                         "(see \"bzr help bugs\")."),
 
2947
             ListOption('author', type=unicode,
 
2948
                    help="Set the author's name, if it's different "
 
2949
                         "from the committer."),
 
2950
             Option('local',
 
2951
                    help="Perform a local commit in a bound "
 
2952
                         "branch.  Local commits are not pushed to "
 
2953
                         "the master branch until a normal commit "
 
2954
                         "is performed."
 
2955
                    ),
 
2956
              Option('show-diff',
 
2957
                     help='When no message is supplied, show the diff along'
 
2958
                     ' with the status summary in the message editor.'),
 
2959
             ]
 
2960
    aliases = ['ci', 'checkin']
 
2961
 
 
2962
    def _iter_bug_fix_urls(self, fixes, branch):
 
2963
        # Configure the properties for bug fixing attributes.
 
2964
        for fixed_bug in fixes:
 
2965
            tokens = fixed_bug.split(':')
 
2966
            if len(tokens) != 2:
 
2967
                raise errors.BzrCommandError(
 
2968
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
2969
                    "See \"bzr help bugs\" for more information on this "
 
2970
                    "feature.\nCommit refused." % fixed_bug)
 
2971
            tag, bug_id = tokens
 
2972
            try:
 
2973
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2974
            except errors.UnknownBugTrackerAbbreviation:
 
2975
                raise errors.BzrCommandError(
 
2976
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2977
            except errors.MalformedBugIdentifier, e:
 
2978
                raise errors.BzrCommandError(
 
2979
                    "%s\nCommit refused." % (str(e),))
 
2980
 
 
2981
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2982
            unchanged=False, strict=False, local=False, fixes=None,
 
2983
            author=None, show_diff=False, exclude=None):
 
2984
        from bzrlib.errors import (
 
2985
            PointlessCommit,
 
2986
            ConflictsInTree,
 
2987
            StrictCommitFailed
 
2988
        )
 
2989
        from bzrlib.msgeditor import (
 
2990
            edit_commit_message_encoded,
 
2991
            generate_commit_message_template,
 
2992
            make_commit_message_template_encoded
 
2993
        )
 
2994
 
 
2995
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2996
        # slightly problematic to run this cross-platform.
 
2997
 
 
2998
        # TODO: do more checks that the commit will succeed before
 
2999
        # spending the user's valuable time typing a commit message.
 
3000
 
 
3001
        properties = {}
 
3002
 
 
3003
        tree, selected_list = tree_files(selected_list)
 
3004
        if selected_list == ['']:
 
3005
            # workaround - commit of root of tree should be exactly the same
 
3006
            # as just default commit in that tree, and succeed even though
 
3007
            # selected-file merge commit is not done yet
 
3008
            selected_list = []
 
3009
 
 
3010
        if fixes is None:
 
3011
            fixes = []
 
3012
        bug_property = bugtracker.encode_fixes_bug_urls(
 
3013
            self._iter_bug_fix_urls(fixes, tree.branch))
 
3014
        if bug_property:
 
3015
            properties['bugs'] = bug_property
 
3016
 
 
3017
        if local and not tree.branch.get_bound_location():
 
3018
            raise errors.LocalRequiresBoundBranch()
 
3019
 
 
3020
        def get_message(commit_obj):
 
3021
            """Callback to get commit message"""
 
3022
            my_message = message
 
3023
            if my_message is None and not file:
 
3024
                t = make_commit_message_template_encoded(tree,
 
3025
                        selected_list, diff=show_diff,
 
3026
                        output_encoding=osutils.get_user_encoding())
 
3027
                start_message = generate_commit_message_template(commit_obj)
 
3028
                my_message = edit_commit_message_encoded(t,
 
3029
                    start_message=start_message)
 
3030
                if my_message is None:
 
3031
                    raise errors.BzrCommandError("please specify a commit"
 
3032
                        " message with either --message or --file")
 
3033
            elif my_message and file:
 
3034
                raise errors.BzrCommandError(
 
3035
                    "please specify either --message or --file")
 
3036
            if file:
 
3037
                my_message = codecs.open(file, 'rt',
 
3038
                                         osutils.get_user_encoding()).read()
 
3039
            if my_message == "":
 
3040
                raise errors.BzrCommandError("empty commit message specified")
 
3041
            return my_message
 
3042
 
 
3043
        # The API permits a commit with a filter of [] to mean 'select nothing'
 
3044
        # but the command line should not do that.
 
3045
        if not selected_list:
 
3046
            selected_list = None
 
3047
        try:
 
3048
            tree.commit(message_callback=get_message,
 
3049
                        specific_files=selected_list,
 
3050
                        allow_pointless=unchanged, strict=strict, local=local,
 
3051
                        reporter=None, verbose=verbose, revprops=properties,
 
3052
                        authors=author,
 
3053
                        exclude=safe_relpath_files(tree, exclude))
 
3054
        except PointlessCommit:
 
3055
            # FIXME: This should really happen before the file is read in;
 
3056
            # perhaps prepare the commit; get the message; then actually commit
 
3057
            raise errors.BzrCommandError("No changes to commit."
 
3058
                              " Use --unchanged to commit anyhow.")
 
3059
        except ConflictsInTree:
 
3060
            raise errors.BzrCommandError('Conflicts detected in working '
 
3061
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
3062
                ' resolve.')
 
3063
        except StrictCommitFailed:
 
3064
            raise errors.BzrCommandError("Commit refused because there are"
 
3065
                              " unknown files in the working tree.")
 
3066
        except errors.BoundBranchOutOfDate, e:
 
3067
            raise errors.BzrCommandError(str(e) + "\n"
 
3068
            'To commit to master branch, run update and then commit.\n'
 
3069
            'You can also pass --local to commit to continue working '
 
3070
            'disconnected.')
 
3071
 
 
3072
 
 
3073
class cmd_check(Command):
 
3074
    """Validate working tree structure, branch consistency and repository history.
 
3075
 
 
3076
    This command checks various invariants about branch and repository storage
 
3077
    to detect data corruption or bzr bugs.
 
3078
 
 
3079
    The working tree and branch checks will only give output if a problem is
 
3080
    detected. The output fields of the repository check are:
 
3081
 
 
3082
    revisions
 
3083
        This is just the number of revisions checked.  It doesn't
 
3084
        indicate a problem.
 
3085
 
 
3086
    versionedfiles
 
3087
        This is just the number of versionedfiles checked.  It
 
3088
        doesn't indicate a problem.
 
3089
 
 
3090
    unreferenced ancestors
 
3091
        Texts that are ancestors of other texts, but
 
3092
        are not properly referenced by the revision ancestry.  This is a
 
3093
        subtle problem that Bazaar can work around.
 
3094
 
 
3095
    unique file texts
 
3096
        This is the total number of unique file contents
 
3097
        seen in the checked revisions.  It does not indicate a problem.
 
3098
 
 
3099
    repeated file texts
 
3100
        This is the total number of repeated texts seen
 
3101
        in the checked revisions.  Texts can be repeated when their file
 
3102
        entries are modified, but the file contents are not.  It does not
 
3103
        indicate a problem.
 
3104
 
 
3105
    If no restrictions are specified, all Bazaar data that is found at the given
 
3106
    location will be checked.
 
3107
 
 
3108
    :Examples:
 
3109
 
 
3110
        Check the tree and branch at 'foo'::
 
3111
 
 
3112
            bzr check --tree --branch foo
 
3113
 
 
3114
        Check only the repository at 'bar'::
 
3115
 
 
3116
            bzr check --repo bar
 
3117
 
 
3118
        Check everything at 'baz'::
 
3119
 
 
3120
            bzr check baz
 
3121
    """
 
3122
 
 
3123
    _see_also = ['reconcile']
 
3124
    takes_args = ['path?']
 
3125
    takes_options = ['verbose',
 
3126
                     Option('branch', help="Check the branch related to the"
 
3127
                                           " current directory."),
 
3128
                     Option('repo', help="Check the repository related to the"
 
3129
                                         " current directory."),
 
3130
                     Option('tree', help="Check the working tree related to"
 
3131
                                         " the current directory.")]
 
3132
 
 
3133
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
3134
            tree=False):
 
3135
        from bzrlib.check import check_dwim
 
3136
        if path is None:
 
3137
            path = '.'
 
3138
        if not branch and not repo and not tree:
 
3139
            branch = repo = tree = True
 
3140
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
3141
 
 
3142
 
 
3143
class cmd_upgrade(Command):
 
3144
    """Upgrade branch storage to current format.
 
3145
 
 
3146
    The check command or bzr developers may sometimes advise you to run
 
3147
    this command. When the default format has changed you may also be warned
 
3148
    during other operations to upgrade.
 
3149
    """
 
3150
 
 
3151
    _see_also = ['check']
 
3152
    takes_args = ['url?']
 
3153
    takes_options = [
 
3154
                    RegistryOption('format',
 
3155
                        help='Upgrade to a specific format.  See "bzr help'
 
3156
                             ' formats" for details.',
 
3157
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
3158
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
3159
                        value_switches=True, title='Branch format'),
 
3160
                    ]
 
3161
 
 
3162
    def run(self, url='.', format=None):
 
3163
        from bzrlib.upgrade import upgrade
 
3164
        upgrade(url, format)
 
3165
 
 
3166
 
 
3167
class cmd_whoami(Command):
 
3168
    """Show or set bzr user id.
 
3169
 
 
3170
    :Examples:
 
3171
        Show the email of the current user::
 
3172
 
 
3173
            bzr whoami --email
 
3174
 
 
3175
        Set the current user::
 
3176
 
 
3177
            bzr whoami "Frank Chu <fchu@example.com>"
 
3178
    """
 
3179
    takes_options = [ Option('email',
 
3180
                             help='Display email address only.'),
 
3181
                      Option('branch',
 
3182
                             help='Set identity for the current branch instead of '
 
3183
                                  'globally.'),
 
3184
                    ]
 
3185
    takes_args = ['name?']
 
3186
    encoding_type = 'replace'
 
3187
 
 
3188
    @display_command
 
3189
    def run(self, email=False, branch=False, name=None):
 
3190
        if name is None:
 
3191
            # use branch if we're inside one; otherwise global config
 
3192
            try:
 
3193
                c = Branch.open_containing('.')[0].get_config()
 
3194
            except errors.NotBranchError:
 
3195
                c = config.GlobalConfig()
 
3196
            if email:
 
3197
                self.outf.write(c.user_email() + '\n')
 
3198
            else:
 
3199
                self.outf.write(c.username() + '\n')
 
3200
            return
 
3201
 
 
3202
        # display a warning if an email address isn't included in the given name.
 
3203
        try:
 
3204
            config.extract_email_address(name)
 
3205
        except errors.NoEmailInUsername, e:
 
3206
            warning('"%s" does not seem to contain an email address.  '
 
3207
                    'This is allowed, but not recommended.', name)
 
3208
 
 
3209
        # use global config unless --branch given
 
3210
        if branch:
 
3211
            c = Branch.open_containing('.')[0].get_config()
 
3212
        else:
 
3213
            c = config.GlobalConfig()
 
3214
        c.set_user_option('email', name)
 
3215
 
 
3216
 
 
3217
class cmd_nick(Command):
 
3218
    """Print or set the branch nickname.
 
3219
 
 
3220
    If unset, the tree root directory name is used as the nickname.
 
3221
    To print the current nickname, execute with no argument.
 
3222
 
 
3223
    Bound branches use the nickname of its master branch unless it is set
 
3224
    locally.
 
3225
    """
 
3226
 
 
3227
    _see_also = ['info']
 
3228
    takes_args = ['nickname?']
 
3229
    def run(self, nickname=None):
 
3230
        branch = Branch.open_containing(u'.')[0]
 
3231
        if nickname is None:
 
3232
            self.printme(branch)
 
3233
        else:
 
3234
            branch.nick = nickname
 
3235
 
 
3236
    @display_command
 
3237
    def printme(self, branch):
 
3238
        print branch.nick
 
3239
 
 
3240
 
 
3241
class cmd_alias(Command):
 
3242
    """Set/unset and display aliases.
 
3243
 
 
3244
    :Examples:
 
3245
        Show the current aliases::
 
3246
 
 
3247
            bzr alias
 
3248
 
 
3249
        Show the alias specified for 'll'::
 
3250
 
 
3251
            bzr alias ll
 
3252
 
 
3253
        Set an alias for 'll'::
 
3254
 
 
3255
            bzr alias ll="log --line -r-10..-1"
 
3256
 
 
3257
        To remove an alias for 'll'::
 
3258
 
 
3259
            bzr alias --remove ll
 
3260
 
 
3261
    """
 
3262
    takes_args = ['name?']
 
3263
    takes_options = [
 
3264
        Option('remove', help='Remove the alias.'),
 
3265
        ]
 
3266
 
 
3267
    def run(self, name=None, remove=False):
 
3268
        if remove:
 
3269
            self.remove_alias(name)
 
3270
        elif name is None:
 
3271
            self.print_aliases()
 
3272
        else:
 
3273
            equal_pos = name.find('=')
 
3274
            if equal_pos == -1:
 
3275
                self.print_alias(name)
 
3276
            else:
 
3277
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3278
 
 
3279
    def remove_alias(self, alias_name):
 
3280
        if alias_name is None:
 
3281
            raise errors.BzrCommandError(
 
3282
                'bzr alias --remove expects an alias to remove.')
 
3283
        # If alias is not found, print something like:
 
3284
        # unalias: foo: not found
 
3285
        c = config.GlobalConfig()
 
3286
        c.unset_alias(alias_name)
 
3287
 
 
3288
    @display_command
 
3289
    def print_aliases(self):
 
3290
        """Print out the defined aliases in a similar format to bash."""
 
3291
        aliases = config.GlobalConfig().get_aliases()
 
3292
        for key, value in sorted(aliases.iteritems()):
 
3293
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3294
 
 
3295
    @display_command
 
3296
    def print_alias(self, alias_name):
 
3297
        from bzrlib.commands import get_alias
 
3298
        alias = get_alias(alias_name)
 
3299
        if alias is None:
 
3300
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3301
        else:
 
3302
            self.outf.write(
 
3303
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3304
 
 
3305
    def set_alias(self, alias_name, alias_command):
 
3306
        """Save the alias in the global config."""
 
3307
        c = config.GlobalConfig()
 
3308
        c.set_alias(alias_name, alias_command)
 
3309
 
 
3310
 
 
3311
class cmd_selftest(Command):
 
3312
    """Run internal test suite.
 
3313
 
 
3314
    If arguments are given, they are regular expressions that say which tests
 
3315
    should run.  Tests matching any expression are run, and other tests are
 
3316
    not run.
 
3317
 
 
3318
    Alternatively if --first is given, matching tests are run first and then
 
3319
    all other tests are run.  This is useful if you have been working in a
 
3320
    particular area, but want to make sure nothing else was broken.
 
3321
 
 
3322
    If --exclude is given, tests that match that regular expression are
 
3323
    excluded, regardless of whether they match --first or not.
 
3324
 
 
3325
    To help catch accidential dependencies between tests, the --randomize
 
3326
    option is useful. In most cases, the argument used is the word 'now'.
 
3327
    Note that the seed used for the random number generator is displayed
 
3328
    when this option is used. The seed can be explicitly passed as the
 
3329
    argument to this option if required. This enables reproduction of the
 
3330
    actual ordering used if and when an order sensitive problem is encountered.
 
3331
 
 
3332
    If --list-only is given, the tests that would be run are listed. This is
 
3333
    useful when combined with --first, --exclude and/or --randomize to
 
3334
    understand their impact. The test harness reports "Listed nn tests in ..."
 
3335
    instead of "Ran nn tests in ..." when list mode is enabled.
 
3336
 
 
3337
    If the global option '--no-plugins' is given, plugins are not loaded
 
3338
    before running the selftests.  This has two effects: features provided or
 
3339
    modified by plugins will not be tested, and tests provided by plugins will
 
3340
    not be run.
 
3341
 
 
3342
    Tests that need working space on disk use a common temporary directory,
 
3343
    typically inside $TMPDIR or /tmp.
 
3344
 
 
3345
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
 
3346
    into a pdb postmortem session.
 
3347
 
 
3348
    :Examples:
 
3349
        Run only tests relating to 'ignore'::
 
3350
 
 
3351
            bzr selftest ignore
 
3352
 
 
3353
        Disable plugins and list tests as they're run::
 
3354
 
 
3355
            bzr --no-plugins selftest -v
 
3356
    """
 
3357
    # NB: this is used from the class without creating an instance, which is
 
3358
    # why it does not have a self parameter.
 
3359
    def get_transport_type(typestring):
 
3360
        """Parse and return a transport specifier."""
 
3361
        if typestring == "sftp":
 
3362
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3363
            return SFTPAbsoluteServer
 
3364
        if typestring == "memory":
 
3365
            from bzrlib.transport.memory import MemoryServer
 
3366
            return MemoryServer
 
3367
        if typestring == "fakenfs":
 
3368
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3369
            return FakeNFSServer
 
3370
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
3371
            (typestring)
 
3372
        raise errors.BzrCommandError(msg)
 
3373
 
 
3374
    hidden = True
 
3375
    takes_args = ['testspecs*']
 
3376
    takes_options = ['verbose',
 
3377
                     Option('one',
 
3378
                             help='Stop when one test fails.',
 
3379
                             short_name='1',
 
3380
                             ),
 
3381
                     Option('transport',
 
3382
                            help='Use a different transport by default '
 
3383
                                 'throughout the test suite.',
 
3384
                            type=get_transport_type),
 
3385
                     Option('benchmark',
 
3386
                            help='Run the benchmarks rather than selftests.'),
 
3387
                     Option('lsprof-timed',
 
3388
                            help='Generate lsprof output for benchmarked'
 
3389
                                 ' sections of code.'),
 
3390
                     Option('lsprof-tests',
 
3391
                            help='Generate lsprof output for each test.'),
 
3392
                     Option('cache-dir', type=str,
 
3393
                            help='Cache intermediate benchmark output in this '
 
3394
                                 'directory.'),
 
3395
                     Option('first',
 
3396
                            help='Run all tests, but run specified tests first.',
 
3397
                            short_name='f',
 
3398
                            ),
 
3399
                     Option('list-only',
 
3400
                            help='List the tests instead of running them.'),
 
3401
                     RegistryOption('parallel',
 
3402
                        help="Run the test suite in parallel.",
 
3403
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3404
                        value_switches=False,
 
3405
                        ),
 
3406
                     Option('randomize', type=str, argname="SEED",
 
3407
                            help='Randomize the order of tests using the given'
 
3408
                                 ' seed or "now" for the current time.'),
 
3409
                     Option('exclude', type=str, argname="PATTERN",
 
3410
                            short_name='x',
 
3411
                            help='Exclude tests that match this regular'
 
3412
                                 ' expression.'),
 
3413
                     Option('subunit',
 
3414
                        help='Output test progress via subunit.'),
 
3415
                     Option('strict', help='Fail on missing dependencies or '
 
3416
                            'known failures.'),
 
3417
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
3418
                            help='Load a test id list from a text file.'),
 
3419
                     ListOption('debugflag', type=str, short_name='E',
 
3420
                                help='Turn on a selftest debug flag.'),
 
3421
                     ListOption('starting-with', type=str, argname='TESTID',
 
3422
                                param_name='starting_with', short_name='s',
 
3423
                                help=
 
3424
                                'Load only the tests starting with TESTID.'),
 
3425
                     ]
 
3426
    encoding_type = 'replace'
 
3427
 
 
3428
    def __init__(self):
 
3429
        Command.__init__(self)
 
3430
        self.additional_selftest_args = {}
 
3431
 
 
3432
    def run(self, testspecs_list=None, verbose=False, one=False,
 
3433
            transport=None, benchmark=None,
 
3434
            lsprof_timed=None, cache_dir=None,
 
3435
            first=False, list_only=False,
 
3436
            randomize=None, exclude=None, strict=False,
 
3437
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3438
            parallel=None, lsprof_tests=False):
 
3439
        from bzrlib.tests import selftest
 
3440
        import bzrlib.benchmarks as benchmarks
 
3441
        from bzrlib.benchmarks import tree_creator
 
3442
 
 
3443
        # Make deprecation warnings visible, unless -Werror is set
 
3444
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3445
 
 
3446
        if cache_dir is not None:
 
3447
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3448
        if testspecs_list is not None:
 
3449
            pattern = '|'.join(testspecs_list)
 
3450
        else:
 
3451
            pattern = ".*"
 
3452
        if subunit:
 
3453
            try:
 
3454
                from bzrlib.tests import SubUnitBzrRunner
 
3455
            except ImportError:
 
3456
                raise errors.BzrCommandError("subunit not available. subunit "
 
3457
                    "needs to be installed to use --subunit.")
 
3458
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3459
        if parallel:
 
3460
            self.additional_selftest_args.setdefault(
 
3461
                'suite_decorators', []).append(parallel)
 
3462
        if benchmark:
 
3463
            test_suite_factory = benchmarks.test_suite
 
3464
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3465
            verbose = not is_quiet()
 
3466
            # TODO: should possibly lock the history file...
 
3467
            benchfile = open(".perf_history", "at", buffering=1)
 
3468
        else:
 
3469
            test_suite_factory = None
 
3470
            benchfile = None
 
3471
        try:
 
3472
            selftest_kwargs = {"verbose": verbose,
 
3473
                              "pattern": pattern,
 
3474
                              "stop_on_failure": one,
 
3475
                              "transport": transport,
 
3476
                              "test_suite_factory": test_suite_factory,
 
3477
                              "lsprof_timed": lsprof_timed,
 
3478
                              "lsprof_tests": lsprof_tests,
 
3479
                              "bench_history": benchfile,
 
3480
                              "matching_tests_first": first,
 
3481
                              "list_only": list_only,
 
3482
                              "random_seed": randomize,
 
3483
                              "exclude_pattern": exclude,
 
3484
                              "strict": strict,
 
3485
                              "load_list": load_list,
 
3486
                              "debug_flags": debugflag,
 
3487
                              "starting_with": starting_with
 
3488
                              }
 
3489
            selftest_kwargs.update(self.additional_selftest_args)
 
3490
            result = selftest(**selftest_kwargs)
 
3491
        finally:
 
3492
            if benchfile is not None:
 
3493
                benchfile.close()
 
3494
        return int(not result)
 
3495
 
 
3496
 
 
3497
class cmd_version(Command):
 
3498
    """Show version of bzr."""
 
3499
 
 
3500
    encoding_type = 'replace'
 
3501
    takes_options = [
 
3502
        Option("short", help="Print just the version number."),
 
3503
        ]
 
3504
 
 
3505
    @display_command
 
3506
    def run(self, short=False):
 
3507
        from bzrlib.version import show_version
 
3508
        if short:
 
3509
            self.outf.write(bzrlib.version_string + '\n')
 
3510
        else:
 
3511
            show_version(to_file=self.outf)
 
3512
 
 
3513
 
 
3514
class cmd_rocks(Command):
 
3515
    """Statement of optimism."""
 
3516
 
 
3517
    hidden = True
 
3518
 
 
3519
    @display_command
 
3520
    def run(self):
 
3521
        print "It sure does!"
 
3522
 
 
3523
 
 
3524
class cmd_find_merge_base(Command):
 
3525
    """Find and print a base revision for merging two branches."""
 
3526
    # TODO: Options to specify revisions on either side, as if
 
3527
    #       merging only part of the history.
 
3528
    takes_args = ['branch', 'other']
 
3529
    hidden = True
 
3530
 
 
3531
    @display_command
 
3532
    def run(self, branch, other):
 
3533
        from bzrlib.revision import ensure_null
 
3534
 
 
3535
        branch1 = Branch.open_containing(branch)[0]
 
3536
        branch2 = Branch.open_containing(other)[0]
 
3537
        branch1.lock_read()
 
3538
        try:
 
3539
            branch2.lock_read()
 
3540
            try:
 
3541
                last1 = ensure_null(branch1.last_revision())
 
3542
                last2 = ensure_null(branch2.last_revision())
 
3543
 
 
3544
                graph = branch1.repository.get_graph(branch2.repository)
 
3545
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3546
 
 
3547
                print 'merge base is revision %s' % base_rev_id
 
3548
            finally:
 
3549
                branch2.unlock()
 
3550
        finally:
 
3551
            branch1.unlock()
 
3552
 
 
3553
 
 
3554
class cmd_merge(Command):
 
3555
    """Perform a three-way merge.
 
3556
 
 
3557
    The source of the merge can be specified either in the form of a branch,
 
3558
    or in the form of a path to a file containing a merge directive generated
 
3559
    with bzr send. If neither is specified, the default is the upstream branch
 
3560
    or the branch most recently merged using --remember.
 
3561
 
 
3562
    When merging a branch, by default the tip will be merged. To pick a different
 
3563
    revision, pass --revision. If you specify two values, the first will be used as
 
3564
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3565
    available revisions, like this is commonly referred to as "cherrypicking".
 
3566
 
 
3567
    Revision numbers are always relative to the branch being merged.
 
3568
 
 
3569
    By default, bzr will try to merge in all new work from the other
 
3570
    branch, automatically determining an appropriate base.  If this
 
3571
    fails, you may need to give an explicit base.
 
3572
 
 
3573
    Merge will do its best to combine the changes in two branches, but there
 
3574
    are some kinds of problems only a human can fix.  When it encounters those,
 
3575
    it will mark a conflict.  A conflict means that you need to fix something,
 
3576
    before you should commit.
 
3577
 
 
3578
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
3579
 
 
3580
    If there is no default branch set, the first merge will set it. After
 
3581
    that, you can omit the branch to use the default.  To change the
 
3582
    default, use --remember. The value will only be saved if the remote
 
3583
    location can be accessed.
 
3584
 
 
3585
    The results of the merge are placed into the destination working
 
3586
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3587
    committed to record the result of the merge.
 
3588
 
 
3589
    merge refuses to run if there are any uncommitted changes, unless
 
3590
    --force is given.
 
3591
 
 
3592
    To select only some changes to merge, use "merge -i", which will prompt
 
3593
    you to apply each diff hunk and file change, similar to "shelve".
 
3594
 
 
3595
    :Examples:
 
3596
        To merge the latest revision from bzr.dev::
 
3597
 
 
3598
            bzr merge ../bzr.dev
 
3599
 
 
3600
        To merge changes up to and including revision 82 from bzr.dev::
 
3601
 
 
3602
            bzr merge -r 82 ../bzr.dev
 
3603
 
 
3604
        To merge the changes introduced by 82, without previous changes::
 
3605
 
 
3606
            bzr merge -r 81..82 ../bzr.dev
 
3607
 
 
3608
        To apply a merge directive contained in /tmp/merge:
 
3609
 
 
3610
            bzr merge /tmp/merge
 
3611
    """
 
3612
 
 
3613
    encoding_type = 'exact'
 
3614
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3615
    takes_args = ['location?']
 
3616
    takes_options = [
 
3617
        'change',
 
3618
        'revision',
 
3619
        Option('force',
 
3620
               help='Merge even if the destination tree has uncommitted changes.'),
 
3621
        'merge-type',
 
3622
        'reprocess',
 
3623
        'remember',
 
3624
        Option('show-base', help="Show base revision text in "
 
3625
               "conflicts."),
 
3626
        Option('uncommitted', help='Apply uncommitted changes'
 
3627
               ' from a working copy, instead of branch changes.'),
 
3628
        Option('pull', help='If the destination is already'
 
3629
                ' completely merged into the source, pull from the'
 
3630
                ' source rather than merging.  When this happens,'
 
3631
                ' you do not need to commit the result.'),
 
3632
        Option('directory',
 
3633
               help='Branch to merge into, '
 
3634
                    'rather than the one containing the working directory.',
 
3635
               short_name='d',
 
3636
               type=unicode,
 
3637
               ),
 
3638
        Option('preview', help='Instead of merging, show a diff of the'
 
3639
               ' merge.'),
 
3640
        Option('interactive', help='Select changes interactively.',
 
3641
            short_name='i')
 
3642
    ]
 
3643
 
 
3644
    def run(self, location=None, revision=None, force=False,
 
3645
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3646
            uncommitted=False, pull=False,
 
3647
            directory=None,
 
3648
            preview=False,
 
3649
            interactive=False,
 
3650
            ):
 
3651
        if merge_type is None:
 
3652
            merge_type = _mod_merge.Merge3Merger
 
3653
 
 
3654
        if directory is None: directory = u'.'
 
3655
        possible_transports = []
 
3656
        merger = None
 
3657
        allow_pending = True
 
3658
        verified = 'inapplicable'
 
3659
        tree = WorkingTree.open_containing(directory)[0]
 
3660
 
 
3661
        try:
 
3662
            basis_tree = tree.revision_tree(tree.last_revision())
 
3663
        except errors.NoSuchRevision:
 
3664
            basis_tree = tree.basis_tree()
 
3665
 
 
3666
        # die as quickly as possible if there are uncommitted changes
 
3667
        if not force:
 
3668
            if tree.has_changes():
 
3669
                raise errors.UncommittedChanges(tree)
 
3670
 
 
3671
        view_info = _get_view_info_for_change_reporter(tree)
 
3672
        change_reporter = delta._ChangeReporter(
 
3673
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
3674
        cleanups = []
 
3675
        try:
 
3676
            pb = ui.ui_factory.nested_progress_bar()
 
3677
            cleanups.append(pb.finished)
 
3678
            tree.lock_write()
 
3679
            cleanups.append(tree.unlock)
 
3680
            if location is not None:
 
3681
                try:
 
3682
                    mergeable = bundle.read_mergeable_from_url(location,
 
3683
                        possible_transports=possible_transports)
 
3684
                except errors.NotABundle:
 
3685
                    mergeable = None
 
3686
                else:
 
3687
                    if uncommitted:
 
3688
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3689
                            ' with bundles or merge directives.')
 
3690
 
 
3691
                    if revision is not None:
 
3692
                        raise errors.BzrCommandError(
 
3693
                            'Cannot use -r with merge directives or bundles')
 
3694
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3695
                       mergeable, pb)
 
3696
 
 
3697
            if merger is None and uncommitted:
 
3698
                if revision is not None and len(revision) > 0:
 
3699
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3700
                        ' --revision at the same time.')
 
3701
                merger = self.get_merger_from_uncommitted(tree, location, pb,
 
3702
                                                          cleanups)
 
3703
                allow_pending = False
 
3704
 
 
3705
            if merger is None:
 
3706
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3707
                    location, revision, remember, possible_transports, pb)
 
3708
 
 
3709
            merger.merge_type = merge_type
 
3710
            merger.reprocess = reprocess
 
3711
            merger.show_base = show_base
 
3712
            self.sanity_check_merger(merger)
 
3713
            if (merger.base_rev_id == merger.other_rev_id and
 
3714
                merger.other_rev_id is not None):
 
3715
                note('Nothing to do.')
 
3716
                return 0
 
3717
            if pull:
 
3718
                if merger.interesting_files is not None:
 
3719
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3720
                if (merger.base_rev_id == tree.last_revision()):
 
3721
                    result = tree.pull(merger.other_branch, False,
 
3722
                                       merger.other_rev_id)
 
3723
                    result.report(self.outf)
 
3724
                    return 0
 
3725
            if merger.this_basis is None:
 
3726
                raise errors.BzrCommandError(
 
3727
                    "This branch has no commits."
 
3728
                    " (perhaps you would prefer 'bzr pull')")
 
3729
            if preview:
 
3730
                return self._do_preview(merger, cleanups)
 
3731
            elif interactive:
 
3732
                return self._do_interactive(merger, cleanups)
 
3733
            else:
 
3734
                return self._do_merge(merger, change_reporter, allow_pending,
 
3735
                                      verified)
 
3736
        finally:
 
3737
            for cleanup in reversed(cleanups):
 
3738
                cleanup()
 
3739
 
 
3740
    def _get_preview(self, merger, cleanups):
 
3741
        tree_merger = merger.make_merger()
 
3742
        tt = tree_merger.make_preview_transform()
 
3743
        cleanups.append(tt.finalize)
 
3744
        result_tree = tt.get_preview_tree()
 
3745
        return result_tree
 
3746
 
 
3747
    def _do_preview(self, merger, cleanups):
 
3748
        from bzrlib.diff import show_diff_trees
 
3749
        result_tree = self._get_preview(merger, cleanups)
 
3750
        show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3751
                        old_label='', new_label='')
 
3752
 
 
3753
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3754
        merger.change_reporter = change_reporter
 
3755
        conflict_count = merger.do_merge()
 
3756
        if allow_pending:
 
3757
            merger.set_pending()
 
3758
        if verified == 'failed':
 
3759
            warning('Preview patch does not match changes')
 
3760
        if conflict_count != 0:
 
3761
            return 1
 
3762
        else:
 
3763
            return 0
 
3764
 
 
3765
    def _do_interactive(self, merger, cleanups):
 
3766
        """Perform an interactive merge.
 
3767
 
 
3768
        This works by generating a preview tree of the merge, then using
 
3769
        Shelver to selectively remove the differences between the working tree
 
3770
        and the preview tree.
 
3771
        """
 
3772
        from bzrlib import shelf_ui
 
3773
        result_tree = self._get_preview(merger, cleanups)
 
3774
        writer = bzrlib.option.diff_writer_registry.get()
 
3775
        shelver = shelf_ui.Shelver(merger.this_tree, result_tree, destroy=True,
 
3776
                                   reporter=shelf_ui.ApplyReporter(),
 
3777
                                   diff_writer=writer(sys.stdout))
 
3778
        shelver.run()
 
3779
 
 
3780
    def sanity_check_merger(self, merger):
 
3781
        if (merger.show_base and
 
3782
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3783
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3784
                                         " merge type. %s" % merger.merge_type)
 
3785
        if merger.reprocess is None:
 
3786
            if merger.show_base:
 
3787
                merger.reprocess = False
 
3788
            else:
 
3789
                # Use reprocess if the merger supports it
 
3790
                merger.reprocess = merger.merge_type.supports_reprocess
 
3791
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3792
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3793
                                         " for merge type %s." %
 
3794
                                         merger.merge_type)
 
3795
        if merger.reprocess and merger.show_base:
 
3796
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3797
                                         " show base.")
 
3798
 
 
3799
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3800
                                possible_transports, pb):
 
3801
        """Produce a merger from a location, assuming it refers to a branch."""
 
3802
        from bzrlib.tag import _merge_tags_if_possible
 
3803
        # find the branch locations
 
3804
        other_loc, user_location = self._select_branch_location(tree, location,
 
3805
            revision, -1)
 
3806
        if revision is not None and len(revision) == 2:
 
3807
            base_loc, _unused = self._select_branch_location(tree,
 
3808
                location, revision, 0)
 
3809
        else:
 
3810
            base_loc = other_loc
 
3811
        # Open the branches
 
3812
        other_branch, other_path = Branch.open_containing(other_loc,
 
3813
            possible_transports)
 
3814
        if base_loc == other_loc:
 
3815
            base_branch = other_branch
 
3816
        else:
 
3817
            base_branch, base_path = Branch.open_containing(base_loc,
 
3818
                possible_transports)
 
3819
        # Find the revision ids
 
3820
        other_revision_id = None
 
3821
        base_revision_id = None
 
3822
        if revision is not None:
 
3823
            if len(revision) >= 1:
 
3824
                other_revision_id = revision[-1].as_revision_id(other_branch)
 
3825
            if len(revision) == 2:
 
3826
                base_revision_id = revision[0].as_revision_id(base_branch)
 
3827
        if other_revision_id is None:
 
3828
            other_revision_id = _mod_revision.ensure_null(
 
3829
                other_branch.last_revision())
 
3830
        # Remember where we merge from
 
3831
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3832
             user_location is not None):
 
3833
            tree.branch.set_submit_branch(other_branch.base)
 
3834
        _merge_tags_if_possible(other_branch, tree.branch)
 
3835
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3836
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3837
        if other_path != '':
 
3838
            allow_pending = False
 
3839
            merger.interesting_files = [other_path]
 
3840
        else:
 
3841
            allow_pending = True
 
3842
        return merger, allow_pending
 
3843
 
 
3844
    def get_merger_from_uncommitted(self, tree, location, pb, cleanups):
 
3845
        """Get a merger for uncommitted changes.
 
3846
 
 
3847
        :param tree: The tree the merger should apply to.
 
3848
        :param location: The location containing uncommitted changes.
 
3849
        :param pb: The progress bar to use for showing progress.
 
3850
        :param cleanups: A list of operations to perform to clean up the
 
3851
            temporary directories, unfinalized objects, etc.
 
3852
        """
 
3853
        location = self._select_branch_location(tree, location)[0]
 
3854
        other_tree, other_path = WorkingTree.open_containing(location)
 
3855
        merger = _mod_merge.Merger.from_uncommitted(tree, other_tree, pb)
 
3856
        if other_path != '':
 
3857
            merger.interesting_files = [other_path]
 
3858
        return merger
 
3859
 
 
3860
    def _select_branch_location(self, tree, user_location, revision=None,
 
3861
                                index=None):
 
3862
        """Select a branch location, according to possible inputs.
 
3863
 
 
3864
        If provided, branches from ``revision`` are preferred.  (Both
 
3865
        ``revision`` and ``index`` must be supplied.)
 
3866
 
 
3867
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3868
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3869
 
 
3870
        :param tree: The working tree to select a branch for merging into
 
3871
        :param location: The location entered by the user
 
3872
        :param revision: The revision parameter to the command
 
3873
        :param index: The index to use for the revision parameter.  Negative
 
3874
            indices are permitted.
 
3875
        :return: (selected_location, user_location).  The default location
 
3876
            will be the user-entered location.
 
3877
        """
 
3878
        if (revision is not None and index is not None
 
3879
            and revision[index] is not None):
 
3880
            branch = revision[index].get_branch()
 
3881
            if branch is not None:
 
3882
                return branch, branch
 
3883
        if user_location is None:
 
3884
            location = self._get_remembered(tree, 'Merging from')
 
3885
        else:
 
3886
            location = user_location
 
3887
        return location, user_location
 
3888
 
 
3889
    def _get_remembered(self, tree, verb_string):
 
3890
        """Use tree.branch's parent if none was supplied.
 
3891
 
 
3892
        Report if the remembered location was used.
 
3893
        """
 
3894
        stored_location = tree.branch.get_submit_branch()
 
3895
        stored_location_type = "submit"
 
3896
        if stored_location is None:
 
3897
            stored_location = tree.branch.get_parent()
 
3898
            stored_location_type = "parent"
 
3899
        mutter("%s", stored_location)
 
3900
        if stored_location is None:
 
3901
            raise errors.BzrCommandError("No location specified or remembered")
 
3902
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3903
        note(u"%s remembered %s location %s", verb_string,
 
3904
                stored_location_type, display_url)
 
3905
        return stored_location
 
3906
 
 
3907
 
 
3908
class cmd_remerge(Command):
 
3909
    """Redo a merge.
 
3910
 
 
3911
    Use this if you want to try a different merge technique while resolving
 
3912
    conflicts.  Some merge techniques are better than others, and remerge
 
3913
    lets you try different ones on different files.
 
3914
 
 
3915
    The options for remerge have the same meaning and defaults as the ones for
 
3916
    merge.  The difference is that remerge can (only) be run when there is a
 
3917
    pending merge, and it lets you specify particular files.
 
3918
 
 
3919
    :Examples:
 
3920
        Re-do the merge of all conflicted files, and show the base text in
 
3921
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3922
 
 
3923
            bzr remerge --show-base
 
3924
 
 
3925
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3926
        additional processing to reduce the size of conflict regions::
 
3927
 
 
3928
            bzr remerge --merge-type weave --reprocess foobar
 
3929
    """
 
3930
    takes_args = ['file*']
 
3931
    takes_options = [
 
3932
            'merge-type',
 
3933
            'reprocess',
 
3934
            Option('show-base',
 
3935
                   help="Show base revision text in conflicts."),
 
3936
            ]
 
3937
 
 
3938
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3939
            reprocess=False):
 
3940
        if merge_type is None:
 
3941
            merge_type = _mod_merge.Merge3Merger
 
3942
        tree, file_list = tree_files(file_list)
 
3943
        tree.lock_write()
 
3944
        try:
 
3945
            parents = tree.get_parent_ids()
 
3946
            if len(parents) != 2:
 
3947
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3948
                                             " merges.  Not cherrypicking or"
 
3949
                                             " multi-merges.")
 
3950
            repository = tree.branch.repository
 
3951
            interesting_ids = None
 
3952
            new_conflicts = []
 
3953
            conflicts = tree.conflicts()
 
3954
            if file_list is not None:
 
3955
                interesting_ids = set()
 
3956
                for filename in file_list:
 
3957
                    file_id = tree.path2id(filename)
 
3958
                    if file_id is None:
 
3959
                        raise errors.NotVersionedError(filename)
 
3960
                    interesting_ids.add(file_id)
 
3961
                    if tree.kind(file_id) != "directory":
 
3962
                        continue
 
3963
 
 
3964
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3965
                        interesting_ids.add(ie.file_id)
 
3966
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3967
            else:
 
3968
                # Remerge only supports resolving contents conflicts
 
3969
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3970
                restore_files = [c.path for c in conflicts
 
3971
                                 if c.typestring in allowed_conflicts]
 
3972
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3973
            tree.set_conflicts(ConflictList(new_conflicts))
 
3974
            if file_list is not None:
 
3975
                restore_files = file_list
 
3976
            for filename in restore_files:
 
3977
                try:
 
3978
                    restore(tree.abspath(filename))
 
3979
                except errors.NotConflicted:
 
3980
                    pass
 
3981
            # Disable pending merges, because the file texts we are remerging
 
3982
            # have not had those merges performed.  If we use the wrong parents
 
3983
            # list, we imply that the working tree text has seen and rejected
 
3984
            # all the changes from the other tree, when in fact those changes
 
3985
            # have not yet been seen.
 
3986
            pb = ui.ui_factory.nested_progress_bar()
 
3987
            tree.set_parent_ids(parents[:1])
 
3988
            try:
 
3989
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3990
                                                             tree, parents[1])
 
3991
                merger.interesting_ids = interesting_ids
 
3992
                merger.merge_type = merge_type
 
3993
                merger.show_base = show_base
 
3994
                merger.reprocess = reprocess
 
3995
                conflicts = merger.do_merge()
 
3996
            finally:
 
3997
                tree.set_parent_ids(parents)
 
3998
                pb.finished()
 
3999
        finally:
 
4000
            tree.unlock()
 
4001
        if conflicts > 0:
 
4002
            return 1
 
4003
        else:
 
4004
            return 0
 
4005
 
 
4006
 
 
4007
class cmd_revert(Command):
 
4008
    """Revert files to a previous revision.
 
4009
 
 
4010
    Giving a list of files will revert only those files.  Otherwise, all files
 
4011
    will be reverted.  If the revision is not specified with '--revision', the
 
4012
    last committed revision is used.
 
4013
 
 
4014
    To remove only some changes, without reverting to a prior version, use
 
4015
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
4016
    changes introduced by -2, without affecting the changes introduced by -1.
 
4017
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
4018
 
 
4019
    By default, any files that have been manually changed will be backed up
 
4020
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
4021
    '.~#~' appended to their name, where # is a number.
 
4022
 
 
4023
    When you provide files, you can use their current pathname or the pathname
 
4024
    from the target revision.  So you can use revert to "undelete" a file by
 
4025
    name.  If you name a directory, all the contents of that directory will be
 
4026
    reverted.
 
4027
 
 
4028
    Any files that have been newly added since that revision will be deleted,
 
4029
    with a backup kept if appropriate.  Directories containing unknown files
 
4030
    will not be deleted.
 
4031
 
 
4032
    The working tree contains a list of pending merged revisions, which will
 
4033
    be included as parents in the next commit.  Normally, revert clears that
 
4034
    list as well as reverting the files.  If any files are specified, revert
 
4035
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
4036
    revert ." in the tree root to revert all files but keep the merge record,
 
4037
    and "bzr revert --forget-merges" to clear the pending merge list without
 
4038
    reverting any files.
 
4039
    """
 
4040
 
 
4041
    _see_also = ['cat', 'export']
 
4042
    takes_options = [
 
4043
        'revision',
 
4044
        Option('no-backup', "Do not save backups of reverted files."),
 
4045
        Option('forget-merges',
 
4046
               'Remove pending merge marker, without changing any files.'),
 
4047
        ]
 
4048
    takes_args = ['file*']
 
4049
 
 
4050
    def run(self, revision=None, no_backup=False, file_list=None,
 
4051
            forget_merges=None):
 
4052
        tree, file_list = tree_files(file_list)
 
4053
        tree.lock_write()
 
4054
        try:
 
4055
            if forget_merges:
 
4056
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
4057
            else:
 
4058
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
4059
        finally:
 
4060
            tree.unlock()
 
4061
 
 
4062
    @staticmethod
 
4063
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
4064
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
4065
        pb = ui.ui_factory.nested_progress_bar()
 
4066
        try:
 
4067
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
4068
                report_changes=True)
 
4069
        finally:
 
4070
            pb.finished()
 
4071
 
 
4072
 
 
4073
class cmd_assert_fail(Command):
 
4074
    """Test reporting of assertion failures"""
 
4075
    # intended just for use in testing
 
4076
 
 
4077
    hidden = True
 
4078
 
 
4079
    def run(self):
 
4080
        raise AssertionError("always fails")
 
4081
 
 
4082
 
 
4083
class cmd_help(Command):
 
4084
    """Show help on a command or other topic.
 
4085
    """
 
4086
 
 
4087
    _see_also = ['topics']
 
4088
    takes_options = [
 
4089
            Option('long', 'Show help on all commands.'),
 
4090
            ]
 
4091
    takes_args = ['topic?']
 
4092
    aliases = ['?', '--help', '-?', '-h']
 
4093
 
 
4094
    @display_command
 
4095
    def run(self, topic=None, long=False):
 
4096
        import bzrlib.help
 
4097
        if topic is None and long:
 
4098
            topic = "commands"
 
4099
        bzrlib.help.help(topic)
 
4100
 
 
4101
 
 
4102
class cmd_shell_complete(Command):
 
4103
    """Show appropriate completions for context.
 
4104
 
 
4105
    For a list of all available commands, say 'bzr shell-complete'.
 
4106
    """
 
4107
    takes_args = ['context?']
 
4108
    aliases = ['s-c']
 
4109
    hidden = True
 
4110
 
 
4111
    @display_command
 
4112
    def run(self, context=None):
 
4113
        import shellcomplete
 
4114
        shellcomplete.shellcomplete(context)
 
4115
 
 
4116
 
 
4117
class cmd_missing(Command):
 
4118
    """Show unmerged/unpulled revisions between two branches.
 
4119
 
 
4120
    OTHER_BRANCH may be local or remote.
 
4121
 
 
4122
    To filter on a range of revisions, you can use the command -r begin..end
 
4123
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
4124
    also valid.
 
4125
 
 
4126
    :Examples:
 
4127
 
 
4128
        Determine the missing revisions between this and the branch at the
 
4129
        remembered pull location::
 
4130
 
 
4131
            bzr missing
 
4132
 
 
4133
        Determine the missing revisions between this and another branch::
 
4134
 
 
4135
            bzr missing http://server/branch
 
4136
 
 
4137
        Determine the missing revisions up to a specific revision on the other
 
4138
        branch::
 
4139
 
 
4140
            bzr missing -r ..-10
 
4141
 
 
4142
        Determine the missing revisions up to a specific revision on this
 
4143
        branch::
 
4144
 
 
4145
            bzr missing --my-revision ..-10
 
4146
    """
 
4147
 
 
4148
    _see_also = ['merge', 'pull']
 
4149
    takes_args = ['other_branch?']
 
4150
    takes_options = [
 
4151
        Option('reverse', 'Reverse the order of revisions.'),
 
4152
        Option('mine-only',
 
4153
               'Display changes in the local branch only.'),
 
4154
        Option('this' , 'Same as --mine-only.'),
 
4155
        Option('theirs-only',
 
4156
               'Display changes in the remote branch only.'),
 
4157
        Option('other', 'Same as --theirs-only.'),
 
4158
        'log-format',
 
4159
        'show-ids',
 
4160
        'verbose',
 
4161
        custom_help('revision',
 
4162
             help='Filter on other branch revisions (inclusive). '
 
4163
                'See "help revisionspec" for details.'),
 
4164
        Option('my-revision',
 
4165
            type=_parse_revision_str,
 
4166
            help='Filter on local branch revisions (inclusive). '
 
4167
                'See "help revisionspec" for details.'),
 
4168
        Option('include-merges',
 
4169
               'Show all revisions in addition to the mainline ones.'),
 
4170
        ]
 
4171
    encoding_type = 'replace'
 
4172
 
 
4173
    @display_command
 
4174
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
4175
            theirs_only=False,
 
4176
            log_format=None, long=False, short=False, line=False,
 
4177
            show_ids=False, verbose=False, this=False, other=False,
 
4178
            include_merges=False, revision=None, my_revision=None):
 
4179
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
4180
        def message(s):
 
4181
            if not is_quiet():
 
4182
                self.outf.write(s)
 
4183
 
 
4184
        if this:
 
4185
            mine_only = this
 
4186
        if other:
 
4187
            theirs_only = other
 
4188
        # TODO: We should probably check that we don't have mine-only and
 
4189
        #       theirs-only set, but it gets complicated because we also have
 
4190
        #       this and other which could be used.
 
4191
        restrict = 'all'
 
4192
        if mine_only:
 
4193
            restrict = 'local'
 
4194
        elif theirs_only:
 
4195
            restrict = 'remote'
 
4196
 
 
4197
        local_branch = Branch.open_containing(u".")[0]
 
4198
        parent = local_branch.get_parent()
 
4199
        if other_branch is None:
 
4200
            other_branch = parent
 
4201
            if other_branch is None:
 
4202
                raise errors.BzrCommandError("No peer location known"
 
4203
                                             " or specified.")
 
4204
            display_url = urlutils.unescape_for_display(parent,
 
4205
                                                        self.outf.encoding)
 
4206
            message("Using saved parent location: "
 
4207
                    + display_url + "\n")
 
4208
 
 
4209
        remote_branch = Branch.open(other_branch)
 
4210
        if remote_branch.base == local_branch.base:
 
4211
            remote_branch = local_branch
 
4212
 
 
4213
        local_revid_range = _revision_range_to_revid_range(
 
4214
            _get_revision_range(my_revision, local_branch,
 
4215
                self.name()))
 
4216
 
 
4217
        remote_revid_range = _revision_range_to_revid_range(
 
4218
            _get_revision_range(revision,
 
4219
                remote_branch, self.name()))
 
4220
 
 
4221
        local_branch.lock_read()
 
4222
        try:
 
4223
            remote_branch.lock_read()
 
4224
            try:
 
4225
                local_extra, remote_extra = find_unmerged(
 
4226
                    local_branch, remote_branch, restrict,
 
4227
                    backward=not reverse,
 
4228
                    include_merges=include_merges,
 
4229
                    local_revid_range=local_revid_range,
 
4230
                    remote_revid_range=remote_revid_range)
 
4231
 
 
4232
                if log_format is None:
 
4233
                    registry = log.log_formatter_registry
 
4234
                    log_format = registry.get_default(local_branch)
 
4235
                lf = log_format(to_file=self.outf,
 
4236
                                show_ids=show_ids,
 
4237
                                show_timezone='original')
 
4238
 
 
4239
                status_code = 0
 
4240
                if local_extra and not theirs_only:
 
4241
                    message("You have %d extra revision(s):\n" %
 
4242
                        len(local_extra))
 
4243
                    for revision in iter_log_revisions(local_extra,
 
4244
                                        local_branch.repository,
 
4245
                                        verbose):
 
4246
                        lf.log_revision(revision)
 
4247
                    printed_local = True
 
4248
                    status_code = 1
 
4249
                else:
 
4250
                    printed_local = False
 
4251
 
 
4252
                if remote_extra and not mine_only:
 
4253
                    if printed_local is True:
 
4254
                        message("\n\n\n")
 
4255
                    message("You are missing %d revision(s):\n" %
 
4256
                        len(remote_extra))
 
4257
                    for revision in iter_log_revisions(remote_extra,
 
4258
                                        remote_branch.repository,
 
4259
                                        verbose):
 
4260
                        lf.log_revision(revision)
 
4261
                    status_code = 1
 
4262
 
 
4263
                if mine_only and not local_extra:
 
4264
                    # We checked local, and found nothing extra
 
4265
                    message('This branch is up to date.\n')
 
4266
                elif theirs_only and not remote_extra:
 
4267
                    # We checked remote, and found nothing extra
 
4268
                    message('Other branch is up to date.\n')
 
4269
                elif not (mine_only or theirs_only or local_extra or
 
4270
                          remote_extra):
 
4271
                    # We checked both branches, and neither one had extra
 
4272
                    # revisions
 
4273
                    message("Branches are up to date.\n")
 
4274
            finally:
 
4275
                remote_branch.unlock()
 
4276
        finally:
 
4277
            local_branch.unlock()
 
4278
        if not status_code and parent is None and other_branch is not None:
 
4279
            local_branch.lock_write()
 
4280
            try:
 
4281
                # handle race conditions - a parent might be set while we run.
 
4282
                if local_branch.get_parent() is None:
 
4283
                    local_branch.set_parent(remote_branch.base)
 
4284
            finally:
 
4285
                local_branch.unlock()
 
4286
        return status_code
 
4287
 
 
4288
 
 
4289
class cmd_pack(Command):
 
4290
    """Compress the data within a repository."""
 
4291
 
 
4292
    _see_also = ['repositories']
 
4293
    takes_args = ['branch_or_repo?']
 
4294
 
 
4295
    def run(self, branch_or_repo='.'):
 
4296
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
4297
        try:
 
4298
            branch = dir.open_branch()
 
4299
            repository = branch.repository
 
4300
        except errors.NotBranchError:
 
4301
            repository = dir.open_repository()
 
4302
        repository.pack()
 
4303
 
 
4304
 
 
4305
class cmd_plugins(Command):
 
4306
    """List the installed plugins.
 
4307
 
 
4308
    This command displays the list of installed plugins including
 
4309
    version of plugin and a short description of each.
 
4310
 
 
4311
    --verbose shows the path where each plugin is located.
 
4312
 
 
4313
    A plugin is an external component for Bazaar that extends the
 
4314
    revision control system, by adding or replacing code in Bazaar.
 
4315
    Plugins can do a variety of things, including overriding commands,
 
4316
    adding new commands, providing additional network transports and
 
4317
    customizing log output.
 
4318
 
 
4319
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4320
    information on plugins including where to find them and how to
 
4321
    install them. Instructions are also provided there on how to
 
4322
    write new plugins using the Python programming language.
 
4323
    """
 
4324
    takes_options = ['verbose']
 
4325
 
 
4326
    @display_command
 
4327
    def run(self, verbose=False):
 
4328
        import bzrlib.plugin
 
4329
        from inspect import getdoc
 
4330
        result = []
 
4331
        for name, plugin in bzrlib.plugin.plugins().items():
 
4332
            version = plugin.__version__
 
4333
            if version == 'unknown':
 
4334
                version = ''
 
4335
            name_ver = '%s %s' % (name, version)
 
4336
            d = getdoc(plugin.module)
 
4337
            if d:
 
4338
                doc = d.split('\n')[0]
 
4339
            else:
 
4340
                doc = '(no description)'
 
4341
            result.append((name_ver, doc, plugin.path()))
 
4342
        for name_ver, doc, path in sorted(result):
 
4343
            print name_ver
 
4344
            print '   ', doc
 
4345
            if verbose:
 
4346
                print '   ', path
 
4347
            print
 
4348
 
 
4349
 
 
4350
class cmd_testament(Command):
 
4351
    """Show testament (signing-form) of a revision."""
 
4352
    takes_options = [
 
4353
            'revision',
 
4354
            Option('long', help='Produce long-format testament.'),
 
4355
            Option('strict',
 
4356
                   help='Produce a strict-format testament.')]
 
4357
    takes_args = ['branch?']
 
4358
    @display_command
 
4359
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
4360
        from bzrlib.testament import Testament, StrictTestament
 
4361
        if strict is True:
 
4362
            testament_class = StrictTestament
 
4363
        else:
 
4364
            testament_class = Testament
 
4365
        if branch == '.':
 
4366
            b = Branch.open_containing(branch)[0]
 
4367
        else:
 
4368
            b = Branch.open(branch)
 
4369
        b.lock_read()
 
4370
        try:
 
4371
            if revision is None:
 
4372
                rev_id = b.last_revision()
 
4373
            else:
 
4374
                rev_id = revision[0].as_revision_id(b)
 
4375
            t = testament_class.from_revision(b.repository, rev_id)
 
4376
            if long:
 
4377
                sys.stdout.writelines(t.as_text_lines())
 
4378
            else:
 
4379
                sys.stdout.write(t.as_short_text())
 
4380
        finally:
 
4381
            b.unlock()
 
4382
 
 
4383
 
 
4384
class cmd_annotate(Command):
 
4385
    """Show the origin of each line in a file.
 
4386
 
 
4387
    This prints out the given file with an annotation on the left side
 
4388
    indicating which revision, author and date introduced the change.
 
4389
 
 
4390
    If the origin is the same for a run of consecutive lines, it is
 
4391
    shown only at the top, unless the --all option is given.
 
4392
    """
 
4393
    # TODO: annotate directories; showing when each file was last changed
 
4394
    # TODO: if the working copy is modified, show annotations on that
 
4395
    #       with new uncommitted lines marked
 
4396
    aliases = ['ann', 'blame', 'praise']
 
4397
    takes_args = ['filename']
 
4398
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
4399
                     Option('long', help='Show commit date in annotations.'),
 
4400
                     'revision',
 
4401
                     'show-ids',
 
4402
                     ]
 
4403
    encoding_type = 'exact'
 
4404
 
 
4405
    @display_command
 
4406
    def run(self, filename, all=False, long=False, revision=None,
 
4407
            show_ids=False):
 
4408
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4409
        wt, branch, relpath = \
 
4410
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4411
        if wt is not None:
 
4412
            wt.lock_read()
 
4413
        else:
 
4414
            branch.lock_read()
 
4415
        try:
 
4416
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4417
            if wt is not None:
 
4418
                file_id = wt.path2id(relpath)
 
4419
            else:
 
4420
                file_id = tree.path2id(relpath)
 
4421
            if file_id is None:
 
4422
                raise errors.NotVersionedError(filename)
 
4423
            file_version = tree.inventory[file_id].revision
 
4424
            if wt is not None and revision is None:
 
4425
                # If there is a tree and we're not annotating historical
 
4426
                # versions, annotate the working tree's content.
 
4427
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4428
                    show_ids=show_ids)
 
4429
            else:
 
4430
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4431
                              show_ids=show_ids)
 
4432
        finally:
 
4433
            if wt is not None:
 
4434
                wt.unlock()
 
4435
            else:
 
4436
                branch.unlock()
 
4437
 
 
4438
 
 
4439
class cmd_re_sign(Command):
 
4440
    """Create a digital signature for an existing revision."""
 
4441
    # TODO be able to replace existing ones.
 
4442
 
 
4443
    hidden = True # is this right ?
 
4444
    takes_args = ['revision_id*']
 
4445
    takes_options = ['revision']
 
4446
 
 
4447
    def run(self, revision_id_list=None, revision=None):
 
4448
        if revision_id_list is not None and revision is not None:
 
4449
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
4450
        if revision_id_list is None and revision is None:
 
4451
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
4452
        b = WorkingTree.open_containing(u'.')[0].branch
 
4453
        b.lock_write()
 
4454
        try:
 
4455
            return self._run(b, revision_id_list, revision)
 
4456
        finally:
 
4457
            b.unlock()
 
4458
 
 
4459
    def _run(self, b, revision_id_list, revision):
 
4460
        import bzrlib.gpg as gpg
 
4461
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
4462
        if revision_id_list is not None:
 
4463
            b.repository.start_write_group()
 
4464
            try:
 
4465
                for revision_id in revision_id_list:
 
4466
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
4467
            except:
 
4468
                b.repository.abort_write_group()
 
4469
                raise
 
4470
            else:
 
4471
                b.repository.commit_write_group()
 
4472
        elif revision is not None:
 
4473
            if len(revision) == 1:
 
4474
                revno, rev_id = revision[0].in_history(b)
 
4475
                b.repository.start_write_group()
 
4476
                try:
 
4477
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
4478
                except:
 
4479
                    b.repository.abort_write_group()
 
4480
                    raise
 
4481
                else:
 
4482
                    b.repository.commit_write_group()
 
4483
            elif len(revision) == 2:
 
4484
                # are they both on rh- if so we can walk between them
 
4485
                # might be nice to have a range helper for arbitrary
 
4486
                # revision paths. hmm.
 
4487
                from_revno, from_revid = revision[0].in_history(b)
 
4488
                to_revno, to_revid = revision[1].in_history(b)
 
4489
                if to_revid is None:
 
4490
                    to_revno = b.revno()
 
4491
                if from_revno is None or to_revno is None:
 
4492
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
4493
                b.repository.start_write_group()
 
4494
                try:
 
4495
                    for revno in range(from_revno, to_revno + 1):
 
4496
                        b.repository.sign_revision(b.get_rev_id(revno),
 
4497
                                                   gpg_strategy)
 
4498
                except:
 
4499
                    b.repository.abort_write_group()
 
4500
                    raise
 
4501
                else:
 
4502
                    b.repository.commit_write_group()
 
4503
            else:
 
4504
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
4505
 
 
4506
 
 
4507
class cmd_bind(Command):
 
4508
    """Convert the current branch into a checkout of the supplied branch.
 
4509
 
 
4510
    Once converted into a checkout, commits must succeed on the master branch
 
4511
    before they will be applied to the local branch.
 
4512
 
 
4513
    Bound branches use the nickname of its master branch unless it is set
 
4514
    locally, in which case binding will update the the local nickname to be
 
4515
    that of the master.
 
4516
    """
 
4517
 
 
4518
    _see_also = ['checkouts', 'unbind']
 
4519
    takes_args = ['location?']
 
4520
    takes_options = []
 
4521
 
 
4522
    def run(self, location=None):
 
4523
        b, relpath = Branch.open_containing(u'.')
 
4524
        if location is None:
 
4525
            try:
 
4526
                location = b.get_old_bound_location()
 
4527
            except errors.UpgradeRequired:
 
4528
                raise errors.BzrCommandError('No location supplied.  '
 
4529
                    'This format does not remember old locations.')
 
4530
            else:
 
4531
                if location is None:
 
4532
                    raise errors.BzrCommandError('No location supplied and no '
 
4533
                        'previous location known')
 
4534
        b_other = Branch.open(location)
 
4535
        try:
 
4536
            b.bind(b_other)
 
4537
        except errors.DivergedBranches:
 
4538
            raise errors.BzrCommandError('These branches have diverged.'
 
4539
                                         ' Try merging, and then bind again.')
 
4540
        if b.get_config().has_explicit_nickname():
 
4541
            b.nick = b_other.nick
 
4542
 
 
4543
 
 
4544
class cmd_unbind(Command):
 
4545
    """Convert the current checkout into a regular branch.
 
4546
 
 
4547
    After unbinding, the local branch is considered independent and subsequent
 
4548
    commits will be local only.
 
4549
    """
 
4550
 
 
4551
    _see_also = ['checkouts', 'bind']
 
4552
    takes_args = []
 
4553
    takes_options = []
 
4554
 
 
4555
    def run(self):
 
4556
        b, relpath = Branch.open_containing(u'.')
 
4557
        if not b.unbind():
 
4558
            raise errors.BzrCommandError('Local branch is not bound')
 
4559
 
 
4560
 
 
4561
class cmd_uncommit(Command):
 
4562
    """Remove the last committed revision.
 
4563
 
 
4564
    --verbose will print out what is being removed.
 
4565
    --dry-run will go through all the motions, but not actually
 
4566
    remove anything.
 
4567
 
 
4568
    If --revision is specified, uncommit revisions to leave the branch at the
 
4569
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
4570
    branch at revision 15.
 
4571
 
 
4572
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4573
    it may make is to restore any pending merges that were present before
 
4574
    the commit.
 
4575
    """
 
4576
 
 
4577
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
4578
    # unreferenced information in 'branch-as-repository' branches.
 
4579
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
4580
    # information in shared branches as well.
 
4581
    _see_also = ['commit']
 
4582
    takes_options = ['verbose', 'revision',
 
4583
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4584
                    Option('force', help='Say yes to all questions.'),
 
4585
                    Option('local',
 
4586
                           help="Only remove the commits from the local branch"
 
4587
                                " when in a checkout."
 
4588
                           ),
 
4589
                    ]
 
4590
    takes_args = ['location?']
 
4591
    aliases = []
 
4592
    encoding_type = 'replace'
 
4593
 
 
4594
    def run(self, location=None,
 
4595
            dry_run=False, verbose=False,
 
4596
            revision=None, force=False, local=False):
 
4597
        if location is None:
 
4598
            location = u'.'
 
4599
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4600
        try:
 
4601
            tree = control.open_workingtree()
 
4602
            b = tree.branch
 
4603
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4604
            tree = None
 
4605
            b = control.open_branch()
 
4606
 
 
4607
        if tree is not None:
 
4608
            tree.lock_write()
 
4609
        else:
 
4610
            b.lock_write()
 
4611
        try:
 
4612
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4613
                             local=local)
 
4614
        finally:
 
4615
            if tree is not None:
 
4616
                tree.unlock()
 
4617
            else:
 
4618
                b.unlock()
 
4619
 
 
4620
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4621
        from bzrlib.log import log_formatter, show_log
 
4622
        from bzrlib.uncommit import uncommit
 
4623
 
 
4624
        last_revno, last_rev_id = b.last_revision_info()
 
4625
 
 
4626
        rev_id = None
 
4627
        if revision is None:
 
4628
            revno = last_revno
 
4629
            rev_id = last_rev_id
 
4630
        else:
 
4631
            # 'bzr uncommit -r 10' actually means uncommit
 
4632
            # so that the final tree is at revno 10.
 
4633
            # but bzrlib.uncommit.uncommit() actually uncommits
 
4634
            # the revisions that are supplied.
 
4635
            # So we need to offset it by one
 
4636
            revno = revision[0].in_history(b).revno + 1
 
4637
            if revno <= last_revno:
 
4638
                rev_id = b.get_rev_id(revno)
 
4639
 
 
4640
        if rev_id is None or _mod_revision.is_null(rev_id):
 
4641
            self.outf.write('No revisions to uncommit.\n')
 
4642
            return 1
 
4643
 
 
4644
        lf = log_formatter('short',
 
4645
                           to_file=self.outf,
 
4646
                           show_timezone='original')
 
4647
 
 
4648
        show_log(b,
 
4649
                 lf,
 
4650
                 verbose=False,
 
4651
                 direction='forward',
 
4652
                 start_revision=revno,
 
4653
                 end_revision=last_revno)
 
4654
 
 
4655
        if dry_run:
 
4656
            print 'Dry-run, pretending to remove the above revisions.'
 
4657
            if not force:
 
4658
                val = raw_input('Press <enter> to continue')
 
4659
        else:
 
4660
            print 'The above revision(s) will be removed.'
 
4661
            if not force:
 
4662
                val = raw_input('Are you sure [y/N]? ')
 
4663
                if val.lower() not in ('y', 'yes'):
 
4664
                    print 'Canceled'
 
4665
                    return 0
 
4666
 
 
4667
        mutter('Uncommitting from {%s} to {%s}',
 
4668
               last_rev_id, rev_id)
 
4669
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
4670
                 revno=revno, local=local)
 
4671
        note('You can restore the old tip by running:\n'
 
4672
             '  bzr pull . -r revid:%s', last_rev_id)
 
4673
 
 
4674
 
 
4675
class cmd_break_lock(Command):
 
4676
    """Break a dead lock on a repository, branch or working directory.
 
4677
 
 
4678
    CAUTION: Locks should only be broken when you are sure that the process
 
4679
    holding the lock has been stopped.
 
4680
 
 
4681
    You can get information on what locks are open via the 'bzr info' command.
 
4682
 
 
4683
    :Examples:
 
4684
        bzr break-lock
 
4685
    """
 
4686
    takes_args = ['location?']
 
4687
 
 
4688
    def run(self, location=None, show=False):
 
4689
        if location is None:
 
4690
            location = u'.'
 
4691
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4692
        try:
 
4693
            control.break_lock()
 
4694
        except NotImplementedError:
 
4695
            pass
 
4696
 
 
4697
 
 
4698
class cmd_wait_until_signalled(Command):
 
4699
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4700
 
 
4701
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4702
    """
 
4703
 
 
4704
    hidden = True
 
4705
 
 
4706
    def run(self):
 
4707
        sys.stdout.write("running\n")
 
4708
        sys.stdout.flush()
 
4709
        sys.stdin.readline()
 
4710
 
 
4711
 
 
4712
class cmd_serve(Command):
 
4713
    """Run the bzr server."""
 
4714
 
 
4715
    aliases = ['server']
 
4716
 
 
4717
    takes_options = [
 
4718
        Option('inet',
 
4719
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4720
        RegistryOption('protocol', 
 
4721
               help="Protocol to serve.", 
 
4722
               lazy_registry=('bzrlib.transport', 'transport_server_registry'),
 
4723
               value_switches=True),
 
4724
        Option('port',
 
4725
               help='Listen for connections on nominated port of the form '
 
4726
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4727
                    'result in a dynamically allocated port.  The default port '
 
4728
                    'depends on the protocol.',
 
4729
               type=str),
 
4730
        Option('directory',
 
4731
               help='Serve contents of this directory.',
 
4732
               type=unicode),
 
4733
        Option('allow-writes',
 
4734
               help='By default the server is a readonly server.  Supplying '
 
4735
                    '--allow-writes enables write access to the contents of '
 
4736
                    'the served directory and below.'
 
4737
                ),
 
4738
        ]
 
4739
 
 
4740
    def get_host_and_port(self, port):
 
4741
        """Return the host and port to run the smart server on.
 
4742
 
 
4743
        If 'port' is None, None will be returned for the host and port.
 
4744
 
 
4745
        If 'port' has a colon in it, the string before the colon will be
 
4746
        interpreted as the host.
 
4747
 
 
4748
        :param port: A string of the port to run the server on.
 
4749
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4750
            and port is an integer TCP/IP port.
 
4751
        """
 
4752
        host = None
 
4753
        if port is not None:
 
4754
            if ':' in port:
 
4755
                host, port = port.split(':')
 
4756
            port = int(port)
 
4757
        return host, port
 
4758
 
 
4759
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
 
4760
            protocol=None):
 
4761
        from bzrlib.transport import get_transport, transport_server_registry
 
4762
        if directory is None:
 
4763
            directory = os.getcwd()
 
4764
        if protocol is None:
 
4765
            protocol = transport_server_registry.get()
 
4766
        host, port = self.get_host_and_port(port)
 
4767
        url = urlutils.local_path_to_url(directory)
 
4768
        if not allow_writes:
 
4769
            url = 'readonly+' + url
 
4770
        transport = get_transport(url)
 
4771
        protocol(transport, host, port, inet)
 
4772
 
 
4773
 
 
4774
class cmd_join(Command):
 
4775
    """Combine a tree into its containing tree.
 
4776
 
 
4777
    This command requires the target tree to be in a rich-root format.
 
4778
 
 
4779
    The TREE argument should be an independent tree, inside another tree, but
 
4780
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4781
    running "bzr branch" with the target inside a tree.)
 
4782
 
 
4783
    The result is a combined tree, with the subtree no longer an independant
 
4784
    part.  This is marked as a merge of the subtree into the containing tree,
 
4785
    and all history is preserved.
 
4786
    """
 
4787
 
 
4788
    _see_also = ['split']
 
4789
    takes_args = ['tree']
 
4790
    takes_options = [
 
4791
            Option('reference', help='Join by reference.', hidden=True),
 
4792
            ]
 
4793
 
 
4794
    def run(self, tree, reference=False):
 
4795
        sub_tree = WorkingTree.open(tree)
 
4796
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4797
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4798
        repo = containing_tree.branch.repository
 
4799
        if not repo.supports_rich_root():
 
4800
            raise errors.BzrCommandError(
 
4801
                "Can't join trees because %s doesn't support rich root data.\n"
 
4802
                "You can use bzr upgrade on the repository."
 
4803
                % (repo,))
 
4804
        if reference:
 
4805
            try:
 
4806
                containing_tree.add_reference(sub_tree)
 
4807
            except errors.BadReferenceTarget, e:
 
4808
                # XXX: Would be better to just raise a nicely printable
 
4809
                # exception from the real origin.  Also below.  mbp 20070306
 
4810
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4811
                                             (tree, e.reason))
 
4812
        else:
 
4813
            try:
 
4814
                containing_tree.subsume(sub_tree)
 
4815
            except errors.BadSubsumeSource, e:
 
4816
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4817
                                             (tree, e.reason))
 
4818
 
 
4819
 
 
4820
class cmd_split(Command):
 
4821
    """Split a subdirectory of a tree into a separate tree.
 
4822
 
 
4823
    This command will produce a target tree in a format that supports
 
4824
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4825
    converted into earlier formats like 'dirstate-tags'.
 
4826
 
 
4827
    The TREE argument should be a subdirectory of a working tree.  That
 
4828
    subdirectory will be converted into an independent tree, with its own
 
4829
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4830
    """
 
4831
 
 
4832
    _see_also = ['join']
 
4833
    takes_args = ['tree']
 
4834
 
 
4835
    def run(self, tree):
 
4836
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4837
        sub_id = containing_tree.path2id(subdir)
 
4838
        if sub_id is None:
 
4839
            raise errors.NotVersionedError(subdir)
 
4840
        try:
 
4841
            containing_tree.extract(sub_id)
 
4842
        except errors.RootNotRich:
 
4843
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
4844
 
 
4845
 
 
4846
class cmd_merge_directive(Command):
 
4847
    """Generate a merge directive for auto-merge tools.
 
4848
 
 
4849
    A directive requests a merge to be performed, and also provides all the
 
4850
    information necessary to do so.  This means it must either include a
 
4851
    revision bundle, or the location of a branch containing the desired
 
4852
    revision.
 
4853
 
 
4854
    A submit branch (the location to merge into) must be supplied the first
 
4855
    time the command is issued.  After it has been supplied once, it will
 
4856
    be remembered as the default.
 
4857
 
 
4858
    A public branch is optional if a revision bundle is supplied, but required
 
4859
    if --diff or --plain is specified.  It will be remembered as the default
 
4860
    after the first use.
 
4861
    """
 
4862
 
 
4863
    takes_args = ['submit_branch?', 'public_branch?']
 
4864
 
 
4865
    hidden = True
 
4866
 
 
4867
    _see_also = ['send']
 
4868
 
 
4869
    takes_options = [
 
4870
        RegistryOption.from_kwargs('patch-type',
 
4871
            'The type of patch to include in the directive.',
 
4872
            title='Patch type',
 
4873
            value_switches=True,
 
4874
            enum_switch=False,
 
4875
            bundle='Bazaar revision bundle (default).',
 
4876
            diff='Normal unified diff.',
 
4877
            plain='No patch, just directive.'),
 
4878
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4879
        Option('mail-to', type=str,
 
4880
            help='Instead of printing the directive, email to this address.'),
 
4881
        Option('message', type=str, short_name='m',
 
4882
            help='Message to use when committing this merge.')
 
4883
        ]
 
4884
 
 
4885
    encoding_type = 'exact'
 
4886
 
 
4887
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4888
            sign=False, revision=None, mail_to=None, message=None):
 
4889
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4890
        include_patch, include_bundle = {
 
4891
            'plain': (False, False),
 
4892
            'diff': (True, False),
 
4893
            'bundle': (True, True),
 
4894
            }[patch_type]
 
4895
        branch = Branch.open('.')
 
4896
        stored_submit_branch = branch.get_submit_branch()
 
4897
        if submit_branch is None:
 
4898
            submit_branch = stored_submit_branch
 
4899
        else:
 
4900
            if stored_submit_branch is None:
 
4901
                branch.set_submit_branch(submit_branch)
 
4902
        if submit_branch is None:
 
4903
            submit_branch = branch.get_parent()
 
4904
        if submit_branch is None:
 
4905
            raise errors.BzrCommandError('No submit branch specified or known')
 
4906
 
 
4907
        stored_public_branch = branch.get_public_branch()
 
4908
        if public_branch is None:
 
4909
            public_branch = stored_public_branch
 
4910
        elif stored_public_branch is None:
 
4911
            branch.set_public_branch(public_branch)
 
4912
        if not include_bundle and public_branch is None:
 
4913
            raise errors.BzrCommandError('No public branch specified or'
 
4914
                                         ' known')
 
4915
        base_revision_id = None
 
4916
        if revision is not None:
 
4917
            if len(revision) > 2:
 
4918
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4919
                    'at most two one revision identifiers')
 
4920
            revision_id = revision[-1].as_revision_id(branch)
 
4921
            if len(revision) == 2:
 
4922
                base_revision_id = revision[0].as_revision_id(branch)
 
4923
        else:
 
4924
            revision_id = branch.last_revision()
 
4925
        revision_id = ensure_null(revision_id)
 
4926
        if revision_id == NULL_REVISION:
 
4927
            raise errors.BzrCommandError('No revisions to bundle.')
 
4928
        directive = merge_directive.MergeDirective2.from_objects(
 
4929
            branch.repository, revision_id, time.time(),
 
4930
            osutils.local_time_offset(), submit_branch,
 
4931
            public_branch=public_branch, include_patch=include_patch,
 
4932
            include_bundle=include_bundle, message=message,
 
4933
            base_revision_id=base_revision_id)
 
4934
        if mail_to is None:
 
4935
            if sign:
 
4936
                self.outf.write(directive.to_signed(branch))
 
4937
            else:
 
4938
                self.outf.writelines(directive.to_lines())
 
4939
        else:
 
4940
            message = directive.to_email(mail_to, branch, sign)
 
4941
            s = SMTPConnection(branch.get_config())
 
4942
            s.send_email(message)
 
4943
 
 
4944
 
 
4945
class cmd_send(Command):
 
4946
    """Mail or create a merge-directive for submitting changes.
 
4947
 
 
4948
    A merge directive provides many things needed for requesting merges:
 
4949
 
 
4950
    * A machine-readable description of the merge to perform
 
4951
 
 
4952
    * An optional patch that is a preview of the changes requested
 
4953
 
 
4954
    * An optional bundle of revision data, so that the changes can be applied
 
4955
      directly from the merge directive, without retrieving data from a
 
4956
      branch.
 
4957
 
 
4958
    If --no-bundle is specified, then public_branch is needed (and must be
 
4959
    up-to-date), so that the receiver can perform the merge using the
 
4960
    public_branch.  The public_branch is always included if known, so that
 
4961
    people can check it later.
 
4962
 
 
4963
    The submit branch defaults to the parent, but can be overridden.  Both
 
4964
    submit branch and public branch will be remembered if supplied.
 
4965
 
 
4966
    If a public_branch is known for the submit_branch, that public submit
 
4967
    branch is used in the merge instructions.  This means that a local mirror
 
4968
    can be used as your actual submit branch, once you have set public_branch
 
4969
    for that mirror.
 
4970
 
 
4971
    Mail is sent using your preferred mail program.  This should be transparent
 
4972
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4973
    If the preferred client can't be found (or used), your editor will be used.
 
4974
 
 
4975
    To use a specific mail program, set the mail_client configuration option.
 
4976
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4977
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
 
4978
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
 
4979
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
 
4980
    supported clients.
 
4981
 
 
4982
    If mail is being sent, a to address is required.  This can be supplied
 
4983
    either on the commandline, by setting the submit_to configuration
 
4984
    option in the branch itself or the child_submit_to configuration option
 
4985
    in the submit branch.
 
4986
 
 
4987
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4988
    merge directive format 2.  It is significantly faster and smaller than
 
4989
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4990
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4991
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4992
 
 
4993
    The merge directives created by bzr send may be applied using bzr merge or
 
4994
    bzr pull by specifying a file containing a merge directive as the location.
 
4995
    """
 
4996
 
 
4997
    encoding_type = 'exact'
 
4998
 
 
4999
    _see_also = ['merge', 'pull']
 
5000
 
 
5001
    takes_args = ['submit_branch?', 'public_branch?']
 
5002
 
 
5003
    takes_options = [
 
5004
        Option('no-bundle',
 
5005
               help='Do not include a bundle in the merge directive.'),
 
5006
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5007
               ' directive.'),
 
5008
        Option('remember',
 
5009
               help='Remember submit and public branch.'),
 
5010
        Option('from',
 
5011
               help='Branch to generate the submission from, '
 
5012
               'rather than the one containing the working directory.',
 
5013
               short_name='f',
 
5014
               type=unicode),
 
5015
        Option('output', short_name='o',
 
5016
               help='Write merge directive to this file; '
 
5017
                    'use - for stdout.',
 
5018
               type=unicode),
 
5019
        Option('strict',
 
5020
               help='Refuse to send if there are uncommitted changes in'
 
5021
               ' the working tree, --no-strict disables the check.'),
 
5022
        Option('mail-to', help='Mail the request to this address.',
 
5023
               type=unicode),
 
5024
        'revision',
 
5025
        'message',
 
5026
        Option('body', help='Body for the email.', type=unicode),
 
5027
        RegistryOption('format',
 
5028
                       help='Use the specified output format.',
 
5029
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5030
        ]
 
5031
 
 
5032
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5033
            no_patch=False, revision=None, remember=False, output=None,
 
5034
            format=None, mail_to=None, message=None, body=None,
 
5035
            strict=None, **kwargs):
 
5036
        from bzrlib.send import send
 
5037
        return send(submit_branch, revision, public_branch, remember,
 
5038
                    format, no_bundle, no_patch, output,
 
5039
                    kwargs.get('from', '.'), mail_to, message, body,
 
5040
                    self.outf,
 
5041
                    strict=strict)
 
5042
 
 
5043
 
 
5044
class cmd_bundle_revisions(cmd_send):
 
5045
    """Create a merge-directive for submitting changes.
 
5046
 
 
5047
    A merge directive provides many things needed for requesting merges:
 
5048
 
 
5049
    * A machine-readable description of the merge to perform
 
5050
 
 
5051
    * An optional patch that is a preview of the changes requested
 
5052
 
 
5053
    * An optional bundle of revision data, so that the changes can be applied
 
5054
      directly from the merge directive, without retrieving data from a
 
5055
      branch.
 
5056
 
 
5057
    If --no-bundle is specified, then public_branch is needed (and must be
 
5058
    up-to-date), so that the receiver can perform the merge using the
 
5059
    public_branch.  The public_branch is always included if known, so that
 
5060
    people can check it later.
 
5061
 
 
5062
    The submit branch defaults to the parent, but can be overridden.  Both
 
5063
    submit branch and public branch will be remembered if supplied.
 
5064
 
 
5065
    If a public_branch is known for the submit_branch, that public submit
 
5066
    branch is used in the merge instructions.  This means that a local mirror
 
5067
    can be used as your actual submit branch, once you have set public_branch
 
5068
    for that mirror.
 
5069
 
 
5070
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
5071
    merge directive format 2.  It is significantly faster and smaller than
 
5072
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
5073
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
5074
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
5075
    """
 
5076
 
 
5077
    takes_options = [
 
5078
        Option('no-bundle',
 
5079
               help='Do not include a bundle in the merge directive.'),
 
5080
        Option('no-patch', help='Do not include a preview patch in the merge'
 
5081
               ' directive.'),
 
5082
        Option('remember',
 
5083
               help='Remember submit and public branch.'),
 
5084
        Option('from',
 
5085
               help='Branch to generate the submission from, '
 
5086
               'rather than the one containing the working directory.',
 
5087
               short_name='f',
 
5088
               type=unicode),
 
5089
        Option('output', short_name='o', help='Write directive to this file.',
 
5090
               type=unicode),
 
5091
        Option('strict',
 
5092
               help='Refuse to bundle revisions if there are uncommitted'
 
5093
               ' changes in the working tree, --no-strict disables the check.'),
 
5094
        'revision',
 
5095
        RegistryOption('format',
 
5096
                       help='Use the specified output format.',
 
5097
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
5098
        ]
 
5099
    aliases = ['bundle']
 
5100
 
 
5101
    _see_also = ['send', 'merge']
 
5102
 
 
5103
    hidden = True
 
5104
 
 
5105
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5106
            no_patch=False, revision=None, remember=False, output=None,
 
5107
            format=None, strict=None, **kwargs):
 
5108
        if output is None:
 
5109
            output = '-'
 
5110
        from bzrlib.send import send
 
5111
        return send(submit_branch, revision, public_branch, remember,
 
5112
                         format, no_bundle, no_patch, output,
 
5113
                         kwargs.get('from', '.'), None, None, None,
 
5114
                         self.outf, strict=strict)
 
5115
 
 
5116
 
 
5117
class cmd_tag(Command):
 
5118
    """Create, remove or modify a tag naming a revision.
 
5119
 
 
5120
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
5121
    (--revision) option can be given -rtag:X, where X is any previously
 
5122
    created tag.
 
5123
 
 
5124
    Tags are stored in the branch.  Tags are copied from one branch to another
 
5125
    along when you branch, push, pull or merge.
 
5126
 
 
5127
    It is an error to give a tag name that already exists unless you pass
 
5128
    --force, in which case the tag is moved to point to the new revision.
 
5129
 
 
5130
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
5131
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5132
    """
 
5133
 
 
5134
    _see_also = ['commit', 'tags']
 
5135
    takes_args = ['tag_name']
 
5136
    takes_options = [
 
5137
        Option('delete',
 
5138
            help='Delete this tag rather than placing it.',
 
5139
            ),
 
5140
        Option('directory',
 
5141
            help='Branch in which to place the tag.',
 
5142
            short_name='d',
 
5143
            type=unicode,
 
5144
            ),
 
5145
        Option('force',
 
5146
            help='Replace existing tags.',
 
5147
            ),
 
5148
        'revision',
 
5149
        ]
 
5150
 
 
5151
    def run(self, tag_name,
 
5152
            delete=None,
 
5153
            directory='.',
 
5154
            force=None,
 
5155
            revision=None,
 
5156
            ):
 
5157
        branch, relpath = Branch.open_containing(directory)
 
5158
        branch.lock_write()
 
5159
        try:
 
5160
            if delete:
 
5161
                branch.tags.delete_tag(tag_name)
 
5162
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5163
            else:
 
5164
                if revision:
 
5165
                    if len(revision) != 1:
 
5166
                        raise errors.BzrCommandError(
 
5167
                            "Tags can only be placed on a single revision, "
 
5168
                            "not on a range")
 
5169
                    revision_id = revision[0].as_revision_id(branch)
 
5170
                else:
 
5171
                    revision_id = branch.last_revision()
 
5172
                if (not force) and branch.tags.has_tag(tag_name):
 
5173
                    raise errors.TagAlreadyExists(tag_name)
 
5174
                branch.tags.set_tag(tag_name, revision_id)
 
5175
                self.outf.write('Created tag %s.\n' % tag_name)
 
5176
        finally:
 
5177
            branch.unlock()
 
5178
 
 
5179
 
 
5180
class cmd_tags(Command):
 
5181
    """List tags.
 
5182
 
 
5183
    This command shows a table of tag names and the revisions they reference.
 
5184
    """
 
5185
 
 
5186
    _see_also = ['tag']
 
5187
    takes_options = [
 
5188
        Option('directory',
 
5189
            help='Branch whose tags should be displayed.',
 
5190
            short_name='d',
 
5191
            type=unicode,
 
5192
            ),
 
5193
        RegistryOption.from_kwargs('sort',
 
5194
            'Sort tags by different criteria.', title='Sorting',
 
5195
            alpha='Sort tags lexicographically (default).',
 
5196
            time='Sort tags chronologically.',
 
5197
            ),
 
5198
        'show-ids',
 
5199
        'revision',
 
5200
    ]
 
5201
 
 
5202
    @display_command
 
5203
    def run(self,
 
5204
            directory='.',
 
5205
            sort='alpha',
 
5206
            show_ids=False,
 
5207
            revision=None,
 
5208
            ):
 
5209
        branch, relpath = Branch.open_containing(directory)
 
5210
 
 
5211
        tags = branch.tags.get_tag_dict().items()
 
5212
        if not tags:
 
5213
            return
 
5214
 
 
5215
        branch.lock_read()
 
5216
        try:
 
5217
            if revision:
 
5218
                graph = branch.repository.get_graph()
 
5219
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5220
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5221
                # only show revisions between revid1 and revid2 (inclusive)
 
5222
                tags = [(tag, revid) for tag, revid in tags if
 
5223
                    graph.is_between(revid, revid1, revid2)]
 
5224
            if sort == 'alpha':
 
5225
                tags.sort()
 
5226
            elif sort == 'time':
 
5227
                timestamps = {}
 
5228
                for tag, revid in tags:
 
5229
                    try:
 
5230
                        revobj = branch.repository.get_revision(revid)
 
5231
                    except errors.NoSuchRevision:
 
5232
                        timestamp = sys.maxint # place them at the end
 
5233
                    else:
 
5234
                        timestamp = revobj.timestamp
 
5235
                    timestamps[revid] = timestamp
 
5236
                tags.sort(key=lambda x: timestamps[x[1]])
 
5237
            if not show_ids:
 
5238
                # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5239
                for index, (tag, revid) in enumerate(tags):
 
5240
                    try:
 
5241
                        revno = branch.revision_id_to_dotted_revno(revid)
 
5242
                        if isinstance(revno, tuple):
 
5243
                            revno = '.'.join(map(str, revno))
 
5244
                    except errors.NoSuchRevision:
 
5245
                        # Bad tag data/merges can lead to tagged revisions
 
5246
                        # which are not in this branch. Fail gracefully ...
 
5247
                        revno = '?'
 
5248
                    tags[index] = (tag, revno)
 
5249
        finally:
 
5250
            branch.unlock()
 
5251
        for tag, revspec in tags:
 
5252
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
5253
 
 
5254
 
 
5255
class cmd_reconfigure(Command):
 
5256
    """Reconfigure the type of a bzr directory.
 
5257
 
 
5258
    A target configuration must be specified.
 
5259
 
 
5260
    For checkouts, the bind-to location will be auto-detected if not specified.
 
5261
    The order of preference is
 
5262
    1. For a lightweight checkout, the current bound location.
 
5263
    2. For branches that used to be checkouts, the previously-bound location.
 
5264
    3. The push location.
 
5265
    4. The parent location.
 
5266
    If none of these is available, --bind-to must be specified.
 
5267
    """
 
5268
 
 
5269
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
5270
    takes_args = ['location?']
 
5271
    takes_options = [
 
5272
        RegistryOption.from_kwargs(
 
5273
            'target_type',
 
5274
            title='Target type',
 
5275
            help='The type to reconfigure the directory to.',
 
5276
            value_switches=True, enum_switch=False,
 
5277
            branch='Reconfigure to be an unbound branch with no working tree.',
 
5278
            tree='Reconfigure to be an unbound branch with a working tree.',
 
5279
            checkout='Reconfigure to be a bound branch with a working tree.',
 
5280
            lightweight_checkout='Reconfigure to be a lightweight'
 
5281
                ' checkout (with no local history).',
 
5282
            standalone='Reconfigure to be a standalone branch '
 
5283
                '(i.e. stop using shared repository).',
 
5284
            use_shared='Reconfigure to use a shared repository.',
 
5285
            with_trees='Reconfigure repository to create '
 
5286
                'working trees on branches by default.',
 
5287
            with_no_trees='Reconfigure repository to not create '
 
5288
                'working trees on branches by default.'
 
5289
            ),
 
5290
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
5291
        Option('force',
 
5292
            help='Perform reconfiguration even if local changes'
 
5293
            ' will be lost.'),
 
5294
        Option('stacked-on',
 
5295
            help='Reconfigure a branch to be stacked on another branch.',
 
5296
            type=unicode,
 
5297
            ),
 
5298
        Option('unstacked',
 
5299
            help='Reconfigure a branch to be unstacked.  This '
 
5300
                'may require copying substantial data into it.',
 
5301
            ),
 
5302
        ]
 
5303
 
 
5304
    def run(self, location=None, target_type=None, bind_to=None, force=False,
 
5305
            stacked_on=None,
 
5306
            unstacked=None):
 
5307
        directory = bzrdir.BzrDir.open(location)
 
5308
        if stacked_on and unstacked:
 
5309
            raise BzrCommandError("Can't use both --stacked-on and --unstacked")
 
5310
        elif stacked_on is not None:
 
5311
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
 
5312
        elif unstacked:
 
5313
            reconfigure.ReconfigureUnstacked().apply(directory)
 
5314
        # At the moment you can use --stacked-on and a different
 
5315
        # reconfiguration shape at the same time; there seems no good reason
 
5316
        # to ban it.
 
5317
        if target_type is None:
 
5318
            if stacked_on or unstacked:
 
5319
                return
 
5320
            else:
 
5321
                raise errors.BzrCommandError('No target configuration '
 
5322
                    'specified')
 
5323
        elif target_type == 'branch':
 
5324
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
5325
        elif target_type == 'tree':
 
5326
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
5327
        elif target_type == 'checkout':
 
5328
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
5329
                directory, bind_to)
 
5330
        elif target_type == 'lightweight-checkout':
 
5331
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
5332
                directory, bind_to)
 
5333
        elif target_type == 'use-shared':
 
5334
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
5335
        elif target_type == 'standalone':
 
5336
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5337
        elif target_type == 'with-trees':
 
5338
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5339
                directory, True)
 
5340
        elif target_type == 'with-no-trees':
 
5341
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5342
                directory, False)
 
5343
        reconfiguration.apply(force)
 
5344
 
 
5345
 
 
5346
class cmd_switch(Command):
 
5347
    """Set the branch of a checkout and update.
 
5348
 
 
5349
    For lightweight checkouts, this changes the branch being referenced.
 
5350
    For heavyweight checkouts, this checks that there are no local commits
 
5351
    versus the current bound branch, then it makes the local branch a mirror
 
5352
    of the new location and binds to it.
 
5353
 
 
5354
    In both cases, the working tree is updated and uncommitted changes
 
5355
    are merged. The user can commit or revert these as they desire.
 
5356
 
 
5357
    Pending merges need to be committed or reverted before using switch.
 
5358
 
 
5359
    The path to the branch to switch to can be specified relative to the parent
 
5360
    directory of the current branch. For example, if you are currently in a
 
5361
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
5362
    /path/to/newbranch.
 
5363
 
 
5364
    Bound branches use the nickname of its master branch unless it is set
 
5365
    locally, in which case switching will update the the local nickname to be
 
5366
    that of the master.
 
5367
    """
 
5368
 
 
5369
    takes_args = ['to_location']
 
5370
    takes_options = [Option('force',
 
5371
                        help='Switch even if local commits will be lost.'),
 
5372
                     Option('create-branch', short_name='b',
 
5373
                        help='Create the target branch from this one before'
 
5374
                             ' switching to it.'),
 
5375
                     ]
 
5376
 
 
5377
    def run(self, to_location, force=False, create_branch=False):
 
5378
        from bzrlib import switch
 
5379
        tree_location = '.'
 
5380
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5381
        try:
 
5382
            branch = control_dir.open_branch()
 
5383
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
5384
        except errors.NotBranchError:
 
5385
            branch = None
 
5386
            had_explicit_nick = False
 
5387
        if create_branch:
 
5388
            if branch is None:
 
5389
                raise errors.BzrCommandError('cannot create branch without'
 
5390
                                             ' source branch')
 
5391
            if '/' not in to_location and '\\' not in to_location:
 
5392
                # This path is meant to be relative to the existing branch
 
5393
                this_url = self._get_branch_location(control_dir)
 
5394
                to_location = urlutils.join(this_url, '..', to_location)
 
5395
            to_branch = branch.bzrdir.sprout(to_location,
 
5396
                                 possible_transports=[branch.bzrdir.root_transport],
 
5397
                                 source_branch=branch).open_branch()
 
5398
            # try:
 
5399
            #     from_branch = control_dir.open_branch()
 
5400
            # except errors.NotBranchError:
 
5401
            #     raise BzrCommandError('Cannot create a branch from this'
 
5402
            #         ' location when we cannot open this branch')
 
5403
            # from_branch.bzrdir.sprout(
 
5404
            pass
 
5405
        else:
 
5406
            try:
 
5407
                to_branch = Branch.open(to_location)
 
5408
            except errors.NotBranchError:
 
5409
                this_url = self._get_branch_location(control_dir)
 
5410
                to_branch = Branch.open(
 
5411
                    urlutils.join(this_url, '..', to_location))
 
5412
        switch.switch(control_dir, to_branch, force)
 
5413
        if had_explicit_nick:
 
5414
            branch = control_dir.open_branch() #get the new branch!
 
5415
            branch.nick = to_branch.nick
 
5416
        note('Switched to branch: %s',
 
5417
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
5418
 
 
5419
    def _get_branch_location(self, control_dir):
 
5420
        """Return location of branch for this control dir."""
 
5421
        try:
 
5422
            this_branch = control_dir.open_branch()
 
5423
            # This may be a heavy checkout, where we want the master branch
 
5424
            master_location = this_branch.get_bound_location()
 
5425
            if master_location is not None:
 
5426
                return master_location
 
5427
            # If not, use a local sibling
 
5428
            return this_branch.base
 
5429
        except errors.NotBranchError:
 
5430
            format = control_dir.find_branch_format()
 
5431
            if getattr(format, 'get_reference', None) is not None:
 
5432
                return format.get_reference(control_dir)
 
5433
            else:
 
5434
                return control_dir.root_transport.base
 
5435
 
 
5436
 
 
5437
class cmd_view(Command):
 
5438
    """Manage filtered views.
 
5439
 
 
5440
    Views provide a mask over the tree so that users can focus on
 
5441
    a subset of a tree when doing their work. After creating a view,
 
5442
    commands that support a list of files - status, diff, commit, etc -
 
5443
    effectively have that list of files implicitly given each time.
 
5444
    An explicit list of files can still be given but those files
 
5445
    must be within the current view.
 
5446
 
 
5447
    In most cases, a view has a short life-span: it is created to make
 
5448
    a selected change and is deleted once that change is committed.
 
5449
    At other times, you may wish to create one or more named views
 
5450
    and switch between them.
 
5451
 
 
5452
    To disable the current view without deleting it, you can switch to
 
5453
    the pseudo view called ``off``. This can be useful when you need
 
5454
    to see the whole tree for an operation or two (e.g. merge) but
 
5455
    want to switch back to your view after that.
 
5456
 
 
5457
    :Examples:
 
5458
      To define the current view::
 
5459
 
 
5460
        bzr view file1 dir1 ...
 
5461
 
 
5462
      To list the current view::
 
5463
 
 
5464
        bzr view
 
5465
 
 
5466
      To delete the current view::
 
5467
 
 
5468
        bzr view --delete
 
5469
 
 
5470
      To disable the current view without deleting it::
 
5471
 
 
5472
        bzr view --switch off
 
5473
 
 
5474
      To define a named view and switch to it::
 
5475
 
 
5476
        bzr view --name view-name file1 dir1 ...
 
5477
 
 
5478
      To list a named view::
 
5479
 
 
5480
        bzr view --name view-name
 
5481
 
 
5482
      To delete a named view::
 
5483
 
 
5484
        bzr view --name view-name --delete
 
5485
 
 
5486
      To switch to a named view::
 
5487
 
 
5488
        bzr view --switch view-name
 
5489
 
 
5490
      To list all views defined::
 
5491
 
 
5492
        bzr view --all
 
5493
 
 
5494
      To delete all views::
 
5495
 
 
5496
        bzr view --delete --all
 
5497
    """
 
5498
 
 
5499
    _see_also = []
 
5500
    takes_args = ['file*']
 
5501
    takes_options = [
 
5502
        Option('all',
 
5503
            help='Apply list or delete action to all views.',
 
5504
            ),
 
5505
        Option('delete',
 
5506
            help='Delete the view.',
 
5507
            ),
 
5508
        Option('name',
 
5509
            help='Name of the view to define, list or delete.',
 
5510
            type=unicode,
 
5511
            ),
 
5512
        Option('switch',
 
5513
            help='Name of the view to switch to.',
 
5514
            type=unicode,
 
5515
            ),
 
5516
        ]
 
5517
 
 
5518
    def run(self, file_list,
 
5519
            all=False,
 
5520
            delete=False,
 
5521
            name=None,
 
5522
            switch=None,
 
5523
            ):
 
5524
        tree, file_list = tree_files(file_list, apply_view=False)
 
5525
        current_view, view_dict = tree.views.get_view_info()
 
5526
        if name is None:
 
5527
            name = current_view
 
5528
        if delete:
 
5529
            if file_list:
 
5530
                raise errors.BzrCommandError(
 
5531
                    "Both --delete and a file list specified")
 
5532
            elif switch:
 
5533
                raise errors.BzrCommandError(
 
5534
                    "Both --delete and --switch specified")
 
5535
            elif all:
 
5536
                tree.views.set_view_info(None, {})
 
5537
                self.outf.write("Deleted all views.\n")
 
5538
            elif name is None:
 
5539
                raise errors.BzrCommandError("No current view to delete")
 
5540
            else:
 
5541
                tree.views.delete_view(name)
 
5542
                self.outf.write("Deleted '%s' view.\n" % name)
 
5543
        elif switch:
 
5544
            if file_list:
 
5545
                raise errors.BzrCommandError(
 
5546
                    "Both --switch and a file list specified")
 
5547
            elif all:
 
5548
                raise errors.BzrCommandError(
 
5549
                    "Both --switch and --all specified")
 
5550
            elif switch == 'off':
 
5551
                if current_view is None:
 
5552
                    raise errors.BzrCommandError("No current view to disable")
 
5553
                tree.views.set_view_info(None, view_dict)
 
5554
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
5555
            else:
 
5556
                tree.views.set_view_info(switch, view_dict)
 
5557
                view_str = views.view_display_str(tree.views.lookup_view())
 
5558
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
5559
        elif all:
 
5560
            if view_dict:
 
5561
                self.outf.write('Views defined:\n')
 
5562
                for view in sorted(view_dict):
 
5563
                    if view == current_view:
 
5564
                        active = "=>"
 
5565
                    else:
 
5566
                        active = "  "
 
5567
                    view_str = views.view_display_str(view_dict[view])
 
5568
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
5569
            else:
 
5570
                self.outf.write('No views defined.\n')
 
5571
        elif file_list:
 
5572
            if name is None:
 
5573
                # No name given and no current view set
 
5574
                name = 'my'
 
5575
            elif name == 'off':
 
5576
                raise errors.BzrCommandError(
 
5577
                    "Cannot change the 'off' pseudo view")
 
5578
            tree.views.set_view(name, sorted(file_list))
 
5579
            view_str = views.view_display_str(tree.views.lookup_view())
 
5580
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
5581
        else:
 
5582
            # list the files
 
5583
            if name is None:
 
5584
                # No name given and no current view set
 
5585
                self.outf.write('No current view.\n')
 
5586
            else:
 
5587
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
5588
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
5589
 
 
5590
 
 
5591
class cmd_hooks(Command):
 
5592
    """Show hooks."""
 
5593
 
 
5594
    hidden = True
 
5595
 
 
5596
    def run(self):
 
5597
        for hook_key in sorted(hooks.known_hooks.keys()):
 
5598
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
5599
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
5600
            for hook_name, hook_point in sorted(some_hooks.items()):
 
5601
                self.outf.write("  %s:\n" % (hook_name,))
 
5602
                found_hooks = list(hook_point)
 
5603
                if found_hooks:
 
5604
                    for hook in found_hooks:
 
5605
                        self.outf.write("    %s\n" %
 
5606
                                        (some_hooks.get_hook_name(hook),))
 
5607
                else:
 
5608
                    self.outf.write("    <no hooks installed>\n")
 
5609
 
 
5610
 
 
5611
class cmd_shelve(Command):
 
5612
    """Temporarily set aside some changes from the current tree.
 
5613
 
 
5614
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
5615
    ie. out of the way, until a later time when you can bring them back from
 
5616
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
5617
    your working tree, and so they aren't propagated along with your branch nor
 
5618
    will they survive its deletion.
 
5619
 
 
5620
    If shelve --list is specified, previously-shelved changes are listed.
 
5621
 
 
5622
    Shelve is intended to help separate several sets of changes that have
 
5623
    been inappropriately mingled.  If you just want to get rid of all changes
 
5624
    and you don't need to restore them later, use revert.  If you want to
 
5625
    shelve all text changes at once, use shelve --all.
 
5626
 
 
5627
    If filenames are specified, only the changes to those files will be
 
5628
    shelved. Other files will be left untouched.
 
5629
 
 
5630
    If a revision is specified, changes since that revision will be shelved.
 
5631
 
 
5632
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
5633
    restore the most recently shelved changes.
 
5634
    """
 
5635
 
 
5636
    takes_args = ['file*']
 
5637
 
 
5638
    takes_options = [
 
5639
        'revision',
 
5640
        Option('all', help='Shelve all changes.'),
 
5641
        'message',
 
5642
        RegistryOption('writer', 'Method to use for writing diffs.',
 
5643
                       bzrlib.option.diff_writer_registry,
 
5644
                       value_switches=True, enum_switch=False),
 
5645
 
 
5646
        Option('list', help='List shelved changes.'),
 
5647
        Option('destroy',
 
5648
               help='Destroy removed changes instead of shelving them.'),
 
5649
    ]
 
5650
    _see_also = ['unshelve']
 
5651
 
 
5652
    def run(self, revision=None, all=False, file_list=None, message=None,
 
5653
            writer=None, list=False, destroy=False):
 
5654
        if list:
 
5655
            return self.run_for_list()
 
5656
        from bzrlib.shelf_ui import Shelver
 
5657
        if writer is None:
 
5658
            writer = bzrlib.option.diff_writer_registry.get()
 
5659
        try:
 
5660
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
 
5661
                file_list, message, destroy=destroy)
 
5662
            try:
 
5663
                shelver.run()
 
5664
            finally:
 
5665
                shelver.work_tree.unlock()
 
5666
        except errors.UserAbort:
 
5667
            return 0
 
5668
 
 
5669
    def run_for_list(self):
 
5670
        tree = WorkingTree.open_containing('.')[0]
 
5671
        tree.lock_read()
 
5672
        try:
 
5673
            manager = tree.get_shelf_manager()
 
5674
            shelves = manager.active_shelves()
 
5675
            if len(shelves) == 0:
 
5676
                note('No shelved changes.')
 
5677
                return 0
 
5678
            for shelf_id in reversed(shelves):
 
5679
                message = manager.get_metadata(shelf_id).get('message')
 
5680
                if message is None:
 
5681
                    message = '<no message>'
 
5682
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5683
            return 1
 
5684
        finally:
 
5685
            tree.unlock()
 
5686
 
 
5687
 
 
5688
class cmd_unshelve(Command):
 
5689
    """Restore shelved changes.
 
5690
 
 
5691
    By default, the most recently shelved changes are restored. However if you
 
5692
    specify a shelf by id those changes will be restored instead.  This works
 
5693
    best when the changes don't depend on each other.
 
5694
    """
 
5695
 
 
5696
    takes_args = ['shelf_id?']
 
5697
    takes_options = [
 
5698
        RegistryOption.from_kwargs(
 
5699
            'action', help="The action to perform.",
 
5700
            enum_switch=False, value_switches=True,
 
5701
            apply="Apply changes and remove from the shelf.",
 
5702
            dry_run="Show changes, but do not apply or remove them.",
 
5703
            delete_only="Delete changes without applying them."
 
5704
        )
 
5705
    ]
 
5706
    _see_also = ['shelve']
 
5707
 
 
5708
    def run(self, shelf_id=None, action='apply'):
 
5709
        from bzrlib.shelf_ui import Unshelver
 
5710
        unshelver = Unshelver.from_args(shelf_id, action)
 
5711
        try:
 
5712
            unshelver.run()
 
5713
        finally:
 
5714
            unshelver.tree.unlock()
 
5715
 
 
5716
 
 
5717
class cmd_clean_tree(Command):
 
5718
    """Remove unwanted files from working tree.
 
5719
 
 
5720
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
5721
    files are never deleted.
 
5722
 
 
5723
    Another class is 'detritus', which includes files emitted by bzr during
 
5724
    normal operations and selftests.  (The value of these files decreases with
 
5725
    time.)
 
5726
 
 
5727
    If no options are specified, unknown files are deleted.  Otherwise, option
 
5728
    flags are respected, and may be combined.
 
5729
 
 
5730
    To check what clean-tree will do, use --dry-run.
 
5731
    """
 
5732
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5733
                     Option('detritus', help='Delete conflict files, merge'
 
5734
                            ' backups, and failed selftest dirs.'),
 
5735
                     Option('unknown',
 
5736
                            help='Delete files unknown to bzr (default).'),
 
5737
                     Option('dry-run', help='Show files to delete instead of'
 
5738
                            ' deleting them.'),
 
5739
                     Option('force', help='Do not prompt before deleting.')]
 
5740
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
5741
            force=False):
 
5742
        from bzrlib.clean_tree import clean_tree
 
5743
        if not (unknown or ignored or detritus):
 
5744
            unknown = True
 
5745
        if dry_run:
 
5746
            force = True
 
5747
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5748
                   dry_run=dry_run, no_prompt=force)
 
5749
 
 
5750
 
 
5751
class cmd_reference(Command):
 
5752
    """list, view and set branch locations for nested trees.
 
5753
 
 
5754
    If no arguments are provided, lists the branch locations for nested trees.
 
5755
    If one argument is provided, display the branch location for that tree.
 
5756
    If two arguments are provided, set the branch location for that tree.
 
5757
    """
 
5758
 
 
5759
    hidden = True
 
5760
 
 
5761
    takes_args = ['path?', 'location?']
 
5762
 
 
5763
    def run(self, path=None, location=None):
 
5764
        branchdir = '.'
 
5765
        if path is not None:
 
5766
            branchdir = path
 
5767
        tree, branch, relpath =(
 
5768
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
 
5769
        if path is not None:
 
5770
            path = relpath
 
5771
        if tree is None:
 
5772
            tree = branch.basis_tree()
 
5773
        if path is None:
 
5774
            info = branch._get_all_reference_info().iteritems()
 
5775
            self._display_reference_info(tree, branch, info)
 
5776
        else:
 
5777
            file_id = tree.path2id(path)
 
5778
            if file_id is None:
 
5779
                raise errors.NotVersionedError(path)
 
5780
            if location is None:
 
5781
                info = [(file_id, branch.get_reference_info(file_id))]
 
5782
                self._display_reference_info(tree, branch, info)
 
5783
            else:
 
5784
                branch.set_reference_info(file_id, path, location)
 
5785
 
 
5786
    def _display_reference_info(self, tree, branch, info):
 
5787
        ref_list = []
 
5788
        for file_id, (path, location) in info:
 
5789
            try:
 
5790
                path = tree.id2path(file_id)
 
5791
            except errors.NoSuchId:
 
5792
                pass
 
5793
            ref_list.append((path, location))
 
5794
        for path, location in sorted(ref_list):
 
5795
            self.outf.write('%s %s\n' % (path, location))
 
5796
 
 
5797
 
 
5798
# these get imported and then picked up by the scan for cmd_*
 
5799
# TODO: Some more consistent way to split command definitions across files;
 
5800
# we do need to load at least some information about them to know of
 
5801
# aliases.  ideally we would avoid loading the implementation until the
 
5802
# details were needed.
 
5803
from bzrlib.cmd_version_info import cmd_version_info
 
5804
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5805
from bzrlib.bundle.commands import (
 
5806
    cmd_bundle_info,
 
5807
    )
 
5808
from bzrlib.foreign import cmd_dpush
 
5809
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5810
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5811
        cmd_weave_plan_merge, cmd_weave_merge_text