/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-29 14:51:13 UTC
  • mfrom: (4489 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4490.
  • Revision ID: aaron@aaronbentley.com-20090629145113-3w350dxgqppnzo4g
Merge bzr.dev

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