/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: Robert J. Tanner
  • Date: 2009-04-20 08:37:32 UTC
  • mfrom: (4299 +trunk)
  • mto: This revision was merged to the branch mainline in revision 4300.
  • Revision ID: tanner@real-time.com-20090420083732-bzx919oo7wpmqc2u
[merge] 1.14rc2 back into bzr.dev (Bob Tanner)

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. View is %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. View is %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 info -v
 
1324
 
 
1325
      Display the above together with number of committers to the branch:
 
1326
 
 
1327
        bzr info -vv
 
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, the standard log formats show
 
1956
      just the top level (mainline).
 
1957
 
 
1958
      Status summaries are shown using status flags like A, M, etc. To see
 
1959
      the changes explained using words like ``added`` and ``modified``
 
1960
      instead, use the -vv option.
 
1961
 
 
1962
    :Ordering control:
 
1963
 
 
1964
      To display revisions from oldest to newest, use the --forward option.
 
1965
      In most cases, using this option will have little impact on the total
 
1966
      time taken to produce a log, though --forward does not incrementally
 
1967
      display revisions like --reverse does when it can.
 
1968
 
 
1969
    :Revision filtering:
 
1970
 
 
1971
      The -r option can be used to specify what revision or range of revisions
 
1972
      to filter against. The various forms are shown below::
 
1973
 
 
1974
        -rX      display revision X
 
1975
        -rX..    display revision X and later
 
1976
        -r..Y    display up to and including revision Y
 
1977
        -rX..Y   display from X to Y inclusive
 
1978
 
 
1979
      See ``bzr help revisionspec`` for details on how to specify X and Y.
 
1980
      Some common examples are given below::
 
1981
 
 
1982
        -r-1                show just the tip
 
1983
        -r-10..             show the last 10 mainline revisions
 
1984
        -rsubmit:..         show what's new on this branch
 
1985
        -rancestor:path..   show changes since the common ancestor of this
 
1986
                            branch and the one at location path
 
1987
        -rdate:yesterday..  show changes since yesterday
 
1988
 
 
1989
      When logging a range of revisions using -rX..Y, log starts at
 
1990
      revision Y and searches back in history through the primary
 
1991
      ("left-hand") parents until it finds X. When logging just the
 
1992
      top level (using -n1), an error is reported if X is not found
 
1993
      along the way. If multi-level logging is used (-n0), X may be
 
1994
      a nested merge revision and the log will be truncated accordingly.
 
1995
 
 
1996
    :Path filtering:
 
1997
 
 
1998
      If parameters are given and the first one is not a branch, the log
 
1999
      will be filtered to show only those revisions that changed the
 
2000
      nominated files or directories.
 
2001
 
 
2002
      Filenames are interpreted within their historical context. To log a
 
2003
      deleted file, specify a revision range so that the file existed at
 
2004
      the end or start of the range.
 
2005
 
 
2006
      Historical context is also important when interpreting pathnames of
 
2007
      renamed files/directories. Consider the following example:
 
2008
 
 
2009
      * revision 1: add tutorial.txt
 
2010
      * revision 2: modify tutorial.txt
 
2011
      * revision 3: rename tutorial.txt to guide.txt; add tutorial.txt
 
2012
 
 
2013
      In this case:
 
2014
 
 
2015
      * ``bzr log guide.txt`` will log the file added in revision 1
 
2016
 
 
2017
      * ``bzr log tutorial.txt`` will log the new file added in revision 3
 
2018
 
 
2019
      * ``bzr log -r2 -p tutorial.txt`` will show the changes made to
 
2020
        the original file in revision 2.
 
2021
 
 
2022
      * ``bzr log -r2 -p guide.txt`` will display an error message as there
 
2023
        was no file called guide.txt in revision 2.
 
2024
 
 
2025
      Renames are always followed by log. By design, there is no need to
 
2026
      explicitly ask for this (and no way to stop logging a file back
 
2027
      until it was last renamed).
 
2028
 
 
2029
    :Other filtering:
 
2030
 
 
2031
      The --message option can be used for finding revisions that match a
 
2032
      regular expression in a commit message.
 
2033
 
 
2034
    :Tips & tricks:
 
2035
 
 
2036
      GUI tools and IDEs are often better at exploring history than command
 
2037
      line tools. You may prefer qlog or glog from the QBzr and Bzr-Gtk packages
 
2038
      respectively for example. (TortoiseBzr uses qlog for displaying logs.) See
 
2039
      http://bazaar-vcs.org/BzrPlugins and http://bazaar-vcs.org/IDEIntegration.
 
2040
 
 
2041
      Web interfaces are often better at exploring history than command line
 
2042
      tools, particularly for branches on servers. You may prefer Loggerhead
 
2043
      or one of its alternatives. See http://bazaar-vcs.org/WebInterface.
 
2044
 
 
2045
      You may find it useful to add the aliases below to ``bazaar.conf``::
 
2046
 
 
2047
        [ALIASES]
 
2048
        tip = log -r-1
 
2049
        top = log -l10 --line
 
2050
        show = log -v -p
 
2051
 
 
2052
      ``bzr tip`` will then show the latest revision while ``bzr top``
 
2053
      will show the last 10 mainline revisions. To see the details of a
 
2054
      particular revision X,  ``bzr show -rX``.
 
2055
 
 
2056
      If you are interested in looking deeper into a particular merge X,
 
2057
      use ``bzr log -n0 -rX``.
 
2058
 
 
2059
      ``bzr log -v`` on a branch with lots of history is currently
 
2060
      very slow. A fix for this issue is currently under development.
 
2061
      With or without that fix, it is recommended that a revision range
 
2062
      be given when using the -v option.
 
2063
 
 
2064
      bzr has a generic full-text matching plugin, bzr-search, that can be
 
2065
      used to find revisions matching user names, commit messages, etc.
 
2066
      Among other features, this plugin can find all revisions containing
 
2067
      a list of words but not others.
 
2068
 
 
2069
      When exploring non-mainline history on large projects with deep
 
2070
      history, the performance of log can be greatly improved by installing
 
2071
      the revnocache plugin. This plugin buffers historical information
 
2072
      trading disk space for faster speed.
 
2073
    """
 
2074
    takes_args = ['file*']
 
2075
    _see_also = ['log-formats', 'revisionspec']
 
2076
    takes_options = [
 
2077
            Option('forward',
 
2078
                   help='Show from oldest to newest.'),
 
2079
            'timezone',
 
2080
            custom_help('verbose',
 
2081
                   help='Show files changed in each revision.'),
 
2082
            'show-ids',
 
2083
            'revision',
 
2084
            Option('change',
 
2085
                   type=bzrlib.option._parse_revision_str,
 
2086
                   short_name='c',
 
2087
                   help='Show just the specified revision.'
 
2088
                   ' See also "help revisionspec".'),
 
2089
            'log-format',
 
2090
            Option('levels',
 
2091
                   short_name='n',
 
2092
                   help='Number of levels to display - 0 for all, 1 for flat.',
 
2093
                   argname='N',
 
2094
                   type=_parse_levels),
 
2095
            Option('message',
 
2096
                   short_name='m',
 
2097
                   help='Show revisions whose message matches this '
 
2098
                        'regular expression.',
 
2099
                   type=str),
 
2100
            Option('limit',
 
2101
                   short_name='l',
 
2102
                   help='Limit the output to the first N revisions.',
 
2103
                   argname='N',
 
2104
                   type=_parse_limit),
 
2105
            Option('show-diff',
 
2106
                   short_name='p',
 
2107
                   help='Show changes made in each revision as a patch.'),
 
2108
            Option('include-merges',
 
2109
                   help='Show merged revisions like --levels 0 does.'),
 
2110
            ]
 
2111
    encoding_type = 'replace'
 
2112
 
 
2113
    @display_command
 
2114
    def run(self, file_list=None, timezone='original',
 
2115
            verbose=False,
 
2116
            show_ids=False,
 
2117
            forward=False,
 
2118
            revision=None,
 
2119
            change=None,
 
2120
            log_format=None,
 
2121
            levels=None,
 
2122
            message=None,
 
2123
            limit=None,
 
2124
            show_diff=False,
 
2125
            include_merges=False):
 
2126
        from bzrlib.log import (
 
2127
            Logger,
 
2128
            make_log_request_dict,
 
2129
            _get_info_for_log_files,
 
2130
            )
 
2131
        direction = (forward and 'forward') or 'reverse'
 
2132
        if include_merges:
 
2133
            if levels is None:
 
2134
                levels = 0
 
2135
            else:
 
2136
                raise errors.BzrCommandError(
 
2137
                    '--levels and --include-merges are mutually exclusive')
 
2138
 
 
2139
        if change is not None:
 
2140
            if len(change) > 1:
 
2141
                raise errors.RangeInChangeOption()
 
2142
            if revision is not None:
 
2143
                raise errors.BzrCommandError(
 
2144
                    '--revision and --change are mutually exclusive')
 
2145
            else:
 
2146
                revision = change
 
2147
 
 
2148
        file_ids = []
 
2149
        filter_by_dir = False
 
2150
        if file_list:
 
2151
            # find the file ids to log and check for directory filtering
 
2152
            b, file_info_list, rev1, rev2 = _get_info_for_log_files(revision,
 
2153
                file_list)
 
2154
            for relpath, file_id, kind in file_info_list:
 
2155
                if file_id is None:
 
2156
                    raise errors.BzrCommandError(
 
2157
                        "Path unknown at end or start of revision range: %s" %
 
2158
                        relpath)
 
2159
                # If the relpath is the top of the tree, we log everything
 
2160
                if relpath == '':
 
2161
                    file_ids = []
 
2162
                    break
 
2163
                else:
 
2164
                    file_ids.append(file_id)
 
2165
                filter_by_dir = filter_by_dir or (
 
2166
                    kind in ['directory', 'tree-reference'])
 
2167
        else:
 
2168
            # log everything
 
2169
            # FIXME ? log the current subdir only RBC 20060203
 
2170
            if revision is not None \
 
2171
                    and len(revision) > 0 and revision[0].get_branch():
 
2172
                location = revision[0].get_branch()
 
2173
            else:
 
2174
                location = '.'
 
2175
            dir, relpath = bzrdir.BzrDir.open_containing(location)
 
2176
            b = dir.open_branch()
 
2177
            rev1, rev2 = _get_revision_range(revision, b, self.name())
 
2178
 
 
2179
        # Decide on the type of delta & diff filtering to use
 
2180
        # TODO: add an --all-files option to make this configurable & consistent
 
2181
        if not verbose:
 
2182
            delta_type = None
 
2183
        else:
 
2184
            delta_type = 'full'
 
2185
        if not show_diff:
 
2186
            diff_type = None
 
2187
        elif file_ids:
 
2188
            diff_type = 'partial'
 
2189
        else:
 
2190
            diff_type = 'full'
 
2191
 
 
2192
        b.lock_read()
 
2193
        try:
 
2194
            # Build the log formatter
 
2195
            if log_format is None:
 
2196
                log_format = log.log_formatter_registry.get_default(b)
 
2197
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
2198
                            show_timezone=timezone,
 
2199
                            delta_format=get_verbosity_level(),
 
2200
                            levels=levels,
 
2201
                            show_advice=levels is None)
 
2202
 
 
2203
            # Choose the algorithm for doing the logging. It's annoying
 
2204
            # having multiple code paths like this but necessary until
 
2205
            # the underlying repository format is faster at generating
 
2206
            # deltas or can provide everything we need from the indices.
 
2207
            # The default algorithm - match-using-deltas - works for
 
2208
            # multiple files and directories and is faster for small
 
2209
            # amounts of history (200 revisions say). However, it's too
 
2210
            # slow for logging a single file in a repository with deep
 
2211
            # history, i.e. > 10K revisions. In the spirit of "do no
 
2212
            # evil when adding features", we continue to use the
 
2213
            # original algorithm - per-file-graph - for the "single
 
2214
            # file that isn't a directory without showing a delta" case.
 
2215
            partial_history = revision and b.repository._format.supports_chks
 
2216
            match_using_deltas = (len(file_ids) != 1 or filter_by_dir
 
2217
                or delta_type or partial_history)
 
2218
 
 
2219
            # Build the LogRequest and execute it
 
2220
            if len(file_ids) == 0:
 
2221
                file_ids = None
 
2222
            rqst = make_log_request_dict(
 
2223
                direction=direction, specific_fileids=file_ids,
 
2224
                start_revision=rev1, end_revision=rev2, limit=limit,
 
2225
                message_search=message, delta_type=delta_type,
 
2226
                diff_type=diff_type, _match_using_deltas=match_using_deltas)
 
2227
            Logger(b, rqst).show(lf)
 
2228
        finally:
 
2229
            b.unlock()
 
2230
 
 
2231
 
 
2232
def _get_revision_range(revisionspec_list, branch, command_name):
 
2233
    """Take the input of a revision option and turn it into a revision range.
 
2234
 
 
2235
    It returns RevisionInfo objects which can be used to obtain the rev_id's
 
2236
    of the desired revisions. It does some user input validations.
 
2237
    """
 
2238
    if revisionspec_list is None:
 
2239
        rev1 = None
 
2240
        rev2 = None
 
2241
    elif len(revisionspec_list) == 1:
 
2242
        rev1 = rev2 = revisionspec_list[0].in_history(branch)
 
2243
    elif len(revisionspec_list) == 2:
 
2244
        start_spec = revisionspec_list[0]
 
2245
        end_spec = revisionspec_list[1]
 
2246
        if end_spec.get_branch() != start_spec.get_branch():
 
2247
            # b is taken from revision[0].get_branch(), and
 
2248
            # show_log will use its revision_history. Having
 
2249
            # different branches will lead to weird behaviors.
 
2250
            raise errors.BzrCommandError(
 
2251
                "bzr %s doesn't accept two revisions in different"
 
2252
                " branches." % command_name)
 
2253
        rev1 = start_spec.in_history(branch)
 
2254
        # Avoid loading all of history when we know a missing
 
2255
        # end of range means the last revision ...
 
2256
        if end_spec.spec is None:
 
2257
            last_revno, last_revision_id = branch.last_revision_info()
 
2258
            rev2 = RevisionInfo(branch, last_revno, last_revision_id)
 
2259
        else:
 
2260
            rev2 = end_spec.in_history(branch)
 
2261
    else:
 
2262
        raise errors.BzrCommandError(
 
2263
            'bzr %s --revision takes one or two values.' % command_name)
 
2264
    return rev1, rev2
 
2265
 
 
2266
 
 
2267
def _revision_range_to_revid_range(revision_range):
 
2268
    rev_id1 = None
 
2269
    rev_id2 = None
 
2270
    if revision_range[0] is not None:
 
2271
        rev_id1 = revision_range[0].rev_id
 
2272
    if revision_range[1] is not None:
 
2273
        rev_id2 = revision_range[1].rev_id
 
2274
    return rev_id1, rev_id2
 
2275
 
 
2276
def get_log_format(long=False, short=False, line=False, default='long'):
 
2277
    log_format = default
 
2278
    if long:
 
2279
        log_format = 'long'
 
2280
    if short:
 
2281
        log_format = 'short'
 
2282
    if line:
 
2283
        log_format = 'line'
 
2284
    return log_format
 
2285
 
 
2286
 
 
2287
class cmd_touching_revisions(Command):
 
2288
    """Return revision-ids which affected a particular file.
 
2289
 
 
2290
    A more user-friendly interface is "bzr log FILE".
 
2291
    """
 
2292
 
 
2293
    hidden = True
 
2294
    takes_args = ["filename"]
 
2295
 
 
2296
    @display_command
 
2297
    def run(self, filename):
 
2298
        tree, relpath = WorkingTree.open_containing(filename)
 
2299
        b = tree.branch
 
2300
        file_id = tree.path2id(relpath)
 
2301
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
 
2302
            self.outf.write("%6d %s\n" % (revno, what))
 
2303
 
 
2304
 
 
2305
class cmd_ls(Command):
 
2306
    """List files in a tree.
 
2307
    """
 
2308
 
 
2309
    _see_also = ['status', 'cat']
 
2310
    takes_args = ['path?']
 
2311
    takes_options = [
 
2312
            'verbose',
 
2313
            'revision',
 
2314
            Option('recursive', short_name='R',
 
2315
                   help='Recurse into subdirectories.'),
 
2316
            Option('from-root',
 
2317
                   help='Print paths relative to the root of the branch.'),
 
2318
            Option('unknown', help='Print unknown files.'),
 
2319
            Option('versioned', help='Print versioned files.',
 
2320
                   short_name='V'),
 
2321
            Option('ignored', help='Print ignored files.'),
 
2322
            Option('null',
 
2323
                   help='Write an ascii NUL (\\0) separator '
 
2324
                   'between files rather than a newline.'),
 
2325
            Option('kind',
 
2326
                   help='List entries of a particular kind: file, directory, symlink.',
 
2327
                   type=unicode),
 
2328
            'show-ids',
 
2329
            ]
 
2330
    @display_command
 
2331
    def run(self, revision=None, verbose=False,
 
2332
            recursive=False, from_root=False,
 
2333
            unknown=False, versioned=False, ignored=False,
 
2334
            null=False, kind=None, show_ids=False, path=None):
 
2335
 
 
2336
        if kind and kind not in ('file', 'directory', 'symlink'):
 
2337
            raise errors.BzrCommandError('invalid kind specified')
 
2338
 
 
2339
        if verbose and null:
 
2340
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
 
2341
        all = not (unknown or versioned or ignored)
 
2342
 
 
2343
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
2344
 
 
2345
        if path is None:
 
2346
            fs_path = '.'
 
2347
            prefix = ''
 
2348
        else:
 
2349
            if from_root:
 
2350
                raise errors.BzrCommandError('cannot specify both --from-root'
 
2351
                                             ' and PATH')
 
2352
            fs_path = path
 
2353
            prefix = path
 
2354
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
2355
            fs_path)
 
2356
        if from_root:
 
2357
            relpath = u''
 
2358
        elif relpath:
 
2359
            relpath += '/'
 
2360
        if revision is not None or tree is None:
 
2361
            tree = _get_one_revision_tree('ls', revision, branch=branch)
 
2362
 
 
2363
        apply_view = False
 
2364
        if isinstance(tree, WorkingTree) and tree.supports_views():
 
2365
            view_files = tree.views.lookup_view()
 
2366
            if view_files:
 
2367
                apply_view = True
 
2368
                view_str = views.view_display_str(view_files)
 
2369
                note("Ignoring files outside view. View is %s" % view_str)
 
2370
 
 
2371
        tree.lock_read()
 
2372
        try:
 
2373
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
2374
                if fp.startswith(relpath):
 
2375
                    rp = fp[len(relpath):]
 
2376
                    fp = osutils.pathjoin(prefix, rp)
 
2377
                    if not recursive and '/' in rp:
 
2378
                        continue
 
2379
                    if not all and not selection[fc]:
 
2380
                        continue
 
2381
                    if kind is not None and fkind != kind:
 
2382
                        continue
 
2383
                    if apply_view:
 
2384
                        try:
 
2385
                            views.check_path_in_view(tree, fp)
 
2386
                        except errors.FileOutsideView:
 
2387
                            continue
 
2388
                    kindch = entry.kind_character()
 
2389
                    outstring = fp + kindch
 
2390
                    if verbose:
 
2391
                        outstring = '%-8s %s' % (fc, outstring)
 
2392
                        if show_ids and fid is not None:
 
2393
                            outstring = "%-50s %s" % (outstring, fid)
 
2394
                        self.outf.write(outstring + '\n')
 
2395
                    elif null:
 
2396
                        self.outf.write(fp + '\0')
 
2397
                        if show_ids:
 
2398
                            if fid is not None:
 
2399
                                self.outf.write(fid)
 
2400
                            self.outf.write('\0')
 
2401
                        self.outf.flush()
 
2402
                    else:
 
2403
                        if fid is not None:
 
2404
                            my_id = fid
 
2405
                        else:
 
2406
                            my_id = ''
 
2407
                        if show_ids:
 
2408
                            self.outf.write('%-50s %s\n' % (outstring, my_id))
 
2409
                        else:
 
2410
                            self.outf.write(outstring + '\n')
 
2411
        finally:
 
2412
            tree.unlock()
 
2413
 
 
2414
 
 
2415
class cmd_unknowns(Command):
 
2416
    """List unknown files.
 
