← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2010-08-30 22:49:20 UTC
  • mfrom: (5397.1.6 jam-integration)
  • Revision ID: pqm@pqm.ubuntu.com-20100830224920-w9zw1vhsd5oiyljv
(vila, jam) Get PQM running correctly again (bug #626667),
        skip test_bzr_connect_to_bzr_ssh (bug #626876)

Show diffs side-by-side

added added

removed removed

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