~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2010-01-12 02:00:23 UTC
  • mto: This revision was merged to the branch mainline in revision 4949.
  • Revision ID: mbp@sourcefrog.net-20100112020023-ib3ii1wcpvljmprk
Update bug handling doc to deprecate fixcommitted and to explain other states better

Show diffs side-by-side

added added

removed removed

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