2417
    """
 
2418
 
 
2419
    hidden = True
 
2420
    _see_also = ['ls']
 
2421
 
 
2422
    @display_command
 
2423
    def run(self):
 
2424
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
2425
            self.outf.write(osutils.quotefn(f) + '\n')
 
2426
 
 
2427
 
 
2428
class cmd_ignore(Command):
 
2429
    """Ignore specified files or patterns.
 
2430
 
 
2431
    See ``bzr help patterns`` for details on the syntax of patterns.
 
2432
 
 
2433
    To remove patterns from the ignore list, edit the .bzrignore file.
 
2434
    After adding, editing or deleting that file either indirectly by
 
2435
    using this command or directly by using an editor, be sure to commit
 
2436
    it.
 
2437
 
 
2438
    Note: ignore patterns containing shell wildcards must be quoted from
 
2439
    the shell on Unix.
 
2440
 
 
2441
    :Examples:
 
2442
        Ignore the top level Makefile::
 
2443
 
 
2444
            bzr ignore ./Makefile
 
2445
 
 
2446
        Ignore class files in all directories::
 
2447
 
 
2448
            bzr ignore "*.class"
 
2449
 
 
2450
        Ignore .o files under the lib directory::
 
2451
 
 
2452
            bzr ignore "lib/**/*.o"
 
2453
 
 
2454
        Ignore .o files under the lib directory::
 
2455
 
 
2456
            bzr ignore "RE:lib/.*\.o"
 
2457
 
 
2458
        Ignore everything but the "debian" toplevel directory::
 
2459
 
 
2460
            bzr ignore "RE:(?!debian/).*"
 
2461
    """
 
2462
 
 
2463
    _see_also = ['status', 'ignored', 'patterns']
 
2464
    takes_args = ['name_pattern*']
 
2465
    takes_options = [
 
2466
        Option('old-default-rules',
 
2467
               help='Write out the ignore rules bzr < 0.9 always used.')
 
2468
        ]
 
2469
 
 
2470
    def run(self, name_pattern_list=None, old_default_rules=None):
 
2471
        from bzrlib import ignores
 
2472
        if old_default_rules is not None:
 
2473
            # dump the rules and exit
 
2474
            for pattern in ignores.OLD_DEFAULTS:
 
2475
                print pattern
 
2476
            return
 
2477
        if not name_pattern_list:
 
2478
            raise errors.BzrCommandError("ignore requires at least one "
 
2479
                                  "NAME_PATTERN or --old-default-rules")
 
2480
        name_pattern_list = [globbing.normalize_pattern(p)
 
2481
                             for p in name_pattern_list]
 
2482
        for name_pattern in name_pattern_list:
 
2483
            if (name_pattern[0] == '/' or
 
2484
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
 
2485
                raise errors.BzrCommandError(
 
2486
                    "NAME_PATTERN should not be an absolute path")
 
2487
        tree, relpath = WorkingTree.open_containing(u'.')
 
2488
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
2489
        ignored = globbing.Globster(name_pattern_list)
 
2490
        matches = []
 
2491
        tree.lock_read()
 
2492
        for entry in tree.list_files():
 
2493
            id = entry[3]
 
2494
            if id is not None:
 
2495
                filename = entry[0]
 
2496
                if ignored.match(filename):
 
2497
                    matches.append(filename.encode('utf-8'))
 
2498
        tree.unlock()
 
2499
        if len(matches) > 0:
 
2500
            print "Warning: the following files are version controlled and" \
 
2501
                  " match your ignore pattern:\n%s" \
 
2502
                  "\nThese files will continue to be version controlled" \
 
2503
                  " unless you 'bzr remove' them." % ("\n".join(matches),)
 
2504
 
 
2505
 
 
2506
class cmd_ignored(Command):
 
2507
    """List ignored files and the patterns that matched them.
 
2508
 
 
2509
    List all the ignored files and the ignore pattern that caused the file to
 
2510
    be ignored.
 
2511
 
 
2512
    Alternatively, to list just the files::
 
2513
 
 
2514
        bzr ls --ignored
 
2515
    """
 
2516
 
 
2517
    encoding_type = 'replace'
 
2518
    _see_also = ['ignore', 'ls']
 
2519
 
 
2520
    @display_command
 
2521
    def run(self):
 
2522
        tree = WorkingTree.open_containing(u'.')[0]
 
2523
        tree.lock_read()
 
2524
        try:
 
2525
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2526
                if file_class != 'I':
 
2527
                    continue
 
2528
                ## XXX: Slightly inefficient since this was already calculated
 
2529
                pat = tree.is_ignored(path)
 
2530
                self.outf.write('%-50s %s\n' % (path, pat))
 
2531
        finally:
 
2532
            tree.unlock()
 
2533
 
 
2534
 
 
2535
class cmd_lookup_revision(Command):
 
2536
    """Lookup the revision-id from a revision-number
 
2537
 
 
2538
    :Examples:
 
2539
        bzr lookup-revision 33
 
2540
    """
 
2541
    hidden = True
 
2542
    takes_args = ['revno']
 
2543
 
 
2544
    @display_command
 
2545
    def run(self, revno):
 
2546
        try:
 
2547
            revno = int(revno)
 
2548
        except ValueError:
 
2549
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2550
 
 
2551
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
2552
 
 
2553
 
 
2554
class cmd_export(Command):
 
2555
    """Export current or past revision to a destination directory or archive.
 
2556
 
 
2557
    If no revision is specified this exports the last committed revision.
 
2558
 
 
2559
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
2560
    given, try to find the format with the extension. If no extension
 
2561
    is found exports to a directory (equivalent to --format=dir).
 
2562
 
 
2563
    If root is supplied, it will be used as the root directory inside
 
2564
    container formats (tar, zip, etc). If it is not supplied it will default
 
2565
    to the exported filename. The root option has no effect for 'dir' format.
 
2566
 
 
2567
    If branch is omitted then the branch containing the current working
 
2568
    directory will be used.
 
2569
 
 
2570
    Note: Export of tree with non-ASCII filenames to zip is not supported.
 
2571
 
 
2572
      =================       =========================
 
2573
      Supported formats       Autodetected by extension
 
2574
      =================       =========================
 
2575
         dir                         (none)
 
2576
         tar                          .tar
 
2577
         tbz2                    .tar.bz2, .tbz2
 
2578
         tgz                      .tar.gz, .tgz
 
2579
         zip                          .zip
 
2580
      =================       =========================
 
2581
    """
 
2582
    takes_args = ['dest', 'branch_or_subdir?']
 
2583
    takes_options = [
 
2584
        Option('format',
 
2585
               help="Type of file to export to.",
 
2586
               type=unicode),
 
2587
        'revision',
 
2588
        Option('filters', help='Apply content filters to export the '
 
2589
                'convenient form.'),
 
2590
        Option('root',
 
2591
               type=str,
 
2592
               help="Name of the root directory inside the exported file."),
 
2593
        ]
 
2594
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
 
2595
        root=None, filters=False):
 
2596
        from bzrlib.export import export
 
2597
 
 
2598
        if branch_or_subdir is None:
 
2599
            tree = WorkingTree.open_containing(u'.')[0]
 
2600
            b = tree.branch
 
2601
            subdir = None
 
2602
        else:
 
2603
            b, subdir = Branch.open_containing(branch_or_subdir)
 
2604
            tree = None
 
2605
 
 
2606
        rev_tree = _get_one_revision_tree('export', revision, branch=b, tree=tree)
 
2607
        try:
 
2608
            export(rev_tree, dest, format, root, subdir, filtered=filters)
 
2609
        except errors.NoSuchExportFormat, e:
 
2610
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
 
2611
 
 
2612
 
 
2613
class cmd_cat(Command):
 
2614
    """Write the contents of a file as of a given revision to standard output.
 
2615
 
 
2616
    If no revision is nominated, the last revision is used.
 
2617
 
 
2618
    Note: Take care to redirect standard output when using this command on a
 
2619
    binary file.
 
2620
    """
 
2621
 
 
2622
    _see_also = ['ls']
 
2623
    takes_options = [
 
2624
        Option('name-from-revision', help='The path name in the old tree.'),
 
2625
        Option('filters', help='Apply content filters to display the '
 
2626
                'convenience form.'),
 
2627
        'revision',
 
2628
        ]
 
2629
    takes_args = ['filename']
 
2630
    encoding_type = 'exact'
 
2631
 
 
2632
    @display_command
 
2633
    def run(self, filename, revision=None, name_from_revision=False,
 
2634
            filters=False):
 
2635
        if revision is not None and len(revision) != 1:
 
2636
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2637
                                         " one revision specifier")
 
2638
        tree, branch, relpath = \
 
2639
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2640
        branch.lock_read()
 
2641
        try:
 
2642
            return self._run(tree, branch, relpath, filename, revision,
 
2643
                             name_from_revision, filters)
 
2644
        finally:
 
2645
            branch.unlock()
 
2646
 
 
2647
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
 
2648
        filtered):
 
2649
        if tree is None:
 
2650
            tree = b.basis_tree()
 
2651
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
 
2652
 
 
2653
        old_file_id = rev_tree.path2id(relpath)
 
2654
 
 
2655
        if name_from_revision:
 
2656
            # Try in revision if requested
 
2657
            if old_file_id is None:
 
2658
                raise errors.BzrCommandError(
 
2659
                    "%r is not present in revision %s" % (
 
2660
                        filename, rev_tree.get_revision_id()))
 
2661
            else:
 
2662
                content = rev_tree.get_file_text(old_file_id)
 
2663
        else:
 
2664
            cur_file_id = tree.path2id(relpath)
 
2665
            found = False
 
2666
            if cur_file_id is not None:
 
2667
                # Then try with the actual file id
 
2668
                try:
 
2669
                    content = rev_tree.get_file_text(cur_file_id)
 
2670
                    found = True
 
2671
                except errors.NoSuchId:
 
2672
                    # The actual file id didn't exist at that time
 
2673
                    pass
 
2674
            if not found and old_file_id is not None:
 
2675
                # Finally try with the old file id
 
2676
                content = rev_tree.get_file_text(old_file_id)
 
2677
                found = True
 
2678
            if not found:
 
2679
                # Can't be found anywhere
 
2680
                raise errors.BzrCommandError(
 
2681
                    "%r is not present in revision %s" % (
 
2682
                        filename, rev_tree.get_revision_id()))
 
2683
        if filtered:
 
2684
            from bzrlib.filters import (
 
2685
                ContentFilterContext,
 
2686
                filtered_output_bytes,
 
2687
                )
 
2688
            filters = rev_tree._content_filter_stack(relpath)
 
2689
            chunks = content.splitlines(True)
 
2690
            content = filtered_output_bytes(chunks, filters,
 
2691
                ContentFilterContext(relpath, rev_tree))
 
2692
            self.outf.writelines(content)
 
2693
        else:
 
2694
            self.outf.write(content)
 
2695
 
 
2696
 
 
2697
class cmd_local_time_offset(Command):
 
2698
    """Show the offset in seconds from GMT to local time."""
 
2699
    hidden = True
 
2700
    @display_command
 
2701
    def run(self):
 
2702
        print osutils.local_time_offset()
 
2703
 
 
2704
 
 
2705
 
 
2706
class cmd_commit(Command):
 
2707
    """Commit changes into a new revision.
 
2708
 
 
2709
    If no arguments are given, the entire tree is committed.
 
2710
 
 
2711
    If selected files are specified, only changes to those files are
 
2712
    committed.  If a directory is specified then the directory and everything
 
2713
    within it is committed.
 
2714
 
 
2715
    When excludes are given, they take precedence over selected files.
 
2716
    For example, too commit only changes within foo, but not changes within
 
2717
    foo/bar::
 
2718
 
 
2719
      bzr commit foo -x foo/bar
 
2720
 
 
2721
    If author of the change is not the same person as the committer, you can
 
2722
    specify the author's name using the --author option. The name should be
 
2723
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2724
    If there is more than one author of the change you can specify the option
 
2725
    multiple times, once for each author.
 
2726
 
 
2727
    A selected-file commit may fail in some cases where the committed
 
2728
    tree would be invalid. Consider::
 
2729
 
 
2730
      bzr init foo
 
2731
      mkdir foo/bar
 
2732
      bzr add foo/bar
 
2733
      bzr commit foo -m "committing foo"
 
2734
      bzr mv foo/bar foo/baz
 
2735
      mkdir foo/bar
 
2736
      bzr add foo/bar
 
2737
      bzr commit foo/bar -m "committing bar but not baz"
 
2738
 
 
2739
    In the example above, the last commit will fail by design. This gives
 
2740
    the user the opportunity to decide whether they want to commit the
 
