← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2009-06-16 08:06:58 UTC
  • mto: This revision was merged to the branch mainline in revision 4446.
  • Revision ID: andrew.bennetts@canonical.com-20090616080658-ej18m1u773k55tsc
Fix test failures in test_lookup_revision_id_by_dotted.

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