/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin
  • Date: 2009-11-28 00:48:03 UTC
  • mto: This revision was merged to the branch mainline in revision 4853.
  • Revision ID: gzlist@googlemail.com-20091128004803-nirz54wazyj0waf8
MergeDirective.from_lines claims to want an iterable but currently requires a list, rewrite so it really wants an iterable

Show diffs side-by-side

added added

removed removed

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