2741
    rename at the same time, separately first, or not at all. (As a general
 
2742
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2743
 
 
2744
    Note: A selected-file commit after a merge is not yet supported.
 
2745
    """
 
2746
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2747
 
 
2748
    # TODO: Strict commit that fails if there are deleted files.
 
2749
    #       (what does "deleted files" mean ??)
 
2750
 
 
2751
    # TODO: Give better message for -s, --summary, used by tla people
 
2752
 
 
2753
    # XXX: verbose currently does nothing
 
2754
 
 
2755
    _see_also = ['bugs', 'uncommit']
 
2756
    takes_args = ['selected*']
 
2757
    takes_options = [
 
2758
            ListOption('exclude', type=str, short_name='x',
 
2759
                help="Do not consider changes made to a given path."),
 
2760
            Option('message', type=unicode,
 
2761
                   short_name='m',
 
2762
                   help="Description of the new revision."),
 
2763
            'verbose',
 
2764
             Option('unchanged',
 
2765
                    help='Commit even if nothing has changed.'),
 
2766
             Option('file', type=str,
 
2767
                    short_name='F',
 
2768
                    argname='msgfile',
 
2769
                    help='Take commit message from this file.'),
 
2770
             Option('strict',
 
2771
                    help="Refuse to commit if there are unknown "
 
2772
                    "files in the working tree."),
 
2773
             ListOption('fixes', type=str,
 
2774
                    help="Mark a bug as being fixed by this revision "
 
2775
                         "(see \"bzr help bugs\")."),
 
2776
             ListOption('author', type=unicode,
 
2777
                    help="Set the author's name, if it's different "
 
2778
                         "from the committer."),
 
2779
             Option('local',
 
2780
                    help="Perform a local commit in a bound "
 
2781
                         "branch.  Local commits are not pushed to "
 
2782
                         "the master branch until a normal commit "
 
2783
                         "is performed."
 
2784
                    ),
 
2785
              Option('show-diff',
 
2786
                     help='When no message is supplied, show the diff along'
 
2787
                     ' with the status summary in the message editor.'),
 
2788
             ]
 
2789
    aliases = ['ci', 'checkin']
 
2790
 
 
2791
    def _iter_bug_fix_urls(self, fixes, branch):
 
2792
        # Configure the properties for bug fixing attributes.
 
2793
        for fixed_bug in fixes:
 
2794
            tokens = fixed_bug.split(':')
 
2795
            if len(tokens) != 2:
 
2796
                raise errors.BzrCommandError(
 
2797
                    "Invalid bug %s. Must be in the form of 'tracker:id'. "
 
2798
                    "See \"bzr help bugs\" for more information on this "
 
2799
                    "feature.\nCommit refused." % fixed_bug)
 
2800
            tag, bug_id = tokens
 
2801
            try:
 
2802
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2803
            except errors.UnknownBugTrackerAbbreviation:
 
2804
                raise errors.BzrCommandError(
 
2805
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2806
            except errors.MalformedBugIdentifier, e:
 
2807
                raise errors.BzrCommandError(
 
2808
                    "%s\nCommit refused." % (str(e),))
 
2809
 
 
2810
    def run(self, message=None, file=None, verbose=False, selected_list=None,
 
2811
            unchanged=False, strict=False, local=False, fixes=None,
 
2812
            author=None, show_diff=False, exclude=None):
 
2813
        from bzrlib.errors import (
 
2814
            PointlessCommit,
 
2815
            ConflictsInTree,
 
2816
            StrictCommitFailed
 
2817
        )
 
2818
        from bzrlib.msgeditor import (
 
2819
            edit_commit_message_encoded,
 
2820
            generate_commit_message_template,
 
2821
            make_commit_message_template_encoded
 
2822
        )
 
2823
 
 
2824
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2825
        # slightly problematic to run this cross-platform.
 
2826
 
 
2827
        # TODO: do more checks that the commit will succeed before
 
2828
        # spending the user's valuable time typing a commit message.
 
2829
 
 
2830
        properties = {}
 
2831
 
 
2832
        tree, selected_list = tree_files(selected_list)
 
2833
        if selected_list == ['']:
 
2834
            # workaround - commit of root of tree should be exactly the same
 
2835
            # as just default commit in that tree, and succeed even though
 
2836
            # selected-file merge commit is not done yet
 
2837
            selected_list = []
 
2838
 
 
2839
        if fixes is None:
 
2840
            fixes = []
 
2841
        bug_property = bugtracker.encode_fixes_bug_urls(
 
2842
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2843
        if bug_property:
 
2844
            properties['bugs'] = bug_property
 
2845
 
 
2846
        if local and not tree.branch.get_bound_location():
 
2847
            raise errors.LocalRequiresBoundBranch()
 
2848
 
 
2849
        def get_message(commit_obj):
 
2850
            """Callback to get commit message"""
 
2851
            my_message = message
 
2852
            if my_message is None and not file:
 
2853
                t = make_commit_message_template_encoded(tree,
 
2854
                        selected_list, diff=show_diff,
 
2855
                        output_encoding=osutils.get_user_encoding())
 
2856
                start_message = generate_commit_message_template(commit_obj)
 
2857
                my_message = edit_commit_message_encoded(t,
 
2858
                    start_message=start_message)
 
2859
                if my_message is None:
 
2860
                    raise errors.BzrCommandError("please specify a commit"
 
2861
                        " message with either --message or --file")
 
2862
            elif my_message and file:
 
2863
                raise errors.BzrCommandError(
 
2864
                    "please specify either --message or --file")
 
2865
            if file:
 
2866
                my_message = codecs.open(file, 'rt',
 
2867
                                         osutils.get_user_encoding()).read()
 
2868
            if my_message == "":
 
2869
                raise errors.BzrCommandError("empty commit message specified")
 
2870
            return my_message
 
2871
 
 
2872
        try:
 
2873
            tree.commit(message_callback=get_message,
 
2874
                        specific_files=selected_list,
 
2875
                        allow_pointless=unchanged, strict=strict, local=local,
 
2876
                        reporter=None, verbose=verbose, revprops=properties,
 
2877
                        authors=author,
 
2878
                        exclude=safe_relpath_files(tree, exclude))
 
2879
        except PointlessCommit:
 
2880
            # FIXME: This should really happen before the file is read in;
 
2881
            # perhaps prepare the commit; get the message; then actually commit
 
2882
            raise errors.BzrCommandError("no changes to commit."
 
2883
                              " use --unchanged to commit anyhow")
 
2884
        except ConflictsInTree:
 
2885
            raise errors.BzrCommandError('Conflicts detected in working '
 
2886
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
 
2887
                ' resolve.')
 
2888
        except StrictCommitFailed:
 
2889
            raise errors.BzrCommandError("Commit refused because there are"
 
2890
                              " unknown files in the working tree.")
 
2891
        except errors.BoundBranchOutOfDate, e:
 
2892
            raise errors.BzrCommandError(str(e) + "\n"
 
2893
            'To commit to master branch, run update and then commit.\n'
 
2894
            'You can also pass --local to commit to continue working '
 
2895
            'disconnected.')
 
2896
 
 
2897
 
 
2898
class cmd_check(Command):
 
2899
    """Validate working tree structure, branch consistency and repository history.
 
2900
 
 
2901
    This command checks various invariants about branch and repository storage
 
2902
    to detect data corruption or bzr bugs.
 
2903
 
 
2904
    The working tree and branch checks will only give output if a problem is
 
2905
    detected. The output fields of the repository check are:
 
2906
 
 
2907
        revisions: This is just the number of revisions checked.  It doesn't
 
2908
            indicate a problem.
 
2909
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2910
            doesn't indicate a problem.
 
2911
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2912
            are not properly referenced by the revision ancestry.  This is a
 
2913
            subtle problem that Bazaar can work around.
 
2914
        unique file texts: This is the total number of unique file contents
 
2915
            seen in the checked revisions.  It does not indicate a problem.
 
2916
        repeated file texts: This is the total number of repeated texts seen
 
2917
            in the checked revisions.  Texts can be repeated when their file
 
2918
            entries are modified, but the file contents are not.  It does not
 
2919
            indicate a problem.
 
2920
 
 
2921
    If no restrictions are specified, all Bazaar data that is found at the given
 
2922
    location will be checked.
 
2923
 
 
2924
    :Examples:
 
2925
 
 
2926
        Check the tree and branch at 'foo'::
 
2927
 
 
2928
            bzr check --tree --branch foo
 
2929
 
 
2930
        Check only the repository at 'bar'::
 
2931
 
 
2932
            bzr check --repo bar
 
2933
 
 
2934
        Check everything at 'baz'::
 
2935
 
 
2936
            bzr check baz
 
2937
    """
 
2938
 
 
2939
    _see_also = ['reconcile']
 
2940
    takes_args = ['path?']
 
2941
    takes_options = ['verbose',
 
2942
                     Option('branch', help="Check the branch related to the"
 
2943
                                           " current directory."),
 
2944
                     Option('repo', help="Check the repository related to the"
 
2945
                                         " current directory."),
 
2946
                     Option('tree', help="Check the working tree related to"
 
2947
                                         " the current directory.")]
 
2948
 
 
2949
    def run(self, path=None, verbose=False, branch=False, repo=False,
 
2950
            tree=False):
 
2951
        from bzrlib.check import check_dwim
 
2952
        if path is None:
 
2953
            path = '.'
 
2954
        if not branch and not repo and not tree:
 
2955
            branch = repo = tree = True
 
2956
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2957
 
 
2958
 
 
2959
class cmd_upgrade(Command):
 
2960
    """Upgrade branch storage to current format.
 
2961
 
 
2962
    The check command or bzr developers may sometimes advise you to run
 
2963
    this command. When the default format has changed you may also be warned
 
2964
    during other operations to upgrade.
 
2965
    """
 
2966
 
 
2967
    _see_also = ['check']
 
2968
    takes_args = ['url?']
 
2969
    takes_options = [
 
2970
                    RegistryOption('format',
 
2971
                        help='Upgrade to a specific format.  See "bzr help'
 
2972
                             ' formats" for details.',
 
2973
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
 
2974
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2975
                        value_switches=True, title='Branch format'),
 
2976
                    ]
 
2977
 
 
2978
    def run(self, url='.', format=None):
 
2979
        from bzrlib.upgrade import upgrade
 
2980
        upgrade(url, format)
 
2981
 
 
2982
 
 
2983
class cmd_whoami(Command):
 
2984
    """Show or set bzr user id.
 
2985
 
 
2986
    :Examples:
 
2987
        Show the email of the current user::
 
2988
 
 
2989
            bzr whoami --email
 
2990
 
 
2991
        Set the current user::
 
2992
 
 
2993
            bzr whoami "Frank Chu <fchu@example.com>"
 
2994
    """
 
2995
    takes_options = [ Option('email',
 
2996
                             help='Display email address only.'),
 
2997
                      Option('branch',
 
2998
                             help='Set identity for the current branch instead of '
 
2999
                                  'globally.'),
 
3000
                    ]
 
3001
    takes_args = ['name?']
 
3002
    encoding_type = 'replace'
 
3003
 
 
3004
    @display_command
 
3005
    def run(self, email=False, branch=False, name=None):
 
3006
        if name is None:
 
3007
            # use branch if we're inside one; otherwise global config
 
3008
            try:
 
3009
                c = Branch.open_containing('.')[0].get_config()
 
3010
            except errors.NotBranchError:
 
3011
                c = config.GlobalConfig()
 
3012
            if email:
 
3013
                self.outf.write(c.user_email() + '\n')
 
3014
            else:
 
3015
                self.outf.write(c.username() + '\n')
 
3016
            return
 
3017
 
 
3018
        # display a warning if an email address isn't included in the given name.
 
3019
        try:
 
3020
            config.extract_email_address(name)
 
3021
        except errors.NoEmailInUsername, e:
 
3022
            warning('"%s" does not seem to contain an email address.  '
 
3023
                    'This is allowed, but not recommended.', name)
 
3024
 
 
3025
        # use global config unless --branch given
 
3026
        if branch:
 
3027
            c = Branch.open_containing('.')[0].get_config()
 
3028
        else:
 
3029
            c = config.GlobalConfig()
 
3030
        c.set_user_option('email', name)
 
3031
 
 
3032
 
 
3033
class cmd_nick(Command):
 
3034
    """Print or set the branch nickname.
 
3035
 
 
3036
    If unset, the tree root directory name is used as the nickname.
 
3037
    To print the current nickname, execute with no argument.
 
3038
 
 
3039
    Bound branches use the nickname of its master branch unless it is set
 
3040
    locally.
 
3041
    """
 
3042
 
 
3043
    _see_also = ['info']
 
3044
    takes_args = ['nickname?']
 
3045
    def run(self, nickname=None):
 
3046
        branch = Branch.open_containing(u'.')[0]
 
3047
        if nickname is None:
 
3048
            self.printme(branch)
 
3049
        else:
 
3050
            branch.nick = nickname
 
3051
 
 
3052
    @display_command
 
3053
    def printme(self, branch):
 
3054
        print branch.nick
 
3055
 
 
3056
 
 
3057
class cmd_alias(Command):
 
3058
    """Set/unset and display aliases.
 
3059
 
 
3060
    :Examples:
 
3061
        Show the current aliases::
 
3062
 
 
3063
            bzr alias
 
3064
 
 
3065
        Show the alias specified for 'll'::
 
3066
 
 
3067
            bzr alias ll
 
3068
 
 
3069
        Set an alias for 'll'::
 
3070
 
 
3071
            bzr alias ll="log --line -r-10..-1"
 
3072
 
 
3073
        To remove an alias for 'll'::
 
3074
 
 
3075
            bzr alias --remove ll
 
3076
 
 
3077
    """
 
3078
    takes_args = ['name?']
 
3079
    takes_options = [
 
3080
        Option('remove', help='Remove the alias.'),
 
3081
        ]
 
3082
 
 
3083
    def run(self, name=None, remove=False):
 
3084
        if remove:
 
3085
            self.remove_alias(name)
 
3086
        elif name is None:
 
3087
            self.print_aliases()
 
3088
        else:
 
3089
            equal_pos = name.find('=')
 
3090
            if equal_pos == -1:
 
3091
                self.print_alias(name)
 
3092
            else:
 
3093
                self.set_alias(name[:equal_pos], name[equal_pos+1:])
 
3094
 
 
3095
    def remove_alias(self, alias_name):
 
3096
        if alias_name is None:
 
3097
            raise errors.BzrCommandError(
 
3098
                'bzr alias --remove expects an alias to remove.')
 
3099
        # If alias is not found, print something like:
 
3100
        # unalias: foo: not found
 
3101
        c = config.GlobalConfig()
 
3102
        c.unset_alias(alias_name)
 
3103
 
 
3104
    @display_command
 
3105
    def print_aliases(self):
 
3106
        """Print out the defined aliases in a similar format to bash."""
 
3107
        aliases = config.GlobalConfig().get_aliases()
 
3108
        for key, value in sorted(aliases.iteritems()):
 
3109
            self.outf.write('bzr alias %s="%s"\n' % (key, value))
 
3110
 
 
3111
    @display_command
 
3112
    def print_alias(self, alias_name):
 
3113
        from bzrlib.commands import get_alias
 
3114
        alias = get_alias(alias_name)
 
3115
        if alias is None:
 
3116
            self.outf.write("bzr alias: %s: not found\n" % alias_name)
 
3117
        else:
 
3118
            self.outf.write(
 
3119
                'bzr alias %s="%s"\n' % (alias_name, ' '.join(alias)))
 
3120
 
 
3121
    def set_alias(self, alias_name, alias_command):
 
3122
        """Save the alias in the global config."""
 
3123
        c = config.GlobalConfig()
 
3124
        c.set_alias(alias_name, alias_command)
 
3125
 
 
3126
 
 
3127
class cmd_selftest(Command):
 
3128
    """Run internal test suite.
 
3129
 
 
3130
    If arguments are given, they are regular expressions that say which tests
 
3131
    should run.  Tests matching any expression are run, and other tests are
 
3132
    not run.
 
3133
 
 
3134
    Alternatively if --first is given, matching tests are run first and then
 
3135
    all other tests are run.  This is useful if you have been working in a
 
3136
    particular area, but want to make sure nothing else was broken.
 
3137
 
 
3138
    If --exclude is given, tests that match that regular expression are
 
3139
    excluded, regardless of whether they match --first or not.
 
3140
 
 
3141
    To help catch accidential dependencies between tests, the --randomize
 
3142
    option is useful. In most cases, the argument used is the word 'now'.
 
3143
    Note that the seed used for the random number generator is displayed
 
3144
    when this option is used. The seed can be explicitly passed as the
 
3145
    argument to this option if required. This enables reproduction of the
 
3146
    actual ordering used if and when an order sensitive problem is encountered.
 
3147
 
 
3148
    If --list-only is given, the tests that would be run are listed. This is
 
3149
    useful when combined with --first, --exclude and/or --randomize to
 
3150
    understand their impact. The test harness reports "Listed nn tests in ..."
 
3151
    instead of "Ran nn tests in ..." when list mode is enabled.
 
3152
 
 
3153
    If the global option '--no-plugins' is given, plugins are not loaded
 
3154
    before running the selftests.  This has two effects: features provided or
 
3155
    modified by plugins will not be tested, and tests provided by plugins will
 
3156
    not be run.
 
3157
 
 
3158
    Tests that need working space on disk use a common temporary directory,
 
3159
    typically inside $TMPDIR or /tmp.
 
3160
 
 
3161
    :Examples:
 
3162
        Run only tests relating to 'ignore'::
 
3163
 
 
3164
            bzr selftest ignore
 
3165
 
 
3166
        Disable plugins and list tests as they're run::
 
3167
 
 
3168
            bzr --no-plugins selftest -v
 
3169
    """
 
3170
    # NB: this is used from the class without creating an instance, which is
 
3171
    # why it does not have a self parameter.
 
3172
    def get_transport_type(typestring):
 
3173
        """Parse and return a transport specifier."""
 
3174
        if typestring == "sftp":
 
3175
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
3176
            return SFTPAbsoluteServer
 
3177
        if typestring == "memory":
 
3178
            from bzrlib.transport.memory import MemoryServer
 
3179
            return MemoryServer
 
3180
        if typestring == "fakenfs":
 
3181
            from bzrlib.transport.fakenfs import FakeNFSServer
 
3182
            return FakeNFSServer
 
3183
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
3184
            (typestring)
 
3185
        raise errors.BzrCommandError(msg)
 
3186
 
 
3187
    hidden = True
 
3188
    takes_args = ['testspecs*']
 
3189
    takes_options = ['verbose',
 
3190
                     Option('one',
 
3191
                             help='Stop when one test fails.',
 
3192
                             short_name='1',
 
3193
                             ),
 
3194
                     Option('transport',
 
3195
                            help='Use a different transport by default '
 
3196
                                 'throughout the test suite.',
 
3197
                            type=get_transport_type),
 
3198
                     Option('benchmark',
 
3199
                            help='Run the benchmarks rather than selftests.'),
 
3200
                     Option('lsprof-timed',
 
3201
                            help='Generate lsprof output for benchmarked'
 
3202
                                 ' sections of code.'),
 
3203
                     Option('cache-dir', type=str,
 
3204
                            help='Cache intermediate benchmark output in this '
 
3205
                                 'directory.'),
 
3206
                     Option('first',
 
3207
                            help='Run all tests, but run specified tests first.',
 
3208
                            short_name='f',
 
3209
                            ),
 
3210
                     Option('list-only',
 
3211
                            help='List the tests instead of running them.'),
 
3212
                     RegistryOption('parallel',
 
3213
                        help="Run the test suite in parallel.",
 
3214
                        lazy_registry=('bzrlib.tests', 'parallel_registry'),
 
3215
                        value_switches=False,
 
3216
                        ),
 
3217
                     Option('randomize', type=str, argname="SEED",
 
3218
                            help='Randomize the order of tests using the given'
 
3219
                                 ' seed or "now" for the current time.'),
 
3220
                     Option('exclude', type=str, argname="PATTERN",
 
3221
                            short_name='x',
 
3222
                            help='Exclude tests that match this regular'
 
3223
                                 ' expression.'),
 
3224
                     Option('subunit',
 
3225
                        help='Output test progress via subunit.'),
 
3226
                     Option('strict', help='Fail on missing dependencies or '
 
3227
                            'known failures.'),
 
3228
                     Option('load-list', type=str, argname='TESTLISTFILE',
 
3229
                            help='Load a test id list from a text file.'),
 
3230
                     ListOption('debugflag', type=str, short_name='E',
 
3231
                                help='Turn on a selftest debug flag.'),
 
3232
                     ListOption('starting-with', type=str, argname='TESTID',
 
3233
                                param_name='starting_with', short_name='s',
 
3234
                                help=
 
3235
                                'Load only the tests starting with TESTID.'),
 
3236
                     ]
 
3237
    encoding_type = 'replace'
 
3238
 
 
3239
    def __init__(self):
 
3240
        Command.__init__(self)
 
3241
        self.additional_selftest_args = {}
 
3242
 
 
3243
    def run(self, testspecs_list=None, verbose=False, one=False,
 
3244
            transport=None, benchmark=None,
 
3245
            lsprof_timed=None, cache_dir=None,
 
3246
            first=False, list_only=False,
 
3247
            randomize=None, exclude=None, strict=False,
 
3248
            load_list=None, debugflag=None, starting_with=None, subunit=False,
 
3249
            parallel=None):
 
3250
        from bzrlib.tests import selftest
 
3251
        import bzrlib.benchmarks as benchmarks
 
3252
        from bzrlib.benchmarks import tree_creator
 
3253
 
 
3254
        # Make deprecation warnings visible, unless -Werror is set
 
3255
        symbol_versioning.activate_deprecation_warnings(override=False)
 
3256
 
 
3257
        if cache_dir is not None:
 
3258
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
3259
        if testspecs_list is not None:
 
3260
            pattern = '|'.join(testspecs_list)
 
3261
        else:
 
3262
            pattern = ".*"
 
3263
        if subunit:
 
3264
            try:
 
3265
                from bzrlib.tests import SubUnitBzrRunner
 
3266
            except ImportError:
 
3267
                raise errors.BzrCommandError("subunit not available. subunit "
 
3268
                    "needs to be installed to use --subunit.")
 
3269
            self.additional_selftest_args['runner_class'] = SubUnitBzrRunner
 
3270
        if parallel:
 
3271
            self.additional_selftest_args.setdefault(
 
3272
                'suite_decorators', []).append(parallel)
 
3273
        if benchmark:
 
3274
            test_suite_factory = benchmarks.test_suite
 
3275
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
3276
            verbose = not is_quiet()
 
3277
            # TODO: should possibly lock the history file...
 
3278
            benchfile = open(".perf_history", "at", buffering=1)
 
3279
        else:
 
3280
            test_suite_factory = None
 
3281
            benchfile = None
 
3282
        try:
 
3283
            selftest_kwargs = {"verbose": verbose,
 
3284
                              "pattern": pattern,
 
3285
                              "stop_on_failure": one,
 
3286
                              "transport": transport,
 
3287
                              "test_suite_factory": test_suite_factory,
 
3288
                              "lsprof_timed": lsprof_timed,
 
3289
                              "bench_history": benchfile,
 
3290
                              "matching_tests_first": first,
 
3291
                              "list_only": list_only,
 
3292
                              "random_seed": randomize,
 
3293
                              "exclude_pattern": exclude,
 
3294
                              "strict": strict,
 
3295
                              "load_list": load_list,
 
3296
                              "debug_flags": debugflag,
 
3297
                              "starting_with": starting_with
 
3298
                              }
 
3299
            selftest_kwargs.update(self.additional_selftest_args)
 
3300
            result = selftest(**selftest_kwargs)
 
3301
        finally:
 
3302
            if benchfile is not None:
 
3303
                benchfile.close()
 
3304
        return int(not result)
 
3305
 
 
3306
 
 
3307
class cmd_version(Command):
 
3308
    """Show version of bzr."""
 
3309
 
 
3310
    encoding_type = 'replace'
 
3311
    takes_options = [
 
3312
        Option("short", help="Print just the version number."),
 
3313
        ]
 
3314
 
 
3315
    @display_command
 
3316
    def run(self, short=False):
 
3317
        from bzrlib.version import show_version
 
3318
        if short:
 
3319
            self.outf.write(bzrlib.version_string + '\n')
 
3320
        else:
 
3321
            show_version(to_file=self.outf)
 
3322
 
 
3323
 
 
3324
class cmd_rocks(Command):
 
3325
    """Statement of optimism."""
 
3326
 
 
3327
    hidden = True
 
3328
 
 
3329
    @display_command
 
3330
    def run(self):
 
3331
        print "It sure does!"
 
3332
 
 
3333
 
 
3334
class cmd_find_merge_base(Command):
 
3335
    """Find and print a base revision for merging two branches."""
 
3336
    # TODO: Options to specify revisions on either side, as if
 
3337
    #       merging only part of the history.
 
3338
    takes_args = ['branch', 'other']
 
3339
    hidden = True
 
3340
 
 
3341
    @display_command
 
3342
    def run(self, branch, other):
 
3343
        from bzrlib.revision import ensure_null
 
3344
 
 
3345
        branch1 = Branch.open_containing(branch)[0]
 
3346
        branch2 = Branch.open_containing(other)[0]
 
3347
        branch1.lock_read()
 
3348
        try:
 
3349
            branch2.lock_read()
 
3350
            try:
 
3351
                last1 = ensure_null(branch1.last_revision())
 
3352
                last2 = ensure_null(branch2.last_revision())
 
3353
 
 
3354
                graph = branch1.repository.get_graph(branch2.repository)
 
3355
                base_rev_id = graph.find_unique_lca(last1, last2)
 
3356
 
 
3357
                print 'merge base is revision %s' % base_rev_id
 
3358
            finally:
 
3359
                branch2.unlock()
 
3360
        finally:
 
3361
            branch1.unlock()
 
3362
 
 
3363
 
 
3364
class cmd_merge(Command):
 
3365
    """Perform a three-way merge.
 
3366
 
 
3367
    The source of the merge can be specified either in the form of a branch,
 
3368
    or in the form of a path to a file containing a merge directive generated
 
3369
    with bzr send. If neither is specified, the default is the upstream branch
 
3370
    or the branch most recently merged using --remember.
 
3371
 
 
3372
    When merging a branch, by default the tip will be merged. To pick a different
 
3373
    revision, pass --revision. If you specify two values, the first will be used as
 
3374
    BASE and the second one as OTHER. Merging individual revisions, or a subset of
 
3375
    available revisions, like this is commonly referred to as "cherrypicking".
 
3376
 
 
3377
    Revision numbers are always relative to the branch being merged.
 
3378
 
 
3379
    By default, bzr will try to merge in all new work from the other
 
3380
    branch, automatically determining an appropriate base.  If this
 
3381
    fails, you may need to give an explicit base.
 
3382
 
 
3383
    Merge will do its best to combine the changes in two branches, but there
 
3384
    are some kinds of problems only a human can fix.  When it encounters those,
 
3385
    it will mark a conflict.  A conflict means that you need to fix something,
 
3386
    before you should commit.
 
3387
 
 
3388
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
3389
 
 
3390
    If there is no default branch set, the first merge will set it. After
 
3391
    that, you can omit the branch to use the default.  To change the
 
3392
    default, use --remember. The value will only be saved if the remote
 
3393
    location can be accessed.
 
3394
 
 
3395
    The results of the merge are placed into the destination working
 
3396
    directory, where they can be reviewed (with bzr diff), tested, and then
 
3397
    committed to record the result of the merge.
 
3398
 
 
3399
    merge refuses to run if there are any uncommitted changes, unless
 
3400
    --force is given.
 
3401
 
 
3402
    :Examples:
 
3403
        To merge the latest revision from bzr.dev::
 
3404
 
 
3405
            bzr merge ../bzr.dev
 
3406
 
 
3407
        To merge changes up to and including revision 82 from bzr.dev::
 
3408
 
 
3409
            bzr merge -r 82 ../bzr.dev
 
3410
 
 
3411
        To merge the changes introduced by 82, without previous changes::
 
3412
 
 
3413
            bzr merge -r 81..82 ../bzr.dev
 
3414
 
 
3415
        To apply a merge directive contained in /tmp/merge:
 
3416
 
 
3417
            bzr merge /tmp/merge
 
3418
    """
 
3419
 
 
3420
    encoding_type = 'exact'
 
3421
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
3422
    takes_args = ['location?']
 
3423
    takes_options = [
 
3424
        'change',
 
3425
        'revision',
 
3426
        Option('force',
 
3427
               help='Merge even if the destination tree has uncommitted changes.'),
 
3428
        'merge-type',
 
3429
        'reprocess',
 
3430
        'remember',
 
3431
        Option('show-base', help="Show base revision text in "
 
3432
               "conflicts."),
 
3433
        Option('uncommitted', help='Apply uncommitted changes'
 
3434
               ' from a working copy, instead of branch changes.'),
 
3435
        Option('pull', help='If the destination is already'
 
3436
                ' completely merged into the source, pull from the'
 
3437
                ' source rather than merging.  When this happens,'
 
3438
                ' you do not need to commit the result.'),
 
3439
        Option('directory',
 
3440
               help='Branch to merge into, '
 
3441
                    'rather than the one containing the working directory.',
 
3442
               short_name='d',
 
3443
               type=unicode,
 
3444
               ),
 
3445
        Option('preview', help='Instead of merging, show a diff of the merge.')
 
3446
    ]
 
3447
 
 
3448
    def run(self, location=None, revision=None, force=False,
 
3449
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
3450
            uncommitted=False, pull=False,
 
3451
            directory=None,
 
3452
            preview=False,
 
3453
            ):
 
3454
        if merge_type is None:
 
3455
            merge_type = _mod_merge.Merge3Merger
 
3456
 
 
3457
        if directory is None: directory = u'.'
 
3458
        possible_transports = []
 
3459
        merger = None
 
3460
        allow_pending = True
 
3461
        verified = 'inapplicable'
 
3462
        tree = WorkingTree.open_containing(directory)[0]
 
3463
 
 
3464
        # die as quickly as possible if there are uncommitted changes
 
3465
        try:
 
3466
            basis_tree = tree.revision_tree(tree.last_revision())
 
3467
        except errors.NoSuchRevision:
 
3468
            basis_tree = tree.basis_tree()
 
3469
        if not force:
 
3470
            changes = tree.changes_from(basis_tree)
 
3471
            if changes.has_changed():
 
3472
                raise errors.UncommittedChanges(tree)
 
3473
 
 
3474
        view_info = _get_view_info_for_change_reporter(tree)
 
3475
        change_reporter = delta._ChangeReporter(
 
3476
            unversioned_filter=tree.is_ignored, view_info=view_info)
 
3477
        cleanups = []
 
3478
        try:
 
3479
            pb = ui.ui_factory.nested_progress_bar()
 
3480
            cleanups.append(pb.finished)
 
3481
            tree.lock_write()
 
3482
            cleanups.append(tree.unlock)
 
3483
            if location is not None:
 
3484
                try:
 
3485
                    mergeable = bundle.read_mergeable_from_url(location,
 
3486
                        possible_transports=possible_transports)
 
3487
                except errors.NotABundle:
 
3488
                    mergeable = None
 
3489
                else:
 
3490
                    if uncommitted:
 
3491
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
3492
                            ' with bundles or merge directives.')
 
3493
 
 
3494
                    if revision is not None:
 
3495
                        raise errors.BzrCommandError(
 
3496
                            'Cannot use -r with merge directives or bundles')
 
3497
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
3498
                       mergeable, pb)
 
3499
 
 
3500
            if merger is None and uncommitted:
 
3501
                if revision is not None and len(revision) > 0:
 
3502
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
3503
                        ' --revision at the same time.')
 
3504
                location = self._select_branch_location(tree, location)[0]
 
3505
                other_tree, other_path = WorkingTree.open_containing(location)
 
3506
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
3507
                    pb)
 
3508
                allow_pending = False
 
3509
                if other_path != '':
 
3510
                    merger.interesting_files = [other_path]
 
3511
 
 
3512
            if merger is None:
 
3513
                merger, allow_pending = self._get_merger_from_branch(tree,
 
3514
                    location, revision, remember, possible_transports, pb)
 
3515
 
 
3516
            merger.merge_type = merge_type
 
3517
            merger.reprocess = reprocess
 
3518
            merger.show_base = show_base
 
3519
            self.sanity_check_merger(merger)
 
3520
            if (merger.base_rev_id == merger.other_rev_id and
 
3521
                merger.other_rev_id is not None):
 
3522
                note('Nothing to do.')
 
3523
                return 0
 
3524
            if pull:
 
3525
                if merger.interesting_files is not None:
 
3526
                    raise errors.BzrCommandError('Cannot pull individual files')
 
3527
                if (merger.base_rev_id == tree.last_revision()):
 
3528
                    result = tree.pull(merger.other_branch, False,
 
3529
                                       merger.other_rev_id)
 
3530
                    result.report(self.outf)
 
3531
                    return 0
 
3532
            merger.check_basis(False)
 
3533
            if preview:
 
3534
                return self._do_preview(merger)
 
3535
            else:
 
3536
                return self._do_merge(merger, change_reporter, allow_pending,
 
3537
                                      verified)
 
3538
        finally:
 
3539
            for cleanup in reversed(cleanups):
 
3540
                cleanup()
 
3541
 
 
3542
    def _do_preview(self, merger):
 
3543
        from bzrlib.diff import show_diff_trees
 
3544
        tree_merger = merger.make_merger()
 
3545
        tt = tree_merger.make_preview_transform()
 
3546
        try:
 
3547
            result_tree = tt.get_preview_tree()
 
3548
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
3549
                            old_label='', new_label='')
 
3550
        finally:
 
3551
            tt.finalize()
 
3552
 
 
3553
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
 
3554
        merger.change_reporter = change_reporter
 
3555
        conflict_count = merger.do_merge()
 
3556
        if allow_pending:
 
3557
            merger.set_pending()
 
3558
        if verified == 'failed':
 
3559
            warning('Preview patch does not match changes')
 
3560
        if conflict_count != 0:
 
3561
            return 1
 
3562
        else:
 
3563
            return 0
 
3564
 
 
3565
    def sanity_check_merger(self, merger):
 
3566
        if (merger.show_base and
 
3567
            not merger.merge_type is _mod_merge.Merge3Merger):
 
3568
            raise errors.BzrCommandError("Show-base is not supported for this"
 
3569
                                         " merge type. %s" % merger.merge_type)
 
3570
        if merger.reprocess is None:
 
3571
            if merger.show_base:
 
3572
                merger.reprocess = False
 
3573
            else:
 
3574
                # Use reprocess if the merger supports it
 
3575
                merger.reprocess = merger.merge_type.supports_reprocess
 
3576
        if merger.reprocess and not merger.merge_type.supports_reprocess:
 
3577
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
3578
                                         " for merge type %s." %
 
3579
                                         merger.merge_type)
 
3580
        if merger.reprocess and merger.show_base:
 
3581
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
3582
                                         " show base.")
 
3583
 
 
3584
    def _get_merger_from_branch(self, tree, location, revision, remember,
 
3585
                                possible_transports, pb):
 
3586
        """Produce a merger from a location, assuming it refers to a branch."""
 
3587
        from bzrlib.tag import _merge_tags_if_possible
 
3588
        # find the branch locations
 
3589
        other_loc, user_location = self._select_branch_location(tree, location,
 
3590
            revision, -1)
 
3591
        if revision is not None and len(revision) == 2:
 
3592
            base_loc, _unused = self._select_branch_location(tree,
 
3593
                location, revision, 0)
 
3594
        else:
 
3595
            base_loc = other_loc
 
3596
        # Open the branches
 
3597
        other_branch, other_path = Branch.open_containing(other_loc,
 
3598
            possible_transports)
 
3599
        if base_loc == other_loc:
 
3600
            base_branch = other_branch
 
3601
        else:
 
3602
            base_branch, base_path = Branch.open_containing(base_loc,
 
3603
                possible_transports)
 
3604
        # Find the revision ids
 
3605
        if revision is None or len(revision) < 1 or revision[-1] is None:
 
3606
            other_revision_id = _mod_revision.ensure_null(
 
3607
                other_branch.last_revision())
 
3608
        else:
 
3609
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3610
        if (revision is not None and len(revision) == 2
 
3611
            and revision[0] is not None):
 
3612
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3613
        else:
 
3614
            base_revision_id = None
 
3615
        # Remember where we merge from
 
3616
        if ((remember or tree.branch.get_submit_branch() is None) and
 
3617
             user_location is not None):
 
3618
            tree.branch.set_submit_branch(other_branch.base)
 
3619
        _merge_tags_if_possible(other_branch, tree.branch)
 
3620
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
 
3621
            other_revision_id, base_revision_id, other_branch, base_branch)
 
3622
        if other_path != '':
 
3623
            allow_pending = False
 
3624
            merger.interesting_files = [other_path]
 
3625
        else:
 
3626
            allow_pending = True
 
3627
        return merger, allow_pending
 
3628
 
 
3629
    def _select_branch_location(self, tree, user_location, revision=None,
 
3630
                                index=None):
 
3631
        """Select a branch location, according to possible inputs.
 
3632
 
 
3633
        If provided, branches from ``revision`` are preferred.  (Both
 
3634
        ``revision`` and ``index`` must be supplied.)
 
3635
 
 
3636
        Otherwise, the ``location`` parameter is used.  If it is None, then the
 
3637
        ``submit`` or ``parent`` location is used, and a note is printed.
 
3638
 
 
3639
        :param tree: The working tree to select a branch for merging into
 
3640
        :param location: The location entered by the user
 
3641
        :param revision: The revision parameter to the command
 
3642
        :param index: The index to use for the revision parameter.  Negative
 
3643
            indices are permitted.
 
3644
        :return: (selected_location, user_location).  The default location
 
3645
            will be the user-entered location.
 
3646
        """
 
3647
        if (revision is not None and index is not None
 
3648
            and revision[index] is not None):
 
3649
            branch = revision[index].get_branch()
 
3650
            if branch is not None:
 
3651
                return branch, branch
 
3652
        if user_location is None:
 
3653
            location = self._get_remembered(tree, 'Merging from')
 
3654
        else:
 
3655
            location = user_location
 
3656
        return location, user_location
 
3657
 
 
3658
    def _get_remembered(self, tree, verb_string):
 
3659
        """Use tree.branch's parent if none was supplied.
 
3660
 
 
3661
        Report if the remembered location was used.
 
3662
        """
 
3663
        stored_location = tree.branch.get_submit_branch()
 
3664
        stored_location_type = "submit"
 
3665
        if stored_location is None:
 
3666
            stored_location = tree.branch.get_parent()
 
3667
            stored_location_type = "parent"
 
3668
        mutter("%s", stored_location)
 
3669
        if stored_location is None:
 
3670
            raise errors.BzrCommandError("No location specified or remembered")
 
3671
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
 
3672
        note(u"%s remembered %s location %s", verb_string,
 
3673
                stored_location_type, display_url)
 
3674
        return stored_location
 
3675
 
 
3676
 
 
3677
class cmd_remerge(Command):
 
3678
    """Redo a merge.
 
3679
 
 
3680
    Use this if you want to try a different merge technique while resolving
 
3681
    conflicts.  Some merge techniques are better than others, and remerge
 
3682
    lets you try different ones on different files.
 
3683
 
 
3684
    The options for remerge have the same meaning and defaults as the ones for
 
3685
    merge.  The difference is that remerge can (only) be run when there is a
 
3686
    pending merge, and it lets you specify particular files.
 
3687
 
 
3688
    :Examples:
 
3689
        Re-do the merge of all conflicted files, and show the base text in
 
3690
        conflict regions, in addition to the usual THIS and OTHER texts::
 
3691
 
 
3692
            bzr remerge --show-base
 
3693
 
 
3694
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
3695
        additional processing to reduce the size of conflict regions::
 
3696
 
 
3697
            bzr remerge --merge-type weave --reprocess foobar
 
3698
    """
 
3699
    takes_args = ['file*']
 
3700
    takes_options = [
 
3701
            'merge-type',
 
3702
            'reprocess',
 
3703
            Option('show-base',
 
3704
                   help="Show base revision text in conflicts."),
 
3705
            ]
 
3706
 
 
3707
    def run(self, file_list=None, merge_type=None, show_base=False,
 
3708
            reprocess=False):
 
3709
        if merge_type is None:
 
3710
            merge_type = _mod_merge.Merge3Merger
 
3711
        tree, file_list = tree_files(file_list)
 
3712
        tree.lock_write()
 
3713
        try:
 
3714
            parents = tree.get_parent_ids()
 
3715
            if len(parents) != 2:
 
3716
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3717
                                             " merges.  Not cherrypicking or"
 
3718
                                             " multi-merges.")
 
3719
            repository = tree.branch.repository
 
3720
            interesting_ids = None
 
3721
            new_conflicts = []
 
3722
            conflicts = tree.conflicts()
 
3723
            if file_list is not None:
 
3724
                interesting_ids = set()
 
3725
                for filename in file_list:
 
3726
                    file_id = tree.path2id(filename)
 
3727
                    if file_id is None:
 
3728
                        raise errors.NotVersionedError(filename)
 
3729
                    interesting_ids.add(file_id)
 
3730
                    if tree.kind(file_id) != "directory":
 
3731
                        continue
 
3732
 
 
3733
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3734
                        interesting_ids.add(ie.file_id)
 
3735
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3736
            else:
 
3737
                # Remerge only supports resolving contents conflicts
 
3738
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3739
                restore_files = [c.path for c in conflicts
 
3740
                                 if c.typestring in allowed_conflicts]
 
3741
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3742
            tree.set_conflicts(ConflictList(new_conflicts))
 
3743
            if file_list is not None:
 
3744
                restore_files = file_list
 
3745
            for filename in restore_files:
 
3746
                try:
 
3747
                    restore(tree.abspath(filename))
 
3748
                except errors.NotConflicted:
 
3749
                    pass
 
3750
            # Disable pending merges, because the file texts we are remerging
 
3751
            # have not had those merges performed.  If we use the wrong parents
 
3752
            # list, we imply that the working tree text has seen and rejected
 
3753
            # all the changes from the other tree, when in fact those changes
 
3754
            # have not yet been seen.
 
3755
            pb = ui.ui_factory.nested_progress_bar()
 
3756
            tree.set_parent_ids(parents[:1])
 
3757
            try:
 
3758
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3759
                                                             tree, parents[1])
 
3760
                merger.interesting_ids = interesting_ids
 
3761
                merger.merge_type = merge_type
 
3762
                merger.show_base = show_base
 
3763
                merger.reprocess = reprocess
 
3764
                conflicts = merger.do_merge()
 
3765
            finally:
 
3766
                tree.set_parent_ids(parents)
 
3767
                pb.finished()
 
3768
        finally:
 
3769
            tree.unlock()
 
3770
        if conflicts > 0:
 
3771
            return 1
 
3772
        else:
 
3773
            return 0
 
3774
 
 
3775
 
 
3776
class cmd_revert(Command):
 
3777
    """Revert files to a previous revision.
 
3778
 
 
3779
    Giving a list of files will revert only those files.  Otherwise, all files
 
3780
    will be reverted.  If the revision is not specified with '--revision', the
 
3781
    last committed revision is used.
 
3782
 
 
3783
    To remove only some changes, without reverting to a prior version, use
 
3784
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3785
    changes introduced by -2, without affecting the changes introduced by -1.
 
3786
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3787
 
 
3788
    By default, any files that have been manually changed will be backed up
 
3789
    first.  (Files changed only by merge are not backed up.)  Backup files have
 
3790
    '.~#~' appended to their name, where # is a number.
 
3791
 
 
3792
    When you provide files, you can use their current pathname or the pathname
 
3793
    from the target revision.  So you can use revert to "undelete" a file by
 
3794
    name.  If you name a directory, all the contents of that directory will be
 
3795
    reverted.
 
3796
 
 
3797
    Any files that have been newly added since that revision will be deleted,
 
3798
    with a backup kept if appropriate.  Directories containing unknown files
 
3799
    will not be deleted.
 
3800
 
 
3801
    The working tree contains a list of pending merged revisions, which will
 
3802
    be included as parents in the next commit.  Normally, revert clears that
 
3803
    list as well as reverting the files.  If any files are specified, revert
 
3804
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3805
    revert ." in the tree root to revert all files but keep the merge record,
 
3806
    and "bzr revert --forget-merges" to clear the pending merge list without
 
3807
    reverting any files.
 
3808
    """
 
3809
 
 
3810
    _see_also = ['cat', 'export']
 
3811
    takes_options = [
 
3812
        'revision',
 
3813
        Option('no-backup', "Do not save backups of reverted files."),
 
3814
        Option('forget-merges',
 
3815
               'Remove pending merge marker, without changing any files.'),
 
3816
        ]
 
3817
    takes_args = ['file*']
 
3818
 
 
3819
    def run(self, revision=None, no_backup=False, file_list=None,
 
3820
            forget_merges=None):
 
3821
        tree, file_list = tree_files(file_list)
 
3822
        tree.lock_write()
 
3823
        try:
 
3824
            if forget_merges:
 
3825
                tree.set_parent_ids(tree.get_parent_ids()[:1])
 
3826
            else:
 
3827
                self._revert_tree_to_revision(tree, revision, file_list, no_backup)
 
3828
        finally:
 
3829
            tree.unlock()
 
3830
 
 
3831
    @staticmethod
 
3832
    def _revert_tree_to_revision(tree, revision, file_list, no_backup):
 
3833
        rev_tree = _get_one_revision_tree('revert', revision, tree=tree)
 
3834
        pb = ui.ui_factory.nested_progress_bar()
 
3835
        try:
 
3836
            tree.revert(file_list, rev_tree, not no_backup, pb,
 
3837
                report_changes=True)
 
3838
        finally:
 
3839
            pb.finished()
 
3840
 
 
3841
 
 
3842
class cmd_assert_fail(Command):
 
3843
    """Test reporting of assertion failures"""
 
3844
    # intended just for use in testing
 
3845
 
 
3846
    hidden = True
 
3847
 
 
3848
    def run(self):
 
3849
        raise AssertionError("always fails")
 
3850
 
 
3851
 
 
3852
class cmd_help(Command):
 
3853
    """Show help on a command or other topic.
 
3854
    """
 
3855
 
 
3856
    _see_also = ['topics']
 
3857
    takes_options = [
 
3858
            Option('long', 'Show help on all commands.'),
 
3859
            ]
 
3860
    takes_args = ['topic?']
 
3861
    aliases = ['?', '--help', '-?', '-h']
 
3862
 
 
3863
    @display_command
 
3864
    def run(self, topic=None, long=False):
 
3865
        import bzrlib.help
 
3866
        if topic is None and long:
 
3867
            topic = "commands"
 
3868
        bzrlib.help.help(topic)
 
3869
 
 
3870
 
 
3871
class cmd_shell_complete(Command):
 
3872
    """Show appropriate completions for context.
 
3873
 
 
3874
    For a list of all available commands, say 'bzr shell-complete'.
 
3875
    """
 
3876
    takes_args = ['context?']
 
3877
    aliases = ['s-c']
 
3878
    hidden = True
 
3879
 
 
3880
    @display_command
 
3881
    def run(self, context=None):
 
3882
        import shellcomplete
 
3883
        shellcomplete.shellcomplete(context)
 
3884
 
 
3885
 
 
3886
class cmd_missing(Command):
 
3887
    """Show unmerged/unpulled revisions between two branches.
 
3888
 
 
3889
    OTHER_BRANCH may be local or remote.
 
3890
 
 
3891
    To filter on a range of revisions, you can use the command -r begin..end
 
3892
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
3893
    also valid.
 
3894
 
 
3895
    :Examples:
 
3896
 
 
3897
        Determine the missing revisions between this and the branch at the
 
3898
        remembered pull location::
 
3899
 
 
3900
            bzr missing
 
3901
 
 
3902
        Determine the missing revisions between this and another branch::
 
3903
 
 
3904
            bzr missing http://server/branch
 
3905
 
 
3906
        Determine the missing revisions up to a specific revision on the other
 
3907
        branch::
 
3908
 
 
3909
            bzr missing -r ..-10
 
3910
 
 
3911
        Determine the missing revisions up to a specific revision on this
 
3912
        branch::
 
3913
 
 
3914
            bzr missing --my-revision ..-10
 
3915
    """
 
3916
 
 
3917
    _see_also = ['merge', 'pull']
 
3918
    takes_args = ['other_branch?']
 
3919
    takes_options = [
 
3920
        Option('reverse', 'Reverse the order of revisions.'),
 
3921
        Option('mine-only',
 
3922
               'Display changes in the local branch only.'),
 
3923
        Option('this' , 'Same as --mine-only.'),
 
3924
        Option('theirs-only',
 
3925
               'Display changes in the remote branch only.'),
 
3926
        Option('other', 'Same as --theirs-only.'),
 
3927
        'log-format',
 
3928
        'show-ids',
 
3929
        'verbose',
 
3930
        custom_help('revision',
 
3931
             help='Filter on other branch revisions (inclusive). '
 
3932
                'See "help revisionspec" for details.'),
 
3933
        Option('my-revision',
 
3934
            type=_parse_revision_str,
 
3935
            help='Filter on local branch revisions (inclusive). '
 
3936
                'See "help revisionspec" for details.'),
 
3937
        Option('include-merges',
 
3938
               'Show all revisions in addition to the mainline ones.'),
 
3939
        ]
 
3940
    encoding_type = 'replace'
 
3941
 
 
3942
    @display_command
 
3943
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
3944
            theirs_only=False,
 
3945
            log_format=None, long=False, short=False, line=False,
 
3946
            show_ids=False, verbose=False, this=False, other=False,
 
3947
            include_merges=False, revision=None, my_revision=None):
 
3948
        from bzrlib.missing import find_unmerged, iter_log_revisions
 
3949
        def message(s):
 
3950
            if not is_quiet():
 
3951
                self.outf.write(s)
 
3952
 
 
3953
        if this:
 
3954
            mine_only = this
 
3955
        if other:
 
3956
            theirs_only = other
 
3957
        # TODO: We should probably check that we don't have mine-only and
 
3958
        #       theirs-only set, but it gets complicated because we also have
 
3959
        #       this and other which could be used.
 
3960
        restrict = 'all'
 
3961
        if mine_only:
 
3962
            restrict = 'local'
 
3963
        elif theirs_only:
 
3964
            restrict = 'remote'
 
3965
 
 
3966
        local_branch = Branch.open_containing(u".")[0]
 
3967
        parent = local_branch.get_parent()
 
3968
        if other_branch is None:
 
3969
            other_branch = parent
 
3970
            if other_branch is None:
 
3971
                raise errors.BzrCommandError("No peer location known"
 
3972
                                             " or specified.")
 
3973
            display_url = urlutils.unescape_for_display(parent,
 
3974
                                                        self.outf.encoding)
 
3975
            message("Using saved parent location: "
 
3976
                    + display_url + "\n")
 
3977
 
 
3978
        remote_branch = Branch.open(other_branch)
 
3979
        if remote_branch.base == local_branch.base:
 
3980
            remote_branch = local_branch
 
3981
 
 
3982
        local_revid_range = _revision_range_to_revid_range(
 
3983
            _get_revision_range(my_revision, local_branch,
 
3984
                self.name()))
 
3985
 
 
3986
        remote_revid_range = _revision_range_to_revid_range(
 
3987
            _get_revision_range(revision,
 
3988
                remote_branch, self.name()))
 
3989
 
 
3990
        local_branch.lock_read()
 
3991
        try:
 
3992
            remote_branch.lock_read()
 
3993
            try:
 
3994
                local_extra, remote_extra = find_unmerged(
 
3995
                    local_branch, remote_branch, restrict,
 
3996
                    backward=not reverse,
 
3997
                    include_merges=include_merges,
 
3998
                    local_revid_range=local_revid_range,
 
3999
                    remote_revid_range=remote_revid_range)
 
4000
 
 
4001
                if log_format is None:
 
4002
                    registry = log.log_formatter_registry
 
4003
                    log_format = registry.get_default(local_branch)
 
4004
                lf = log_format(to_file=self.outf,
 
4005
                                show_ids=show_ids,
 
4006
                                show_timezone='original')
 
4007
 
 
4008
                status_code = 0
 
4009
                if local_extra and not theirs_only:
 
4010
                    message("You have %d extra revision(s):\n" %
 
4011
                        len(local_extra))
 
4012
                    for revision in iter_log_revisions(local_extra,
 
4013
                                        local_branch.repository,
 
4014
                                        verbose):
 
4015
                        lf.log_revision(revision)
 
4016
                    printed_local = True
 
4017
                    status_code = 1
 
4018
                else:
 
4019
                    printed_local = False
 
4020
 
 
4021
                if remote_extra and not mine_only:
 
4022
                    if printed_local is True:
 
4023
                        message("\n\n\n")
 
4024
                    message("You are missing %d revision(s):\n" %
 
4025
                        len(remote_extra))
 
4026
                    for revision in iter_log_revisions(remote_extra,
 
4027
                                        remote_branch.repository,
 
4028
                                        verbose):
 
4029
                        lf.log_revision(revision)
 
4030
                    status_code = 1
 
4031
 
 
4032
                if mine_only and not local_extra:
 
4033
                    # We checked local, and found nothing extra
 
4034
                    message('This branch is up to date.\n')
 
4035
                elif theirs_only and not remote_extra:
 
4036
                    # We checked remote, and found nothing extra
 
4037
                    message('Other branch is up to date.\n')
 
4038
                elif not (mine_only or theirs_only or local_extra or
 
4039
                          remote_extra):
 
4040
                    # We checked both branches, and neither one had extra
 
4041
                    # revisions
 
4042
                    message("Branches are up to date.\n")
 
4043
            finally:
 
4044
                remote_branch.unlock()
 
4045
        finally:
 
4046
            local_branch.unlock()
 
4047
        if not status_code and parent is None and other_branch is not None:
 
4048
            local_branch.lock_write()
 
4049
            try:
 
4050
                # handle race conditions - a parent might be set while we run.
 
4051
                if local_branch.get_parent() is None:
 
4052
                    local_branch.set_parent(remote_branch.base)
 
4053
            finally:
 
4054
                local_branch.unlock()
 
4055
        return status_code
 
4056
 
 
4057
 
 
4058
class cmd_pack(Command):
 
4059
    """Compress the data within a repository."""
 
4060
 
 
4061
    _see_also = ['repositories']
 
4062
    takes_args = ['branch_or_repo?']
 
4063
 
 
4064
    def run(self, branch_or_repo='.'):
 
4065
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
 
4066
        try:
 
4067
            branch = dir.open_branch()
 
4068
            repository = branch.repository
 
4069
        except errors.NotBranchError:
 
4070
            repository = dir.open_repository()
 
4071
        repository.pack()
 
4072
 
 
4073
 
 
4074
class cmd_plugins(Command):
 
4075
    """List the installed plugins.
 
4076
 
 
4077
    This command displays the list of installed plugins including
 
4078
    version of plugin and a short description of each.
 
4079
 
 
4080
    --verbose shows the path where each plugin is located.
 
4081
 
 
4082
    A plugin is an external component for Bazaar that extends the
 
4083
    revision control system, by adding or replacing code in Bazaar.
 
4084
    Plugins can do a variety of things, including overriding commands,
 
4085
    adding new commands, providing additional network transports and
 
4086
    customizing log output.
 
4087
 
 
4088
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
4089
    information on plugins including where to find them and how to
 
4090
    install them. Instructions are also provided there on how to
 
4091
    write new plugins using the Python programming language.
 
4092
    """
 
4093
    takes_options = ['verbose']
 
4094
 
 
4095
    @display_command
 
4096
    def run(self, verbose=False):
 
4097
        import bzrlib.plugin
 
4098
        from inspect import getdoc
 
4099
        result = []
 
4100
        for name, plugin in bzrlib.plugin.plugins().items():
 
4101
            version = plugin.__version__
 
4102
            if version == 'unknown':
 
4103
                version = ''
 
4104
            name_ver = '%s %s' % (name, version)
 
4105
            d = getdoc(plugin.module)
 
4106
            if d:
 
4107
                doc = d.split('\n')[0]
 
4108
            else:
 
4109
                doc = '(no description)'
 
4110
            result.append((name_ver, doc, plugin.path()))
 
4111
        for name_ver, doc, path in sorted(result):
 
4112
            print name_ver
 
4113
            print '   ', doc
 
4114
            if verbose:
 
4115
                print '   ', path
 
4116
            print
 
4117
 
 
4118
 
 
4119
class cmd_testament(Command):
 
4120
    """Show testament (signing-form) of a revision."""
 
4121
    takes_options = [
 
4122
            'revision',
 
4123
            Option('long', help='Produce long-format testament.'),
 
4124
            Option('strict',
 
4125
                   help='Produce a strict-format testament.')]
 
4126
    takes_args = ['branch?']
 
4127
    @display_command
 
4128
    def run(self, branch=u'.', revision=None, long=False, strict=False):
 
4129
        from bzrlib.testament import Testament, StrictTestament
 
4130
        if strict is True:
 
4131
            testament_class = StrictTestament
 
4132
        else:
 
4133
            testament_class = Testament
 
4134
        if branch == '.':
 
4135
            b = Branch.open_containing(branch)[0]
 
4136
        else:
 
4137
            b = Branch.open(branch)
 
4138
        b.lock_read()
 
4139
        try:
 
4140
            if revision is None:
 
4141
                rev_id = b.last_revision()
 
4142
            else:
 
4143
                rev_id = revision[0].as_revision_id(b)
 
4144
            t = testament_class.from_revision(b.repository, rev_id)
 
4145
            if long:
 
4146
                sys.stdout.writelines(t.as_text_lines())
 
4147
            else:
 
4148
                sys.stdout.write(t.as_short_text())
 
4149
        finally:
 
4150
            b.unlock()
 
4151
 
 
4152
 
 
4153
class cmd_annotate(Command):
 
4154
    """Show the origin of each line in a file.
 
4155
 
 
4156
    This prints out the given file with an annotation on the left side
 
4157
    indicating which revision, author and date introduced the change.
 
4158
 
 
4159
    If the origin is the same for a run of consecutive lines, it is
 
4160
    shown only at the top, unless the --all option is given.
 
4161
    """
 
4162
    # TODO: annotate directories; showing when each file was last changed
 
4163
    # TODO: if the working copy is modified, show annotations on that
 
4164
    #       with new uncommitted lines marked
 
4165
    aliases = ['ann', 'blame', 'praise']
 
4166
    takes_args = ['filename']
 
4167
    takes_options = [Option('all', help='Show annotations on all lines.'),
 
4168
                     Option('long', help='Show commit date in annotations.'),
 
4169
                     'revision',
 
4170
                     'show-ids',
 
4171
                     ]
 
4172
    encoding_type = 'exact'
 
4173
 
 
4174
    @display_command
 
4175
    def run(self, filename, all=False, long=False, revision=None,
 
4176
            show_ids=False):
 
4177
        from bzrlib.annotate import annotate_file, annotate_file_tree
 
4178
        wt, branch, relpath = \
 
4179
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
4180
        if wt is not None:
 
4181
            wt.lock_read()
 
4182
        else:
 
4183
            branch.lock_read()
 
4184
        try:
 
4185
            tree = _get_one_revision_tree('annotate', revision, branch=branch)
 
4186
            if wt is not None:
 
4187
                file_id = wt.path2id(relpath)
 
4188
            else:
 
4189
                file_id = tree.path2id(relpath)
 
4190
            if file_id is None:
 
4191
                raise errors.NotVersionedError(filename)
 
4192
            file_version = tree.inventory[file_id].revision
 
4193
            if wt is not None and revision is None:
 
4194
                # If there is a tree and we're not annotating historical
 
4195
                # versions, annotate the working tree's content.
 
4196
                annotate_file_tree(wt, file_id, self.outf, long, all,
 
4197
                    show_ids=show_ids)
 
4198
            else:
 
4199
                annotate_file(branch, file_version, file_id, long, all, self.outf,
 
4200
                              show_ids=show_ids)
 
4201
        finally:
 
4202
            if wt is not None:
 
4203
                wt.unlock()
 
4204
            else:
 
4205
                branch.unlock()
 
4206
 
 
4207
 
 
4208
class cmd_re_sign(Command):
 
4209
    """Create a digital signature for an existing revision."""
 
4210
    # TODO be able to replace existing ones.
 
4211
 
 
4212
    hidden = True # is this right ?
 
4213
    takes_args = ['revision_id*']
 
4214
    takes_options = ['revision']
 
4215
 
 
4216
    def run(self, revision_id_list=None, revision=None):
 
4217
        if revision_id_list is not None and revision is not None:
 
4218
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
 
4219
        if revision_id_list is None and revision is None:
 
4220
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
4221
        b = WorkingTree.open_containing(u'.')[0].branch
 
4222
        b.lock_write()
 
4223
        try:
 
4224
            return self._run(b, revision_id_list, revision)
 
4225
        finally:
 
4226
            b.unlock()
 
4227
 
 
4228
    def _run(self, b, revision_id_list, revision):
 
4229
        import bzrlib.gpg as gpg
 
4230
        gpg_strategy = gpg.GPGStrategy(b.get_config())
 
4231
        if revision_id_list is not None:
 
4232
            b.repository.start_write_group()
 
4233
            try:
 
4234
                for revision_id in revision_id_list:
 
4235
                    b.repository.sign_revision(revision_id, gpg_strategy)
 
4236
            except:
 
4237
                b.repository.abort_write_group()
 
4238
                raise
 
4239
            else:
 
4240
                b.repository.commit_write_group()
 
4241
        elif revision is not None:
 
4242
            if len(revision) == 1:
 
4243
                revno, rev_id = revision[0].in_history(b)
 
4244
                b.repository.start_write_group()
 
4245
                try:
 
4246
                    b.repository.sign_revision(rev_id, gpg_strategy)
 
4247
                except:
 
4248
                    b.repository.abort_write_group()
 
4249
                    raise
 
4250
                else:
 
4251
                    b.repository.commit_write_group()
 
4252
            elif len(revision) == 2:
 
4253
                # are they both on rh- if so we can walk between them
 
4254
                # might be nice to have a range helper for arbitrary
 
4255
                # revision paths. hmm.
 
4256
                from_revno, from_revid = revision[0].in_history(b)
 
4257
                to_revno, to_revid = revision[1].in_history(b)
 
4258
                if to_revid is None:
 
4259
                    to_revno = b.revno()
 
4260
                if from_revno is None or to_revno is None:
 
4261
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
4262
                b.repository.start_write_group()
 
4263
                try:
 
4264
                    for revno in range(from_revno, to_revno + 1):
 
4265
                        b.repository.sign_revision(b.get_rev_id(revno),
 
4266
                                                   gpg_strategy)
 
4267
                except:
 
4268
                    b.repository.abort_write_group()
 
4269
                    raise
 
4270
                else:
 
4271
                    b.repository.commit_write_group()
 
4272
            else:
 
4273
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
 
4274
 
 
4275
 
 
4276
class cmd_bind(Command):
 
4277
    """Convert the current branch into a checkout of the supplied branch.
 
4278
 
 
4279
    Once converted into a checkout, commits must succeed on the master branch
 
4280
    before they will be applied to the local branch.
 
4281
 
 
4282
    Bound branches use the nickname of its master branch unless it is set
 
4283
    locally, in which case binding will update the the local nickname to be
 
4284
    that of the master.
 
4285
    """
 
4286
 
 
4287
    _see_also = ['checkouts', 'unbind']
 
4288
    takes_args = ['location?']
 
4289
    takes_options = []
 
4290
 
 
4291
    def run(self, location=None):
 
4292
        b, relpath = Branch.open_containing(u'.')
 
4293
        if location is None:
 
4294
            try:
 
4295
                location = b.get_old_bound_location()
 
4296
            except errors.UpgradeRequired:
 
4297
                raise errors.BzrCommandError('No location supplied.  '
 
4298
                    'This format does not remember old locations.')
 
4299
            else:
 
4300
                if location is None:
 
4301
                    raise errors.BzrCommandError('No location supplied and no '
 
4302
                        'previous location known')
 
4303
        b_other = Branch.open(location)
 
4304
        try:
 
4305
            b.bind(b_other)
 
4306
        except errors.DivergedBranches:
 
4307
            raise errors.BzrCommandError('These branches have diverged.'
 
4308
                                         ' Try merging, and then bind again.')
 
4309
        if b.get_config().has_explicit_nickname():
 
4310
            b.nick = b_other.nick
 
4311
 
 
4312
 
 
4313
class cmd_unbind(Command):
 
4314
    """Convert the current checkout into a regular branch.
 
4315
 
 
4316
    After unbinding, the local branch is considered independent and subsequent
 
4317
    commits will be local only.
 
4318
    """
 
4319
 
 
4320
    _see_also = ['checkouts', 'bind']
 
4321
    takes_args = []
 
4322
    takes_options = []
 
4323
 
 
4324
    def run(self):
 
4325
        b, relpath = Branch.open_containing(u'.')
 
4326
        if not b.unbind():
 
4327
            raise errors.BzrCommandError('Local branch is not bound')
 
4328
 
 
4329
 
 
4330
class cmd_uncommit(Command):
 
4331
    """Remove the last committed revision.
 
4332
 
 
4333
    --verbose will print out what is being removed.
 
4334
    --dry-run will go through all the motions, but not actually
 
4335
    remove anything.
 
4336
 
 
4337
    If --revision is specified, uncommit revisions to leave the branch at the
 
4338
    specified revision.  For example, "bzr uncommit -r 15" will leave the
 
4339
    branch at revision 15.
 
4340
 
 
4341
    Uncommit leaves the working tree ready for a new commit.  The only change
 
4342
    it may make is to restore any pending merges that were present before
 
4343
    the commit.
 
4344
    """
 
4345
 
 
4346
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
4347
    # unreferenced information in 'branch-as-repository' branches.
 
4348
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
4349
    # information in shared branches as well.
 
4350
    _see_also = ['commit']
 
4351
    takes_options = ['verbose', 'revision',
 
4352
                    Option('dry-run', help='Don\'t actually make changes.'),
 
4353
                    Option('force', help='Say yes to all questions.'),
 
4354
                    Option('local',
 
4355
                           help="Only remove the commits from the local branch"
 
4356
                                " when in a checkout."
 
4357
                           ),
 
4358
                    ]
 
4359
    takes_args = ['location?']
 
4360
    aliases = []
 
4361
    encoding_type = 'replace'
 
4362
 
 
4363
    def run(self, location=None,
 
4364
            dry_run=False, verbose=False,
 
4365
            revision=None, force=False, local=False):
 
4366
        if location is None:
 
4367
            location = u'.'
 
4368
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4369
        try:
 
4370
            tree = control.open_workingtree()
 
4371
            b = tree.branch
 
4372
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
4373
            tree = None
 
4374
            b = control.open_branch()
 
4375
 
 
4376
        if tree is not None:
 
4377
            tree.lock_write()
 
4378
        else:
 
4379
            b.lock_write()
 
4380
        try:
 
4381
            return self._run(b, tree, dry_run, verbose, revision, force,
 
4382
                             local=local)
 
4383
        finally:
 
4384
            if tree is not None:
 
4385
                tree.unlock()
 
4386
            else:
 
4387
                b.unlock()
 
4388
 
 
4389
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
 
4390
        from bzrlib.log import log_formatter, show_log
 
4391
        from bzrlib.uncommit import uncommit
 
4392
 
 
4393
        last_revno, last_rev_id = b.last_revision_info()
 
4394
 
 
4395
        rev_id = None
 
4396
        if revision is None:
 
4397
            revno = last_revno
 
4398
            rev_id = last_rev_id
 
4399
        else:
 
4400
            # 'bzr uncommit -r 10' actually means uncommit
 
4401
            # so that the final tree is at revno 10.
 
4402
            # but bzrlib.uncommit.uncommit() actually uncommits
 
4403
            # the revisions that are supplied.
 
4404
            # So we need to offset it by one
 
4405
            revno = revision[0].in_history(b).revno + 1
 
4406
            if revno <= last_revno:
 
4407
                rev_id = b.get_rev_id(revno)
 
4408
 
 
4409
        if rev_id is None or _mod_revision.is_null(rev_id):
 
4410
            self.outf.write('No revisions to uncommit.\n')
 
4411
            return 1
 
4412
 
 
4413
        lf = log_formatter('short',
 
4414
                           to_file=self.outf,
 
4415
                           show_timezone='original')
 
4416
 
 
4417
        show_log(b,
 
4418
                 lf,
 
4419
                 verbose=False,
 
4420
                 direction='forward',
 
4421
                 start_revision=revno,
 
4422
                 end_revision=last_revno)
 
4423
 
 
4424
        if dry_run:
 
4425
            print 'Dry-run, pretending to remove the above revisions.'
 
4426
            if not force:
 
4427
                val = raw_input('Press <enter> to continue')
 
4428
        else:
 
4429
            print 'The above revision(s) will be removed.'
 
4430
            if not force:
 
4431
                val = raw_input('Are you sure [y/N]? ')
 
4432
                if val.lower() not in ('y', 'yes'):
 
4433
                    print 'Canceled'
 
4434
                    return 0
 
4435
 
 
4436
        mutter('Uncommitting from {%s} to {%s}',
 
4437
               last_rev_id, rev_id)
 
4438
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
4439
                 revno=revno, local=local)
 
4440
        note('You can restore the old tip by running:\n'
 
4441
             '  bzr pull . -r revid:%s', last_rev_id)
 
4442
 
 
4443
 
 
4444
class cmd_break_lock(Command):
 
4445
    """Break a dead lock on a repository, branch or working directory.
 
4446
 
 
4447
    CAUTION: Locks should only be broken when you are sure that the process
 
4448
    holding the lock has been stopped.
 
4449
 
 
4450
    You can get information on what locks are open via the 'bzr info' command.
 
4451
 
 
4452
    :Examples:
 
4453
        bzr break-lock
 
4454
    """
 
4455
    takes_args = ['location?']
 
4456
 
 
4457
    def run(self, location=None, show=False):
 
4458
        if location is None:
 
4459
            location = u'.'
 
4460
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
4461
        try:
 
4462
            control.break_lock()
 
4463
        except NotImplementedError:
 
4464
            pass
 
4465
 
 
4466
 
 
4467
class cmd_wait_until_signalled(Command):
 
4468
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
4469
 
 
4470
    This just prints a line to signal when it is ready, then blocks on stdin.
 
4471
    """
 
4472
 
 
4473
    hidden = True
 
4474
 
 
4475
    def run(self):
 
4476
        sys.stdout.write("running\n")
 
4477
        sys.stdout.flush()
 
4478
        sys.stdin.readline()
 
4479
 
 
4480
 
 
4481
class cmd_serve(Command):
 
4482
    """Run the bzr server."""
 
4483
 
 
4484
    aliases = ['server']
 
4485
 
 
4486
    takes_options = [
 
4487
        Option('inet',
 
4488
               help='Serve on stdin/out for use from inetd or sshd.'),
 
4489
        Option('port',
 
4490
               help='Listen for connections on nominated port of the form '
 
4491
                    '[hostname:]portnumber.  Passing 0 as the port number will '
 
4492
                    'result in a dynamically allocated port.  The default port is '
 
4493
                    '4155.',
 
4494
               type=str),
 
4495
        Option('directory',
 
4496
               help='Serve contents of this directory.',
 
4497
               type=unicode),
 
4498
        Option('allow-writes',
 
4499
               help='By default the server is a readonly server.  Supplying '
 
4500
                    '--allow-writes enables write access to the contents of '
 
4501
                    'the served directory and below.'
 
4502
                ),
 
4503
        ]
 
4504
 
 
4505
    def run_smart_server(self, smart_server):
 
4506
        """Run 'smart_server' forever, with no UI output at all."""
 
4507
        # For the duration of this server, no UI output is permitted. note
 
4508
        # that this may cause problems with blackbox tests. This should be
 
4509
        # changed with care though, as we dont want to use bandwidth sending
 
4510
        # progress over stderr to smart server clients!
 
4511
        from bzrlib import lockdir
 
4512
        old_factory = ui.ui_factory
 
4513
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
4514
        try:
 
4515
            ui.ui_factory = ui.SilentUIFactory()
 
4516
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
4517
            smart_server.serve()
 
4518
        finally:
 
4519
            ui.ui_factory = old_factory
 
4520
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
 
4521
 
 
4522
    def get_host_and_port(self, port):
 
4523
        """Return the host and port to run the smart server on.
 
4524
 
 
4525
        If 'port' is None, the default host (`medium.BZR_DEFAULT_INTERFACE`)
 
4526
        and port (`medium.BZR_DEFAULT_PORT`) will be used.
 
4527
 
 
4528
        If 'port' has a colon in it, the string before the colon will be
 
4529
        interpreted as the host.
 
4530
 
 
4531
        :param port: A string of the port to run the server on.
 
4532
        :return: A tuple of (host, port), where 'host' is a host name or IP,
 
4533
            and port is an integer TCP/IP port.
 
4534
        """
 
4535
        from bzrlib.smart import medium
 
4536
        host = medium.BZR_DEFAULT_INTERFACE
 
4537
        if port is None:
 
4538
            port = medium.BZR_DEFAULT_PORT
 
4539
        else:
 
4540
            if ':' in port:
 
4541
                host, port = port.split(':')
 
4542
            port = int(port)
 
4543
        return host, port
 
4544
 
 
4545
    def get_smart_server(self, transport, inet, port):
 
4546
        """Construct a smart server.
 
4547
 
 
4548
        :param transport: The base transport from which branches will be
 
4549
            served.
 
4550
        :param inet: If True, serve over stdin and stdout. Used for running
 
4551
            from inet.
 
4552
        :param port: The port to listen on. By default, it's `
 
4553
            medium.BZR_DEFAULT_PORT`. See `get_host_and_port` for more
 
4554
            information.
 
4555
        :return: A smart server.
 
4556
        """
 
4557
        from bzrlib.smart import medium, server
 
4558
        if inet:
 
4559
            smart_server = medium.SmartServerPipeStreamMedium(
 
4560
                sys.stdin, sys.stdout, transport)
 
4561
        else:
 
4562
            host, port = self.get_host_and_port(port)
 
4563
            smart_server = server.SmartTCPServer(
 
4564
                transport, host=host, port=port)
 
4565
            note('listening on port: %s' % smart_server.port)
 
4566
        return smart_server
 
4567
 
 
4568
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
4569
        from bzrlib.transport import get_transport
 
4570
        from bzrlib.transport.chroot import ChrootServer
 
4571
        if directory is None:
 
4572
            directory = os.getcwd()
 
4573
        url = urlutils.local_path_to_url(directory)
 
4574
        if not allow_writes:
 
4575
            url = 'readonly+' + url
 
4576
        chroot_server = ChrootServer(get_transport(url))
 
4577
        chroot_server.setUp()
 
4578
        t = get_transport(chroot_server.get_url())
 
4579
        smart_server = self.get_smart_server(t, inet, port)
 
4580
        self.run_smart_server(smart_server)
 
4581
 
 
4582
 
 
4583
class cmd_join(Command):
 
4584
    """Combine a tree into its containing tree.
 
4585
 
 
4586
    This command requires the target tree to be in a rich-root format.
 
4587
 
 
4588
    The TREE argument should be an independent tree, inside another tree, but
 
4589
    not part of it.  (Such trees can be produced by "bzr split", but also by
 
4590
    running "bzr branch" with the target inside a tree.)
 
4591
 
 
4592
    The result is a combined tree, with the subtree no longer an independant
 
4593
    part.  This is marked as a merge of the subtree into the containing tree,
 
4594
    and all history is preserved.
 
4595
    """
 
4596
 
 
4597
    _see_also = ['split']
 
4598
    takes_args = ['tree']
 
4599
    takes_options = [
 
4600
            Option('reference', help='Join by reference.', hidden=True),
 
4601
            ]
 
4602
 
 
4603
    def run(self, tree, reference=False):
 
4604
        sub_tree = WorkingTree.open(tree)
 
4605
        parent_dir = osutils.dirname(sub_tree.basedir)
 
4606
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
 
4607
        repo = containing_tree.branch.repository
 
4608
        if not repo.supports_rich_root():
 
4609
            raise errors.BzrCommandError(
 
4610
                "Can't join trees because %s doesn't support rich root data.\n"
 
4611
                "You can use bzr upgrade on the repository."
 
4612
                % (repo,))
 
4613
        if reference:
 
4614
            try:
 
4615
                containing_tree.add_reference(sub_tree)
 
4616
            except errors.BadReferenceTarget, e:
 
4617
                # XXX: Would be better to just raise a nicely printable
 
4618
                # exception from the real origin.  Also below.  mbp 20070306
 
4619
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4620
                                             (tree, e.reason))
 
