/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: Aaron Bentley
  • Date: 2009-06-26 17:24:01 UTC
  • mto: This revision was merged to the branch mainline in revision 4490.
  • Revision ID: aaron@aaronbentley.com-20090626172401-ykvzf3ifxoi5nvvj
Make inconsistency in skipped records fatal for revisions.

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