/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-10-08 01:50:30 UTC
  • mfrom: (4731 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4732.
  • Revision ID: andrew.bennetts@canonical.com-20091008015030-8n02kppogh8radr0
Merge lp:bzr.

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