4621
        else:
 
4622
            try:
 
4623
                containing_tree.subsume(sub_tree)
 
4624
            except errors.BadSubsumeSource, e:
 
4625
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
4626
                                             (tree, e.reason))
 
4627
 
 
4628
 
 
4629
class cmd_split(Command):
 
4630
    """Split a subdirectory of a tree into a separate tree.
 
4631
 
 
4632
    This command will produce a target tree in a format that supports
 
4633
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
 
4634
    converted into earlier formats like 'dirstate-tags'.
 
4635
 
 
4636
    The TREE argument should be a subdirectory of a working tree.  That
 
4637
    subdirectory will be converted into an independent tree, with its own
 
4638
    branch.  Commits in the top-level tree will not apply to the new subtree.
 
4639
    """
 
4640
 
 
4641
    _see_also = ['join']
 
4642
    takes_args = ['tree']
 
4643
 
 
4644
    def run(self, tree):
 
4645
        containing_tree, subdir = WorkingTree.open_containing(tree)
 
4646
        sub_id = containing_tree.path2id(subdir)
 
4647
        if sub_id is None:
 
4648
            raise errors.NotVersionedError(subdir)
 
4649
        try:
 
4650
            containing_tree.extract(sub_id)
 
4651
        except errors.RootNotRich:
 
