/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2009-11-16 05:57:00 UTC
  • mto: This revision was merged to the branch mainline in revision 5032.
  • Revision ID: andrew.bennetts@canonical.com-20091116055700-lzlw30496263bz49
Fix bug introduced by the change to take multiple locations, and add a test for multiple locations.

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