/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-07-02 13:07:14 UTC
  • mto: (4524.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 4525.
  • Revision ID: v.ladeuil+lp@free.fr-20090702130714-hsyqfusi8vn3a11m
Use tree.has_changes() where appropriate (the test suite caught a
bug in has_changes() (not filtering out the root) in an impressive
number of tests)

* bzrlib/send.py:
(send): Use tree.has_changes() instead of tree.changes_from().

* bzrlib/reconfigure.py:
(Reconfigure._check): Use tree.has_changes() instead of
tree.changes_from().

* bzrlib/merge.py:
(Merger.ensure_revision_trees, Merger.compare_basis): Use
tree.has_changes() instead of tree.changes_from().

* bzrlib/builtins.py:
(cmd_remove_tree.run, cmd_push.run, cmd_merge.run): Use
tree.has_changes() instead of tree.changes_from().

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