4652
            raise errors.UpgradeRequired(containing_tree.branch.base)
 
4653
 
 
4654
 
 
4655
class cmd_merge_directive(Command):
 
4656
    """Generate a merge directive for auto-merge tools.
 
4657
 
 
4658
    A directive requests a merge to be performed, and also provides all the
 
4659
    information necessary to do so.  This means it must either include a
 
4660
    revision bundle, or the location of a branch containing the desired
 
4661
    revision.
 
4662
 
 
4663
    A submit branch (the location to merge into) must be supplied the first
 
4664
    time the command is issued.  After it has been supplied once, it will
 
4665
    be remembered as the default.
 
4666
 
 
4667
    A public branch is optional if a revision bundle is supplied, but required
 
4668
    if --diff or --plain is specified.  It will be remembered as the default
 
4669
    after the first use.
 
4670
    """
 
4671
 
 
4672
    takes_args = ['submit_branch?', 'public_branch?']
 
4673
 
 
4674
    hidden = True
 
4675
 
 
4676
    _see_also = ['send']
 
4677
 
 
4678
    takes_options = [
 
4679
        RegistryOption.from_kwargs('patch-type',
 
4680
            'The type of patch to include in the directive.',
 
4681
            title='Patch type',
 
4682
            value_switches=True,
 
4683
            enum_switch=False,
 
4684
            bundle='Bazaar revision bundle (default).',
 
4685
            diff='Normal unified diff.',
 
4686
            plain='No patch, just directive.'),
 
4687
        Option('sign', help='GPG-sign the directive.'), 'revision',
 
4688
        Option('mail-to', type=str,
 
4689
            help='Instead of printing the directive, email to this address.'),
 
4690
        Option('message', type=str, short_name='m',
 
4691
            help='Message to use when committing this merge.')
 
4692
        ]
 
