/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: Andrew Bennetts
  • Date: 2009-07-01 10:30:41 UTC
  • mto: This revision was merged to the branch mainline in revision 4504.
  • Revision ID: andrew.bennetts@canonical.com-20090701103041-hszh45eg136rs1gx
Fix undefined locals and remove unused import from branch.py.

Show diffs side-by-side

added added

removed removed

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