/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Jelmer Vernooij
  • Date: 2009-06-15 19:04:38 UTC
  • mfrom: (4416.5.1 bzr.dev)
  • mto: This revision was merged to the branch mainline in revision 4444.
  • Revision ID: jelmer@samba.org-20090615190438-3yy3e0gviyej2rtv
Merge in patch to squash XML invalid characters in serializer.

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