4693
 
 
4694
    encoding_type = 'exact'
 
4695
 
 
4696
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
 
4697
            sign=False, revision=None, mail_to=None, message=None):
 
4698
        from bzrlib.revision import ensure_null, NULL_REVISION
 
4699
        include_patch, include_bundle = {
 
4700
            'plain': (False, False),
 
4701
            'diff': (True, False),
 
4702
            'bundle': (True, True),
 
4703
            }[patch_type]
 
4704
        branch = Branch.open('.')
 
4705
        stored_submit_branch = branch.get_submit_branch()
 
4706
        if submit_branch is None:
 
4707
            submit_branch = stored_submit_branch
 
4708
        else:
 
4709
            if stored_submit_branch is None:
 
4710
                branch.set_submit_branch(submit_branch)
 
4711
        if submit_branch is None:
 
4712
            submit_branch = branch.get_parent()
 
4713
        if submit_branch is None:
 
4714
            raise errors.BzrCommandError('No submit branch specified or known')
 
4715
 
 
4716
        stored_public_branch = branch.get_public_branch()
 
4717
        if public_branch is None:
 
4718
            public_branch = stored_public_branch
 
4719
        elif stored_public_branch is None:
 
4720
            branch.set_public_branch(public_branch)
 
4721
        if not include_bundle and public_branch is None:
 
