← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Ian Clatworthy
  • Date: 2007-08-13 14:33:10 UTC
  • mto: (2733.1.1 ianc-integration)
  • mto: This revision was merged to the branch mainline in revision 2734.
  • Revision ID: ian.clatworthy@internode.on.net-20070813143310-twhj4la0qnupvze8
Added Quick Start Summary

Show diffs side-by-side

added added

removed removed

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