/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: Robert Collins
  • Date: 2009-08-25 19:58:32 UTC
  • mto: This revision was merged to the branch mainline in revision 4650.
  • Revision ID: robertc@robertcollins.net-20090825195832-oz7fisc4vhxw6xpz
Fix test_merge_missing for lock strictness. Merger was creating a new revision tree unnecessarily, so add an api to cache the revision trees more comprehensively and use it.

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