/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: Aaron Bentley
  • Date: 2009-04-01 20:30:51 UTC
  • mto: This revision was merged to the branch mainline in revision 4241.
  • Revision ID: aaron@aaronbentley.com-20090401203051-d69lplsnxovk6nxi
Finish up conversion to mv --auto.

Show diffs side-by-side

added added

removed removed

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