4722
            raise errors.BzrCommandError('No public branch specified or'
 
4723
                                         ' known')
 
4724
        base_revision_id = None
 
4725
        if revision is not None:
 
4726
            if len(revision) > 2:
 
4727
                raise errors.BzrCommandError('bzr merge-directive takes '
 
4728
                    'at most two one revision identifiers')
 
4729
            revision_id = revision[-1].as_revision_id(branch)
 
4730
            if len(revision) == 2:
 
4731
                base_revision_id = revision[0].as_revision_id(branch)
 
4732
        else:
 
4733
            revision_id = branch.last_revision()
 
4734
        revision_id = ensure_null(revision_id)
 
4735
        if revision_id == NULL_REVISION:
 
4736
            raise errors.BzrCommandError('No revisions to bundle.')
 
4737
        directive = merge_directive.MergeDirective2.from_objects(
 
4738
            branch.repository, revision_id, time.time(),
 
4739
            osutils.local_time_offset(), submit_branch,
 
4740
            public_branch=public_branch, include_patch=include_patch,
 
4741
            include_bundle=include_bundle, message=message,
 
4742
            base_revision_id=base_revision_id)
 
4743
        if mail_to is None:
 
4744
            if sign:
 
4745
                self.outf.write(directive.to_signed(branch))
 
4746
            else:
 
4747
                self.outf.writelines(directive.to_lines())
 
4748
        else:
 
4749
            message = directive.to_email(mail_to, branch, sign)
 
4750
            s = SMTPConnection(branch.get_config())
 
4751
            s.send_email(message)
 
4752
 
 
4753
 
 
4754
class cmd_send(Command):
 
4755
    """Mail or create a merge-directive for submitting changes.
 
4756
 
 
4757
    A merge directive provides many things needed for requesting merges:
 
4758
 
 
4759
    * A machine-readable description of the merge to perform
 
4760
 
 
4761
    * An optional patch that is a preview of the changes requested
 
4762
 
 
4763
    * An optional bundle of revision data, so that the changes can be applied
 
4764
      directly from the merge directive, without retrieving data from a
 
4765
      branch.
 
4766
 
 
4767
    If --no-bundle is specified, then public_branch is needed (and must be
 
4768
    up-to-date), so that the receiver can perform the merge using the
 
4769
    public_branch.  The public_branch is always included if known, so that
 
4770
    people can check it later.
 
4771
 
 
4772
    The submit branch defaults to the parent, but can be overridden.  Both
 
4773
    submit branch and public branch will be remembered if supplied.
 
4774
 
 
4775
    If a public_branch is known for the submit_branch, that public submit
 
4776
    branch is used in the merge instructions.  This means that a local mirror
 
4777
    can be used as your actual submit branch, once you have set public_branch
 
4778
    for that mirror.
 
4779
 
 
4780
    Mail is sent using your preferred mail program.  This should be transparent
 
4781
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
 
4782
    If the preferred client can't be found (or used), your editor will be used.
 
4783
 
 
4784
    To use a specific mail program, set the mail_client configuration option.
 
4785
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
 
4786
    specific clients are "claws", "evolution", "kmail", "mutt", and
 
4787
    "thunderbird"; generic options are "default", "editor", "emacsclient",
 
4788
    "mapi", and "xdg-email".  Plugins may also add supported clients.
 
4789
 
 
4790
    If mail is being sent, a to address is required.  This can be supplied
 
4791
    either on the commandline, by setting the submit_to configuration
 
4792
    option in the branch itself or the child_submit_to configuration option
 
4793
    in the submit branch.
 
4794
 
 
4795
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4796
    merge directive format 2.  It is significantly faster and smaller than
 
4797
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4798
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4799
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4800
 
 
4801
    The merge directives created by bzr send may be applied using bzr merge or
 
4802
    bzr pull by specifying a file containing a merge directive as the location.
 
4803
    """
 
4804
 
 
4805
    encoding_type = 'exact'
 
4806
 
 
4807
    _see_also = ['merge', 'pull']
 
4808
 
 
4809
    takes_args = ['submit_branch?', 'public_branch?']
 
4810
 
 
4811
    takes_options = [
 
4812
        Option('no-bundle',
 
4813
               help='Do not include a bundle in the merge directive.'),
 
4814
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4815
               ' directive.'),
 
4816
        Option('remember',
 
4817
               help='Remember submit and public branch.'),
 
4818
        Option('from',
 
4819
               help='Branch to generate the submission from, '
 
4820
               'rather than the one containing the working directory.',
 
4821
               short_name='f',
 
4822
               type=unicode),
 
4823
        Option('output', short_name='o',
 
4824
               help='Write merge directive to this file; '
 
4825
                    'use - for stdout.',
 
4826
               type=unicode),
 
4827
        Option('mail-to', help='Mail the request to this address.',
 
4828
               type=unicode),
 
4829
        'revision',
 
4830
        'message',
 
4831
        Option('body', help='Body for the email.', type=unicode),
 
4832
        RegistryOption.from_kwargs('format',
 
4833
        'Use the specified output format.',
 
4834
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4835
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
4836
        ]
 
4837
 
 
4838
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
4839
            no_patch=False, revision=None, remember=False, output=None,
 
4840
            format='4', mail_to=None, message=None, body=None, **kwargs):
 
4841
        return self._run(submit_branch, revision, public_branch, remember,
 
4842
                         format, no_bundle, no_patch, output,
 
4843
                         kwargs.get('from', '.'), mail_to, message, body)
 
4844
 
 
4845
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4846
             no_bundle, no_patch, output, from_, mail_to, message, body):
 
4847
        from bzrlib.revision import NULL_REVISION
 
4848
        branch = Branch.open_containing(from_)[0]
 
4849
        if output is None:
 
4850
            outfile = cStringIO.StringIO()
 
4851
        elif output == '-':
 
4852
            outfile = self.outf
 
4853
        else:
 
4854
            outfile = open(output, 'wb')
 
4855
        # we may need to write data into branch's repository to calculate
 
4856
        # the data to send.
 
4857
        branch.lock_write()
 
4858
        try:
 
4859
            if output is None:
 
4860
                config = branch.get_config()
 
4861
                if mail_to is None:
 
4862
                    mail_to = config.get_user_option('submit_to')
 
4863
                mail_client = config.get_mail_client()
 
4864
                if (not getattr(mail_client, 'supports_body', False)
 
4865
                    and body is not None):
 
4866
                    raise errors.BzrCommandError(
 
4867
                        'Mail client "%s" does not support specifying body' %
 
4868
                        mail_client.__class__.__name__)
 
4869
            if remember and submit_branch is None:
 
4870
                raise errors.BzrCommandError(
 
4871
                    '--remember requires a branch to be specified.')
 
4872
            stored_submit_branch = branch.get_submit_branch()
 
4873
            remembered_submit_branch = None
 
4874
            if submit_branch is None:
 
4875
                submit_branch = stored_submit_branch
 
4876
                remembered_submit_branch = "submit"
 
4877
            else:
 
4878
                if stored_submit_branch is None or remember:
 
4879
                    branch.set_submit_branch(submit_branch)
 
4880
            if submit_branch is None:
 
4881
                submit_branch = branch.get_parent()
 
4882
                remembered_submit_branch = "parent"
 
4883
            if submit_branch is None:
 
4884
                raise errors.BzrCommandError('No submit branch known or'
 
4885
                                             ' specified')
 
4886
            if remembered_submit_branch is not None:
 
4887
                note('Using saved %s location "%s" to determine what '
 
4888
                        'changes to submit.', remembered_submit_branch,
 
4889
                        submit_branch)
 
4890
 
 
4891
            if mail_to is None:
 
4892
                submit_config = Branch.open(submit_branch).get_config()
 
4893
                mail_to = submit_config.get_user_option("child_submit_to")
 
4894
 
 
4895
            stored_public_branch = branch.get_public_branch()
 
4896
            if public_branch is None:
 
4897
                public_branch = stored_public_branch
 
4898
            elif stored_public_branch is None or remember:
 
4899
                branch.set_public_branch(public_branch)
 
4900
            if no_bundle and public_branch is None:
 
4901
                raise errors.BzrCommandError('No public branch specified or'
 
4902
                                             ' known')
 
4903
            base_revision_id = None
 
4904
            revision_id = None
 
4905
            if revision is not None:
 
4906
                if len(revision) > 2:
 
4907
                    raise errors.BzrCommandError('bzr send takes '
 
4908
                        'at most two one revision identifiers')
 
4909
                revision_id = revision[-1].as_revision_id(branch)
 
4910
                if len(revision) == 2:
 
4911
                    base_revision_id = revision[0].as_revision_id(branch)
 
4912
            if revision_id is None:
 
4913
                revision_id = branch.last_revision()
 
4914
            if revision_id == NULL_REVISION:
 
4915
                raise errors.BzrCommandError('No revisions to submit.')
 
4916
            if format == '4':
 
4917
                directive = merge_directive.MergeDirective2.from_objects(
 
4918
                    branch.repository, revision_id, time.time(),
 
4919
                    osutils.local_time_offset(), submit_branch,
 
4920
                    public_branch=public_branch, include_patch=not no_patch,
 
4921
                    include_bundle=not no_bundle, message=message,
 
4922
                    base_revision_id=base_revision_id)
 
4923
            elif format == '0.9':
 
4924
                if not no_bundle:
 
4925
                    if not no_patch:
 
4926
                        patch_type = 'bundle'
 
4927
                    else:
 
4928
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4929
                            ' permit bundle with no patch')
 
4930
                else:
 
4931
                    if not no_patch:
 
4932
                        patch_type = 'diff'
 
4933
                    else:
 
4934
                        patch_type = None
 
4935
                directive = merge_directive.MergeDirective.from_objects(
 
4936
                    branch.repository, revision_id, time.time(),
 
4937
                    osutils.local_time_offset(), submit_branch,
 
4938
                    public_branch=public_branch, patch_type=patch_type,
 
4939
                    message=message)
 
4940
 
 
4941
            outfile.writelines(directive.to_lines())
 
4942
            if output is None:
 
4943
                subject = '[MERGE] '
 
4944
                if message is not None:
 
4945
                    subject += message
 
4946
                else:
 
4947
                    revision = branch.repository.get_revision(revision_id)
 
4948
                    subject += revision.get_summary()
 
4949
                basename = directive.get_disk_name(branch)
 
4950
                mail_client.compose_merge_request(mail_to, subject,
 
4951
                                                  outfile.getvalue(),
 
4952
                                                  basename, body)
 
4953
        finally:
 
4954
            if output != '-':
 
4955
                outfile.close()
 
4956
            branch.unlock()
 
4957
 
 
4958
 
 
4959
class cmd_bundle_revisions(cmd_send):
 
4960
 
 
4961
    """Create a merge-directive for submitting changes.
 
4962
 
 
4963
    A merge directive provides many things needed for requesting merges:
 
4964
 
 
4965
    * A machine-readable description of the merge to perform
 
4966
 
 
4967
    * An optional patch that is a preview of the changes requested
 
4968
 
 
4969
    * An optional bundle of revision data, so that the changes can be applied
 
4970
      directly from the merge directive, without retrieving data from a
 
4971
      branch.
 
4972
 
 
4973
    If --no-bundle is specified, then public_branch is needed (and must be
 
4974
    up-to-date), so that the receiver can perform the merge using the
 
4975
    public_branch.  The public_branch is always included if known, so that
 
4976
    people can check it later.
 
4977
 
 
4978
    The submit branch defaults to the parent, but can be overridden.  Both
 
4979
    submit branch and public branch will be remembered if supplied.
 
4980
 
 
4981
    If a public_branch is known for the submit_branch, that public submit
 
4982
    branch is used in the merge instructions.  This means that a local mirror
 
4983
    can be used as your actual submit branch, once you have set public_branch
 
4984
    for that mirror.
 
4985
 
 
4986
    Two formats are currently supported: "4" uses revision bundle format 4 and
 
4987
    merge directive format 2.  It is significantly faster and smaller than
 
4988
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
 
4989
    default.  "0.9" uses revision bundle format 0.9 and merge directive
 
4990
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
 
4991
    """
 
4992
 
 
4993
    takes_options = [
 
4994
        Option('no-bundle',
 
4995
               help='Do not include a bundle in the merge directive.'),
 
4996
        Option('no-patch', help='Do not include a preview patch in the merge'
 
4997
               ' directive.'),
 
4998
        Option('remember',
 
4999
               help='Remember submit and public branch.'),
 
5000
        Option('from',
 
5001
               help='Branch to generate the submission from, '
 
5002
               'rather than the one containing the working directory.',
 
5003
               short_name='f',
 
5004
               type=unicode),
 
5005
        Option('output', short_name='o', help='Write directive to this file.',
 
5006
               type=unicode),
 
5007
        'revision',
 
5008
        RegistryOption.from_kwargs('format',
 
5009
        'Use the specified output format.',
 
5010
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
5011
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
 
5012
        ]
 
5013
    aliases = ['bundle']
 
5014
 
 
5015
    _see_also = ['send', 'merge']
 
5016
 
 
5017
    hidden = True
 
5018
 
 
5019
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
 
5020
            no_patch=False, revision=None, remember=False, output=None,
 
5021
            format='4', **kwargs):
 
5022
        if output is None:
 
5023
            output = '-'
 
5024
        return self._run(submit_branch, revision, public_branch, remember,
 
5025
                         format, no_bundle, no_patch, output,
 
5026
                         kwargs.get('from', '.'), None, None, None)
 
5027
 
 
5028
 
 
5029
class cmd_tag(Command):
 
5030
    """Create, remove or modify a tag naming a revision.
 
5031
 
 
5032
    Tags give human-meaningful names to revisions.  Commands that take a -r
 
5033
    (--revision) option can be given -rtag:X, where X is any previously
 
5034
    created tag.
 
5035
 
 
5036
    Tags are stored in the branch.  Tags are copied from one branch to another
 
5037
    along when you branch, push, pull or merge.
 
5038
 
 
5039
    It is an error to give a tag name that already exists unless you pass
 
5040
    --force, in which case the tag is moved to point to the new revision.
 
5041
 
 
5042
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
 
5043
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
 
5044
    """
 
5045
 
 
5046
    _see_also = ['commit', 'tags']
 
5047
    takes_args = ['tag_name']
 
5048
    takes_options = [
 
5049
        Option('delete',
 
5050
            help='Delete this tag rather than placing it.',
 
5051
            ),
 
5052
        Option('directory',
 
5053
            help='Branch in which to place the tag.',
 
5054
            short_name='d',
 
5055
            type=unicode,
 
5056
            ),
 
5057
        Option('force',
 
5058
            help='Replace existing tags.',
 
5059
            ),
 
5060
        'revision',
 
5061
        ]
 
5062
 
 
5063
    def run(self, tag_name,
 
5064
            delete=None,
 
5065
            directory='.',
 
5066
            force=None,
 
5067
            revision=None,
 
5068
            ):
 
5069
        branch, relpath = Branch.open_containing(directory)
 
5070
        branch.lock_write()
 
5071
        try:
 
5072
            if delete:
 
5073
                branch.tags.delete_tag(tag_name)
 
5074
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
5075
            else:
 
5076
                if revision:
 
5077
                    if len(revision) != 1:
 
5078
                        raise errors.BzrCommandError(
 
5079
                            "Tags can only be placed on a single revision, "
 
5080
                            "not on a range")
 
5081
                    revision_id = revision[0].as_revision_id(branch)
 
5082
                else:
 
5083
                    revision_id = branch.last_revision()
 
5084
                if (not force) and branch.tags.has_tag(tag_name):
 
5085
                    raise errors.TagAlreadyExists(tag_name)
 
5086
                branch.tags.set_tag(tag_name, revision_id)
 
5087
                self.outf.write('Created tag %s.\n' % tag_name)
 
5088
        finally:
 
5089
            branch.unlock()
 
5090
 
 
5091
 
 
5092
class cmd_tags(Command):
 
5093
    """List tags.
 
5094
 
 
5095
    This command shows a table of tag names and the revisions they reference.
 
5096
    """
 
5097
 
 
5098
    _see_also = ['tag']
 
5099
    takes_options = [
 
5100
        Option('directory',
 
5101
            help='Branch whose tags should be displayed.',
 
5102
            short_name='d',
 
5103
            type=unicode,
 
5104
            ),
 
5105
        RegistryOption.from_kwargs('sort',
 
5106
            'Sort tags by different criteria.', title='Sorting',
 
5107
            alpha='Sort tags lexicographically (default).',
 
5108
            time='Sort tags chronologically.',
 
5109
            ),
 
5110
        'show-ids',
 
5111
        'revision',
 
5112
    ]
 
5113
 
 
5114
    @display_command
 
5115
    def run(self,
 
5116
            directory='.',
 
5117
            sort='alpha',
 
5118
            show_ids=False,
 
5119
            revision=None,
 
5120
            ):
 
5121
        branch, relpath = Branch.open_containing(directory)
 
5122
 
 
5123
        tags = branch.tags.get_tag_dict().items()
 
5124
        if not tags:
 
5125
            return
 
5126
 
 
5127
        if revision:
 
5128
            branch.lock_read()
 
5129
            try:
 
5130
                graph = branch.repository.get_graph()
 
5131
                rev1, rev2 = _get_revision_range(revision, branch, self.name())
 
5132
                revid1, revid2 = rev1.rev_id, rev2.rev_id
 
5133
                # only show revisions between revid1 and revid2 (inclusive)
 
5134
                tags = [(tag, revid) for tag, revid in tags if
 
5135
                    graph.is_between(revid, revid1, revid2)]
 
5136
            finally:
 
5137
                branch.unlock()
 
5138
        if sort == 'alpha':
 
5139
            tags.sort()
 
5140
        elif sort == 'time':
 
5141
            timestamps = {}
 
5142
            for tag, revid in tags:
 
5143
                try:
 
5144
                    revobj = branch.repository.get_revision(revid)
 
5145
                except errors.NoSuchRevision:
 
5146
                    timestamp = sys.maxint # place them at the end
 
5147
                else:
 
5148
                    timestamp = revobj.timestamp
 
5149
                timestamps[revid] = timestamp
 
5150
            tags.sort(key=lambda x: timestamps[x[1]])
 
5151
        if not show_ids:
 
5152
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
 
5153
            revno_map = branch.get_revision_id_to_revno_map()
 
5154
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
5155
                        for tag, revid in tags ]
 
5156
        for tag, revspec in tags:
 
5157
            self.outf.write('%-20s %s\n' % (tag, revspec))
 
5158
 
 
5159
 
 
5160
class cmd_reconfigure(Command):
 
