← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Packman
  • Date: 2011-12-02 13:36:43 UTC
  • mto: This revision was merged to the branch mainline in revision 6344.
  • Revision ID: martin.packman@canonical.com-20111202133643-0j1f9botvq8d61ar
Add get_message_encoding() for use in decoding system messages

Show diffs side-by-side

added added

removed removed

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