/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: Vincent Ladeuil
  • Date: 2009-06-30 15:54:23 UTC
  • mto: (4496.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4497.
  • Revision ID: v.ladeuil+lp@free.fr-20090630155423-afousrl3zrdx0he2
Fixed as per jam's review.

* tests/blackbox/test_push.py:
(load_tests): One more changes type.
(TestPushStrictMixin): Switch to using mixin, it's clearer.
Define some default values as attributes so that they can be
changed more easily.
(TestPushStrictMixin.assertPushFails,
TestPushStrictMixin.assertPushSucceeds): Use default values from
attributes.
(TestPushStrictWithChanges._out_of_sync_trees): Setup a new
context and change the default values.

* errors.py:
(OutOfDateTree, UncommittedChanges): Add a more parameter so more
details can be given.

* builtins.py:
(cmd_push.run): Add an additional check that the tree is still in
sync with its branch before pushing.

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