/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: Canonical.com Patch Queue Manager
  • Date: 2009-08-19 18:04:49 UTC
  • mfrom: (4593.5.43 1.19-known-graph-sorted)
  • Revision ID: pqm@pqm.ubuntu.com-20090819180449-p5dibldf9pcp24n4
(jam) Add VersionedFiles.get_known_graph_ancestry and
        KnownGraph.merge_sort()

Show diffs side-by-side

added added

removed removed

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