/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: Martin Pool
  • Date: 2009-06-10 03:31:01 UTC
  • mfrom: (4070.12.3 249908-doc-generate)
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090610033101-ce26xd79i9cbmpsd
Merge other outstanding work on 249908

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