5161
    """Reconfigure the type of a bzr directory.
 
5162
 
 
5163
    A target configuration must be specified.
 
5164
 
 
5165
    For checkouts, the bind-to location will be auto-detected if not specified.
 
5166
    The order of preference is
 
5167
    1. For a lightweight checkout, the current bound location.
 
5168
    2. For branches that used to be checkouts, the previously-bound location.
 
5169
    3. The push location.
 
5170
    4. The parent location.
 
5171
    If none of these is available, --bind-to must be specified.
 
5172
    """
 
5173
 
 
5174
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
 
5175
    takes_args = ['location?']
 
5176
    takes_options = [
 
5177
        RegistryOption.from_kwargs(
 
5178
            'target_type',
 
5179
            title='Target type',
 
5180
            help='The type to reconfigure the directory to.',
 
5181
            value_switches=True, enum_switch=False,
 
5182
            branch='Reconfigure to be an unbound branch with no working tree.',
 
5183
            tree='Reconfigure to be an unbound branch with a working tree.',
 
5184
            checkout='Reconfigure to be a bound branch with a working tree.',
 
5185
            lightweight_checkout='Reconfigure to be a lightweight'
 
5186
                ' checkout (with no local history).',
 
5187
            standalone='Reconfigure to be a standalone branch '
 
5188
                '(i.e. stop using shared repository).',
 
5189
            use_shared='Reconfigure to use a shared repository.',
 
5190
            with_trees='Reconfigure repository to create '
 
5191
                'working trees on branches by default.',
 
5192
            with_no_trees='Reconfigure repository to not create '
 
5193
                'working trees on branches by default.'
 
5194
            ),
 
5195
        Option('bind-to', help='Branch to bind checkout to.', type=str),
 
5196
        Option('force',
 
5197
               help='Perform reconfiguration even if local changes'
 
5198
               ' will be lost.')
 
5199
        ]
 
5200
 
 
5201
    def run(self, location=None, target_type=None, bind_to=None, force=False):
 
5202
        directory = bzrdir.BzrDir.open(location)
 
5203
        if target_type is None:
 
5204
            raise errors.BzrCommandError('No target configuration specified')
 
5205
        elif target_type == 'branch':
 
5206
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
 
5207
        elif target_type == 'tree':
 
5208
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
 
5209
        elif target_type == 'checkout':
 
5210
            reconfiguration = reconfigure.Reconfigure.to_checkout(
 
5211
                directory, bind_to)
 
5212
        elif target_type == 'lightweight-checkout':
 
5213
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
 
5214
                directory, bind_to)
 
5215
        elif target_type == 'use-shared':
 
5216
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
 
5217
        elif target_type == 'standalone':
 
5218
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
 
5219
        elif target_type == 'with-trees':
 
5220
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5221
                directory, True)
 
5222
        elif target_type == 'with-no-trees':
 
5223
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
 
5224
                directory, False)
 
5225
        reconfiguration.apply(force)
 
5226
 
 
5227
 
 
5228
class cmd_switch(Command):
 
5229
    """Set the branch of a checkout and update.
 
5230
 
 
5231
    For lightweight checkouts, this changes the branch being referenced.
 
5232
    For heavyweight checkouts, this checks that there are no local commits
 
5233
    versus the current bound branch, then it makes the local branch a mirror
 
5234
    of the new location and binds to it.
 
5235
 
 
5236
    In both cases, the working tree is updated and uncommitted changes
 
5237
    are merged. The user can commit or revert these as they desire.
 
5238
 
 
5239
    Pending merges need to be committed or reverted before using switch.
 
5240
 
 
5241
    The path to the branch to switch to can be specified relative to the parent
 
5242
    directory of the current branch. For example, if you are currently in a
 
5243
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
 
5244
    /path/to/newbranch.
 
5245
 
 
5246
    Bound branches use the nickname of its master branch unless it is set
 
5247
    locally, in which case switching will update the the local nickname to be
 
5248
    that of the master.
 
5249
    """
 
5250
 
 
5251
    takes_args = ['to_location']
 
5252
    takes_options = [Option('force',
 
5253
                        help='Switch even if local commits will be lost.')
 
5254
                     ]
 
5255
 
 
5256
    def run(self, to_location, force=False):
 
5257
        from bzrlib import switch
 
5258
        tree_location = '.'
 
5259
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
 
5260
        branch = control_dir.open_branch()
 
5261
        try:
 
5262
            to_branch = Branch.open(to_location)
 
5263
        except errors.NotBranchError:
 
5264
            this_branch = control_dir.open_branch()
 
5265
            # This may be a heavy checkout, where we want the master branch
 
5266
            this_url = this_branch.get_bound_location()
 
5267
            # If not, use a local sibling
 
5268
            if this_url is None:
 
5269
                this_url = this_branch.base
 
5270
            to_branch = Branch.open(
 
5271
                urlutils.join(this_url, '..', to_location))
 
5272
        switch.switch(control_dir, to_branch, force)
 
5273
        if branch.get_config().has_explicit_nickname():
 
5274
            branch = control_dir.open_branch() #get the new branch!
 
5275
            branch.nick = to_branch.nick
 
5276
        note('Switched to branch: %s',
 
5277
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
 
5278
 
 
5279
 
 
5280
class cmd_view(Command):
 
5281
    """Manage filtered views.
 
5282
 
 
5283
    Views provide a mask over the tree so that users can focus on
 
5284
    a subset of a tree when doing their work. After creating a view,
 
5285
    commands that support a list of files - status, diff, commit, etc -
 
5286
    effectively have that list of files implicitly given each time.
 
5287
    An explicit list of files can still be given but those files
 
5288
    must be within the current view.
 
5289
 
 
5290
    In most cases, a view has a short life-span: it is created to make
 
5291
    a selected change and is deleted once that change is committed.
 
5292
    At other times, you may wish to create one or more named views
 
5293
    and switch between them.
 
5294
 
 
5295
    To disable the current view without deleting it, you can switch to
 
5296
    the pseudo view called ``off``. This can be useful when you need
 
5297
    to see the whole tree for an operation or two (e.g. merge) but
 
5298
    want to switch back to your view after that.
 
5299
 
 
5300
    :Examples:
 
5301
      To define the current view::
 
5302
 
 
5303
        bzr view file1 dir1 ...
 
5304
 
 
5305
      To list the current view::
 
5306
 
 
5307
        bzr view
 
5308
 
 
5309
      To delete the current view::
 
5310
 
 
5311
        bzr view --delete
 
5312
 
 
5313
      To disable the current view without deleting it::
 
5314
 
 
5315
        bzr view --switch off
 
5316
 
 
5317
      To define a named view and switch to it::
 
5318
 
 
5319
        bzr view --name view-name file1 dir1 ...
 
5320
 
 
5321
      To list a named view::
 
5322
 
 
5323
        bzr view --name view-name
 
5324
 
 
5325
      To delete a named view::
 
5326
 
 
5327
        bzr view --name view-name --delete
 
5328
 
 
5329
      To switch to a named view::
 
5330
 
 
5331
        bzr view --switch view-name
 
5332
 
 
5333
      To list all views defined::
 
5334
 
 
5335
        bzr view --all
 
5336
 
 
5337
      To delete all views::
 
5338
 
 
5339
        bzr view --delete --all
 
5340
    """
 
5341
 
 
5342
    _see_also = []
 
5343
    takes_args = ['file*']
 
5344
    takes_options = [
 
5345
        Option('all',
 
5346
            help='Apply list or delete action to all views.',
 
5347
            ),
 
5348
        Option('delete',
 
5349
            help='Delete the view.',
 
5350
            ),
 
5351
        Option('name',
 
5352
            help='Name of the view to define, list or delete.',
 
5353
            type=unicode,
 
5354
            ),
 
5355
        Option('switch',
 
5356
            help='Name of the view to switch to.',
 
5357
            type=unicode,
 
5358
            ),
 
5359
        ]
 
5360
 
 
5361
    def run(self, file_list,
 
5362
            all=False,
 
5363
            delete=False,
 
5364
            name=None,
 
5365
            switch=None,
 
5366
            ):
 
5367
        tree, file_list = tree_files(file_list, apply_view=False)
 
5368
        current_view, view_dict = tree.views.get_view_info()
 
5369
        if name is None:
 
5370
            name = current_view
 
5371
        if delete:
 
5372
            if file_list:
 
5373
                raise errors.BzrCommandError(
 
5374
                    "Both --delete and a file list specified")
 
5375
            elif switch:
 
5376
                raise errors.BzrCommandError(
 
5377
                    "Both --delete and --switch specified")
 
5378
            elif all:
 
5379
                tree.views.set_view_info(None, {})
 
5380
                self.outf.write("Deleted all views.\n")
 
5381
            elif name is None:
 
5382
                raise errors.BzrCommandError("No current view to delete")
 
5383
            else:
 
5384
                tree.views.delete_view(name)
 
5385
                self.outf.write("Deleted '%s' view.\n" % name)
 
5386
        elif switch:
 
5387
            if file_list:
 
5388
                raise errors.BzrCommandError(
 
5389
                    "Both --switch and a file list specified")
 
5390
            elif all:
 
5391
                raise errors.BzrCommandError(
 
5392
                    "Both --switch and --all specified")
 
5393
            elif switch == 'off':
 
5394
                if current_view is None:
 
5395
                    raise errors.BzrCommandError("No current view to disable")
 
5396
                tree.views.set_view_info(None, view_dict)
 
5397
                self.outf.write("Disabled '%s' view.\n" % (current_view))
 
5398
            else:
 
5399
                tree.views.set_view_info(switch, view_dict)
 
5400
                view_str = views.view_display_str(tree.views.lookup_view())
 
5401
                self.outf.write("Using '%s' view: %s\n" % (switch, view_str))
 
5402
        elif all:
 
5403
            if view_dict:
 
5404
                self.outf.write('Views defined:\n')
 
5405
                for view in sorted(view_dict):
 
5406
                    if view == current_view:
 
5407
                        active = "=>"
 
5408
                    else:
 
5409
                        active = "  "
 
5410
                    view_str = views.view_display_str(view_dict[view])
 
5411
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
 
5412
            else:
 
5413
                self.outf.write('No views defined.\n')
 
5414
        elif file_list:
 
5415
            if name is None:
 
5416
                # No name given and no current view set
 
5417
                name = 'my'
 
5418
            elif name == 'off':
 
5419
                raise errors.BzrCommandError(
 
5420
                    "Cannot change the 'off' pseudo view")
 
5421
            tree.views.set_view(name, sorted(file_list))
 
5422
            view_str = views.view_display_str(tree.views.lookup_view())
 
5423
            self.outf.write("Using '%s' view: %s\n" % (name, view_str))
 
5424
        else:
 
5425
            # list the files
 
5426
            if name is None:
 
5427
                # No name given and no current view set
 
5428
                self.outf.write('No current view.\n')
 
5429
            else:
 
5430
                view_str = views.view_display_str(tree.views.lookup_view(name))
 
5431
                self.outf.write("'%s' view is: %s\n" % (name, view_str))
 
5432
 
 
5433
 
 
5434
class cmd_hooks(Command):
 
5435
    """Show hooks."""
 
5436
 
 
5437
    hidden = True
 
5438
 
 
5439
    def run(self):
 
5440
        for hook_key in sorted(hooks.known_hooks.keys()):
 
5441
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
 
5442
            self.outf.write("%s:\n" % type(some_hooks).__name__)
 
5443
            for hook_name, hook_point in sorted(some_hooks.items()):
 
5444
                self.outf.write("  %s:\n" % (hook_name,))
 
5445
                found_hooks = list(hook_point)
 
5446
                if found_hooks:
 
5447
                    for hook in found_hooks:
 
5448
                        self.outf.write("    %s\n" %
 
5449
                                        (some_hooks.get_hook_name(hook),))
 
5450
                else:
 
5451
                    self.outf.write("    <no hooks installed>\n")
 
5452
 
 
5453
 
 
5454
class cmd_shelve(Command):
 
5455
    """Temporarily set aside some changes from the current tree.
 
5456
 
 
5457
    Shelve allows you to temporarily put changes you've made "on the shelf",
 
5458
    ie. out of the way, until a later time when you can bring them back from
 
5459
    the shelf with the 'unshelve' command.  The changes are stored alongside
 
5460
    your working tree, and so they aren't propagated along with your branch nor
 
5461
    will they survive its deletion.
 
5462
 
 
5463
    If shelve --list is specified, previously-shelved changes are listed.
 
5464
 
 
5465
    Shelve is intended to help separate several sets of changes that have
 
5466
    been inappropriately mingled.  If you just want to get rid of all changes
 
5467
    and you don't need to restore them later, use revert.  If you want to
 
5468
    shelve all text changes at once, use shelve --all.
 
5469
 
 
5470
    If filenames are specified, only the changes to those files will be
 
5471
    shelved. Other files will be left untouched.
 
5472
 
 
5473
    If a revision is specified, changes since that revision will be shelved.
 
5474
 
 
5475
    You can put multiple items on the shelf, and by default, 'unshelve' will
 
5476
    restore the most recently shelved changes.
 
5477
    """
 
5478
 
 
5479
    takes_args = ['file*']
 
5480
 
 
5481
    takes_options = [
 
5482
        'revision',
 
5483
        Option('all', help='Shelve all changes.'),
 
5484
        'message',
 
5485
        RegistryOption('writer', 'Method to use for writing diffs.',
 
5486
                       bzrlib.option.diff_writer_registry,
 
5487
                       value_switches=True, enum_switch=False),
 
5488
 
 
5489
        Option('list', help='List shelved changes.'),
 
5490
        Option('destroy',
 
5491
               help='Destroy removed changes instead of shelving them.'),
 
5492
    ]
 
5493
    _see_also = ['unshelve']
 
5494
 
 
5495
    def run(self, revision=None, all=False, file_list=None, message=None,
 
5496
            writer=None, list=False, destroy=False):
 
5497
        if list:
 
5498
            return self.run_for_list()
 
5499
        from bzrlib.shelf_ui import Shelver
 
5500
        if writer is None:
 
5501
            writer = bzrlib.option.diff_writer_registry.get()
 
5502
        try:
 
5503
            Shelver.from_args(writer(sys.stdout), revision, all, file_list,
 
5504
                              message, destroy=destroy).run()
 
5505
        except errors.UserAbort:
 
5506
            return 0
 
5507
 
 
5508
    def run_for_list(self):
 
5509
        tree = WorkingTree.open_containing('.')[0]
 
5510
        tree.lock_read()
 
5511
        try:
 
5512
            manager = tree.get_shelf_manager()
 
5513
            shelves = manager.active_shelves()
 
5514
            if len(shelves) == 0:
 
5515
                note('No shelved changes.')
 
5516
                return 0
 
5517
            for shelf_id in reversed(shelves):
 
5518
                message = manager.get_metadata(shelf_id).get('message')
 
5519
                if message is None:
 
5520
                    message = '<no message>'
 
5521
                self.outf.write('%3d: %s\n' % (shelf_id, message))
 
5522
            return 1
 
5523
        finally:
 
5524
            tree.unlock()
 
5525
 
 
5526
 
 
5527
class cmd_unshelve(Command):
 
5528
    """Restore shelved changes.
 
5529
 
 
5530
    By default, the most recently shelved changes are restored. However if you
 
5531
    specify a shelf by id those changes will be restored instead.  This works
 
5532
    best when the changes don't depend on each other.
 
5533
    """
 
5534
 
 
5535
    takes_args = ['shelf_id?']
 
5536
    takes_options = [
 
5537
        RegistryOption.from_kwargs(
 
5538
            'action', help="The action to perform.",
 
5539
            enum_switch=False, value_switches=True,
 
5540
            apply="Apply changes and remove from the shelf.",
 
5541
            dry_run="Show changes, but do not apply or remove them.",
 
5542
            delete_only="Delete changes without applying them."
 
5543
        )
 
5544
    ]
 
5545
    _see_also = ['shelve']
 
5546
 
 
5547
    def run(self, shelf_id=None, action='apply'):
 
5548
        from bzrlib.shelf_ui import Unshelver
 
5549
        Unshelver.from_args(shelf_id, action).run()
 
5550
 
 
5551
 
 
5552
class cmd_clean_tree(Command):
 
5553
    """Remove unwanted files from working tree.
 
5554
 
 
5555
    By default, only unknown files, not ignored files, are deleted.  Versioned
 
5556
    files are never deleted.
 
5557
 
 
5558
    Another class is 'detritus', which includes files emitted by bzr during
 
5559
    normal operations and selftests.  (The value of these files decreases with
 
5560
    time.)
 
5561
 
 
5562
    If no options are specified, unknown files are deleted.  Otherwise, option
 
5563
    flags are respected, and may be combined.
 
5564
 
 
5565
    To check what clean-tree will do, use --dry-run.
 
5566
    """
 
5567
    takes_options = [Option('ignored', help='Delete all ignored files.'),
 
5568
                     Option('detritus', help='Delete conflict files, merge'
 
5569
                            ' backups, and failed selftest dirs.'),
 
5570
                     Option('unknown',
 
5571
                            help='Delete files unknown to bzr (default).'),
 
5572
                     Option('dry-run', help='Show files to delete instead of'
 
5573
                            ' deleting them.'),
 
5574
                     Option('force', help='Do not prompt before deleting.')]
 
5575
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
 
5576
            force=False):
 
5577
        from bzrlib.clean_tree import clean_tree
 
5578
        if not (unknown or ignored or detritus):
 
5579
            unknown = True
 
5580
        if dry_run:
 
5581
            force = True
 
5582
        clean_tree('.', unknown=unknown, ignored=ignored, detritus=detritus,
 
5583
                   dry_run=dry_run, no_prompt=force)
 
5584
 
 
5585
 
 
5586
def _create_prefix(cur_transport):
 
5587
    needed = [cur_transport]
 
5588
    # Recurse upwards until we can create a directory successfully
 
5589
    while True:
 
5590
        new_transport = cur_transport.clone('..')
 
5591
        if new_transport.base == cur_transport.base:
 
5592
            raise errors.BzrCommandError(
 
5593
                "Failed to create path prefix for %s."
 
5594
                % cur_transport.base)
 
5595
        try:
 
5596
            new_transport.mkdir('.')
 
5597
        except errors.NoSuchFile:
 
5598
            needed.append(new_transport)
 
5599
            cur_transport = new_transport
 
5600
        else:
 
5601
            break
 
5602
    # Now we only need to create child directories
 
5603
    while needed:
 
5604
        cur_transport = needed.pop()
 
5605
        cur_transport.ensure_base()
 
5606
 
 
5607
 
 
5608
# these get imported and then picked up by the scan for cmd_*
 
5609
# TODO: Some more consistent way to split command definitions across files;
 
5610
# we do need to load at least some information about them to know of
 
5611
# aliases.  ideally we would avoid loading the implementation until the
 
5612
# details were needed.
 
5613
from bzrlib.cmd_version_info import cmd_version_info
 
5614
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
5615
from bzrlib.bundle.commands import (
 
5616
    cmd_bundle_info,
 
5617
    )
 
5618
from bzrlib.foreign import cmd_dpush
 
5619
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
5620
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
5621
        cmd_weave_plan_merge, cmd_weave_merge_text