← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

merge merge tweaks from aaron, which includes latest .dev

Show diffs side-by-side

added added

removed removed

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