← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-03-16 14:01:20 UTC
  • mfrom: (3280.2.5 integration)
  • Revision ID: pqm@pqm.ubuntu.com-20080316140120-i3yq8yr1l66m11h7
Start 1.4 development

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
24
25
import sys
25
26
import time
26
27
 
28
29
from bzrlib import (
29
30
    bugtracker,
30
31
    bundle,
31
 
    btree_index,
32
32
    bzrdir,
33
 
    directory_service,
34
33
    delta,
35
 
    config as _mod_config,
 
34
    config,
36
35
    errors,
37
36
    globbing,
38
 
    hooks,
 
37
    ignores,
39
38
    log,
40
39
    merge as _mod_merge,
41
40
    merge_directive,
42
41
    osutils,
43
42
    reconfigure,
44
 
    rename_map,
45
43
    revision as _mod_revision,
46
 
    static_tuple,
47
 
    timestamp,
 
44
    symbol_versioning,
48
45
    transport,
 
46
    tree as _mod_tree,
49
47
    ui,
50
48
    urlutils,
51
 
    views,
52
 
    gpg,
53
49
    )
54
50
from bzrlib.branch import Branch
55
51
from bzrlib.conflicts import ConflictList
56
 
from bzrlib.transport import memory
57
 
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
 
52
from bzrlib.revisionspec import RevisionSpec
58
53
from bzrlib.smtp_connection import SMTPConnection
59
54
from bzrlib.workingtree import WorkingTree
60
 
from bzrlib.i18n import gettext, ngettext
61
55
""")
62
56
 
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
 
57
from bzrlib.commands import Command, display_command
 
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
 
60
 
 
61
 
 
62
def tree_files(file_list, default_branch=u'.'):
 
63
    try:
 
64
        return internal_tree_files(file_list, default_branch)
 
65
    except errors.FileInWrongBranch, e:
 
66
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
 
67
                                     (e.path, file_list[0]))
151
68
 
152
69
 
153
70
# XXX: Bad function name; should possibly also be a class method of
154
71
# 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):
 
72
def internal_tree_files(file_list, default_branch=u'.'):
158
73
    """Convert command-line paths to a WorkingTree and relative paths.
159
74
 
160
 
    Deprecated: use WorkingTree.open_containing_paths instead.
161
 
 
162
75
    This is typically used for command-line processors that take one or
163
76
    more filenames, and infer the workingtree that contains them.
164
77
 
165
78
    The filenames given are not required to exist.
166
79
 
167
 
    :param file_list: Filenames to convert.
 
80
    :param file_list: Filenames to convert.  
168
81
 
169
82
    :param default_branch: Fallback tree path to use if file_list is empty or
170
83
        None.
171
84
 
172
 
    :param apply_view: if True and a view is set, apply it or check that
173
 
        specified files are within it
174
 
 
175
85
    :return: workingtree, [relative_paths]
176
86
    """
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
 
87
    if file_list is None or len(file_list) == 0:
 
88
        return WorkingTree.open_containing(default_branch)[0], file_list
 
89
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
 
90
    new_list = []
 
91
    for filename in file_list:
 
92
        try:
 
93
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
 
94
        except errors.PathNotChild:
 
95
            raise errors.FileInWrongBranch(tree.branch, filename)
 
96
    return tree, new_list
 
97
 
 
98
 
 
99
@symbol_versioning.deprecated_function(symbol_versioning.zero_fifteen)
 
100
def get_format_type(typestring):
 
101
    """Parse and return a format specifier."""
 
102
    # Have to use BzrDirMetaFormat1 directly, so that
 
103
    # RepositoryFormat.set_default_format works
 
104
    if typestring == "default":
 
105
        return bzrdir.BzrDirMetaFormat1()
186
106
    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)
 
107
        return bzrdir.format_registry.make_bzrdir(typestring)
 
108
    except KeyError:
 
109
        msg = 'Unknown bzr format "%s". See "bzr help formats".' % typestring
 
110
        raise errors.BzrCommandError(msg)
201
111
 
202
112
 
203
113
# TODO: Make sure no commands unconditionally use the working directory as a
207
117
# opens the branch?)
208
118
 
209
119
class cmd_status(Command):
210
 
    __doc__ = """Display status summary.
 
120
    """Display status summary.
211
121
 
212
122
    This reports on versioned and unknown files, reporting them
213
123
    grouped by state.  Possible states are:
233
143
    unknown
234
144
        Not versioned and not matching an ignore pattern.
235
145
 
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
146
    To see ignored files use 'bzr ignored'.  For details on the
242
147
    changes to file texts, use 'bzr diff'.
243
 
 
 
148
    
244
149
    Note that --short or -S gives status flags for each item, similar
245
150
    to Subversion's status command. To get output similar to svn -q,
246
 
    use bzr status -SV.
 
151
    use bzr -SV.
247
152
 
248
153
    If no arguments are specified, the status of the entire working
249
154
    directory is shown.  Otherwise, only the status of the specified
250
155
    files or directories is reported.  If a directory is given, status
251
156
    is reported for everything inside that directory.
252
157
 
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'.
 
158
    If a revision argument is given, the status is calculated against
 
159
    that revision, or between two revisions if two are provided.
264
160
    """
265
 
 
 
161
    
266
162
    # TODO: --no-recurse, --recurse options
267
 
 
 
163
    
268
164
    takes_args = ['file*']
269
 
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
165
    takes_options = ['show-ids', 'revision', 'change',
270
166
                     Option('short', help='Use short status indicators.',
271
167
                            short_name='S'),
272
168
                     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
 
                           ),
 
169
                            short_name='V')
279
170
                     ]
280
171
    aliases = ['st', 'stat']
281
172
 
282
173
    encoding_type = 'replace'
283
174
    _see_also = ['diff', 'revert', 'status-flags']
284
 
 
 
175
    
285
176
    @display_command
286
177
    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):
 
178
            versioned=False):
289
179
        from bzrlib.status import show_tree_status
290
180
 
291
181
        if revision and len(revision) > 2:
292
 
            raise errors.BzrCommandError(gettext('bzr status --revision takes exactly'
293
 
                                         ' one or two revision specifiers'))
 
182
            raise errors.BzrCommandError('bzr status --revision takes exactly'
 
183
                                         ' one or two revision specifiers')
294
184
 
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
 
185
        tree, file_list = tree_files(file_list)
 
186
            
305
187
        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)
 
188
                         specific_files=file_list, revision=revision,
 
189
                         to_file=self.outf, short=short, versioned=versioned)
310
190
 
311
191
 
312
192
class cmd_cat_revision(Command):
313
 
    __doc__ = """Write out metadata for a revision.
314
 
 
 
193
    """Write out metadata for a revision.
 
194
    
315
195
    The revision to print can either be specified by a specific
316
196
    revision identifier, or you can use --revision.
317
197
    """
318
198
 
319
199
    hidden = True
320
200
    takes_args = ['revision_id?']
321
 
    takes_options = ['directory', 'revision']
 
201
    takes_options = ['revision']
322
202
    # cat-revision is more for frontends so should be exact
323
203
    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
 
 
 
204
    
333
205
    @display_command
334
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
206
    def run(self, revision_id=None, revision=None):
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
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
218
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
219
        elif revision is not None:
 
220
            for rev in revision:
 
221
                if rev is None:
 
222
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
223
                                                 ' revision.')
 
224
                revno, rev_id = rev.in_history(b)
 
225
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
226
    
454
227
 
455
228
class cmd_remove_tree(Command):
456
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
229
    """Remove the working tree from a given branch/checkout.
457
230
 
458
231
    Since a lightweight checkout is little more than a working tree
459
232
    this will refuse to run against one.
461
234
    To re-create the working tree, use "bzr checkout".
462
235
    """
463
236
    _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]
 
237
 
 
238
    takes_args = ['location?']
 
239
 
 
240
    def run(self, location='.'):
 
241
        d = bzrdir.BzrDir.open(location)
 
242
        
539
243
        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
 
 
 
244
            working = d.open_workingtree()
 
245
        except errors.NoWorkingTree:
 
246
            raise errors.BzrCommandError("No working tree to remove")
 
247
        except errors.NotLocalUrl:
 
248
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
249
                                         "remote path")
 
250
        
 
251
        working_path = working.bzrdir.root_transport.base
 
252
        branch_path = working.branch.bzrdir.root_transport.base
 
253
        if working_path != branch_path:
 
254
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
255
                                         "a lightweight checkout")
 
256
        
 
257
        d.destroy_workingtree()
 
258
        
549
259
 
550
260
class cmd_revno(Command):
551
 
    __doc__ = """Show current revision number.
 
261
    """Show current revision number.
552
262
 
553
263
    This is equal to the number of revisions on this branch.
554
264
    """
555
265
 
556
266
    _see_also = ['info']
557
267
    takes_args = ['location?']
558
 
    takes_options = [
559
 
        Option('tree', help='Show revno of working tree'),
560
 
        ]
561
268
 
562
269
    @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')
 
270
    def run(self, location=u'.'):
 
271
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
272
        self.outf.write('\n')
582
273
 
583
274
 
584
275
class cmd_revision_info(Command):
585
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
276
    """Show revision number and revision id for a given revision identifier.
586
277
    """
587
278
    hidden = True
588
279
    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
 
        ]
 
280
    takes_options = ['revision']
596
281
 
597
282
    @display_command
598
 
    def run(self, revision=None, directory=u'.', tree=False,
599
 
            revision_info_list=[]):
 
283
    def run(self, revision=None, revision_info_list=[]):
600
284
 
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 = []
 
285
        revs = []
610
286
        if revision is not None:
611
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
287
            revs.extend(revision)
612
288
        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())
 
289
            for rev in revision_info_list:
 
290
                revs.append(RevisionSpec.from_string(rev))
 
291
 
 
292
        b = Branch.open_containing(u'.')[0]
 
293
 
 
294
        if len(revs) == 0:
 
295
            revs.append(RevisionSpec.from_string('-1'))
 
296
 
 
297
        for rev in revs:
 
298
            revinfo = rev.in_history(b)
 
299
            if revinfo.revno is None:
 
300
                dotted_map = b.get_revision_id_to_revno_map()
 
301
                revno = '.'.join(str(i) for i in dotted_map[revinfo.rev_id])
 
302
                print '%s %s' % (revno, revinfo.rev_id)
622
303
            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
 
 
 
304
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
305
 
 
306
    
641
307
class cmd_add(Command):
642
 
    __doc__ = """Add specified files or directories.
 
308
    """Add specified files or directories.
643
309
 
644
310
    In non-recursive mode, all the named items are added, regardless
645
311
    of whether they were previously ignored.  A warning is given if
653
319
    are added.  This search proceeds recursively into versioned
654
320
    directories.  If no names are given '.' is assumed.
655
321
 
656
 
    A warning will be printed when nested trees are encountered,
657
 
    unless they are explicitly ignored.
658
 
 
659
322
    Therefore simply saying 'bzr add' will version all files that
660
323
    are currently unknown.
661
324
 
664
327
    you should never need to explicitly add a directory, they'll just
665
328
    get added when you add a file in the directory.
666
329
 
667
 
    --dry-run will show which files would be added, but not actually
 
330
    --dry-run will show which files would be added, but not actually 
668
331
    add them.
669
332
 
670
333
    --file-ids-from will try to use the file ids from the supplied path.
674
337
    branches that will be merged later (without showing the two different
675
338
    adds as a conflict). It is also useful when merging another project
676
339
    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
340
    """
685
341
    takes_args = ['file*']
686
342
    takes_options = [
694
350
               help='Lookup file ids from this tree.'),
695
351
        ]
696
352
    encoding_type = 'replace'
697
 
    _see_also = ['remove', 'ignore']
 
353
    _see_also = ['remove']
698
354
 
699
355
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
700
356
            file_ids_from=None):
713
369
            action = bzrlib.add.AddFromBaseAction(base_tree, base_path,
714
370
                          to_file=self.outf, should_print=(not is_quiet()))
715
371
        else:
716
 
            action = bzrlib.add.AddWithSkipLargeAction(to_file=self.outf,
 
372
            action = bzrlib.add.AddAction(to_file=self.outf,
717
373
                should_print=(not is_quiet()))
718
374
 
719
375
        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()
 
376
            base_tree.lock_read()
 
377
        try:
 
378
            file_list = self._maybe_expand_globs(file_list)
 
379
            if file_list:
 
380
                tree = WorkingTree.open_containing(file_list[0])[0]
 
381
            else:
 
382
                tree = WorkingTree.open_containing(u'.')[0]
 
383
            added, ignored = tree.smart_add(file_list, not
 
384
                no_recurse, action=action, save=not dry_run)
 
385
        finally:
 
386
            if base_tree is not None:
 
387
                base_tree.unlock()
725
388
        if len(ignored) > 0:
726
389
            if verbose:
727
390
                for glob in sorted(ignored.keys()):
728
391
                    for path in ignored[glob]:
729
 
                        self.outf.write(
730
 
                         gettext("ignored {0} matching \"{1}\"\n").format(
731
 
                         path, glob))
 
392
                        self.outf.write("ignored %s matching \"%s\"\n" 
 
393
                                        % (path, glob))
 
394
            else:
 
395
                match_len = 0
 
396
                for glob, paths in ignored.items():
 
397
                    match_len += len(paths)
 
398
                self.outf.write("ignored %d file(s).\n" % match_len)
 
399
            self.outf.write("If you wish to add some of these files,"
 
400
                            " please add them by name.\n")
732
401
 
733
402
 
734
403
class cmd_mkdir(Command):
735
 
    __doc__ = """Create a new versioned directory.
 
404
    """Create a new versioned directory.
736
405
 
737
406
    This is equivalent to creating the directory and then adding it.
738
407
    """
742
411
 
743
412
    def run(self, dir_list):
744
413
        for d in dir_list:
 
414
            os.mkdir(d)
745
415
            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)
 
416
            wt.add([dd])
 
417
            self.outf.write('added %s\n' % d)
754
418
 
755
419
 
756
420
class cmd_relpath(Command):
757
 
    __doc__ = """Show path of a file relative to root"""
 
421
    """Show path of a file relative to root"""
758
422
 
759
423
    takes_args = ['filename']
760
424
    hidden = True
761
 
 
 
425
    
762
426
    @display_command
763
427
    def run(self, filename):
764
428
        # TODO: jam 20050106 Can relpath return a munged path if
769
433
 
770
434
 
771
435
class cmd_inventory(Command):
772
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
436
    """Show inventory of the current working copy or a revision.
773
437
 
774
438
    It is possible to limit the output to a particular entry
775
439
    type using the --kind option.  For example: --kind file.
792
456
    @display_command
793
457
    def run(self, revision=None, show_ids=False, kind=None, file_list=None):
794
458
        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()
 
459
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
 
460
 
 
461
        work_tree, file_list = tree_files(file_list)
 
462
        work_tree.lock_read()
 
463
        try:
 
464
            if revision is not None:
 
465
                if len(revision) > 1:
 
466
                    raise errors.BzrCommandError(
 
467
                        'bzr inventory --revision takes exactly one revision'
 
468
                        ' identifier')
 
469
                revision_id = revision[0].in_history(work_tree.branch).rev_id
 
470
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
471
 
 
472
                extra_trees = [work_tree]
 
473
                tree.lock_read()
 
474
            else:
 
475
                tree = work_tree
 
476
                extra_trees = []
 
477
 
 
478
            if file_list is not None:
 
479
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
480
                                          require_versioned=True)
 
481
                # find_ids_across_trees may include some paths that don't
 
482
                # exist in 'tree'.
 
483
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
484
                                 for file_id in file_ids if file_id in tree)
 
485
            else:
 
486
                entries = tree.inventory.entries()
 
487
        finally:
 
488
            tree.unlock()
 
489
            if tree is not work_tree:
 
490
                work_tree.unlock()
 
491
 
821
492
        for path, entry in entries:
822
493
            if kind and kind != entry.kind:
823
494
                continue
829
500
 
830
501
 
831
502
class cmd_mv(Command):
832
 
    __doc__ = """Move or rename a file.
 
503
    """Move or rename a file.
833
504
 
834
505
    :Usage:
835
506
        bzr mv OLDNAME NEWNAME
852
523
    takes_args = ['names*']
853
524
    takes_options = [Option("after", help="Move only the bzr identifier"
854
525
        " 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
526
        ]
858
527
    aliases = ['move', 'rename']
859
528
    encoding_type = 'replace'
860
529
 
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.'))
 
530
    def run(self, names_list, after=False):
866
531
        if names_list is None:
867
532
            names_list = []
 
533
 
868
534
        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:
 
535
            raise errors.BzrCommandError("missing file argument")
 
536
        tree, rel_names = tree_files(names_list)
 
537
 
 
538
        dest = names_list[-1]
 
539
        isdir = os.path.isdir(dest)
 
540
        if (isdir and not tree.case_sensitive and len(rel_names) == 2
 
541
            and rel_names[0].lower() == rel_names[1].lower()):
 
542
                isdir = False
 
543
        if isdir:
907
544
            # 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))
 
545
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
546
                self.outf.write("%s => %s\n" % pair)
914
547
        else:
915
548
            if len(names_list) != 2:
916
 
                raise errors.BzrCommandError(gettext('to mv multiple files the'
 
549
                raise errors.BzrCommandError('to mv multiple files the'
917
550
                                             ' 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))
 
551
                                             ' directory')
 
552
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
553
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
965
554
 
966
555
 
967
556
class cmd_pull(Command):
968
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
557
    """Turn this branch into a mirror of another branch.
969
558
 
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.
 
559
    This command only works on branches that have not diverged.  Branches are
 
560
    considered diverged if the destination branch's most recent commit is one
 
561
    that has not been merged (directly or indirectly) into the parent.
974
562
 
975
563
    If branches have diverged, you can use 'bzr merge' to integrate the changes
976
564
    from one into the other.  Once one branch has merged, the other should
977
565
    be able to pull it again.
978
566
 
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.
 
567
    If you want to forget your local changes and just update your branch to
 
568
    match the remote one, use pull --overwrite.
 
569
 
 
570
    If there is no default location set, the first pull will set it.  After
 
571
    that, you can omit the location to use the default.  To change the
 
572
    default, use --remember. The value will only be saved if the remote
 
573
    location can be accessed.
991
574
    """
992
575
 
993
 
    _see_also = ['push', 'update', 'status-flags', 'send']
 
576
    _see_also = ['push', 'update', 'status-flags']
994
577
    takes_options = ['remember', 'overwrite', 'revision',
995
578
        custom_help('verbose',
996
579
            help='Show logs of pulled revisions.'),
997
 
        custom_help('directory',
 
580
        Option('directory',
998
581
            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."
 
582
                 'rather than the one containing the working directory.',
 
583
            short_name='d',
 
584
            type=unicode,
1004
585
            ),
1005
 
        Option('show-base',
1006
 
            help="Show base revision text in conflicts.")
1007
586
        ]
1008
587
    takes_args = ['location?']
1009
588
    encoding_type = 'replace'
1010
589
 
1011
 
    def run(self, location=None, remember=None, overwrite=False,
 
590
    def run(self, location=None, remember=False, overwrite=False,
1012
591
            revision=None, verbose=False,
1013
 
            directory=None, local=False,
1014
 
            show_base=False):
 
592
            directory=None):
1015
593
        # FIXME: too much stuff is in the command class
1016
594
        revision_id = None
1017
595
        mergeable = None
1020
598
        try:
1021
599
            tree_to = WorkingTree.open_containing(directory)[0]
1022
600
            branch_to = tree_to.branch
1023
 
            self.add_cleanup(tree_to.lock_write().unlock)
1024
601
        except errors.NoWorkingTree:
1025
602
            tree_to = None
1026
603
            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
604
 
1035
605
        possible_transports = []
1036
606
        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
 
607
            mergeable, location_transport = _get_mergeable_helper(location)
 
608
            possible_transports.append(location_transport)
1042
609
 
1043
610
        stored_loc = branch_to.get_parent()
1044
611
        if location is None:
1045
612
            if stored_loc is None:
1046
 
                raise errors.BzrCommandError(gettext("No pull location known or"
1047
 
                                             " specified."))
 
613
                raise errors.BzrCommandError("No pull location known or"
 
614
                                             " specified.")
1048
615
            else:
1049
616
                display_url = urlutils.unescape_for_display(stored_loc,
1050
617
                        self.outf.encoding)
1051
618
                if not is_quiet():
1052
 
                    self.outf.write(gettext("Using saved parent location: %s\n") % display_url)
 
619
                    self.outf.write("Using saved location: %s\n" % display_url)
1053
620
                location = stored_loc
 
621
                location_transport = transport.get_transport(
 
622
                    location, possible_transports=possible_transports)
1054
623
 
1055
 
        revision = _get_one_revision('pull', revision)
1056
624
        if mergeable is not None:
1057
625
            if revision is not None:
1058
 
                raise errors.BzrCommandError(gettext(
1059
 
                    'Cannot use -r with merge directives or bundles'))
 
626
                raise errors.BzrCommandError(
 
627
                    'Cannot use -r with merge directives or bundles')
1060
628
            mergeable.install_revisions(branch_to.repository)
1061
629
            base_revision_id, revision_id, verified = \
1062
630
                mergeable.get_merge_request(branch_to.repository)
1063
631
            branch_from = branch_to
1064
632
        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)):
 
633
            branch_from = Branch.open_from_transport(location_transport)
 
634
 
 
635
            if branch_to.get_parent() is None or remember:
1071
636
                branch_to.set_parent(branch_from.base)
1072
637
 
1073
638
        if revision is not None:
1074
 
            revision_id = revision.as_revision_id(branch_from)
 
639
            if len(revision) == 1:
 
640
                revision_id = revision[0].in_history(branch_from).rev_id
 
641
            else:
 
642
                raise errors.BzrCommandError(
 
643
                    'bzr pull --revision takes one value.')
1075
644
 
 
645
        if verbose:
 
646
            old_rh = branch_to.revision_history()
1076
647
        if tree_to is not None:
1077
 
            view_info = _get_view_info_for_change_reporter(tree_to)
1078
648
            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)
 
649
                unversioned_filter=tree_to.is_ignored)
 
650
            result = tree_to.pull(branch_from, overwrite, revision_id,
 
651
                                  change_reporter,
 
652
                                  possible_transports=possible_transports)
1084
653
        else:
1085
 
            result = branch_to.pull(
1086
 
                branch_from, overwrite, revision_id, local=local)
 
654
            result = branch_to.pull(branch_from, overwrite, revision_id)
1087
655
 
1088
656
        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
 
657
        if verbose:
 
658
            new_rh = branch_to.revision_history()
 
659
            log.show_changed_revisions(branch_to, old_rh, new_rh,
 
660
                                       to_file=self.outf)
1097
661
 
1098
662
 
1099
663
class cmd_push(Command):
1100
 
    __doc__ = """Update a mirror of this branch.
1101
 
 
 
664
    """Update a mirror of this branch.
 
665
    
1102
666
    The target branch will not have its working tree populated because this
1103
667
    is both expensive, and is not supported on remote file systems.
1104
 
 
 
668
    
1105
669
    Some smart servers or protocols *may* put the working tree in place in
1106
670
    the future.
1107
671
 
1111
675
 
1112
676
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1113
677
    the other branch completely, discarding its unmerged changes.
1114
 
 
 
678
    
1115
679
    If you want to ensure you have the different changes in the other branch,
1116
680
    do a merge (see bzr help merge) from the other branch, and commit that.
1117
681
    After that you will be able to do a push without '--overwrite'.
1118
682
 
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.
 
683
    If there is no default push location set, the first push will set it.
 
684
    After that, you can omit the location to use the default.  To change the
 
685
    default, use --remember. The value will only be saved if the remote
 
686
    location can be accessed.
1123
687
    """
1124
688
 
1125
689
    _see_also = ['pull', 'update', 'working-trees']
1127
691
        Option('create-prefix',
1128
692
               help='Create the path leading up to the branch '
1129
693
                    'if it does not already exist.'),
1130
 
        custom_help('directory',
 
694
        Option('directory',
1131
695
            help='Branch to push from, '
1132
 
                 'rather than the one containing the working directory.'),
 
696
                 'rather than the one containing the working directory.',
 
697
            short_name='d',
 
698
            type=unicode,
 
699
            ),
1133
700
        Option('use-existing-dir',
1134
701
               help='By default push will fail if the target'
1135
702
                    ' directory exists, but does not already'
1136
703
                    ' have a control directory.  This flag will'
1137
704
                    ' 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
705
        ]
1153
706
    takes_args = ['location?']
1154
707
    encoding_type = 'replace'
1155
708
 
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
 
 
 
709
    def run(self, location=None, remember=False, overwrite=False,
 
710
            create_prefix=False, verbose=False, revision=None,
 
711
            use_existing_dir=False,
 
712
            directory=None):
 
713
        # FIXME: Way too big!  Put this into a function called from the
 
714
        # command.
1162
715
        if directory is None:
1163
716
            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
 
717
        br_from = Branch.open_containing(directory)[0]
 
718
        stored_loc = br_from.get_push_location()
1197
719
        if location is None:
1198
 
            stored_loc = br_from.get_push_location()
1199
720
            if stored_loc is None:
1200
 
                raise errors.BzrCommandError(gettext(
1201
 
                    "No push location known or specified."))
 
721
                raise errors.BzrCommandError("No push location known or specified.")
1202
722
            else:
1203
723
                display_url = urlutils.unescape_for_display(stored_loc,
1204
724
                        self.outf.encoding)
1205
 
                note(gettext("Using saved push location: %s") % display_url)
 
725
                self.outf.write("Using saved location: %s\n" % display_url)
1206
726
                location = stored_loc
1207
727
 
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)
 
728
        to_transport = transport.get_transport(location)
 
729
 
 
730
        br_to = repository_to = dir_to = None
 
731
        try:
 
732
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
733
        except errors.NotBranchError:
 
734
            pass # Didn't find anything
 
735
        else:
 
736
            # If we can open a branch, use its direct repository, otherwise see
 
737
            # if there is a repository without a branch.
 
738
            try:
 
739
                br_to = dir_to.open_branch()
 
740
            except errors.NotBranchError:
 
741
                # Didn't find a branch, can we find a repository?
 
742
                try:
 
743
                    repository_to = dir_to.find_repository()
 
744
                except errors.NoRepositoryPresent:
 
745
                    pass
 
746
            else:
 
747
                # Found a branch, so we must have found a repository
 
748
                repository_to = br_to.repository
 
749
 
 
750
        if revision is not None:
 
751
            if len(revision) == 1:
 
752
                revision_id = revision[0].in_history(br_from).rev_id
 
753
            else:
 
754
                raise errors.BzrCommandError(
 
755
                    'bzr push --revision takes one value.')
 
756
        else:
 
757
            revision_id = br_from.last_revision()
 
758
 
 
759
        push_result = None
 
760
        if verbose:
 
761
            old_rh = []
 
762
        if dir_to is None:
 
763
            # The destination doesn't exist; create it.
 
764
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
765
            #      common helper function
 
766
 
 
767
            def make_directory(transport):
 
768
                transport.mkdir('.')
 
769
                return transport
 
770
 
 
771
            def redirected(redirected_transport, e, redirection_notice):
 
772
                return transport.get_transport(e.get_target_url())
 
773
 
 
774
            try:
 
775
                to_transport = transport.do_catching_redirections(
 
776
                    make_directory, to_transport, redirected)
 
777
            except errors.FileExists:
 
778
                if not use_existing_dir:
 
779
                    raise errors.BzrCommandError("Target directory %s"
 
780
                         " already exists, but does not have a valid .bzr"
 
781
                         " directory. Supply --use-existing-dir to push"
 
782
                         " there anyway." % location)
 
783
            except errors.NoSuchFile:
 
784
                if not create_prefix:
 
785
                    raise errors.BzrCommandError("Parent directory of %s"
 
786
                        " does not exist."
 
787
                        "\nYou may supply --create-prefix to create all"
 
788
                        " leading parent directories."
 
789
                        % location)
 
790
                _create_prefix(to_transport)
 
791
            except errors.TooManyRedirections:
 
792
                raise errors.BzrCommandError("Too many redirections trying "
 
793
                                             "to make %s." % location)
 
794
 
 
795
            # Now the target directory exists, but doesn't have a .bzr
 
796
            # directory. So we need to create it, along with any work to create
 
797
            # all of the dependent branches, etc.
 
798
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
799
                                                       revision_id=revision_id)
 
800
            br_to = dir_to.open_branch()
 
801
            # TODO: Some more useful message about what was copied
 
802
            note('Created new branch.')
 
803
            # We successfully created the target, remember it
 
804
            if br_from.get_push_location() is None or remember:
 
805
                br_from.set_push_location(br_to.base)
 
806
        elif repository_to is None:
 
807
            # we have a bzrdir but no branch or repository
 
808
            # XXX: Figure out what to do other than complain.
 
809
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
810
                " directory, but not a branch or repository. This is an"
 
811
                " unsupported configuration. Please move the target directory"
 
812
                " out of the way and try again."
 
813
                % location)
 
814
        elif br_to is None:
 
815
            # We have a repository but no branch, copy the revisions, and then
 
816
            # create a branch.
 
817
            repository_to.fetch(br_from.repository, revision_id=revision_id)
 
818
            br_to = br_from.clone(dir_to, revision_id=revision_id)
 
819
            note('Created new branch.')
 
820
            if br_from.get_push_location() is None or remember:
 
821
                br_from.set_push_location(br_to.base)
 
822
        else: # We have a valid to branch
 
823
            # We were able to connect to the remote location, so remember it
 
824
            # we don't need to successfully push because of possible divergence.
 
825
            if br_from.get_push_location() is None or remember:
 
826
                br_from.set_push_location(br_to.base)
 
827
            if verbose:
 
828
                old_rh = br_to.revision_history()
 
829
            try:
 
830
                try:
 
831
                    tree_to = dir_to.open_workingtree()
 
832
                except errors.NotLocalUrl:
 
833
                    warning("This transport does not update the working " 
 
834
                            "tree of: %s. See 'bzr help working-trees' for "
 
835
                            "more information." % br_to.base)
 
836
                    push_result = br_from.push(br_to, overwrite,
 
837
                                               stop_revision=revision_id)
 
838
                except errors.NoWorkingTree:
 
839
                    push_result = br_from.push(br_to, overwrite,
 
840
                                               stop_revision=revision_id)
 
841
                else:
 
842
                    tree_to.lock_write()
 
843
                    try:
 
844
                        push_result = br_from.push(tree_to.branch, overwrite,
 
845
                                                   stop_revision=revision_id)
 
846
                        tree_to.update()
 
847
                    finally:
 
848
                        tree_to.unlock()
 
849
            except errors.DivergedBranches:
 
850
                raise errors.BzrCommandError('These branches have diverged.'
 
851
                                        '  Try using "merge" and then "push".')
 
852
        if push_result is not None:
 
853
            push_result.report(self.outf)
 
854
        elif verbose:
 
855
            new_rh = br_to.revision_history()
 
856
            if old_rh != new_rh:
 
857
                # Something changed
 
858
                from bzrlib.log import show_changed_revisions
 
859
                show_changed_revisions(br_to, old_rh, new_rh,
 
860
                                       to_file=self.outf)
 
861
        else:
 
862
            # we probably did a clone rather than a push, so a message was
 
863
            # emitted above
 
864
            pass
1212
865
 
1213
866
 
1214
867
class cmd_branch(Command):
1215
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
868
    """Create a new copy of a branch.
1216
869
 
1217
870
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1218
871
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1223
876
 
1224
877
    To retrieve the branch as of a particular revision, supply the --revision
1225
878
    parameter, as in "branch foo/bar -r 5".
1226
 
 
1227
 
    The synonyms 'clone' and 'get' for this command are deprecated.
1228
879
    """
1229
880
 
1230
881
    _see_also = ['checkout']
1231
882
    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
 
        ]
 
883
    takes_options = ['revision', Option('hardlink',
 
884
        help='Hard-link working tree files where possible.')]
1255
885
    aliases = ['get', 'clone']
1256
886
 
1257
887
    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
 
888
            hardlink=False):
1262
889
        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')
 
890
        if revision is None:
 
891
            revision = [None]
 
892
        elif len(revision) > 1:
 
893
            raise errors.BzrCommandError(
 
894
                'bzr branch --revision takes exactly 1 revision value')
 
895
 
1269
896
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1270
897
            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))
 
898
        br_from.lock_read()
 
899
        try:
 
900
            if len(revision) == 1 and revision[0] is not None:
 
901
                revision_id = revision[0].in_history(br_from)[1]
 
902
            else:
 
903
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
904
                # None or perhaps NULL_REVISION to mean copy nothing
 
905
                # RBC 20060209
 
906
                revision_id = br_from.last_revision()
 
907
            if to_location is None:
 
908
                to_location = urlutils.derive_to_location(from_location)
 
909
                name = None
 
910
            else:
 
911
                name = os.path.basename(to_location) + '\n'
 
912
 
 
913
            to_transport = transport.get_transport(to_location)
 
914
            try:
 
915
                to_transport.mkdir('.')
 
916
            except errors.FileExists:
 
917
                raise errors.BzrCommandError('Target directory "%s" already'
 
918
                                             ' exists.' % to_location)
 
919
            except errors.NoSuchFile:
 
920
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
921
                                             % to_location)
 
922
            try:
 
923
                # preserve whatever source format we have.
 
924
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
925
                                            possible_transports=[to_transport],
 
926
                                            accelerator_tree=accelerator_tree,
 
927
                                            hardlink=hardlink)
 
928
                branch = dir.open_branch()
 
929
            except errors.NoSuchRevision:
 
930
                to_transport.delete_tree('.')
 
931
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
932
                raise errors.BzrCommandError(msg)
 
933
            if name:
 
934
                branch.control_files.put_utf8('branch-name', name)
 
935
            _merge_tags_if_possible(br_from, branch)
 
936
            note('Branched %d revision(s).' % branch.revno())
 
937
        finally:
 
938
            br_from.unlock()
1375
939
 
1376
940
 
1377
941
class cmd_checkout(Command):
1378
 
    __doc__ = """Create a new checkout of an existing branch.
 
942
    """Create a new checkout of an existing branch.
1379
943
 
1380
944
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1381
945
    the branch found in '.'. This is useful if you have removed the working tree
1382
946
    or if it was never created - i.e. if you pushed the branch to its current
1383
947
    location using SFTP.
1384
 
 
 
948
    
1385
949
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1386
950
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1387
951
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1415
979
 
1416
980
    def run(self, branch_location=None, to_location=None, revision=None,
1417
981
            lightweight=False, files_from=None, hardlink=False):
 
982
        if revision is None:
 
983
            revision = [None]
 
984
        elif len(revision) > 1:
 
985
            raise errors.BzrCommandError(
 
986
                'bzr checkout --revision takes exactly 1 revision value')
1418
987
        if branch_location is None:
1419
988
            branch_location = osutils.getcwd()
1420
989
            to_location = branch_location
1421
990
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1422
991
            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:
 
992
        if files_from is not None:
1430
993
            accelerator_tree = WorkingTree.open(files_from)
1431
 
        if revision is not None:
1432
 
            revision_id = revision.as_revision_id(source)
 
994
        if len(revision) == 1 and revision[0] is not None:
 
995
            revision_id = _mod_revision.ensure_null(
 
996
                revision[0].in_history(source)[1])
1433
997
        else:
1434
998
            revision_id = None
1435
999
        if to_location is None:
1436
1000
            to_location = urlutils.derive_to_location(branch_location)
1437
 
        # if the source and to_location are the same,
 
1001
        # if the source and to_location are the same, 
1438
1002
        # and there is no working tree,
1439
1003
        # then reconstitute a branch
1440
1004
        if (osutils.abspath(to_location) ==
1449
1013
 
1450
1014
 
1451
1015
class cmd_renames(Command):
1452
 
    __doc__ = """Show list of renamed files.
 
1016
    """Show list of renamed files.
1453
1017
    """
1454
1018
    # TODO: Option to show renames between two historical versions.
1455
1019
 
1460
1024
    @display_command
1461
1025
    def run(self, dir=u'.'):
1462
1026
        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))
 
1027
        tree.lock_read()
 
1028
        try:
 
1029
            new_inv = tree.inventory
 
1030
            old_tree = tree.basis_tree()
 
1031
            old_tree.lock_read()
 
1032
            try:
 
1033
                old_inv = old_tree.inventory
 
1034
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
1035
                renames.sort()
 
1036
                for old_name, new_name in renames:
 
1037
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1038
            finally:
 
1039
                old_tree.unlock()
 
1040
        finally:
 
1041
            tree.unlock()
1479
1042
 
1480
1043
 
1481
1044
class cmd_update(Command):
1482
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
1483
 
 
 
1045
    """Update a tree to have the latest code committed to its branch.
 
1046
    
1484
1047
    This will perform a merge into the working tree, and may generate
1485
 
    conflicts. If you have any local changes, you will still
 
1048
    conflicts. If you have any local changes, you will still 
1486
1049
    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
 
1050
    
 
1051
    If you want to discard your local changes, you can just do a 
1489
1052
    '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
1053
    """
1497
1054
 
1498
1055
    _see_also = ['pull', 'working-trees', 'status-flags']
1499
1056
    takes_args = ['dir?']
1500
 
    takes_options = ['revision',
1501
 
                     Option('show-base',
1502
 
                            help="Show base revision text in conflicts."),
1503
 
                     ]
1504
1057
    aliases = ['up']
1505
1058
 
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"))
 
1059
    def run(self, dir='.'):
1510
1060
        tree = WorkingTree.open_containing(dir)[0]
1511
 
        branch = tree.branch
1512
1061
        possible_transports = []
1513
 
        master = branch.get_master_branch(
 
1062
        master = tree.branch.get_master_branch(
1514
1063
            possible_transports=possible_transports)
1515
1064
        if master is not None:
1516
 
            branch_location = master.base
1517
1065
            tree.lock_write()
1518
1066
        else:
1519
 
            branch_location = tree.branch.base
1520
1067
            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
1068
        try:
 
1069
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1070
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1071
            if last_rev == _mod_revision.ensure_null(
 
1072
                tree.branch.last_revision()):
 
1073
                # may be up to date, check master too.
 
1074
                if master is None or last_rev == _mod_revision.ensure_null(
 
1075
                    master.last_revision()):
 
1076
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1077
                    note("Tree is up to date at revision %d." % (revno,))
 
1078
                    return 0
1548
1079
            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
 
1080
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1081
                possible_transports=possible_transports)
 
1082
            revno = tree.branch.revision_id_to_revno(
 
1083
                _mod_revision.ensure_null(tree.last_revision()))
 
1084
            note('Updated to revision %d.' % (revno,))
 
1085
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1086
                note('Your local commits will now show as pending merges with '
 
1087
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1088
            if conflicts != 0:
 
1089
                return 1
 
1090
            else:
 
1091
                return 0
 
1092
        finally:
 
1093
            tree.unlock()
1572
1094
 
1573
1095
 
1574
1096
class cmd_info(Command):
1575
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1097
    """Show information about a working tree, branch or repository.
1576
1098
 
1577
1099
    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.
 
1100
    tree, branch or repository.  Statistical information is included with
 
1101
    each report.
1583
1102
 
1584
1103
    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
1104
    """
1602
1105
    _see_also = ['revno', 'working-trees', 'repositories']
1603
1106
    takes_args = ['location?']
1607
1110
    @display_command
1608
1111
    def run(self, location=None, verbose=False):
1609
1112
        if verbose:
1610
 
            noise_level = get_verbosity_level()
 
1113
            noise_level = 2
1611
1114
        else:
1612
1115
            noise_level = 0
1613
1116
        from bzrlib.info import show_bzrdir_info
1616
1119
 
1617
1120
 
1618
1121
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.
 
1122
    """Remove files or directories.
 
1123
 
 
1124
    This makes bzr stop tracking changes to the specified files and
 
1125
    delete them if they can easily be recovered using revert.
 
1126
 
 
1127
    You can specify one or more files, and/or --new.  If you specify --new,
 
1128
    only 'added' files will be removed.  If you specify both, then new files
 
1129
    in the specified directories will be removed.  If the directories are
 
1130
    also new, they will also be removed.
1626
1131
    """
1627
1132
    takes_args = ['file*']
1628
1133
    takes_options = ['verbose',
1629
 
        Option('new', help='Only remove files that have never been committed.'),
 
1134
        Option('new', help='Remove newly-added files.'),
1630
1135
        RegistryOption.from_kwargs('file-deletion-strategy',
1631
1136
            'The file deletion mode to be used.',
1632
1137
            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.',
 
1138
            safe='Only delete files if they can be'
 
1139
                 ' safely recovered (default).',
 
1140
            keep="Don't delete any files.",
1636
1141
            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']
 
1142
                'recovered and even if they are non-empty directories.')]
 
1143
    aliases = ['rm']
1640
1144
    encoding_type = 'replace'
1641
1145
 
1642
1146
    def run(self, file_list, verbose=False, new=False,
1643
1147
        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)
 
1148
        tree, file_list = tree_files(file_list)
1650
1149
 
1651
1150
        if file_list is not None:
1652
1151
            file_list = [f for f in file_list]
 
1152
        elif not new:
 
1153
            raise errors.BzrCommandError('Specify one or more files to'
 
1154
            ' remove, or use --new.')
1653
1155
 
1654
 
        self.add_cleanup(tree.lock_write().unlock)
1655
 
        # Heuristics should probably all move into tree.remove_smart or
1656
 
        # some such?
1657
1156
        if new:
1658
1157
            added = tree.changes_from(tree.basis_tree(),
1659
1158
                specific_files=file_list).added
1660
1159
            file_list = sorted([f[0] for f in added], reverse=True)
1661
1160
            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'
 
1161
                raise errors.BzrCommandError('No matching files.')
1673
1162
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1674
1163
            keep_files=file_deletion_strategy=='keep',
1675
 
            force=(file_deletion_strategy=='no-backup'))
 
1164
            force=file_deletion_strategy=='force')
1676
1165
 
1677
1166
 
1678
1167
class cmd_file_id(Command):
1679
 
    __doc__ = """Print file_id of a particular file or directory.
 
1168
    """Print file_id of a particular file or directory.
1680
1169
 
1681
1170
    The file_id is assigned when the file is first added and remains the
1682
1171
    same through all revisions where the file exists, even when it is
1698
1187
 
1699
1188
 
1700
1189
class cmd_file_path(Command):
1701
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1190
    """Print path of file_ids to a file or directory.
1702
1191
 
1703
1192
    This prints one line for each directory down to the target,
1704
1193
    starting at the branch root.
1720
1209
 
1721
1210
 
1722
1211
class cmd_reconcile(Command):
1723
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1212
    """Reconcile bzr metadata in a branch.
1724
1213
 
1725
1214
    This can correct data mismatches that may have been caused by
1726
1215
    previous ghost operations or bzr upgrades. You should only
1727
 
    need to run this command if 'bzr check' or a bzr developer
 
1216
    need to run this command if 'bzr check' or a bzr developer 
1728
1217
    advises you to run it.
1729
1218
 
1730
1219
    If a second branch is provided, cross-branch reconciliation is
1732
1221
    id which was not present in very early bzr versions is represented
1733
1222
    correctly in both branches.
1734
1223
 
1735
 
    At the same time it is run it may recompress data resulting in
 
1224
    At the same time it is run it may recompress data resulting in 
1736
1225
    a potential saving in disk space or performance gain.
1737
1226
 
1738
1227
    The branch *MUST* be on a listable system such as local disk or sftp.
1740
1229
 
1741
1230
    _see_also = ['check']
1742
1231
    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
1232
 
1750
 
    def run(self, branch=".", canonicalize_chks=False):
 
1233
    def run(self, branch="."):
1751
1234
        from bzrlib.reconcile import reconcile
1752
1235
        dir = bzrdir.BzrDir.open(branch)
1753
 
        reconcile(dir, canonicalize_chks=canonicalize_chks)
 
1236
        reconcile(dir)
1754
1237
 
1755
1238
 
1756
1239
class cmd_revision_history(Command):
1757
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1240
    """Display the list of revision ids on a branch."""
1758
1241
 
1759
1242
    _see_also = ['log']
1760
1243
    takes_args = ['location?']
1770
1253
 
1771
1254
 
1772
1255
class cmd_ancestry(Command):
1773
 
    __doc__ = """List all revisions merged into this branch."""
 
1256
    """List all revisions merged into this branch."""
1774
1257
 
1775
1258
    _see_also = ['log', 'revision-history']
1776
1259
    takes_args = ['location?']
1788
1271
            b = wt.branch
1789
1272
            last_revision = wt.last_revision()
1790
1273
 
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
 
1274
        revision_ids = b.repository.get_ancestry(last_revision)
 
1275
        assert revision_ids[0] is None
 
1276
        revision_ids.pop(0)
 
1277
        for revision_id in revision_ids:
1798
1278
            self.outf.write(revision_id + '\n')
1799
1279
 
1800
1280
 
1801
1281
class cmd_init(Command):
1802
 
    __doc__ = """Make a directory into a versioned branch.
 
1282
    """Make a directory into a versioned branch.
1803
1283
 
1804
1284
    Use this to create an empty branch, or before importing an
1805
1285
    existing project.
1806
1286
 
1807
 
    If there is a repository in a parent directory of the location, then
 
1287
    If there is a repository in a parent directory of the location, then 
1808
1288
    the history of the branch will be stored in the repository.  Otherwise
1809
1289
    init creates a standalone branch which carries its own history
1810
1290
    in the .bzr directory.
1830
1310
         RegistryOption('format',
1831
1311
                help='Specify a format for this branch. '
1832
1312
                'See "help formats".',
1833
 
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1834
 
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1313
                registry=bzrdir.format_registry,
 
1314
                converter=bzrdir.format_registry.make_bzrdir,
1835
1315
                value_switches=True,
1836
 
                title="Branch format",
 
1316
                title="Branch Format",
1837
1317
                ),
1838
1318
         Option('append-revisions-only',
1839
1319
                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.')
 
1320
                '  Append revisions to it only.')
1843
1321
         ]
1844
1322
    def run(self, location=None, format=None, append_revisions_only=False,
1845
 
            create_prefix=False, no_tree=False):
 
1323
            create_prefix=False):
1846
1324
        if format is None:
1847
1325
            format = bzrdir.format_registry.make_bzrdir('default')
1848
1326
        if location is None:
1859
1337
            to_transport.ensure_base()
1860
1338
        except errors.NoSuchFile:
1861
1339
            if not create_prefix:
1862
 
                raise errors.BzrCommandError(gettext("Parent directory of %s"
 
1340
                raise errors.BzrCommandError("Parent directory of %s"
1863
1341
                    " does not exist."
1864
1342
                    "\nYou may supply --create-prefix to create all"
1865
 
                    " leading parent directories.")
 
1343
                    " leading parent directories."
1866
1344
                    % location)
1867
 
            to_transport.create_prefix()
 
1345
            _create_prefix(to_transport)
1868
1346
 
1869
1347
        try:
1870
 
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1348
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1871
1349
        except errors.NotBranchError:
1872
1350
            # really a NotBzrDir error...
1873
1351
            create_branch = bzrdir.BzrDir.create_branch_convenience
1874
 
            if no_tree:
1875
 
                force_new_tree = False
1876
 
            else:
1877
 
                force_new_tree = None
1878
1352
            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
 
1353
                                   possible_transports=[to_transport])
1882
1354
        else:
1883
1355
            from bzrlib.transport.local import LocalTransport
1884
 
            if a_bzrdir.has_branch():
 
1356
            if existing_bzrdir.has_branch():
1885
1357
                if (isinstance(to_transport, LocalTransport)
1886
 
                    and not a_bzrdir.has_workingtree()):
 
1358
                    and not existing_bzrdir.has_workingtree()):
1887
1359
                        raise errors.BranchExistsWithoutWorkingTree(location)
1888
1360
                raise errors.AlreadyBranchError(location)
1889
 
            branch = a_bzrdir.create_branch()
1890
 
            if not no_tree:
1891
 
                a_bzrdir.create_workingtree()
 
1361
            else:
 
1362
                branch = existing_bzrdir.create_branch()
 
1363
                existing_bzrdir.create_workingtree()
1892
1364
        if append_revisions_only:
1893
1365
            try:
1894
1366
                branch.set_append_revisions_only(True)
1895
1367
            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)
 
1368
                raise errors.BzrCommandError('This branch format cannot be set'
 
1369
                    ' to append-revisions-only.  Try --experimental-branch6')
1917
1370
 
1918
1371
 
1919
1372
class cmd_init_repository(Command):
1920
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1373
    """Create a shared repository to hold branches.
1921
1374
 
1922
1375
    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.
 
1376
    revisions in the repository, not in the branch directory.
1926
1377
 
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.
 
1378
    If the --no-trees option is used then the branches in the repository
 
1379
    will not have working trees by default.
1933
1380
 
1934
1381
    :Examples:
1935
 
        Create a shared repository holding just branches::
 
1382
        Create a shared repositories holding just branches::
1936
1383
 
1937
1384
            bzr init-repo --no-trees repo
1938
1385
            bzr init repo/trunk
1949
1396
    takes_options = [RegistryOption('format',
1950
1397
                            help='Specify a format for this repository. See'
1951
1398
                                 ' "bzr help formats" for details.',
1952
 
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1953
 
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1399
                            registry=bzrdir.format_registry,
 
1400
                            converter=bzrdir.format_registry.make_bzrdir,
1954
1401
                            value_switches=True, title='Repository format'),
1955
1402
                     Option('no-trees',
1956
1403
                             help='Branches in the repository will default to'
1971
1418
        newdir = format.initialize_on_transport(to_transport)
1972
1419
        repo = newdir.create_repository(shared=True)
1973
1420
        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
1421
 
1978
1422
 
1979
1423
class cmd_diff(Command):
1980
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
1981
 
 
 
1424
    """Show differences in the working tree, between revisions or branches.
 
1425
    
1982
1426
    If no arguments are given, all changes for the current tree are listed.
1983
1427
    If files are given, only the changes in those files are listed.
1984
1428
    Remote and multiple branches can be compared by using the --old and
1989
1433
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
1990
1434
    produces patches suitable for "patch -p1".
1991
1435
 
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
1436
    :Exit values:
2000
1437
        1 - changed
2001
1438
        2 - unrepresentable changes
2011
1448
 
2012
1449
            bzr diff -r1
2013
1450
 
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..
 
1451
        Difference between revision 2 and revision 1::
 
1452
 
 
1453
            bzr diff -r1..2
 
1454
 
 
1455
        Difference between revision 2 and revision 1 for branch xxx::
 
1456
 
 
1457
            bzr diff -r1..2 xxx
2040
1458
 
2041
1459
        Show just the differences for file NEWS::
2042
1460
 
2057
1475
        Same as 'bzr diff' but prefix paths with old/ and new/::
2058
1476
 
2059
1477
            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
2064
1478
    """
2065
1479
    _see_also = ['status']
2066
1480
    takes_args = ['file*']
2085
1499
            help='Use this command to compare files.',
2086
1500
            type=unicode,
2087
1501
            ),
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
1502
        ]
2094
1503
    aliases = ['di', 'dif']
2095
1504
    encoding_type = 'exact'
2096
1505
 
2097
1506
    @display_command
2098
1507
    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)
 
1508
            prefix=None, old=None, new=None, using=None):
 
1509
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
2102
1510
 
2103
1511
        if (prefix is None) or (prefix == '0'):
2104
1512
            # diff -p0 format
2110
1518
        elif ':' in prefix:
2111
1519
            old_label, new_label = prefix.split(":")
2112
1520
        else:
2113
 
            raise errors.BzrCommandError(gettext(
 
1521
            raise errors.BzrCommandError(
2114
1522
                '--prefix expects two values separated by a colon'
2115
 
                ' (eg "old/:new/")'))
 
1523
                ' (eg "old/:new/")')
2116
1524
 
2117
1525
        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,
 
1526
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
 
1527
                                         ' one or two revision specifiers')
 
1528
 
 
1529
        old_tree, new_tree, specific_files, extra_trees = \
 
1530
                _get_trees_to_diff(file_list, revision, old, new)
 
1531
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
2133
1532
                               specific_files=specific_files,
2134
1533
                               external_diff_options=diff_options,
2135
1534
                               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)
 
1535
                               extra_trees=extra_trees, using=using)
2140
1536
 
2141
1537
 
2142
1538
class cmd_deleted(Command):
2143
 
    __doc__ = """List files deleted in the working tree.
 
1539
    """List files deleted in the working tree.
2144
1540
    """
2145
1541
    # TODO: Show files deleted since a previous revision, or
2146
1542
    # between two revisions.
2149
1545
    # level of effort but possibly much less IO.  (Or possibly not,
2150
1546
    # if the directories are very large...)
2151
1547
    _see_also = ['status', 'ls']
2152
 
    takes_options = ['directory', 'show-ids']
 
1548
    takes_options = ['show-ids']
2153
1549
 
2154
1550
    @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')
 
1551
    def run(self, show_ids=False):
 
1552
        tree = WorkingTree.open_containing(u'.')[0]
 
1553
        tree.lock_read()
 
1554
        try:
 
1555
            old = tree.basis_tree()
 
1556
            old.lock_read()
 
1557
            try:
 
1558
                for path, ie in old.inventory.iter_entries():
 
1559
                    if not tree.has_id(ie.file_id):
 
1560
                        self.outf.write(path)
 
1561
                        if show_ids:
 
1562
                            self.outf.write(' ')
 
1563
                            self.outf.write(ie.file_id)
 
1564
                        self.outf.write('\n')
 
1565
            finally:
 
1566
                old.unlock()
 
1567
        finally:
 
1568
            tree.unlock()
2167
1569
 
2168
1570
 
2169
1571
class cmd_modified(Command):
2170
 
    __doc__ = """List files modified in working tree.
 
1572
    """List files modified in working tree.
2171
1573
    """
2172
1574
 
2173
1575
    hidden = True
2174
1576
    _see_also = ['status', 'ls']
2175
 
    takes_options = ['directory', 'null']
2176
1577
 
2177
1578
    @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)
 
1579
    def run(self):
 
1580
        tree = WorkingTree.open_containing(u'.')[0]
2181
1581
        td = tree.changes_from(tree.basis_tree())
2182
 
        self.cleanup_now()
2183
1582
        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')
 
1583
            self.outf.write(path + '\n')
2188
1584
 
2189
1585
 
2190
1586
class cmd_added(Command):
2191
 
    __doc__ = """List files added in working tree.
 
1587
    """List files added in working tree.
2192
1588
    """
2193
1589
 
2194
1590
    hidden = True
2195
1591
    _see_also = ['status', 'ls']
2196
 
    takes_options = ['directory', 'null']
2197
1592
 
2198
1593
    @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')
 
1594
    def run(self):
 
1595
        wt = WorkingTree.open_containing(u'.')[0]
 
1596
        wt.lock_read()
 
1597
        try:
 
1598
            basis = wt.basis_tree()
 
1599
            basis.lock_read()
 
1600
            try:
 
1601
                basis_inv = basis.inventory
 
1602
                inv = wt.inventory
 
1603
                for file_id in inv:
 
1604
                    if file_id in basis_inv:
 
1605
                        continue
 
1606
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1607
                        continue
 
1608
                    path = inv.id2path(file_id)
 
1609
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1610
                        continue
 
1611
                    self.outf.write(path + '\n')
 
1612
            finally:
 
1613
                basis.unlock()
 
1614
        finally:
 
1615
            wt.unlock()
2218
1616
 
2219
1617
 
2220
1618
class cmd_root(Command):
2221
 
    __doc__ = """Show the tree root directory.
 
1619
    """Show the tree root directory.
2222
1620
 
2223
1621
    The root is the nearest enclosing directory with a .bzr control
2224
1622
    directory."""
2235
1633
    try:
2236
1634
        return int(limitstring)
2237
1635
    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.")
 
1636
        msg = "The limit argument must be an integer."
2247
1637
        raise errors.BzrCommandError(msg)
2248
1638
 
2249
1639
 
2250
1640
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.
 
1641
    """Show log of a branch, file, or directory.
 
1642
 
 
1643
    By default show the log of the branch containing the working directory.
 
1644
 
 
1645
    To request a range of logs, you can use the command -r begin..end
 
1646
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1647
    also valid.
 
1648
 
 
1649
    :Examples:
 
1650
        Log the current branch::
 
1651
 
 
1652
            bzr log
 
1653
 
 
1654
        Log a file::
 
1655
 
 
1656
            bzr log foo.c
 
1657
 
 
1658
        Log the last 10 revisions of a branch::
 
1659
 
 
1660
            bzr log -r -10.. http://server/branch
2404
1661
    """
2405
 
    takes_args = ['file*']
2406
 
    _see_also = ['log-formats', 'revisionspec']
 
1662
 
 
1663
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1664
 
 
1665
    takes_args = ['location?']
2407
1666
    takes_options = [
2408
1667
            Option('forward',
2409
1668
                   help='Show from oldest to newest.'),
2410
 
            'timezone',
 
1669
            Option('timezone',
 
1670
                   type=str,
 
1671
                   help='Display timezone as local, original, or utc.'),
2411
1672
            custom_help('verbose',
2412
1673
                   help='Show files changed in each revision.'),
2413
1674
            'show-ids',
2414
1675
            '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
1676
            '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
1677
            Option('message',
 
1678
                   short_name='m',
2432
1679
                   help='Show revisions whose message matches this '
2433
1680
                        'regular expression.',
2434
 
                   type=str,
2435
 
                   hidden=True),
 
1681
                   type=str),
2436
1682
            Option('limit',
2437
1683
                   short_name='l',
2438
1684
                   help='Limit the output to the first N revisions.',
2439
1685
                   argname='N',
2440
1686
                   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
1687
            ]
2478
1688
    encoding_type = 'replace'
2479
1689
 
2480
1690
    @display_command
2481
 
    def run(self, file_list=None, timezone='original',
 
1691
    def run(self, location=None, timezone='original',
2482
1692
            verbose=False,
2483
1693
            show_ids=False,
2484
1694
            forward=False,
2485
1695
            revision=None,
2486
 
            change=None,
2487
1696
            log_format=None,
2488
 
            levels=None,
2489
1697
            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
 
            )
 
1698
            limit=None):
 
1699
        from bzrlib.log import show_log
 
1700
        assert message is None or isinstance(message, basestring), \
 
1701
            "invalid message argument %r" % message
2509
1702
        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:
 
1703
        
 
1704
        # log everything
 
1705
        file_id = None
 
1706
        if location:
 
1707
            # find the file id to log:
 
1708
 
 
1709
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1710
                location)
 
1711
            if fp != '':
 
1712
                if tree is None:
 
1713
                    tree = b.basis_tree()
 
1714
                file_id = tree.path2id(fp)
2554
1715
                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'])
 
1716
                    raise errors.BzrCommandError(
 
1717
                        "Path does not have any revision history: %s" %
 
1718
                        location)
2566
1719
        else:
2567
 
            # log everything
2568
 
            # FIXME ? log the current subdir only RBC 20060203
 
1720
            # local dir only
 
1721
            # FIXME ? log the current subdir only RBC 20060203 
2569
1722
            if revision is not None \
2570
1723
                    and len(revision) > 0 and revision[0].get_branch():
2571
1724
                location = revision[0].get_branch()
2573
1726
                location = '.'
2574
1727
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2575
1728
            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
 
1729
 
 
1730
        b.lock_read()
 
1731
        try:
 
1732
            if revision is None:
 
1733
                rev1 = None
 
1734
                rev2 = None
 
1735
            elif len(revision) == 1:
 
1736
                rev1 = rev2 = revision[0].in_history(b)
 
1737
            elif len(revision) == 2:
 
1738
                if revision[1].get_branch() != revision[0].get_branch():
 
1739
                    # b is taken from revision[0].get_branch(), and
 
1740
                    # show_log will use its revision_history. Having
 
1741
                    # different branches will lead to weird behaviors.
 
1742
                    raise errors.BzrCommandError(
 
1743
                        "Log doesn't accept two revisions in different"
 
1744
                        " branches.")
 
1745
                rev1 = revision[0].in_history(b)
 
1746
                rev2 = revision[1].in_history(b)
 
1747
            else:
 
1748
                raise errors.BzrCommandError(
 
1749
                    'bzr log --revision takes one or two values.')
 
1750
 
 
1751
            if log_format is None:
 
1752
                log_format = log.log_formatter_registry.get_default(b)
 
1753
 
 
1754
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1755
                            show_timezone=timezone)
 
1756
 
 
1757
            show_log(b,
 
1758
                     lf,
 
1759
                     file_id,
 
1760
                     verbose=verbose,
 
1761
                     direction=direction,
 
1762
                     start_revision=rev1,
 
1763
                     end_revision=rev2,
 
1764
                     search=message,
 
1765
                     limit=limit)
 
1766
        finally:
 
1767
            b.unlock()
 
1768
 
2701
1769
 
2702
1770
def get_log_format(long=False, short=False, line=False, default='long'):
2703
1771
    log_format = default
2711
1779
 
2712
1780
 
2713
1781
class cmd_touching_revisions(Command):
2714
 
    __doc__ = """Return revision-ids which affected a particular file.
 
1782
    """Return revision-ids which affected a particular file.
2715
1783
 
2716
1784
    A more user-friendly interface is "bzr log FILE".
2717
1785
    """
2722
1790
    @display_command
2723
1791
    def run(self, filename):
2724
1792
        tree, relpath = WorkingTree.open_containing(filename)
 
1793
        b = tree.branch
2725
1794
        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:
 
1795
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2730
1796
            self.outf.write("%6d %s\n" % (revno, what))
2731
1797
 
2732
1798
 
2733
1799
class cmd_ls(Command):
2734
 
    __doc__ = """List files in a tree.
 
1800
    """List files in a tree.
2735
1801
    """
2736
1802
 
2737
1803
    _see_also = ['status', 'cat']
2738
1804
    takes_args = ['path?']
 
1805
    # TODO: Take a revision or remote path and list that tree instead.
2739
1806
    takes_options = [
2740
1807
            'verbose',
2741
1808
            'revision',
2742
 
            Option('recursive', short_name='R',
2743
 
                   help='Recurse into subdirectories.'),
 
1809
            Option('non-recursive',
 
1810
                   help='Don\'t recurse into subdirectories.'),
2744
1811
            Option('from-root',
2745
1812
                   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',
 
1813
            Option('unknown', help='Print unknown files.'),
 
1814
            Option('versioned', help='Print versioned files.'),
 
1815
            Option('ignored', help='Print ignored files.'),
 
1816
            Option('null',
 
1817
                   help='Write an ascii NUL (\\0) separator '
 
1818
                   'between files rather than a newline.'),
 
1819
            Option('kind',
2753
1820
                   help='List entries of a particular kind: file, directory, symlink.',
2754
1821
                   type=unicode),
2755
 
            'null',
2756
1822
            'show-ids',
2757
 
            'directory',
2758
1823
            ]
2759
1824
    @display_command
2760
1825
    def run(self, revision=None, verbose=False,
2761
 
            recursive=False, from_root=False,
 
1826
            non_recursive=False, from_root=False,
2762
1827
            unknown=False, versioned=False, ignored=False,
2763
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
1828
            null=False, kind=None, show_ids=False, path=None):
2764
1829
 
2765
1830
        if kind and kind not in ('file', 'directory', 'symlink'):
2766
 
            raise errors.BzrCommandError(gettext('invalid kind specified'))
 
1831
            raise errors.BzrCommandError('invalid kind specified')
2767
1832
 
2768
1833
        if verbose and null:
2769
 
            raise errors.BzrCommandError(gettext('Cannot set both --verbose and --null'))
 
1834
            raise errors.BzrCommandError('Cannot set both --verbose and --null')
2770
1835
        all = not (unknown or versioned or ignored)
2771
1836
 
2772
1837
        selection = {'I':ignored, '?':unknown, 'V':versioned}
2773
1838
 
2774
1839
        if path is None:
2775
1840
            fs_path = '.'
 
1841
            prefix = ''
2776
1842
        else:
2777
1843
            if from_root:
2778
 
                raise errors.BzrCommandError(gettext('cannot specify both --from-root'
2779
 
                                             ' and PATH'))
 
1844
                raise errors.BzrCommandError('cannot specify both --from-root'
 
1845
                                             ' and PATH')
2780
1846
            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
 
1847
            prefix = path
 
1848
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1849
            fs_path)
2786
1850
        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')
 
1851
            relpath = u''
 
1852
        elif relpath:
 
1853
            relpath += '/'
 
1854
        if revision is not None:
 
1855
            tree = branch.repository.revision_tree(
 
1856
                revision[0].in_history(branch).rev_id)
 
1857
        elif tree is None:
 
1858
            tree = branch.basis_tree()
 
1859
 
 
1860
        tree.lock_read()
 
1861
        try:
 
1862
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1863
                if fp.startswith(relpath):
 
1864
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1865
                    if non_recursive and '/' in fp:
 
1866
                        continue
 
1867
                    if not all and not selection[fc]:
 
1868
                        continue
 
1869
                    if kind is not None and fkind != kind:
 
1870
                        continue
 
1871
                    if verbose:
 
1872
                        kindch = entry.kind_character()
 
1873
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1874
                        if show_ids and fid is not None:
 
1875
                            outstring = "%-50s %s" % (outstring, fid)
 
1876
                        self.outf.write(outstring + '\n')
 
1877
                    elif null:
 
1878
                        self.outf.write(fp + '\0')
 
1879
                        if show_ids:
 
1880
                            if fid is not None:
 
1881
                                self.outf.write(fid)
 
1882
                            self.outf.write('\0')
 
1883
                        self.outf.flush()
 
1884
                    else:
 
1885
                        if fid is not None:
 
1886
                            my_id = fid
 
1887
                        else:
 
1888
                            my_id = ''
 
1889
                        if show_ids:
 
1890
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1891
                        else:
 
1892
                            self.outf.write(fp + '\n')
 
1893
        finally:
 
1894
            tree.unlock()
2848
1895
 
2849
1896
 
2850
1897
class cmd_unknowns(Command):
2851
 
    __doc__ = """List unknown files.
 
1898
    """List unknown files.
2852
1899
    """
2853
1900
 
2854
1901
    hidden = True
2855
1902
    _see_also = ['ls']
2856
 
    takes_options = ['directory']
2857
1903
 
2858
1904
    @display_command
2859
 
    def run(self, directory=u'.'):
2860
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
1905
    def run(self):
 
1906
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2861
1907
            self.outf.write(osutils.quotefn(f) + '\n')
2862
1908
 
2863
1909
 
2864
1910
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.
 
1911
    """Ignore specified files or patterns.
2874
1912
 
2875
1913
    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.
 
1914
 
 
1915
    Trailing slashes on patterns are ignored. 
 
1916
    If the pattern contains a slash or is a regular expression, it is compared 
 
1917
    to the whole path from the branch root.  Otherwise, it is compared to only
 
1918
    the last component of the path.  To match a file only in the root 
 
1919
    directory, prepend './'.
 
1920
 
 
1921
    Ignore patterns specifying absolute paths are not allowed.
 
1922
 
 
1923
    Ignore patterns may include globbing wildcards such as::
 
1924
 
 
1925
      ? - Matches any single character except '/'
 
1926
      * - Matches 0 or more characters except '/'
 
1927
      /**/ - Matches 0 or more directories in a path
 
1928
      [a-z] - Matches a single character from within a group of characters
 
1929
 
 
1930
    Ignore patterns may also be Python regular expressions.  
 
1931
    Regular expression ignore patterns are identified by a 'RE:' prefix 
 
1932
    followed by the regular expression.  Regular expression ignore patterns
 
1933
    may not include named or numbered groups.
 
1934
 
 
1935
    Note: ignore patterns containing shell wildcards must be quoted from 
 
1936
    the shell on Unix.
2900
1937
 
2901
1938
    :Examples:
2902
1939
        Ignore the top level Makefile::
2903
1940
 
2904
1941
            bzr ignore ./Makefile
2905
1942
 
2906
 
        Ignore .class files in all directories...::
 
1943
        Ignore class files in all directories::
2907
1944
 
2908
1945
            bzr ignore "*.class"
2909
1946
 
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
1947
        Ignore .o files under the lib directory::
2919
1948
 
2920
1949
            bzr ignore "lib/**/*.o"
2926
1955
        Ignore everything but the "debian" toplevel directory::
2927
1956
 
2928
1957
            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 "!!*~"
2936
1958
    """
2937
1959
 
2938
 
    _see_also = ['status', 'ignored', 'patterns']
 
1960
    _see_also = ['status', 'ignored']
2939
1961
    takes_args = ['name_pattern*']
2940
 
    takes_options = ['directory',
2941
 
        Option('default-rules',
2942
 
               help='Display the default ignore rules that bzr uses.')
 
1962
    takes_options = [
 
1963
        Option('old-default-rules',
 
1964
               help='Write out the ignore rules bzr < 0.9 always used.')
2943
1965
        ]
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)
 
1966
    
 
1967
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1968
        from bzrlib.atomicfile import AtomicFile
 
1969
        if old_default_rules is not None:
 
1970
            # dump the rules and exit
 
1971
            for pattern in ignores.OLD_DEFAULTS:
 
1972
                print pattern
2952
1973
            return
2953
1974
        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)
 
1975
            raise errors.BzrCommandError("ignore requires at least one "
 
1976
                                  "NAME_PATTERN or --old-default-rules")
 
1977
        name_pattern_list = [globbing.normalize_pattern(p) 
2957
1978
                             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
1979
        for name_pattern in name_pattern_list:
2971
 
            if (name_pattern[0] == '/' or
 
1980
            if (name_pattern[0] == '/' or 
2972
1981
                (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)
 
1982
                raise errors.BzrCommandError(
 
1983
                    "NAME_PATTERN should not be an absolute path")
 
1984
        tree, relpath = WorkingTree.open_containing(u'.')
 
1985
        ifn = tree.abspath('.bzrignore')
 
1986
        if os.path.exists(ifn):
 
1987
            f = open(ifn, 'rt')
 
1988
            try:
 
1989
                igns = f.read().decode('utf-8')
 
1990
            finally:
 
1991
                f.close()
 
1992
        else:
 
1993
            igns = ''
 
1994
 
 
1995
        # TODO: If the file already uses crlf-style termination, maybe
 
1996
        # we should use that for the newly added lines?
 
1997
 
 
1998
        if igns and igns[-1] != '\n':
 
1999
            igns += '\n'
 
2000
        for name_pattern in name_pattern_list:
 
2001
            igns += name_pattern + '\n'
 
2002
 
 
2003
        f = AtomicFile(ifn, 'wb')
 
2004
        try:
 
2005
            f.write(igns.encode('utf-8'))
 
2006
            f.commit()
 
2007
        finally:
 
2008
            f.close()
 
2009
 
 
2010
        if not tree.path2id('.bzrignore'):
 
2011
            tree.add(['.bzrignore'])
 
2012
 
2977
2013
        ignored = globbing.Globster(name_pattern_list)
2978
2014
        matches = []
2979
 
        self.add_cleanup(tree.lock_read().unlock)
 
2015
        tree.lock_read()
2980
2016
        for entry in tree.list_files():
2981
2017
            id = entry[3]
2982
2018
            if id is not None:
2983
2019
                filename = entry[0]
2984
2020
                if ignored.match(filename):
2985
 
                    matches.append(filename)
 
2021
                    matches.append(filename.encode('utf-8'))
 
2022
        tree.unlock()
2986
2023
        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),))
2991
 
 
 
2024
            print "Warning: the following files are version controlled and" \
 
2025
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
2992
2026
 
2993
2027
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
 
2028
    """List ignored files and the patterns that matched them.
3002
2029
    """
3003
2030
 
3004
2031
    encoding_type = 'replace'
3005
 
    _see_also = ['ignore', 'ls']
3006
 
    takes_options = ['directory']
 
2032
    _see_also = ['ignore']
3007
2033
 
3008
2034
    @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))
 
2035
    def run(self):
 
2036
        tree = WorkingTree.open_containing(u'.')[0]
 
2037
        tree.lock_read()
 
2038
        try:
 
2039
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2040
                if file_class != 'I':
 
2041
                    continue
 
2042
                ## XXX: Slightly inefficient since this was already calculated
 
2043
                pat = tree.is_ignored(path)
 
2044
                self.outf.write('%-50s %s\n' % (path, pat))
 
2045
        finally:
 
2046
            tree.unlock()
3018
2047
 
3019
2048
 
3020
2049
class cmd_lookup_revision(Command):
3021
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2050
    """Lookup the revision-id from a revision-number
3022
2051
 
3023
2052
    :Examples:
3024
2053
        bzr lookup-revision 33
3025
2054
    """
3026
2055
    hidden = True
3027
2056
    takes_args = ['revno']
3028
 
    takes_options = ['directory']
3029
 
 
 
2057
    
3030
2058
    @display_command
3031
 
    def run(self, revno, directory=u'.'):
 
2059
    def run(self, revno):
3032
2060
        try:
3033
2061
            revno = int(revno)
3034
2062
        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)
 
2063
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2064
 
 
2065
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
3039
2066
 
3040
2067
 
3041
2068
class cmd_export(Command):
3042
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2069
    """Export current or past revision to a destination directory or archive.
3043
2070
 
3044
2071
    If no revision is specified this exports the last committed revision.
3045
2072
 
3066
2093
         zip                          .zip
3067
2094
      =================       =========================
3068
2095
    """
3069
 
    encoding = 'exact'
3070
 
    takes_args = ['dest', 'branch_or_subdir?']
3071
 
    takes_options = ['directory',
 
2096
    takes_args = ['dest', 'branch?']
 
2097
    takes_options = [
3072
2098
        Option('format',
3073
2099
               help="Type of file to export to.",
3074
2100
               type=unicode),
3075
2101
        'revision',
3076
 
        Option('filters', help='Apply content filters to export the '
3077
 
                'convenient form.'),
3078
2102
        Option('root',
3079
2103
               type=str,
3080
2104
               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
2105
        ]
3085
 
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
3086
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2106
    def run(self, dest, branch=None, revision=None, format=None, root=None):
3087
2107
        from bzrlib.export import export
3088
2108
 
3089
 
        if branch_or_subdir is None:
3090
 
            tree = WorkingTree.open_containing(directory)[0]
 
2109
        if branch is None:
 
2110
            tree = WorkingTree.open_containing(u'.')[0]
3091
2111
            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)
 
2112
        else:
 
2113
            b = Branch.open(branch)
 
2114
            
 
2115
        if revision is None:
 
2116
            # should be tree.last_revision  FIXME
 
2117
            rev_id = b.last_revision()
 
2118
        else:
 
2119
            if len(revision) != 1:
 
2120
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2121
            rev_id = revision[0].in_history(b).rev_id
 
2122
        t = b.repository.revision_tree(rev_id)
3098
2123
        try:
3099
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
3100
 
                   per_file_timestamps=per_file_timestamps)
 
2124
            export(t, dest, format, root)
3101
2125
        except errors.NoSuchExportFormat, e:
3102
 
            raise errors.BzrCommandError(gettext('Unsupported export format: %s') % e.format)
 
2126
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
3103
2127
 
3104
2128
 
3105
2129
class cmd_cat(Command):
3106
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2130
    """Write the contents of a file as of a given revision to standard output.
3107
2131
 
3108
2132
    If no revision is nominated, the last revision is used.
3109
2133
 
3110
2134
    Note: Take care to redirect standard output when using this command on a
3111
 
    binary file.
 
2135
    binary file. 
3112
2136
    """
3113
2137
 
3114
2138
    _see_also = ['ls']
3115
 
    takes_options = ['directory',
 
2139
    takes_options = [
3116
2140
        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
2141
        'revision',
3120
2142
        ]
3121
2143
    takes_args = ['filename']
3122
2144
    encoding_type = 'exact'
3123
2145
 
3124
2146
    @display_command
3125
 
    def run(self, filename, revision=None, name_from_revision=False,
3126
 
            filters=False, directory=None):
 
2147
    def run(self, filename, revision=None, name_from_revision=False):
3127
2148
        if revision is not None and len(revision) != 1:
3128
 
            raise errors.BzrCommandError(gettext("bzr cat --revision takes exactly"
3129
 
                                         " one revision specifier"))
 
2149
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
 
2150
                                         " one revision specifier")
3130
2151
        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)
 
2152
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2153
        branch.lock_read()
 
2154
        try:
 
2155
            return self._run(tree, branch, relpath, filename, revision,
 
2156
                             name_from_revision)
 
2157
        finally:
 
2158
            branch.unlock()
3135
2159
 
3136
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
3137
 
        filtered):
 
2160
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
3138
2161
        if tree is None:
3139
2162
            tree = b.basis_tree()
3140
 
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
3141
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2163
        if revision is None:
 
2164
            revision_id = b.last_revision()
 
2165
        else:
 
2166
            revision_id = revision[0].in_history(b).rev_id
3142
2167
 
 
2168
        cur_file_id = tree.path2id(relpath)
 
2169
        rev_tree = b.repository.revision_tree(revision_id)
3143
2170
        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.
 
2171
        
3149
2172
        if name_from_revision:
3150
 
            # Try in revision if requested
3151
2173
            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)
 
2174
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2175
                                                % (filename, revision_id))
 
2176
            else:
 
2177
                rev_tree.print_file(old_file_id)
 
2178
        elif cur_file_id is not None:
 
2179
            rev_tree.print_file(cur_file_id)
 
2180
        elif old_file_id is not None:
 
2181
            rev_tree.print_file(old_file_id)
 
2182
        else:
 
2183
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2184
                                         (filename, revision_id))
3176
2185
 
3177
2186
 
3178
2187
class cmd_local_time_offset(Command):
3179
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
3180
 
    hidden = True
 
2188
    """Show the offset in seconds from GMT to local time."""
 
2189
    hidden = True    
3181
2190
    @display_command
3182
2191
    def run(self):
3183
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2192
        print osutils.local_time_offset()
3184
2193
 
3185
2194
 
3186
2195
 
3187
2196
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.
 
2197
    """Commit changes into a new revision.
 
2198
    
 
2199
    If no arguments are given, the entire tree is committed.
 
2200
 
 
2201
    If selected files are specified, only changes to those files are
 
2202
    committed.  If a directory is specified then the directory and everything 
 
2203
    within it is committed.
 
2204
 
 
2205
    If author of the change is not the same person as the committer, you can
 
2206
    specify the author's name using the --author option. The name should be
 
2207
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2208
 
 
2209
    A selected-file commit may fail in some cases where the committed
 
2210
    tree would be invalid. Consider::
 
2211
 
 
2212
      bzr init foo
 
2213
      mkdir foo/bar
 
2214
      bzr add foo/bar
 
2215
      bzr commit foo -m "committing foo"
 
2216
      bzr mv foo/bar foo/baz
 
2217
      mkdir foo/bar
 
2218
      bzr add foo/bar
 
2219
      bzr commit foo/bar -m "committing bar but not baz"
 
2220
 
 
2221
    In the example above, the last commit will fail by design. This gives
 
2222
    the user the opportunity to decide whether they want to commit the
 
2223
    rename at the same time, separately first, or not at all. (As a general
 
2224
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2225
 
 
2226
    Note: A selected-file commit after a merge is not yet supported.
3242
2227
    """
3243
 
 
3244
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2228
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
2229
 
 
2230
    # TODO: Strict commit that fails if there are deleted files.
 
2231
    #       (what does "deleted files" mean ??)
 
2232
 
 
2233
    # TODO: Give better message for -s, --summary, used by tla people
 
2234
 
 
2235
    # XXX: verbose currently does nothing
 
2236
 
 
2237
    _see_also = ['bugs', 'uncommit']
3245
2238
    takes_args = ['selected*']
3246
2239
    takes_options = [
3247
 
            ListOption('exclude', type=str, short_name='x',
3248
 
                help="Do not consider changes made to a given path."),
3249
2240
            Option('message', type=unicode,
3250
2241
                   short_name='m',
3251
2242
                   help="Description of the new revision."),
3259
2250
             Option('strict',
3260
2251
                    help="Refuse to commit if there are unknown "
3261
2252
                    "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
2253
             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,
 
2254
                    help="Mark a bug as being fixed by this revision."),
 
2255
             Option('author', type=unicode,
3269
2256
                    help="Set the author's name, if it's different "
3270
2257
                         "from the committer."),
3271
2258
             Option('local',
3274
2261
                         "the master branch until a normal commit "
3275
2262
                         "is performed."
3276
2263
                    ),
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.'),
 
2264
              Option('show-diff',
 
2265
                     help='When no message is supplied, show the diff along'
 
2266
                     ' with the status summary in the message editor.'),
3284
2267
             ]
3285
2268
    aliases = ['ci', 'checkin']
3286
2269
 
3287
 
    def _iter_bug_fix_urls(self, fixes, branch):
3288
 
        default_bugtracker  = None
 
2270
    def _get_bug_fix_properties(self, fixes, branch):
 
2271
        properties = []
3289
2272
        # Configure the properties for bug fixing attributes.
3290
2273
        for fixed_bug in fixes:
3291
2274
            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
 
2275
            if len(tokens) != 2:
 
2276
                raise errors.BzrCommandError(
 
2277
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2278
                    "Commit refused." % fixed_bug)
 
2279
            tag, bug_id = tokens
3313
2280
            try:
3314
 
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2281
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
3315
2282
            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),))
 
2283
                raise errors.BzrCommandError(
 
2284
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
 
2285
            except errors.MalformedBugIdentifier:
 
2286
                raise errors.BzrCommandError(
 
2287
                    "Invalid bug identifier for %s. Commit refused."
 
2288
                    % fixed_bug)
 
2289
            properties.append('%s fixed' % bug_url)
 
2290
        return '\n'.join(properties)
3321
2291
 
3322
2292
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3323
2293
            unchanged=False, strict=False, local=False, fixes=None,
3324
 
            author=None, show_diff=False, exclude=None, commit_time=None,
3325
 
            lossy=False):
 
2294
            author=None, show_diff=False):
3326
2295
        from bzrlib.errors import (
3327
2296
            PointlessCommit,
3328
2297
            ConflictsInTree,
3330
2299
        )
3331
2300
        from bzrlib.msgeditor import (
3332
2301
            edit_commit_message_encoded,
3333
 
            generate_commit_message_template,
3334
 
            make_commit_message_template_encoded,
3335
 
            set_commit_message,
 
2302
            make_commit_message_template_encoded
3336
2303
        )
3337
2304
 
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)))
 
2305
        # TODO: Need a blackbox test for invoking the external editor; may be
 
2306
        # slightly problematic to run this cross-platform.
 
2307
 
 
2308
        # TODO: do more checks that the commit will succeed before 
 
2309
        # spending the user's valuable time typing a commit message.
3345
2310
 
3346
2311
        properties = {}
3347
2312
 
3348
 
        tree, selected_list = WorkingTree.open_containing_paths(selected_list)
 
2313
        tree, selected_list = tree_files(selected_list)
3349
2314
        if selected_list == ['']:
3350
2315
            # workaround - commit of root of tree should be exactly the same
3351
2316
            # as just default commit in that tree, and succeed even though
3354
2319
 
3355
2320
        if fixes is None:
3356
2321
            fixes = []
3357
 
        bug_property = bugtracker.encode_fixes_bug_urls(
3358
 
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2322
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
3359
2323
        if bug_property:
3360
2324
            properties['bugs'] = bug_property
3361
2325
 
3362
2326
        if local and not tree.branch.get_bound_location():
3363
2327
            raise errors.LocalRequiresBoundBranch()
3364
2328
 
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
2329
        def get_message(commit_obj):
3387
2330
            """Callback to get commit message"""
3388
 
            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,
 
2331
            my_message = message
 
2332
            if my_message is None and not file:
 
2333
                t = make_commit_message_template_encoded(tree,
3400
2334
                        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 \"\"."))
 
2335
                        output_encoding=bzrlib.user_encoding)
 
2336
                my_message = edit_commit_message_encoded(t)
 
2337
                if my_message is None:
 
2338
                    raise errors.BzrCommandError("please specify a commit"
 
2339
                        " message with either --message or --file")
 
2340
            elif my_message and file:
 
2341
                raise errors.BzrCommandError(
 
2342
                    "please specify either --message or --file")
 
2343
            if file:
 
2344
                my_message = codecs.open(file, 'rt', 
 
2345
                                         bzrlib.user_encoding).read()
 
2346
            if my_message == "":
 
2347
                raise errors.BzrCommandError("empty commit message specified")
3420
2348
            return my_message
3421
2349
 
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
3426
2350
        try:
3427
2351
            tree.commit(message_callback=get_message,
3428
2352
                        specific_files=selected_list,
3429
2353
                        allow_pointless=unchanged, strict=strict, local=local,
3430
2354
                        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)
 
2355
                        author=author)
3435
2356
        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."))
 
2357
            # FIXME: This should really happen before the file is read in;
 
2358
            # perhaps prepare the commit; get the message; then actually commit
 
2359
            raise errors.BzrCommandError("no changes to commit."
 
2360
                              " use --unchanged to commit anyhow")
3439
2361
        except ConflictsInTree:
3440
 
            raise errors.BzrCommandError(gettext('Conflicts detected in working '
 
2362
            raise errors.BzrCommandError('Conflicts detected in working '
3441
2363
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3442
 
                ' resolve.'))
 
2364
                ' resolve.')
3443
2365
        except StrictCommitFailed:
3444
 
            raise errors.BzrCommandError(gettext("Commit refused because there are"
3445
 
                              " unknown files in the working tree."))
 
2366
            raise errors.BzrCommandError("Commit refused because there are"
 
2367
                              " unknown files in the working tree.")
3446
2368
        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
 
2369
            raise errors.BzrCommandError(str(e) + "\n"
 
2370
            'To commit to master branch, run update and then commit.\n'
 
2371
            'You can also pass --local to commit to continue working '
 
2372
            'disconnected.')
3452
2373
 
3453
2374
 
3454
2375
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
 
2376
    """Validate consistency of branch history.
 
2377
 
 
2378
    This command checks various invariants about the branch storage to
 
2379
    detect data corruption or bzr bugs.
 
2380
 
 
2381
    Output fields:
 
2382
 
 
2383
        revisions: This is just the number of revisions checked.  It doesn't
 
2384
            indicate a problem.
 
2385
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2386
            doesn't indicate a problem.
 
2387
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2388
            are not properly referenced by the revision ancestry.  This is a
 
2389
            subtle problem that Bazaar can work around.
 
2390
        unique file texts: This is the total number of unique file contents
 
2391
            seen in the checked revisions.  It does not indicate a problem.
 
2392
        repeated file texts: This is the total number of repeated texts seen
 
2393
            in the checked revisions.  Texts can be repeated when their file
 
2394
            entries are modified, but the file contents are not.  It does not
 
2395
            indicate a problem.
3502
2396
    """
3503
2397
 
3504
2398
    _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.")]
 
2399
    takes_args = ['branch?']
 
2400
    takes_options = ['verbose']
3513
2401
 
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)
 
2402
    def run(self, branch=None, verbose=False):
 
2403
        from bzrlib.check import check
 
2404
        if branch is None:
 
2405
            branch_obj = Branch.open_containing('.')[0]
 
2406
        else:
 
2407
            branch_obj = Branch.open(branch)
 
2408
        check(branch_obj, verbose)
 
2409
        # bit hacky, check the tree parent is accurate
 
2410
        try:
 
2411
            if branch is None:
 
2412
                tree = WorkingTree.open_containing('.')[0]
 
2413
            else:
 
2414
                tree = WorkingTree.open(branch)
 
2415
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2416
            pass
 
2417
        else:
 
2418
            # This is a primitive 'check' for tree state. Currently this is not
 
2419
            # integrated into the main check logic as yet.
 
2420
            tree.lock_read()
 
2421
            try:
 
2422
                tree_basis = tree.basis_tree()
 
2423
                tree_basis.lock_read()
 
2424
                try:
 
2425
                    repo_basis = tree.branch.repository.revision_tree(
 
2426
                        tree.last_revision())
 
2427
                    if len(list(repo_basis.iter_changes(tree_basis))):
 
2428
                        raise errors.BzrCheckError(
 
2429
                            "Mismatched basis inventory content.")
 
2430
                    tree._validate()
 
2431
                finally:
 
2432
                    tree_basis.unlock()
 
2433
            finally:
 
2434
                tree.unlock()
3522
2435
 
3523
2436
 
3524
2437
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/.
 
2438
    """Upgrade branch storage to current format.
 
2439
 
 
2440
    The check command or bzr developers may sometimes advise you to run
 
2441
    this command. When the default format has changed you may also be warned
 
2442
    during other operations to upgrade.
3555
2443
    """
3556
2444
 
3557
 
    _see_also = ['check', 'reconcile', 'formats']
 
2445
    _see_also = ['check']
3558
2446
    takes_args = ['url?']
3559
2447
    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
 
    ]
 
2448
                    RegistryOption('format',
 
2449
                        help='Upgrade to a specific format.  See "bzr help'
 
2450
                             ' formats" for details.',
 
2451
                        registry=bzrdir.format_registry,
 
2452
                        converter=bzrdir.format_registry.make_bzrdir,
 
2453
                        value_switches=True, title='Branch format'),
 
2454
                    ]
3571
2455
 
3572
 
    def run(self, url='.', format=None, clean=False, dry_run=False):
 
2456
    def run(self, url='.', format=None):
3573
2457
        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
 
2458
        if format is None:
 
2459
            format = bzrdir.format_registry.make_bzrdir('default')
 
2460
        upgrade(url, format)
3581
2461
 
3582
2462
 
3583
2463
class cmd_whoami(Command):
3584
 
    __doc__ = """Show or set bzr user id.
3585
 
 
 
2464
    """Show or set bzr user id.
 
2465
    
3586
2466
    :Examples:
3587
2467
        Show the email of the current user::
3588
2468
 
3592
2472
 
3593
2473
            bzr whoami "Frank Chu <fchu@example.com>"
3594
2474
    """
3595
 
    takes_options = [ 'directory',
3596
 
                      Option('email',
 
2475
    takes_options = [ Option('email',
3597
2476
                             help='Display email address only.'),
3598
2477
                      Option('branch',
3599
2478
                             help='Set identity for the current branch instead of '
3601
2480
                    ]
3602
2481
    takes_args = ['name?']
3603
2482
    encoding_type = 'replace'
3604
 
 
 
2483
    
3605
2484
    @display_command
3606
 
    def run(self, email=False, branch=False, name=None, directory=None):
 
2485
    def run(self, email=False, branch=False, name=None):
3607
2486
        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()
 
2487
            # use branch if we're inside one; otherwise global config
 
2488
            try:
 
2489
                c = Branch.open_containing('.')[0].get_config()
 
2490
            except errors.NotBranchError:
 
2491
                c = config.GlobalConfig()
3616
2492
            if email:
3617
2493
                self.outf.write(c.user_email() + '\n')
3618
2494
            else:
3619
2495
                self.outf.write(c.username() + '\n')
3620
2496
            return
3621
2497
 
3622
 
        if email:
3623
 
            raise errors.BzrCommandError(gettext("--email can only be used to display existing "
3624
 
                                         "identity"))
3625
 
 
3626
2498
        # display a warning if an email address isn't included in the given name.
3627
2499
        try:
3628
 
            _mod_config.extract_email_address(name)
 
2500
            config.extract_email_address(name)
3629
2501
        except errors.NoEmailInUsername, e:
3630
2502
            warning('"%s" does not seem to contain an email address.  '
3631
2503
                    'This is allowed, but not recommended.', name)
3632
 
 
 
2504
        
3633
2505
        # use global config unless --branch given
3634
2506
        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()
 
2507
            c = Branch.open_containing('.')[0].get_config()
3639
2508
        else:
3640
 
            c = _mod_config.GlobalConfig()
 
2509
            c = config.GlobalConfig()
3641
2510
        c.set_user_option('email', name)
3642
2511
 
3643
2512
 
3644
2513
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.
 
2514
    """Print or set the branch nickname.  
 
2515
 
 
2516
    If unset, the tree root directory name is used as the nickname
 
2517
    To print the current nickname, execute with no argument.  
3652
2518
    """
3653
2519
 
3654
2520
    _see_also = ['info']
3655
2521
    takes_args = ['nickname?']
3656
 
    takes_options = ['directory']
3657
 
    def run(self, nickname=None, directory=u'.'):
3658
 
        branch = Branch.open_containing(directory)[0]
 
2522
    def run(self, nickname=None):
 
2523
        branch = Branch.open_containing(u'.')[0]
3659
2524
        if nickname is None:
3660
2525
            self.printme(branch)
3661
2526
        else:
3663
2528
 
3664
2529
    @display_command
3665
2530
    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)
 
2531
        print branch.nick
3737
2532
 
3738
2533
 
3739
2534
class cmd_selftest(Command):
3740
 
    __doc__ = """Run internal test suite.
3741
 
 
 
2535
    """Run internal test suite.
 
2536
    
3742
2537
    If arguments are given, they are regular expressions that say which tests
3743
2538
    should run.  Tests matching any expression are run, and other tests are
3744
2539
    not run.
3767
2562
    modified by plugins will not be tested, and tests provided by plugins will
3768
2563
    not be run.
3769
2564
 
3770
 
    Tests that need working space on disk use a common temporary directory,
 
2565
    Tests that need working space on disk use a common temporary directory, 
3771
2566
    typically inside $TMPDIR or /tmp.
3772
2567
 
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
2568
    :Examples:
3780
2569
        Run only tests relating to 'ignore'::
3781
2570
 
3790
2579
    def get_transport_type(typestring):
3791
2580
        """Parse and return a transport specifier."""
3792
2581
        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
 
2582
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2583
            return SFTPAbsoluteServer
 
2584
        if typestring == "memory":
 
2585
            from bzrlib.transport.memory import MemoryServer
 
2586
            return MemoryServer
 
2587
        if typestring == "fakenfs":
 
2588
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2589
            return FakeNFSServer
3801
2590
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3802
2591
            (typestring)
3803
2592
        raise errors.BzrCommandError(msg)
3814
2603
                                 'throughout the test suite.',
3815
2604
                            type=get_transport_type),
3816
2605
                     Option('benchmark',
3817
 
                            help='Run the benchmarks rather than selftests.',
3818
 
                            hidden=True),
 
2606
                            help='Run the benchmarks rather than selftests.'),
3819
2607
                     Option('lsprof-timed',
3820
2608
                            help='Generate lsprof output for benchmarked'
3821
2609
                                 ' sections of code.'),
3822
 
                     Option('lsprof-tests',
3823
 
                            help='Generate lsprof output for each test.'),
 
2610
                     Option('cache-dir', type=str,
 
2611
                            help='Cache intermediate benchmark output in this '
 
2612
                                 'directory.'),
3824
2613
                     Option('first',
3825
2614
                            help='Run all tests, but run specified tests first.',
3826
2615
                            short_name='f',
3827
2616
                            ),
3828
2617
                     Option('list-only',
3829
2618
                            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
2619
                     Option('randomize', type=str, argname="SEED",
3836
2620
                            help='Randomize the order of tests using the given'
3837
2621
                                 ' 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.'),
 
2622
                     Option('exclude', type=str, argname="PATTERN",
 
2623
                            short_name='x',
 
2624
                            help='Exclude tests that match this regular'
 
2625
                                 ' expression.'),
3844
2626
                     Option('strict', help='Fail on missing dependencies or '
3845
2627
                            'known failures.'),
3846
2628
                     Option('load-list', type=str, argname='TESTLISTFILE',
3847
2629
                            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
2630
                     ]
3858
2631
    encoding_type = 'replace'
3859
2632
 
3860
 
    def __init__(self):
3861
 
        Command.__init__(self)
3862
 
        self.additional_selftest_args = {}
3863
 
 
3864
2633
    def run(self, testspecs_list=None, verbose=False, one=False,
3865
2634
            transport=None, benchmark=None,
3866
 
            lsprof_timed=None,
 
2635
            lsprof_timed=None, cache_dir=None,
3867
2636
            first=False, list_only=False,
3868
2637
            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
 
2638
            load_list=None):
 
2639
        import bzrlib.ui
 
2640
        from bzrlib.tests import selftest
 
2641
        import bzrlib.benchmarks as benchmarks
 
2642
        from bzrlib.benchmarks import tree_creator
3873
2643
 
 
2644
        if cache_dir is not None:
 
2645
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2646
        if not list_only:
 
2647
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2648
            print '   %s (%s python%s)' % (
 
2649
                    bzrlib.__path__[0],
 
2650
                    bzrlib.version_string,
 
2651
                    '.'.join(map(str, sys.version_info)),
 
2652
                    )
 
2653
        print
3874
2654
        if testspecs_list is not None:
3875
2655
            pattern = '|'.join(testspecs_list)
3876
2656
        else:
3877
2657
            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
2658
        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
 
2659
            test_suite_factory = benchmarks.test_suite
 
2660
            # Unless user explicitly asks for quiet, be verbose in benchmarks
 
2661
            verbose = not is_quiet()
 
2662
            # TODO: should possibly lock the history file...
 
2663
            benchfile = open(".perf_history", "at", buffering=1)
3904
2664
        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)
 
2665
            test_suite_factory = None
 
2666
            benchfile = None
3929
2667
        try:
3930
 
            result = tests.selftest(**selftest_kwargs)
 
2668
            result = selftest(verbose=verbose,
 
2669
                              pattern=pattern,
 
2670
                              stop_on_failure=one,
 
2671
                              transport=transport,
 
2672
                              test_suite_factory=test_suite_factory,
 
2673
                              lsprof_timed=lsprof_timed,
 
2674
                              bench_history=benchfile,
 
2675
                              matching_tests_first=first,
 
2676
                              list_only=list_only,
 
2677
                              random_seed=randomize,
 
2678
                              exclude_pattern=exclude,
 
2679
                              strict=strict,
 
2680
                              load_list=load_list,
 
2681
                              )
3931
2682
        finally:
3932
 
            cleanup()
 
2683
            if benchfile is not None:
 
2684
                benchfile.close()
 
2685
        if result:
 
2686
            note('tests passed')
 
2687
        else:
 
2688
            note('tests failed')
3933
2689
        return int(not result)
3934
2690
 
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
2691
 
3945
2692
class cmd_version(Command):
3946
 
    __doc__ = """Show version of bzr."""
 
2693
    """Show version of bzr."""
3947
2694
 
3948
2695
    encoding_type = 'replace'
3949
 
    takes_options = [
3950
 
        Option("short", help="Print just the version number."),
3951
 
        ]
3952
2696
 
3953
2697
    @display_command
3954
 
    def run(self, short=False):
 
2698
    def run(self):
3955
2699
        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)
 
2700
        show_version(to_file=self.outf)
3960
2701
 
3961
2702
 
3962
2703
class cmd_rocks(Command):
3963
 
    __doc__ = """Statement of optimism."""
 
2704
    """Statement of optimism."""
3964
2705
 
3965
2706
    hidden = True
3966
2707
 
3967
2708
    @display_command
3968
2709
    def run(self):
3969
 
        self.outf.write(gettext("It sure does!\n"))
 
2710
        print "It sure does!"
3970
2711
 
3971
2712
 
3972
2713
class cmd_find_merge_base(Command):
3973
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
2714
    """Find and print a base revision for merging two branches."""
3974
2715
    # TODO: Options to specify revisions on either side, as if
3975
2716
    #       merging only part of the history.
3976
2717
    takes_args = ['branch', 'other']
3977
2718
    hidden = True
3978
 
 
 
2719
    
3979
2720
    @display_command
3980
2721
    def run(self, branch, other):
3981
2722
        from bzrlib.revision import ensure_null
3982
 
 
 
2723
        
3983
2724
        branch1 = Branch.open_containing(branch)[0]
3984
2725
        branch2 = Branch.open_containing(other)[0]
3985
 
        self.add_cleanup(branch1.lock_read().unlock)
3986
 
        self.add_cleanup(branch2.lock_read().unlock)
3987
 
        last1 = ensure_null(branch1.last_revision())
3988
 
        last2 = ensure_null(branch2.last_revision())
3989
 
 
3990
 
        graph = branch1.repository.get_graph(branch2.repository)
3991
 
        base_rev_id = graph.find_unique_lca(last1, last2)
3992
 
 
3993
 
        self.outf.write(gettext('merge base is revision %s\n') % base_rev_id)
 
2726
        branch1.lock_read()
 
2727
        try:
 
2728
            branch2.lock_read()
 
2729
            try:
 
2730
                last1 = ensure_null(branch1.last_revision())
 
2731
                last2 = ensure_null(branch2.last_revision())
 
2732
 
 
2733
                graph = branch1.repository.get_graph(branch2.repository)
 
2734
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2735
 
 
2736
                print 'merge base is revision %s' % base_rev_id
 
2737
            finally:
 
2738
                branch2.unlock()
 
2739
        finally:
 
2740
            branch1.unlock()
3994
2741
 
3995
2742
 
3996
2743
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
 
 
 
2744
    """Perform a three-way merge.
 
2745
    
 
2746
    The branch is the branch you will merge from.  By default, it will merge
 
2747
    the latest revision.  If you specify a revision, that revision will be
 
2748
    merged.  If you specify two revisions, the first will be used as a BASE,
 
2749
    and the second one as OTHER.  Revision numbers are always relative to the
 
2750
    specified branch.
 
2751
 
 
2752
    By default, bzr will try to merge in all new work from the other
 
2753
    branch, automatically determining an appropriate base.  If this
 
2754
    fails, you may need to give an explicit base.
 
2755
    
4024
2756
    Merge will do its best to combine the changes in two branches, but there
4025
2757
    are some kinds of problems only a human can fix.  When it encounters those,
4026
2758
    it will mark a conflict.  A conflict means that you need to fix something,
4028
2760
 
4029
2761
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
4030
2762
 
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.
 
2763
    If there is no default branch set, the first merge will set it. After
 
2764
    that, you can omit the branch to use the default.  To change the
 
2765
    default, use --remember. The value will only be saved if the remote
 
2766
    location can be accessed.
4035
2767
 
4036
2768
    The results of the merge are placed into the destination working
4037
2769
    directory, where they can be reviewed (with bzr diff), tested, and then
4038
2770
    committed to record the result of the merge.
4039
 
 
 
2771
    
4040
2772
    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".
 
2773
    --force is given.
4052
2774
 
4053
2775
    :Examples:
4054
 
        To merge all new revisions from bzr.dev::
 
2776
        To merge the latest revision from bzr.dev::
4055
2777
 
4056
2778
            bzr merge ../bzr.dev
4057
2779
 
4062
2784
        To merge the changes introduced by 82, without previous changes::
4063
2785
 
4064
2786
            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
2787
    """
4077
2788
 
4078
2789
    encoding_type = 'exact'
4079
 
    _see_also = ['update', 'remerge', 'status-flags', 'send']
4080
 
    takes_args = ['location?']
 
2790
    _see_also = ['update', 'remerge', 'status-flags']
 
2791
    takes_args = ['branch?']
4081
2792
    takes_options = [
4082
2793
        'change',
4083
2794
        'revision',
4094
2805
                ' completely merged into the source, pull from the'
4095
2806
                ' source rather than merging.  When this happens,'
4096
2807
                ' you do not need to commit the result.'),
4097
 
        custom_help('directory',
 
2808
        Option('directory',
4098
2809
               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')
 
2810
                    'rather than the one containing the working directory.',
 
2811
               short_name='d',
 
2812
               type=unicode,
 
2813
               ),
 
2814
        Option('preview', help='Instead of merging, show a diff of the merge.')
4104
2815
    ]
4105
2816
 
4106
 
    def run(self, location=None, revision=None, force=False,
4107
 
            merge_type=None, show_base=False, reprocess=None, remember=None,
 
2817
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
2818
            show_base=False, reprocess=False, remember=False,
4108
2819
            uncommitted=False, pull=False,
4109
2820
            directory=None,
4110
2821
            preview=False,
4111
 
            interactive=False,
4112
2822
            ):
 
2823
        # This is actually a branch (or merge-directive) *location*.
 
2824
        location = branch
 
2825
        del branch
 
2826
 
4113
2827
        if merge_type is None:
4114
2828
            merge_type = _mod_merge.Merge3Merger
4115
2829
 
4118
2832
        merger = None
4119
2833
        allow_pending = True
4120
2834
        verified = 'inapplicable'
4121
 
 
4122
2835
        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
 
 
 
2836
        change_reporter = delta._ChangeReporter(
 
2837
            unversioned_filter=tree.is_ignored)
 
2838
        cleanups = []
4127
2839
        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
 
        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
 
2840
            pb = ui.ui_factory.nested_progress_bar()
 
2841
            cleanups.append(pb.finished)
 
2842
            tree.lock_write()
 
2843
            cleanups.append(tree.unlock)
 
2844
            if location is not None:
 
2845
                mergeable, other_transport = _get_mergeable_helper(location)
 
2846
                if mergeable:
 
2847
                    if uncommitted:
 
2848
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2849
                            ' with bundles or merge directives.')
 
2850
 
 
2851
                    if revision is not None:
 
2852
                        raise errors.BzrCommandError(
 
2853
                            'Cannot use -r with merge directives or bundles')
 
2854
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2855
                       mergeable, pb)
 
2856
                possible_transports.append(other_transport)
 
2857
 
 
2858
            if merger is None and uncommitted:
 
2859
                if revision is not None and len(revision) > 0:
 
2860
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2861
                        ' --revision at the same time.')
 
2862
                location = self._select_branch_location(tree, location)[0]
 
2863
                other_tree, other_path = WorkingTree.open_containing(location)
 
2864
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2865
                    pb)
 
2866
                allow_pending = False
 
2867
                if other_path != '':
 
2868
                    merger.interesting_files = [other_path]
 
2869
 
 
2870
            if merger is None:
 
2871
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2872
                    location, revision, remember, possible_transports, pb)
 
2873
 
 
2874
            merger.merge_type = merge_type
 
2875
            merger.reprocess = reprocess
 
2876
            merger.show_base = show_base
 
2877
            self.sanity_check_merger(merger)
 
2878
            if (merger.base_rev_id == merger.other_rev_id and
 
2879
                merger.other_rev_id != None):
 
2880
                note('Nothing to do.')
 
2881
                return 0
 
2882
            if pull:
 
2883
                if merger.interesting_files is not None:
 
2884
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2885
                if (merger.base_rev_id == tree.last_revision()):
 
2886
                    result = tree.pull(merger.other_branch, False,
 
2887
                                       merger.other_rev_id)
 
2888
                    result.report(self.outf)
 
2889
                    return 0
 
2890
            merger.check_basis(not force)
 
2891
            if preview:
 
2892
                return self._do_preview(merger)
4149
2893
            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
 
                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):
 
2894
                return self._do_merge(merger, change_reporter, allow_pending,
 
2895
                                      verified)
 
2896
        finally:
 
2897
            for cleanup in reversed(cleanups):
 
2898
                cleanup()
 
2899
 
 
2900
    def _do_preview(self, merger):
 
2901
        from bzrlib.diff import show_diff_trees
4207
2902
        tree_merger = merger.make_merger()
4208
2903
        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)
 
2904
        try:
 
2905
            result_tree = tt.get_preview_tree()
 
2906
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2907
                            old_label='', new_label='')
 
2908
        finally:
 
2909
            tt.finalize()
4220
2910
 
4221
2911
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
4222
2912
        merger.change_reporter = change_reporter
4230
2920
        else:
4231
2921
            return 0
4232
2922
 
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
 
        finally:
4249
 
            shelver.finalize()
4250
 
 
4251
2923
    def sanity_check_merger(self, merger):
4252
2924
        if (merger.show_base and
4253
2925
            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
 
2926
            raise errors.BzrCommandError("Show-base is not supported for this"
 
2927
                                         " merge type. %s" % merger.merge_type)
4262
2928
        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.") %
 
2929
            raise errors.BzrCommandError("Conflict reduction is not supported"
 
2930
                                         " for merge type %s." %
4265
2931
                                         merger.merge_type)
4266
2932
        if merger.reprocess and merger.show_base:
4267
 
            raise errors.BzrCommandError(gettext("Cannot do conflict reduction and"
4268
 
                                         " show base."))
 
2933
            raise errors.BzrCommandError("Cannot do conflict reduction and"
 
2934
                                         " show base.")
4269
2935
 
4270
2936
    def _get_merger_from_branch(self, tree, location, revision, remember,
4271
2937
                                possible_transports, pb):
4272
2938
        """Produce a merger from a location, assuming it refers to a branch."""
4273
2939
        from bzrlib.tag import _merge_tags_if_possible
 
2940
        assert revision is None or len(revision) < 3
4274
2941
        # find the branch locations
4275
2942
        other_loc, user_location = self._select_branch_location(tree, location,
4276
2943
            revision, -1)
4288
2955
            base_branch, base_path = Branch.open_containing(base_loc,
4289
2956
                possible_transports)
4290
2957
        # 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:
 
2958
        if revision is None or len(revision) < 1 or revision[-1] is None:
4299
2959
            other_revision_id = _mod_revision.ensure_null(
4300
2960
                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)))):
 
2961
        else:
 
2962
            other_revision_id = \
 
2963
                _mod_revision.ensure_null(
 
2964
                    revision[-1].in_history(other_branch).rev_id)
 
2965
        if (revision is not None and len(revision) == 2
 
2966
            and revision[0] is not None):
 
2967
            base_revision_id = \
 
2968
                _mod_revision.ensure_null(
 
2969
                    revision[0].in_history(base_branch).rev_id)
 
2970
        else:
 
2971
            base_revision_id = None
 
2972
        # Remember where we merge from
 
2973
        if ((remember or tree.branch.get_submit_branch() is None) and
 
2974
             user_location is not None):
4310
2975
            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)
 
2976
        _merge_tags_if_possible(other_branch, tree.branch)
4314
2977
        merger = _mod_merge.Merger.from_revision_ids(pb, tree,
4315
2978
            other_revision_id, base_revision_id, other_branch, base_branch)
4316
2979
        if other_path != '':
4320
2983
            allow_pending = True
4321
2984
        return merger, allow_pending
4322
2985
 
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
2986
    def _select_branch_location(self, tree, user_location, revision=None,
4338
2987
                                index=None):
4339
2988
        """Select a branch location, according to possible inputs.
4369
3018
        Report if the remembered location was used.
4370
3019
        """
4371
3020
        stored_location = tree.branch.get_submit_branch()
4372
 
        stored_location_type = "submit"
4373
3021
        if stored_location is None:
4374
3022
            stored_location = tree.branch.get_parent()
4375
 
            stored_location_type = "parent"
4376
3023
        mutter("%s", stored_location)
4377
3024
        if stored_location is None:
4378
 
            raise errors.BzrCommandError(gettext("No location specified or remembered"))
 
3025
            raise errors.BzrCommandError("No location specified or remembered")
4379
3026
        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))
 
3027
        note(u"%s remembered location %s", verb_string, display_url)
4382
3028
        return stored_location
4383
3029
 
4384
3030
 
4385
3031
class cmd_remerge(Command):
4386
 
    __doc__ = """Redo a merge.
 
3032
    """Redo a merge.
4387
3033
 
4388
3034
    Use this if you want to try a different merge technique while resolving
4389
 
    conflicts.  Some merge techniques are better than others, and remerge
 
3035
    conflicts.  Some merge techniques are better than others, and remerge 
4390
3036
    lets you try different ones on different files.
4391
3037
 
4392
3038
    The options for remerge have the same meaning and defaults as the ones for
4396
3042
    :Examples:
4397
3043
        Re-do the merge of all conflicted files, and show the base text in
4398
3044
        conflict regions, in addition to the usual THIS and OTHER texts::
4399
 
 
 
3045
      
4400
3046
            bzr remerge --show-base
4401
3047
 
4402
3048
        Re-do the merge of "foobar", using the weave merge algorithm, with
4403
3049
        additional processing to reduce the size of conflict regions::
4404
 
 
 
3050
      
4405
3051
            bzr remerge --merge-type weave --reprocess foobar
4406
3052
    """
4407
3053
    takes_args = ['file*']
4414
3060
 
4415
3061
    def run(self, file_list=None, merge_type=None, show_base=False,
4416
3062
            reprocess=False):
4417
 
        from bzrlib.conflicts import restore
4418
3063
        if merge_type is None:
4419
3064
            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:
 
3065
        tree, file_list = tree_files(file_list)
 
3066
        tree.lock_write()
 
3067
        try:
 
3068
            parents = tree.get_parent_ids()
 
3069
            if len(parents) != 2:
 
3070
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3071
                                             " merges.  Not cherrypicking or"
 
3072
                                             " multi-merges.")
 
3073
            repository = tree.branch.repository
 
3074
            interesting_ids = None
 
3075
            new_conflicts = []
 
3076
            conflicts = tree.conflicts()
 
3077
            if file_list is not None:
 
3078
                interesting_ids = set()
 
3079
                for filename in file_list:
 
3080
                    file_id = tree.path2id(filename)
 
3081
                    if file_id is None:
 
3082
                        raise errors.NotVersionedError(filename)
 
3083
                    interesting_ids.add(file_id)
 
3084
                    if tree.kind(file_id) != "directory":
 
3085
                        continue
 
3086
                    
 
3087
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3088
                        interesting_ids.add(ie.file_id)
 
3089
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3090
            else:
 
3091
                # Remerge only supports resolving contents conflicts
 
3092
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3093
                restore_files = [c.path for c in conflicts
 
3094
                                 if c.typestring in allowed_conflicts]
 
3095
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3096
            tree.set_conflicts(ConflictList(new_conflicts))
 
3097
            if file_list is not None:
 
3098
                restore_files = file_list
 
3099
            for filename in restore_files:
 
3100
                try:
 
3101
                    restore(tree.abspath(filename))
 
3102
                except errors.NotConflicted:
 
3103
                    pass
 
3104
            # Disable pending merges, because the file texts we are remerging
 
3105
            # have not had those merges performed.  If we use the wrong parents
 
3106
            # list, we imply that the working tree text has seen and rejected
 
3107
            # all the changes from the other tree, when in fact those changes
 
3108
            # have not yet been seen.
 
3109
            pb = ui.ui_factory.nested_progress_bar()
 
3110
            tree.set_parent_ids(parents[:1])
4454
3111
            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()
 
3112
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3113
                                                             tree, parents[1])
 
3114
                merger.interesting_ids = interesting_ids
 
3115
                merger.merge_type = merge_type
 
3116
                merger.show_base = show_base
 
3117
                merger.reprocess = reprocess
 
3118
                conflicts = merger.do_merge()
 
3119
            finally:
 
3120
                tree.set_parent_ids(parents)
 
3121
                pb.finished()
4471
3122
        finally:
4472
 
            tree.set_parent_ids(parents)
 
3123
            tree.unlock()
4473
3124
        if conflicts > 0:
4474
3125
            return 1
4475
3126
        else:
4477
3128
 
4478
3129
 
4479
3130
class cmd_revert(Command):
4480
 
    __doc__ = """Revert files to a previous revision.
 
3131
    """Revert files to a previous revision.
4481
3132
 
4482
3133
    Giving a list of files will revert only those files.  Otherwise, all files
4483
3134
    will be reverted.  If the revision is not specified with '--revision', the
4484
3135
    last committed revision is used.
4485
3136
 
4486
3137
    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
 
 
 
3138
    merge instead.  For example, "merge . --revision -2..-3" will remove the
 
3139
    changes introduced by -2, without affecting the changes introduced by -1.
 
3140
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
 
3141
    
4492
3142
    By default, any files that have been manually changed will be backed up
4493
3143
    first.  (Files changed only by merge are not backed up.)  Backup files have
4494
3144
    '.~#~' appended to their name, where # is a number.
4498
3148
    name.  If you name a directory, all the contents of that directory will be
4499
3149
    reverted.
4500
3150
 
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.
 
3151
    Any files that have been newly added since that revision will be deleted,
 
3152
    with a backup kept if appropriate.  Directories containing unknown files
 
3153
    will not be deleted.
4505
3154
 
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
 
3155
    The working tree contains a list of pending merged revisions, which will
 
3156
    be included as parents in the next commit.  Normally, revert clears that
 
3157
    list as well as reverting the files.  If any files are specified, revert
 
3158
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3159
    revert ." in the tree root to revert all files but keep the merge record,
 
3160
    and "bzr revert --forget-merges" to clear the pending merge list without
4513
3161
    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
3162
    """
4525
3163
 
4526
 
    _see_also = ['cat', 'export', 'merge', 'shelve']
 
3164
    _see_also = ['cat', 'export']
4527
3165
    takes_options = [
4528
3166
        'revision',
4529
3167
        Option('no-backup', "Do not save backups of reverted files."),
4534
3172
 
4535
3173
    def run(self, revision=None, no_backup=False, file_list=None,
4536
3174
            forget_merges=None):
4537
 
        tree, file_list = WorkingTree.open_containing_paths(file_list)
4538
 
        self.add_cleanup(tree.lock_tree_write().unlock)
 
3175
        tree, file_list = tree_files(file_list)
4539
3176
        if forget_merges:
4540
3177
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4541
3178
        else:
4543
3180
 
4544
3181
    @staticmethod
4545
3182
    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)
 
3183
        if revision is None:
 
3184
            rev_id = tree.last_revision()
 
3185
        elif len(revision) != 1:
 
3186
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3187
        else:
 
3188
            rev_id = revision[0].in_history(tree.branch).rev_id
 
3189
        pb = ui.ui_factory.nested_progress_bar()
 
3190
        try:
 
3191
            tree.revert(file_list,
 
3192
                        tree.branch.repository.revision_tree(rev_id),
 
3193
                        not no_backup, pb, report_changes=True)
 
3194
        finally:
 
3195
            pb.finished()
4549
3196
 
4550
3197
 
4551
3198
class cmd_assert_fail(Command):
4552
 
    __doc__ = """Test reporting of assertion failures"""
 
3199
    """Test reporting of assertion failures"""
4553
3200
    # intended just for use in testing
4554
3201
 
4555
3202
    hidden = True
4559
3206
 
4560
3207
 
4561
3208
class cmd_help(Command):
4562
 
    __doc__ = """Show help on a command or other topic.
 
3209
    """Show help on a command or other topic.
4563
3210
    """
4564
3211
 
4565
3212
    _see_also = ['topics']
4568
3215
            ]
4569
3216
    takes_args = ['topic?']
4570
3217
    aliases = ['?', '--help', '-?', '-h']
4571
 
 
 
3218
    
4572
3219
    @display_command
4573
3220
    def run(self, topic=None, long=False):
4574
3221
        import bzrlib.help
4578
3225
 
4579
3226
 
4580
3227
class cmd_shell_complete(Command):
4581
 
    __doc__ = """Show appropriate completions for context.
 
3228
    """Show appropriate completions for context.
4582
3229
 
4583
3230
    For a list of all available commands, say 'bzr shell-complete'.
4584
3231
    """
4585
3232
    takes_args = ['context?']
4586
3233
    aliases = ['s-c']
4587
3234
    hidden = True
4588
 
 
 
3235
    
4589
3236
    @display_command
4590
3237
    def run(self, context=None):
4591
3238
        import shellcomplete
4592
3239
        shellcomplete.shellcomplete(context)
4593
3240
 
4594
3241
 
 
3242
class cmd_fetch(Command):
 
3243
    """Copy in history from another branch but don't merge it.
 
3244
 
 
3245
    This is an internal method used for pull and merge.
 
3246
    """
 
3247
    hidden = True
 
3248
    takes_args = ['from_branch', 'to_branch']
 
3249
    def run(self, from_branch, to_branch):
 
3250
        from bzrlib.fetch import Fetcher
 
3251
        from_b = Branch.open(from_branch)
 
3252
        to_b = Branch.open(to_branch)
 
3253
        Fetcher(to_b, from_b)
 
3254
 
 
3255
 
4595
3256
class cmd_missing(Command):
4596
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4597
 
 
 
3257
    """Show unmerged/unpulled revisions between two branches.
 
3258
    
4598
3259
    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
3260
    """
4629
3261
 
4630
3262
    _see_also = ['merge', 'pull']
4631
3263
    takes_args = ['other_branch?']
4632
3264
    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
 
        ]
 
3265
            Option('reverse', 'Reverse the order of revisions.'),
 
3266
            Option('mine-only',
 
3267
                   'Display changes in the local branch only.'),
 
3268
            Option('this' , 'Same as --mine-only.'),
 
3269
            Option('theirs-only',
 
3270
                   'Display changes in the remote branch only.'),
 
3271
            Option('other', 'Same as --theirs-only.'),
 
3272
            'log-format',
 
3273
            'show-ids',
 
3274
            'verbose'
 
3275
            ]
4656
3276
    encoding_type = 'replace'
4657
3277
 
4658
3278
    @display_command
4659
3279
    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):
 
3280
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3281
            show_ids=False, verbose=False, this=False, other=False):
4666
3282
        from bzrlib.missing import find_unmerged, iter_log_revisions
4667
 
        def message(s):
4668
 
            if not is_quiet():
4669
 
                self.outf.write(s)
4670
3283
 
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
3284
        if this:
4687
 
            mine_only = this
 
3285
          mine_only = this
4688
3286
        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
 
 
 
3287
          theirs_only = other
 
3288
 
 
3289
        local_branch = Branch.open_containing(u".")[0]
4702
3290
        parent = local_branch.get_parent()
4703
3291
        if other_branch is None:
4704
3292
            other_branch = parent
4705
3293
            if other_branch is None:
4706
 
                raise errors.BzrCommandError(gettext("No peer location known"
4707
 
                                             " or specified."))
 
3294
                raise errors.BzrCommandError("No peer location known"
 
3295
                                             " or specified.")
4708
3296
            display_url = urlutils.unescape_for_display(parent,
4709
3297
                                                        self.outf.encoding)
4710
 
            message(gettext("Using saved parent location: {0}\n").format(
4711
 
                    display_url))
 
3298
            self.outf.write("Using last location: " + display_url + "\n")
4712
3299
 
4713
3300
        remote_branch = Branch.open(other_branch)
4714
3301
        if remote_branch.base == local_branch.base:
4715
3302
            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()
 
3303
        local_branch.lock_read()
 
3304
        try:
 
3305
            remote_branch.lock_read()
 
3306
            try:
 
3307
                local_extra, remote_extra = find_unmerged(local_branch,
 
3308
                                                          remote_branch)
 
3309
                if log_format is None:
 
3310
                    registry = log.log_formatter_registry
 
3311
                    log_format = registry.get_default(local_branch)
 
3312
                lf = log_format(to_file=self.outf,
 
3313
                                show_ids=show_ids,
 
3314
                                show_timezone='original')
 
3315
                if reverse is False:
 
3316
                    local_extra.reverse()
 
3317
                    remote_extra.reverse()
 
3318
                if local_extra and not theirs_only:
 
3319
                    self.outf.write("You have %d extra revision(s):\n" %
 
3320
                                    len(local_extra))
 
3321
                    for revision in iter_log_revisions(local_extra,
 
3322
                                        local_branch.repository,
 
3323
                                        verbose):
 
3324
                        lf.log_revision(revision)
 
3325
                    printed_local = True
 
3326
                else:
 
3327
                    printed_local = False
 
3328
                if remote_extra and not mine_only:
 
3329
                    if printed_local is True:
 
3330
                        self.outf.write("\n\n\n")
 
3331
                    self.outf.write("You are missing %d revision(s):\n" %
 
3332
                                    len(remote_extra))
 
3333
                    for revision in iter_log_revisions(remote_extra,
 
3334
                                        remote_branch.repository,
 
3335
                                        verbose):
 
3336
                        lf.log_revision(revision)
 
3337
                if not remote_extra and not local_extra:
 
3338
                    status_code = 0
 
3339
                    self.outf.write("Branches are up to date.\n")
 
3340
                else:
 
3341
                    status_code = 1
 
3342
            finally:
 
3343
                remote_branch.unlock()
 
3344
        finally:
 
3345
            local_branch.unlock()
4781
3346
        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)
 
3347
            local_branch.lock_write()
 
3348
            try:
 
3349
                # handle race conditions - a parent might be set while we run.
 
3350
                if local_branch.get_parent() is None:
 
3351
                    local_branch.set_parent(remote_branch.base)
 
3352
            finally:
 
3353
                local_branch.unlock()
4786
3354
        return status_code
4787
3355
 
4788
3356
 
4789
3357
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
 
    """
 
3358
    """Compress the data within a repository."""
4807
3359
 
4808
3360
    _see_also = ['repositories']
4809
3361
    takes_args = ['branch_or_repo?']
4810
 
    takes_options = [
4811
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4812
 
        ]
4813
3362
 
4814
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
3363
    def run(self, branch_or_repo='.'):
4815
3364
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4816
3365
        try:
4817
3366
            branch = dir.open_branch()
4818
3367
            repository = branch.repository
4819
3368
        except errors.NotBranchError:
4820
3369
            repository = dir.open_repository()
4821
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
3370
        repository.pack()
4822
3371
 
4823
3372
 
4824
3373
class cmd_plugins(Command):
4825
 
    __doc__ = """List the installed plugins.
4826
 
 
 
3374
    """List the installed plugins.
 
3375
    
4827
3376
    This command displays the list of installed plugins including
4828
3377
    version of plugin and a short description of each.
4829
3378
 
4835
3384
    adding new commands, providing additional network transports and
4836
3385
    customizing log output.
4837
3386
 
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.
 
3387
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3388
    information on plugins including where to find them and how to
 
3389
    install them. Instructions are also provided there on how to
 
3390
    write new plugins using the Python programming language.
4842
3391
    """
4843
3392
    takes_options = ['verbose']
4844
3393
 
4845
3394
    @display_command
4846
3395
    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)))
 
3396
        import bzrlib.plugin
 
3397
        from inspect import getdoc
 
3398
        result = []
 
3399
        for name, plugin in bzrlib.plugin.plugins().items():
 
3400
            version = plugin.__version__
 
3401
            if version == 'unknown':
 
3402
                version = ''
 
3403
            name_ver = '%s %s' % (name, version)
 
3404
            d = getdoc(plugin.module)
 
3405
            if d:
 
3406
                doc = d.split('\n')[0]
 
3407
            else:
 
3408
                doc = '(no description)'
 
3409
            result.append((name_ver, doc, plugin.path()))
 
3410
        for name_ver, doc, path in sorted(result):
 
3411
            print name_ver
 
3412
            print '   ', doc
 
3413
            if verbose:
 
3414
                print '   ', path
 
3415
            print
4851
3416
 
4852
3417
 
4853
3418
class cmd_testament(Command):
4854
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
3419
    """Show testament (signing-form) of a revision."""
4855
3420
    takes_options = [
4856
3421
            'revision',
4857
3422
            Option('long', help='Produce long-format testament.'),
4865
3430
            testament_class = StrictTestament
4866
3431
        else:
4867
3432
            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())
 
3433
        b = WorkingTree.open_containing(branch)[0].branch
 
3434
        b.lock_read()
 
3435
        try:
 
3436
            if revision is None:
 
3437
                rev_id = b.last_revision()
 
3438
            else:
 
3439
                rev_id = revision[0].in_history(b).rev_id
 
3440
            t = testament_class.from_revision(b.repository, rev_id)
 
3441
            if long:
 
3442
                sys.stdout.writelines(t.as_text_lines())
 
3443
            else:
 
3444
                sys.stdout.write(t.as_short_text())
 
3445
        finally:
 
3446
            b.unlock()
4882
3447
 
4883
3448
 
4884
3449
class cmd_annotate(Command):
4885
 
    __doc__ = """Show the origin of each line in a file.
 
3450
    """Show the origin of each line in a file.
4886
3451
 
4887
3452
    This prints out the given file with an annotation on the left side
4888
3453
    indicating which revision, author and date introduced the change.
4889
3454
 
4890
 
    If the origin is the same for a run of consecutive lines, it is
 
3455
    If the origin is the same for a run of consecutive lines, it is 
4891
3456
    shown only at the top, unless the --all option is given.
4892
3457
    """
4893
3458
    # TODO: annotate directories; showing when each file was last changed
4894
 
    # TODO: if the working copy is modified, show annotations on that
 
3459
    # TODO: if the working copy is modified, show annotations on that 
4895
3460
    #       with new uncommitted lines marked
4896
3461
    aliases = ['ann', 'blame', 'praise']
4897
3462
    takes_args = ['filename']
4899
3464
                     Option('long', help='Show commit date in annotations.'),
4900
3465
                     'revision',
4901
3466
                     'show-ids',
4902
 
                     'directory',
4903
3467
                     ]
4904
3468
    encoding_type = 'exact'
4905
3469
 
4906
3470
    @display_command
4907
3471
    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
 
            )
 
3472
            show_ids=False):
 
3473
        from bzrlib.annotate import annotate_file
4912
3474
        wt, branch, relpath = \
4913
 
            _open_directory_or_containing_tree_or_branch(filename, directory)
 
3475
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
4914
3476
        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:
4923
 
            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)
 
3477
            wt.lock_read()
 
3478
        else:
 
3479
            branch.lock_read()
 
3480
        try:
 
3481
            if revision is None:
 
3482
                revision_id = branch.last_revision()
 
3483
            elif len(revision) != 1:
 
3484
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3485
            else:
 
3486
                revision_id = revision[0].in_history(branch).rev_id
 
3487
            tree = branch.repository.revision_tree(revision_id)
 
3488
            if wt is not None:
 
3489
                file_id = wt.path2id(relpath)
 
3490
            else:
 
3491
                file_id = tree.path2id(relpath)
 
3492
            if file_id is None:
 
3493
                raise errors.NotVersionedError(filename)
 
3494
            file_version = tree.inventory[file_id].revision
 
3495
            annotate_file(branch, file_version, file_id, long, all, self.outf,
 
3496
                          show_ids=show_ids)
 
3497
        finally:
 
3498
            if wt is not None:
 
3499
                wt.unlock()
 
3500
            else:
 
3501
                branch.unlock()
4934
3502
 
4935
3503
 
4936
3504
class cmd_re_sign(Command):
4937
 
    __doc__ = """Create a digital signature for an existing revision."""
 
3505
    """Create a digital signature for an existing revision."""
4938
3506
    # TODO be able to replace existing ones.
4939
3507
 
4940
3508
    hidden = True # is this right ?
4941
3509
    takes_args = ['revision_id*']
4942
 
    takes_options = ['directory', 'revision']
4943
 
 
4944
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
3510
    takes_options = ['revision']
 
3511
    
 
3512
    def run(self, revision_id_list=None, revision=None):
4945
3513
        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'))
 
3514
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4947
3515
        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)
 
3516
            raise errors.BzrCommandError('You must supply either --revision or a revision_id')
 
3517
        b = WorkingTree.open_containing(u'.')[0].branch
 
3518
        b.lock_write()
 
3519
        try:
 
3520
            return self._run(b, revision_id_list, revision)
 
3521
        finally:
 
3522
            b.unlock()
4952
3523
 
4953
3524
    def _run(self, b, revision_id_list, revision):
4954
3525
        import bzrlib.gpg as gpg
4983
3554
                if to_revid is None:
4984
3555
                    to_revno = b.revno()
4985
3556
                if from_revno is None or to_revno is None:
4986
 
                    raise errors.BzrCommandError(gettext('Cannot sign a range of non-revision-history revisions'))
 
3557
                    raise errors.BzrCommandError('Cannot sign a range of non-revision-history revisions')
4987
3558
                b.repository.start_write_group()
4988
3559
                try:
4989
3560
                    for revno in range(from_revno, to_revno + 1):
4995
3566
                else:
4996
3567
                    b.repository.commit_write_group()
4997
3568
            else:
4998
 
                raise errors.BzrCommandError(gettext('Please supply either one revision, or a range.'))
 
3569
                raise errors.BzrCommandError('Please supply either one revision, or a range.')
4999
3570
 
5000
3571
 
5001
3572
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.
 
3573
    """Convert the current branch into a checkout of the supplied branch.
5004
3574
 
5005
3575
    Once converted into a checkout, commits must succeed on the master branch
5006
3576
    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
3577
    """
5012
3578
 
5013
3579
    _see_also = ['checkouts', 'unbind']
5014
3580
    takes_args = ['location?']
5015
 
    takes_options = ['directory']
 
3581
    takes_options = []
5016
3582
 
5017
 
    def run(self, location=None, directory=u'.'):
5018
 
        b, relpath = Branch.open_containing(directory)
 
3583
    def run(self, location=None):
 
3584
        b, relpath = Branch.open_containing(u'.')
5019
3585
        if location is None:
5020
3586
            try:
5021
3587
                location = b.get_old_bound_location()
5022
3588
            except errors.UpgradeRequired:
5023
 
                raise errors.BzrCommandError(gettext('No location supplied.  '
5024
 
                    'This format does not remember old locations.'))
 
3589
                raise errors.BzrCommandError('No location supplied.  '
 
3590
                    'This format does not remember old locations.')
5025
3591
            else:
5026
3592
                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'))
 
3593
                    raise errors.BzrCommandError('No location supplied and no '
 
3594
                        'previous location known')
5032
3595
        b_other = Branch.open(location)
5033
3596
        try:
5034
3597
            b.bind(b_other)
5035
3598
        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
 
3599
            raise errors.BzrCommandError('These branches have diverged.'
 
3600
                                         ' Try merging, and then bind again.')
5040
3601
 
5041
3602
 
5042
3603
class cmd_unbind(Command):
5043
 
    __doc__ = """Convert the current checkout into a regular branch.
 
3604
    """Convert the current checkout into a regular branch.
5044
3605
 
5045
3606
    After unbinding, the local branch is considered independent and subsequent
5046
3607
    commits will be local only.
5048
3609
 
5049
3610
    _see_also = ['checkouts', 'bind']
5050
3611
    takes_args = []
5051
 
    takes_options = ['directory']
 
3612
    takes_options = []
5052
3613
 
5053
 
    def run(self, directory=u'.'):
5054
 
        b, relpath = Branch.open_containing(directory)
 
3614
    def run(self):
 
3615
        b, relpath = Branch.open_containing(u'.')
5055
3616
        if not b.unbind():
5056
 
            raise errors.BzrCommandError(gettext('Local branch is not bound'))
 
3617
            raise errors.BzrCommandError('Local branch is not bound')
5057
3618
 
5058
3619
 
5059
3620
class cmd_uncommit(Command):
5060
 
    __doc__ = """Remove the last committed revision.
 
3621
    """Remove the last committed revision.
5061
3622
 
5062
3623
    --verbose will print out what is being removed.
5063
3624
    --dry-run will go through all the motions, but not actually
5067
3628
    specified revision.  For example, "bzr uncommit -r 15" will leave the
5068
3629
    branch at revision 15.
5069
3630
 
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.
 
3631
    In the future, uncommit will create a revision bundle, which can then
 
3632
    be re-applied.
5073
3633
    """
5074
3634
 
5075
3635
    # TODO: jam 20060108 Add an option to allow uncommit to remove
5079
3639
    _see_also = ['commit']
5080
3640
    takes_options = ['verbose', 'revision',
5081
3641
                    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
 
                    ]
 
3642
                    Option('force', help='Say yes to all questions.')]
5090
3643
    takes_args = ['location?']
5091
3644
    aliases = []
5092
3645
    encoding_type = 'replace'
5093
3646
 
5094
 
    def run(self, location=None, dry_run=False, verbose=False,
5095
 
            revision=None, force=False, local=False, keep_tags=False):
 
3647
    def run(self, location=None,
 
3648
            dry_run=False, verbose=False,
 
3649
            revision=None, force=False):
5096
3650
        if location is None:
5097
3651
            location = u'.'
5098
3652
        control, relpath = bzrdir.BzrDir.open_containing(location)
5104
3658
            b = control.open_branch()
5105
3659
 
5106
3660
        if tree is not None:
5107
 
            self.add_cleanup(tree.lock_write().unlock)
 
3661
            tree.lock_write()
5108
3662
        else:
5109
 
            self.add_cleanup(b.lock_write().unlock)
5110
 
        return self._run(b, tree, dry_run, verbose, revision, force,
5111
 
                         local, keep_tags)
 
3663
            b.lock_write()
 
3664
        try:
 
3665
            return self._run(b, tree, dry_run, verbose, revision, force)
 
3666
        finally:
 
3667
            if tree is not None:
 
3668
                tree.unlock()
 
3669
            else:
 
3670
                b.unlock()
5112
3671
 
5113
 
    def _run(self, b, tree, dry_run, verbose, revision, force, local,
5114
 
             keep_tags):
 
3672
    def _run(self, b, tree, dry_run, verbose, revision, force):
5115
3673
        from bzrlib.log import log_formatter, show_log
5116
3674
        from bzrlib.uncommit import uncommit
5117
3675
 
5132
3690
                rev_id = b.get_rev_id(revno)
5133
3691
 
5134
3692
        if rev_id is None or _mod_revision.is_null(rev_id):
5135
 
            self.outf.write(gettext('No revisions to uncommit.\n'))
 
3693
            self.outf.write('No revisions to uncommit.\n')
5136
3694
            return 1
5137
3695
 
5138
3696
        lf = log_formatter('short',
5147
3705
                 end_revision=last_revno)
5148
3706
 
5149
3707
        if dry_run:
5150
 
            self.outf.write(gettext('Dry-run, pretending to remove'
5151
 
                            ' the above revisions.\n'))
 
3708
            print 'Dry-run, pretending to remove the above revisions.'
 
3709
            if not force:
 
3710
                val = raw_input('Press <enter> to continue')
5152
3711
        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)
 
3712
            print 'The above revision(s) will be removed.'
 
3713
            if not force:
 
3714
                val = raw_input('Are you sure [y/N]? ')
 
3715
                if val.lower() not in ('y', 'yes'):
 
3716
                    print 'Canceled'
 
3717
                    return 0
 
3718
 
5165
3719
        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)
 
3720
                 revno=revno)
5169
3721
 
5170
3722
 
5171
3723
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.
 
3724
    """Break a dead lock on a repository, branch or working directory.
5176
3725
 
5177
3726
    CAUTION: Locks should only be broken when you are sure that the process
5178
3727
    holding the lock has been stopped.
5179
3728
 
5180
 
    You can get information on what locks are open via the 'bzr info
5181
 
    [location]' command.
5182
 
 
 
3729
    You can get information on what locks are open via the 'bzr info' command.
 
3730
    
5183
3731
    :Examples:
5184
3732
        bzr break-lock
5185
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
5186
 
        bzr break-lock --conf ~/.bazaar
5187
3733
    """
5188
 
 
5189
3734
    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
3735
 
5197
 
    def run(self, location=None, config=False, force=False):
 
3736
    def run(self, location=None, show=False):
5198
3737
        if location is None:
5199
3738
            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
 
 
 
3739
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
3740
        try:
 
3741
            control.break_lock()
 
3742
        except NotImplementedError:
 
3743
            pass
 
3744
        
5214
3745
 
5215
3746
class cmd_wait_until_signalled(Command):
5216
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3747
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
5217
3748
 
5218
3749
    This just prints a line to signal when it is ready, then blocks on stdin.
5219
3750
    """
5227
3758
 
5228
3759
 
5229
3760
class cmd_serve(Command):
5230
 
    __doc__ = """Run the bzr server."""
 
3761
    """Run the bzr server."""
5231
3762
 
5232
3763
    aliases = ['server']
5233
3764
 
5234
3765
    takes_options = [
5235
3766
        Option('inet',
5236
3767
               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
3768
        Option('port',
5242
3769
               help='Listen for connections on nominated port of the form '
5243
3770
                    '[hostname:]portnumber.  Passing 0 as the port number will '
5244
 
                    'result in a dynamically allocated port.  The default port '
5245
 
                    'depends on the protocol.',
 
3771
                    'result in a dynamically allocated port.  The default port is '
 
3772
                    '4155.',
5246
3773
               type=str),
5247
 
        custom_help('directory',
5248
 
               help='Serve contents of this directory.'),
 
3774
        Option('directory',
 
3775
               help='Serve contents of this directory.',
 
3776
               type=unicode),
5249
3777
        Option('allow-writes',
5250
3778
               help='By default the server is a readonly server.  Supplying '
5251
3779
                    '--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.'
 
3780
                    'the served directory and below.'
5257
3781
                ),
5258
 
        Option('client-timeout', type=float,
5259
 
               help='Override the default idle client timeout (5min).'),
5260
3782
        ]
5261
3783
 
5262
 
    def get_host_and_port(self, port):
5263
 
        """Return the host and port to run the smart server on.
5264
 
 
5265
 
        If 'port' is None, None will be returned for the host and port.
5266
 
 
5267
 
        If 'port' has a colon in it, the string before the colon will be
5268
 
        interpreted as the host.
5269
 
 
5270
 
        :param port: A string of the port to run the server on.
5271
 
        :return: A tuple of (host, port), where 'host' is a host name or IP,
5272
 
            and port is an integer TCP/IP port.
5273
 
        """
5274
 
        host = None
5275
 
        if port is not None:
5276
 
            if ':' in port:
5277
 
                host, port = port.split(':')
5278
 
            port = int(port)
5279
 
        return host, port
5280
 
 
5281
 
    def run(self, port=None, inet=False, directory=None, allow_writes=False,
5282
 
            protocol=None, client_timeout=None):
5283
 
        from bzrlib import transport
 
3784
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3785
        from bzrlib import lockdir
 
3786
        from bzrlib.smart import medium, server
 
3787
        from bzrlib.transport import get_transport
 
3788
        from bzrlib.transport.chroot import ChrootServer
5284
3789
        if directory is None:
5285
3790
            directory = os.getcwd()
5286
 
        if protocol is None:
5287
 
            protocol = transport.transport_server_registry.get()
5288
 
        host, port = self.get_host_and_port(port)
5289
3791
        url = urlutils.local_path_to_url(directory)
5290
3792
        if not allow_writes:
5291
3793
            url = 'readonly+' + url
5292
 
        t = transport.get_transport(url)
 
3794
        chroot_server = ChrootServer(get_transport(url))
 
3795
        chroot_server.setUp()
 
3796
        t = get_transport(chroot_server.get_url())
 
3797
        if inet:
 
3798
            smart_server = medium.SmartServerPipeStreamMedium(
 
3799
                sys.stdin, sys.stdout, t)
 
3800
        else:
 
3801
            host = medium.BZR_DEFAULT_INTERFACE
 
3802
            if port is None:
 
3803
                port = medium.BZR_DEFAULT_PORT
 
3804
            else:
 
3805
                if ':' in port:
 
3806
                    host, port = port.split(':')
 
3807
                port = int(port)
 
3808
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3809
            print 'listening on port: ', smart_server.port
 
3810
            sys.stdout.flush()
 
3811
        # for the duration of this server, no UI output is permitted.
 
3812
        # note that this may cause problems with blackbox tests. This should
 
3813
        # be changed with care though, as we dont want to use bandwidth sending
 
3814
        # progress over stderr to smart server clients!
 
3815
        old_factory = ui.ui_factory
 
3816
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
5293
3817
        try:
5294
 
            protocol(t, host, port, inet, client_timeout)
5295
 
        except TypeError, e:
5296
 
            # We use symbol_versioning.deprecated_in just so that people
5297
 
            # grepping can find it here.
5298
 
            # symbol_versioning.deprecated_in((2, 5, 0))
5299
 
            symbol_versioning.warn(
5300
 
                'Got TypeError(%s)\ntrying to call protocol: %s.%s\n'
5301
 
                'Most likely it needs to be updated to support a'
5302
 
                ' "timeout" parameter (added in bzr 2.5.0)'
5303
 
                % (e, protocol.__module__, protocol),
5304
 
                DeprecationWarning)
5305
 
            protocol(t, host, port, inet)
 
3818
            ui.ui_factory = ui.SilentUIFactory()
 
3819
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3820
            smart_server.serve()
 
3821
        finally:
 
3822
            ui.ui_factory = old_factory
 
3823
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
5306
3824
 
5307
3825
 
5308
3826
class cmd_join(Command):
5309
 
    __doc__ = """Combine a tree into its containing tree.
5310
 
 
5311
 
    This command requires the target tree to be in a rich-root format.
 
3827
    """Combine a subtree into its containing tree.
 
3828
    
 
3829
    This command is for experimental use only.  It requires the target tree
 
3830
    to be in dirstate-with-subtree format, which cannot be converted into
 
3831
    earlier formats.
5312
3832
 
5313
3833
    The TREE argument should be an independent tree, inside another tree, but
5314
3834
    not part of it.  (Such trees can be produced by "bzr split", but also by
5315
3835
    running "bzr branch" with the target inside a tree.)
5316
3836
 
5317
 
    The result is a combined tree, with the subtree no longer an independent
 
3837
    The result is a combined tree, with the subtree no longer an independant
5318
3838
    part.  This is marked as a merge of the subtree into the containing tree,
5319
3839
    and all history is preserved.
 
3840
 
 
3841
    If --reference is specified, the subtree retains its independence.  It can
 
3842
    be branched by itself, and can be part of multiple projects at the same
 
3843
    time.  But operations performed in the containing tree, such as commit
 
3844
    and merge, will recurse into the subtree.
5320
3845
    """
5321
3846
 
5322
3847
    _see_also = ['split']
5323
3848
    takes_args = ['tree']
5324
3849
    takes_options = [
5325
 
            Option('reference', help='Join by reference.', hidden=True),
 
3850
            Option('reference', help='Join by reference.'),
5326
3851
            ]
 
3852
    hidden = True
5327
3853
 
5328
3854
    def run(self, tree, reference=False):
5329
3855
        sub_tree = WorkingTree.open(tree)
5331
3857
        containing_tree = WorkingTree.open_containing(parent_dir)[0]
5332
3858
        repo = containing_tree.branch.repository
5333
3859
        if not repo.supports_rich_root():
5334
 
            raise errors.BzrCommandError(gettext(
 
3860
            raise errors.BzrCommandError(
5335
3861
                "Can't join trees because %s doesn't support rich root data.\n"
5336
 
                "You can use bzr upgrade on the repository.")
 
3862
                "You can use bzr upgrade on the repository."
5337
3863
                % (repo,))
5338
3864
        if reference:
5339
3865
            try:
5341
3867
            except errors.BadReferenceTarget, e:
5342
3868
                # XXX: Would be better to just raise a nicely printable
5343
3869
                # exception from the real origin.  Also below.  mbp 20070306
5344
 
                raise errors.BzrCommandError(
5345
 
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
 
3870
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3871
                                             (tree, e.reason))
5346
3872
        else:
5347
3873
            try:
5348
3874
                containing_tree.subsume(sub_tree)
5349
3875
            except errors.BadSubsumeSource, e:
5350
 
                raise errors.BzrCommandError(
5351
 
                       gettext("Cannot join {0}.  {1}").format(tree, e.reason))
 
3876
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
 
3877
                                             (tree, e.reason))
5352
3878
 
5353
3879
 
5354
3880
class cmd_split(Command):
5355
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
3881
    """Split a subdirectory of a tree into a separate tree.
5356
3882
 
5357
3883
    This command will produce a target tree in a format that supports
5358
3884
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
5363
3889
    branch.  Commits in the top-level tree will not apply to the new subtree.
5364
3890
    """
5365
3891
 
5366
 
    _see_also = ['join']
 
3892
    # join is not un-hidden yet
 
3893
    #_see_also = ['join']
5367
3894
    takes_args = ['tree']
5368
3895
 
5369
3896
    def run(self, tree):
5374
3901
        try:
5375
3902
            containing_tree.extract(sub_id)
5376
3903
        except errors.RootNotRich:
5377
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
3904
            raise errors.UpgradeRequired(containing_tree.branch.base)
5378
3905
 
5379
3906
 
5380
3907
class cmd_merge_directive(Command):
5381
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
3908
    """Generate a merge directive for auto-merge tools.
5382
3909
 
5383
3910
    A directive requests a merge to be performed, and also provides all the
5384
3911
    information necessary to do so.  This means it must either include a
5401
3928
    _see_also = ['send']
5402
3929
 
5403
3930
    takes_options = [
5404
 
        'directory',
5405
3931
        RegistryOption.from_kwargs('patch-type',
5406
3932
            'The type of patch to include in the directive.',
5407
3933
            title='Patch type',
5420
3946
    encoding_type = 'exact'
5421
3947
 
5422
3948
    def run(self, submit_branch=None, public_branch=None, patch_type='bundle',
5423
 
            sign=False, revision=None, mail_to=None, message=None,
5424
 
            directory=u'.'):
 
3949
            sign=False, revision=None, mail_to=None, message=None):
5425
3950
        from bzrlib.revision import ensure_null, NULL_REVISION
5426
3951
        include_patch, include_bundle = {
5427
3952
            'plain': (False, False),
5428
3953
            'diff': (True, False),
5429
3954
            'bundle': (True, True),
5430
3955
            }[patch_type]
5431
 
        branch = Branch.open(directory)
 
3956
        branch = Branch.open('.')
5432
3957
        stored_submit_branch = branch.get_submit_branch()
5433
3958
        if submit_branch is None:
5434
3959
            submit_branch = stored_submit_branch
5438
3963
        if submit_branch is None:
5439
3964
            submit_branch = branch.get_parent()
5440
3965
        if submit_branch is None:
5441
 
            raise errors.BzrCommandError(gettext('No submit branch specified or known'))
 
3966
            raise errors.BzrCommandError('No submit branch specified or known')
5442
3967
 
5443
3968
        stored_public_branch = branch.get_public_branch()
5444
3969
        if public_branch is None:
5446
3971
        elif stored_public_branch is None:
5447
3972
            branch.set_public_branch(public_branch)
5448
3973
        if not include_bundle and public_branch is None:
5449
 
            raise errors.BzrCommandError(gettext('No public branch specified or'
5450
 
                                         ' known'))
 
3974
            raise errors.BzrCommandError('No public branch specified or'
 
3975
                                         ' known')
5451
3976
        base_revision_id = None
5452
3977
        if revision is not None:
5453
3978
            if len(revision) > 2:
5454
 
                raise errors.BzrCommandError(gettext('bzr merge-directive takes '
5455
 
                    'at most two one revision identifiers'))
5456
 
            revision_id = revision[-1].as_revision_id(branch)
 
3979
                raise errors.BzrCommandError('bzr merge-directive takes '
 
3980
                    'at most two one revision identifiers')
 
3981
            revision_id = revision[-1].in_history(branch).rev_id
5457
3982
            if len(revision) == 2:
5458
 
                base_revision_id = revision[0].as_revision_id(branch)
 
3983
                base_revision_id = revision[0].in_history(branch).rev_id
 
3984
                base_revision_id = ensure_null(base_revision_id)
5459
3985
        else:
5460
3986
            revision_id = branch.last_revision()
5461
3987
        revision_id = ensure_null(revision_id)
5462
3988
        if revision_id == NULL_REVISION:
5463
 
            raise errors.BzrCommandError(gettext('No revisions to bundle.'))
 
3989
            raise errors.BzrCommandError('No revisions to bundle.')
5464
3990
        directive = merge_directive.MergeDirective2.from_objects(
5465
3991
            branch.repository, revision_id, time.time(),
5466
3992
            osutils.local_time_offset(), submit_branch,
5479
4005
 
5480
4006
 
5481
4007
class cmd_send(Command):
5482
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4008
    """Mail or create a merge-directive for submiting changes.
5483
4009
 
5484
4010
    A merge directive provides many things needed for requesting merges:
5485
4011
 
5491
4017
      directly from the merge directive, without retrieving data from a
5492
4018
      branch.
5493
4019
 
5494
 
    `bzr send` creates a compact data set that, when applied using bzr
5495
 
    merge, has the same effect as merging from the source branch.  
5496
 
    
5497
 
    By default the merge directive is self-contained and can be applied to any
5498
 
    branch containing submit_branch in its ancestory without needing access to
5499
 
    the source branch.
5500
 
    
5501
 
    If --no-bundle is specified, then Bazaar doesn't send the contents of the
5502
 
    revisions, but only a structured request to merge from the
5503
 
    public_location.  In that case the public_branch is needed and it must be
5504
 
    up-to-date and accessible to the recipient.  The public_branch is always
5505
 
    included if known, so that people can check it later.
5506
 
 
5507
 
    The submit branch defaults to the parent of the source branch, but can be
5508
 
    overridden.  Both submit branch and public branch will be remembered in
5509
 
    branch.conf the first time they are used for a particular branch.  The
5510
 
    source branch defaults to that containing the working directory, but can
5511
 
    be changed using --from.
5512
 
 
5513
 
    Both the submit branch and the public branch follow the usual behavior with
5514
 
    respect to --remember: If there is no default location set, the first send
5515
 
    will set it (use --no-remember to avoid setting it). After that, you can
5516
 
    omit the location to use the default.  To change the default, use
5517
 
    --remember. The value will only be saved if the location can be accessed.
5518
 
 
5519
 
    In order to calculate those changes, bzr must analyse the submit branch.
5520
 
    Therefore it is most efficient for the submit branch to be a local mirror.
5521
 
    If a public location is known for the submit_branch, that location is used
5522
 
    in the merge directive.
5523
 
 
5524
 
    The default behaviour is to send the merge directive by mail, unless -o is
5525
 
    given, in which case it is sent to a file.
 
4020
    If --no-bundle is specified, then public_branch is needed (and must be
 
4021
    up-to-date), so that the receiver can perform the merge using the
 
4022
    public_branch.  The public_branch is always included if known, so that
 
4023
    people can check it later.
 
4024
 
 
4025
    The submit branch defaults to the parent, but can be overridden.  Both
 
4026
    submit branch and public branch will be remembered if supplied.
 
4027
 
 
4028
    If a public_branch is known for the submit_branch, that public submit
 
4029
    branch is used in the merge instructions.  This means that a local mirror
 
4030
    can be used as your actual submit branch, once you have set public_branch
 
4031
    for that mirror.
5526
4032
 
5527
4033
    Mail is sent using your preferred mail program.  This should be transparent
5528
 
    on Windows (it uses MAPI).  On Unix, it requires the xdg-email utility.
 
4034
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5529
4035
    If the preferred client can't be found (or used), your editor will be used.
5530
 
 
 
4036
    
5531
4037
    To use a specific mail program, set the mail_client configuration option.
5532
4038
    (For Thunderbird 1.5, this works around some bugs.)  Supported values for
5533
 
    specific clients are "claws", "evolution", "kmail", "mail.app" (MacOS X's
5534
 
    Mail.app), "mutt", and "thunderbird"; generic options are "default",
5535
 
    "editor", "emacsclient", "mapi", and "xdg-email".  Plugins may also add
5536
 
    supported clients.
 
4039
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4040
    generic options are "default", "editor", "mapi", and "xdg-email".
5537
4041
 
5538
4042
    If mail is being sent, a to address is required.  This can be supplied
5539
4043
    either on the commandline, by setting the submit_to configuration
5540
 
    option in the branch itself or the child_submit_to configuration option
 
4044
    option in the branch itself or the child_submit_to configuration option 
5541
4045
    in the submit branch.
5542
4046
 
5543
4047
    Two formats are currently supported: "4" uses revision bundle format 4 and
5545
4049
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5546
4050
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5547
4051
    format 1.  It is compatible with Bazaar 0.12 - 0.18.
5548
 
 
5549
 
    The merge directives created by bzr send may be applied using bzr merge or
5550
 
    bzr pull by specifying a file containing a merge directive as the location.
5551
 
 
5552
 
    bzr send makes extensive use of public locations to map local locations into
5553
 
    URLs that can be used by other people.  See `bzr help configuration` to
5554
 
    set them, and use `bzr info` to display them.
5555
4052
    """
5556
4053
 
5557
4054
    encoding_type = 'exact'
5558
4055
 
5559
 
    _see_also = ['merge', 'pull']
 
4056
    _see_also = ['merge']
5560
4057
 
5561
4058
    takes_args = ['submit_branch?', 'public_branch?']
5562
4059
 
5572
4069
               'rather than the one containing the working directory.',
5573
4070
               short_name='f',
5574
4071
               type=unicode),
5575
 
        Option('output', short_name='o',
5576
 
               help='Write merge directive to this file or directory; '
5577
 
                    'use - for stdout.',
 
4072
        Option('output', short_name='o', help='Write directive to this file.',
5578
4073
               type=unicode),
5579
 
        Option('strict',
5580
 
               help='Refuse to send if there are uncommitted changes in'
5581
 
               ' the working tree, --no-strict disables the check.'),
5582
4074
        Option('mail-to', help='Mail the request to this address.',
5583
4075
               type=unicode),
5584
4076
        'revision',
5585
4077
        'message',
5586
 
        Option('body', help='Body for the email.', type=unicode),
5587
 
        RegistryOption('format',
5588
 
                       help='Use the specified output format.',
5589
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4078
        RegistryOption.from_kwargs('format',
 
4079
        'Use the specified output format.',
 
4080
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4081
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5590
4082
        ]
5591
4083
 
5592
4084
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5593
 
            no_patch=False, revision=None, remember=None, output=None,
5594
 
            format=None, mail_to=None, message=None, body=None,
5595
 
            strict=None, **kwargs):
5596
 
        from bzrlib.send import send
5597
 
        return send(submit_branch, revision, public_branch, remember,
5598
 
                    format, no_bundle, no_patch, output,
5599
 
                    kwargs.get('from', '.'), mail_to, message, body,
5600
 
                    self.outf,
5601
 
                    strict=strict)
 
4085
            no_patch=False, revision=None, remember=False, output=None,
 
4086
            format='4', mail_to=None, message=None, **kwargs):
 
4087
        return self._run(submit_branch, revision, public_branch, remember,
 
4088
                         format, no_bundle, no_patch, output,
 
4089
                         kwargs.get('from', '.'), mail_to, message)
 
4090
 
 
4091
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4092
             no_bundle, no_patch, output, from_, mail_to, message):
 
4093
        from bzrlib.revision import NULL_REVISION
 
4094
        branch = Branch.open_containing(from_)[0]
 
4095
        if output is None:
 
4096
            outfile = StringIO()
 
4097
        elif output == '-':
 
4098
            outfile = self.outf
 
4099
        else:
 
4100
            outfile = open(output, 'wb')
 
4101
        # we may need to write data into branch's repository to calculate
 
4102
        # the data to send.
 
4103
        branch.lock_write()
 
4104
        try:
 
4105
            if output is None:
 
4106
                config = branch.get_config()
 
4107
                if mail_to is None:
 
4108
                    mail_to = config.get_user_option('submit_to')
 
4109
                mail_client = config.get_mail_client()
 
4110
            if remember and submit_branch is None:
 
4111
                raise errors.BzrCommandError(
 
4112
                    '--remember requires a branch to be specified.')
 
4113
            stored_submit_branch = branch.get_submit_branch()
 
4114
            remembered_submit_branch = False
 
4115
            if submit_branch is None:
 
4116
                submit_branch = stored_submit_branch
 
4117
                remembered_submit_branch = True
 
4118
            else:
 
4119
                if stored_submit_branch is None or remember:
 
4120
                    branch.set_submit_branch(submit_branch)
 
4121
            if submit_branch is None:
 
4122
                submit_branch = branch.get_parent()
 
4123
                remembered_submit_branch = True
 
4124
            if submit_branch is None:
 
4125
                raise errors.BzrCommandError('No submit branch known or'
 
4126
                                             ' specified')
 
4127
            if remembered_submit_branch:
 
4128
                note('Using saved location: %s', submit_branch)
 
4129
 
 
4130
            if mail_to is None:
 
4131
                submit_config = Branch.open(submit_branch).get_config()
 
4132
                mail_to = submit_config.get_user_option("child_submit_to")
 
4133
 
 
4134
            stored_public_branch = branch.get_public_branch()
 
4135
            if public_branch is None:
 
4136
                public_branch = stored_public_branch
 
4137
            elif stored_public_branch is None or remember:
 
4138
                branch.set_public_branch(public_branch)
 
4139
            if no_bundle and public_branch is None:
 
4140
                raise errors.BzrCommandError('No public branch specified or'
 
4141
                                             ' known')
 
4142
            base_revision_id = None
 
4143
            revision_id = None
 
4144
            if revision is not None:
 
4145
                if len(revision) > 2:
 
4146
                    raise errors.BzrCommandError('bzr send takes '
 
4147
                        'at most two one revision identifiers')
 
4148
                revision_id = revision[-1].in_history(branch).rev_id
 
4149
                if len(revision) == 2:
 
4150
                    base_revision_id = revision[0].in_history(branch).rev_id
 
4151
            if revision_id is None:
 
4152
                revision_id = branch.last_revision()
 
4153
            if revision_id == NULL_REVISION:
 
4154
                raise errors.BzrCommandError('No revisions to submit.')
 
4155
            if format == '4':
 
4156
                directive = merge_directive.MergeDirective2.from_objects(
 
4157
                    branch.repository, revision_id, time.time(),
 
4158
                    osutils.local_time_offset(), submit_branch,
 
4159
                    public_branch=public_branch, include_patch=not no_patch,
 
4160
                    include_bundle=not no_bundle, message=message,
 
4161
                    base_revision_id=base_revision_id)
 
4162
            elif format == '0.9':
 
4163
                if not no_bundle:
 
4164
                    if not no_patch:
 
4165
                        patch_type = 'bundle'
 
4166
                    else:
 
4167
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4168
                            ' permit bundle with no patch')
 
4169
                else:
 
4170
                    if not no_patch:
 
4171
                        patch_type = 'diff'
 
4172
                    else:
 
4173
                        patch_type = None
 
4174
                directive = merge_directive.MergeDirective.from_objects(
 
4175
                    branch.repository, revision_id, time.time(),
 
4176
                    osutils.local_time_offset(), submit_branch,
 
4177
                    public_branch=public_branch, patch_type=patch_type,
 
4178
                    message=message)
 
4179
 
 
4180
            outfile.writelines(directive.to_lines())
 
4181
            if output is None:
 
4182
                subject = '[MERGE] '
 
4183
                if message is not None:
 
4184
                    subject += message
 
4185
                else:
 
4186
                    revision = branch.repository.get_revision(revision_id)
 
4187
                    subject += revision.get_summary()
 
4188
                basename = directive.get_disk_name(branch)
 
4189
                mail_client.compose_merge_request(mail_to, subject,
 
4190
                                                  outfile.getvalue(), basename)
 
4191
        finally:
 
4192
            if output != '-':
 
4193
                outfile.close()
 
4194
            branch.unlock()
5602
4195
 
5603
4196
 
5604
4197
class cmd_bundle_revisions(cmd_send):
5605
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4198
 
 
4199
    """Create a merge-directive for submiting changes.
5606
4200
 
5607
4201
    A merge directive provides many things needed for requesting merges:
5608
4202
 
5648
4242
               type=unicode),
5649
4243
        Option('output', short_name='o', help='Write directive to this file.',
5650
4244
               type=unicode),
5651
 
        Option('strict',
5652
 
               help='Refuse to bundle revisions if there are uncommitted'
5653
 
               ' changes in the working tree, --no-strict disables the check.'),
5654
4245
        'revision',
5655
 
        RegistryOption('format',
5656
 
                       help='Use the specified output format.',
5657
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4246
        RegistryOption.from_kwargs('format',
 
4247
        'Use the specified output format.',
 
4248
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4249
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5658
4250
        ]
5659
4251
    aliases = ['bundle']
5660
4252
 
5664
4256
 
5665
4257
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5666
4258
            no_patch=False, revision=None, remember=False, output=None,
5667
 
            format=None, strict=None, **kwargs):
 
4259
            format='4', **kwargs):
5668
4260
        if output is None:
5669
4261
            output = '-'
5670
 
        from bzrlib.send import send
5671
 
        return send(submit_branch, revision, public_branch, remember,
 
4262
        return self._run(submit_branch, revision, public_branch, remember,
5672
4263
                         format, no_bundle, no_patch, output,
5673
 
                         kwargs.get('from', '.'), None, None, None,
5674
 
                         self.outf, strict=strict)
 
4264
                         kwargs.get('from', '.'), None, None)
5675
4265
 
5676
4266
 
5677
4267
class cmd_tag(Command):
5678
 
    __doc__ = """Create, remove or modify a tag naming a revision.
5679
 
 
 
4268
    """Create, remove or modify a tag naming a revision.
 
4269
    
5680
4270
    Tags give human-meaningful names to revisions.  Commands that take a -r
5681
4271
    (--revision) option can be given -rtag:X, where X is any previously
5682
4272
    created tag.
5684
4274
    Tags are stored in the branch.  Tags are copied from one branch to another
5685
4275
    along when you branch, push, pull or merge.
5686
4276
 
5687
 
    It is an error to give a tag name that already exists unless you pass
 
4277
    It is an error to give a tag name that already exists unless you pass 
5688
4278
    --force, in which case the tag is moved to point to the new revision.
5689
 
 
5690
 
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5691
 
    tag new-name -r tag:old-name`` and then ``bzr tag --delete oldname``.
5692
 
 
5693
 
    If no tag name is specified it will be determined through the 
5694
 
    'automatic_tag_name' hook. This can e.g. be used to automatically tag
5695
 
    upstream releases by reading configure.ac. See ``bzr help hooks`` for
5696
 
    details.
5697
4279
    """
5698
4280
 
5699
4281
    _see_also = ['commit', 'tags']
5700
 
    takes_args = ['tag_name?']
 
4282
    takes_args = ['tag_name']
5701
4283
    takes_options = [
5702
4284
        Option('delete',
5703
4285
            help='Delete this tag rather than placing it.',
5704
4286
            ),
5705
 
        custom_help('directory',
5706
 
            help='Branch in which to place the tag.'),
 
4287
        Option('directory',
 
4288
            help='Branch in which to place the tag.',
 
4289
            short_name='d',
 
4290
            type=unicode,
 
4291
            ),
5707
4292
        Option('force',
5708
4293
            help='Replace existing tags.',
5709
4294
            ),
5710
4295
        'revision',
5711
4296
        ]
5712
4297
 
5713
 
    def run(self, tag_name=None,
 
4298
    def run(self, tag_name,
5714
4299
            delete=None,
5715
4300
            directory='.',
5716
4301
            force=None,
5717
4302
            revision=None,
5718
4303
            ):
5719
4304
        branch, relpath = Branch.open_containing(directory)
5720
 
        self.add_cleanup(branch.lock_write().unlock)
5721
 
        if delete:
5722
 
            if tag_name is None:
5723
 
                raise errors.BzrCommandError(gettext("No tag specified to delete."))
5724
 
            branch.tags.delete_tag(tag_name)
5725
 
            note(gettext('Deleted tag %s.') % tag_name)
5726
 
        else:
5727
 
            if revision:
5728
 
                if len(revision) != 1:
5729
 
                    raise errors.BzrCommandError(gettext(
5730
 
                        "Tags can only be placed on a single revision, "
5731
 
                        "not on a range"))
5732
 
                revision_id = revision[0].as_revision_id(branch)
5733
 
            else:
5734
 
                revision_id = branch.last_revision()
5735
 
            if tag_name is None:
5736
 
                tag_name = branch.automatic_tag_name(revision_id)
5737
 
                if tag_name is None:
5738
 
                    raise errors.BzrCommandError(gettext(
5739
 
                        "Please specify a tag name."))
5740
 
            try:
5741
 
                existing_target = branch.tags.lookup_tag(tag_name)
5742
 
            except errors.NoSuchTag:
5743
 
                existing_target = None
5744
 
            if not force and existing_target not in (None, revision_id):
5745
 
                raise errors.TagAlreadyExists(tag_name)
5746
 
            if existing_target == revision_id:
5747
 
                note(gettext('Tag %s already exists for that revision.') % tag_name)
5748
 
            else:
 
4305
        branch.lock_write()
 
4306
        try:
 
4307
            if delete:
 
4308
                branch.tags.delete_tag(tag_name)
 
4309
                self.outf.write('Deleted tag %s.\n' % tag_name)
 
4310
            else:
 
4311
                if revision:
 
4312
                    if len(revision) != 1:
 
4313
                        raise errors.BzrCommandError(
 
4314
                            "Tags can only be placed on a single revision, "
 
4315
                            "not on a range")
 
4316
                    revision_id = revision[0].in_history(branch).rev_id
 
4317
                else:
 
4318
                    revision_id = branch.last_revision()
 
4319
                if (not force) and branch.tags.has_tag(tag_name):
 
4320
                    raise errors.TagAlreadyExists(tag_name)
5749
4321
                branch.tags.set_tag(tag_name, revision_id)
5750
 
                if existing_target is None:
5751
 
                    note(gettext('Created tag %s.') % tag_name)
5752
 
                else:
5753
 
                    note(gettext('Updated tag %s.') % tag_name)
 
4322
                self.outf.write('Created tag %s.\n' % tag_name)
 
4323
        finally:
 
4324
            branch.unlock()
5754
4325
 
5755
4326
 
5756
4327
class cmd_tags(Command):
5757
 
    __doc__ = """List tags.
 
4328
    """List tags.
5758
4329
 
5759
4330
    This command shows a table of tag names and the revisions they reference.
5760
4331
    """
5761
4332
 
5762
4333
    _see_also = ['tag']
5763
4334
    takes_options = [
5764
 
        custom_help('directory',
5765
 
            help='Branch whose tags should be displayed.'),
5766
 
        RegistryOption('sort',
 
4335
        Option('directory',
 
4336
            help='Branch whose tags should be displayed.',
 
4337
            short_name='d',
 
4338
            type=unicode,
 
4339
            ),
 
4340
        RegistryOption.from_kwargs('sort',
5767
4341
            'Sort tags by different criteria.', title='Sorting',
5768
 
            lazy_registry=('bzrlib.tag', 'tag_sort_methods')
 
4342
            alpha='Sort tags lexicographically (default).',
 
4343
            time='Sort tags chronologically.',
5769
4344
            ),
5770
4345
        'show-ids',
5771
 
        'revision',
5772
4346
    ]
5773
4347
 
5774
4348
    @display_command
5775
 
    def run(self, directory='.', sort=None, show_ids=False, revision=None):
5776
 
        from bzrlib.tag import tag_sort_methods
 
4349
    def run(self,
 
4350
            directory='.',
 
4351
            sort='alpha',
 
4352
            show_ids=False,
 
4353
            ):
5777
4354
        branch, relpath = Branch.open_containing(directory)
5778
 
 
5779
4355
        tags = branch.tags.get_tag_dict().items()
5780
 
        if not tags:
5781
 
            return
5782
 
 
5783
 
        self.add_cleanup(branch.lock_read().unlock)
5784
 
        if revision:
5785
 
            # Restrict to the specified range
5786
 
            tags = self._tags_for_range(branch, revision)
5787
 
        if sort is None:
5788
 
            sort = tag_sort_methods.get()
5789
 
        sort(branch, tags)
 
4356
        if sort == 'alpha':
 
4357
            tags.sort()
 
4358
        elif sort == 'time':
 
4359
            timestamps = {}
 
4360
            for tag, revid in tags:
 
4361
                try:
 
4362
                    revobj = branch.repository.get_revision(revid)
 
4363
                except errors.NoSuchRevision:
 
4364
                    timestamp = sys.maxint # place them at the end
 
4365
                else:
 
4366
                    timestamp = revobj.timestamp
 
4367
                timestamps[revid] = timestamp
 
4368
            tags.sort(key=lambda x: timestamps[x[1]])
5790
4369
        if not show_ids:
5791
4370
            # [ (tag, revid), ... ] -> [ (tag, dotted_revno), ... ]
5792
 
            for index, (tag, revid) in enumerate(tags):
5793
 
                try:
5794
 
                    revno = branch.revision_id_to_dotted_revno(revid)
5795
 
                    if isinstance(revno, tuple):
5796
 
                        revno = '.'.join(map(str, revno))
5797
 
                except (errors.NoSuchRevision,
5798
 
                        errors.GhostRevisionsHaveNoRevno):
5799
 
                    # Bad tag data/merges can lead to tagged revisions
5800
 
                    # which are not in this branch. Fail gracefully ...
5801
 
                    revno = '?'
5802
 
                tags[index] = (tag, revno)
5803
 
        self.cleanup_now()
 
4371
            revno_map = branch.get_revision_id_to_revno_map()
 
4372
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4373
                        for tag, revid in tags ]
5804
4374
        for tag, revspec in tags:
5805
4375
            self.outf.write('%-20s %s\n' % (tag, revspec))
5806
4376
 
5807
 
    def _tags_for_range(self, branch, revision):
5808
 
        range_valid = True
5809
 
        rev1, rev2 = _get_revision_range(revision, branch, self.name())
5810
 
        revid1, revid2 = rev1.rev_id, rev2.rev_id
5811
 
        # _get_revision_range will always set revid2 if it's not specified.
5812
 
        # If revid1 is None, it means we want to start from the branch
5813
 
        # origin which is always a valid ancestor. If revid1 == revid2, the
5814
 
        # ancestry check is useless.
5815
 
        if revid1 and revid1 != revid2:
5816
 
            # FIXME: We really want to use the same graph than
5817
 
            # branch.iter_merge_sorted_revisions below, but this is not
5818
 
            # easily available -- vila 2011-09-23
5819
 
            if branch.repository.get_graph().is_ancestor(revid2, revid1):
5820
 
                # We don't want to output anything in this case...
5821
 
                return []
5822
 
        # only show revisions between revid1 and revid2 (inclusive)
5823
 
        tagged_revids = branch.tags.get_reverse_tag_dict()
5824
 
        found = []
5825
 
        for r in branch.iter_merge_sorted_revisions(
5826
 
            start_revision_id=revid2, stop_revision_id=revid1,
5827
 
            stop_rule='include'):
5828
 
            revid_tags = tagged_revids.get(r[0], None)
5829
 
            if revid_tags:
5830
 
                found.extend([(tag, r[0]) for tag in revid_tags])
5831
 
        return found
5832
 
 
5833
4377
 
5834
4378
class cmd_reconfigure(Command):
5835
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
4379
    """Reconfigure the type of a bzr directory.
5836
4380
 
5837
4381
    A target configuration must be specified.
5838
4382
 
5845
4389
    If none of these is available, --bind-to must be specified.
5846
4390
    """
5847
4391
 
5848
 
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5849
4392
    takes_args = ['location?']
5850
 
    takes_options = [
5851
 
        RegistryOption.from_kwargs(
5852
 
            'tree_type',
5853
 
            title='Tree type',
5854
 
            help='The relation between branch and tree.',
5855
 
            value_switches=True, enum_switch=False,
5856
 
            branch='Reconfigure to be an unbound branch with no working tree.',
5857
 
            tree='Reconfigure to be an unbound branch with a working tree.',
5858
 
            checkout='Reconfigure to be a bound branch with a working tree.',
5859
 
            lightweight_checkout='Reconfigure to be a lightweight'
5860
 
                ' checkout (with no local history).',
5861
 
            ),
5862
 
        RegistryOption.from_kwargs(
5863
 
            'repository_type',
5864
 
            title='Repository type',
5865
 
            help='Location fo the repository.',
5866
 
            value_switches=True, enum_switch=False,
5867
 
            standalone='Reconfigure to be a standalone branch '
5868
 
                '(i.e. stop using shared repository).',
5869
 
            use_shared='Reconfigure to use a shared repository.',
5870
 
            ),
5871
 
        RegistryOption.from_kwargs(
5872
 
            'repository_trees',
5873
 
            title='Trees in Repository',
5874
 
            help='Whether new branches in the repository have trees.',
5875
 
            value_switches=True, enum_switch=False,
5876
 
            with_trees='Reconfigure repository to create '
5877
 
                'working trees on branches by default.',
5878
 
            with_no_trees='Reconfigure repository to not create '
5879
 
                'working trees on branches by default.'
5880
 
            ),
5881
 
        Option('bind-to', help='Branch to bind checkout to.', type=str),
5882
 
        Option('force',
5883
 
            help='Perform reconfiguration even if local changes'
5884
 
            ' will be lost.'),
5885
 
        Option('stacked-on',
5886
 
            help='Reconfigure a branch to be stacked on another branch.',
5887
 
            type=unicode,
5888
 
            ),
5889
 
        Option('unstacked',
5890
 
            help='Reconfigure a branch to be unstacked.  This '
5891
 
                'may require copying substantial data into it.',
5892
 
            ),
5893
 
        ]
 
4393
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4394
                     title='Target type',
 
4395
                     help='The type to reconfigure the directory to.',
 
4396
                     value_switches=True, enum_switch=False,
 
4397
                     branch='Reconfigure to a branch.',
 
4398
                     tree='Reconfigure to a tree.',
 
4399
                     checkout='Reconfigure to a checkout.',
 
4400
                     lightweight_checkout='Reconfigure to a lightweight'
 
4401
                     ' checkout.'),
 
4402
                     Option('bind-to', help='Branch to bind checkout to.',
 
4403
                            type=str),
 
4404
                     Option('force',
 
4405
                        help='Perform reconfiguration even if local changes'
 
4406
                        ' will be lost.')
 
4407
                     ]
5894
4408
 
5895
 
    def run(self, location=None, bind_to=None, force=False,
5896
 
            tree_type=None, repository_type=None, repository_trees=None,
5897
 
            stacked_on=None, unstacked=None):
 
4409
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5898
4410
        directory = bzrdir.BzrDir.open(location)
5899
 
        if stacked_on and unstacked:
5900
 
            raise errors.BzrCommandError(gettext("Can't use both --stacked-on and --unstacked"))
5901
 
        elif stacked_on is not None:
5902
 
            reconfigure.ReconfigureStackedOn().apply(directory, stacked_on)
5903
 
        elif unstacked:
5904
 
            reconfigure.ReconfigureUnstacked().apply(directory)
5905
 
        # At the moment you can use --stacked-on and a different
5906
 
        # reconfiguration shape at the same time; there seems no good reason
5907
 
        # to ban it.
5908
 
        if (tree_type is None and
5909
 
            repository_type is None and
5910
 
            repository_trees is None):
5911
 
            if stacked_on or unstacked:
5912
 
                return
5913
 
            else:
5914
 
                raise errors.BzrCommandError(gettext('No target configuration '
5915
 
                    'specified'))
5916
 
        reconfiguration = None
5917
 
        if tree_type == 'branch':
 
4411
        if target_type is None:
 
4412
            raise errors.BzrCommandError('No target configuration specified')
 
4413
        elif target_type == 'branch':
5918
4414
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5919
 
        elif tree_type == 'tree':
 
4415
        elif target_type == 'tree':
5920
4416
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5921
 
        elif tree_type == 'checkout':
5922
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5923
 
                directory, bind_to)
5924
 
        elif tree_type == 'lightweight-checkout':
 
4417
        elif target_type == 'checkout':
 
4418
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4419
                                                                  bind_to)
 
4420
        elif target_type == 'lightweight-checkout':
5925
4421
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5926
4422
                directory, bind_to)
5927
 
        if reconfiguration:
5928
 
            reconfiguration.apply(force)
5929
 
            reconfiguration = None
5930
 
        if repository_type == 'use-shared':
5931
 
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5932
 
        elif repository_type == 'standalone':
5933
 
            reconfiguration = reconfigure.Reconfigure.to_standalone(directory)
5934
 
        if reconfiguration:
5935
 
            reconfiguration.apply(force)
5936
 
            reconfiguration = None
5937
 
        if repository_trees == 'with-trees':
5938
 
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5939
 
                directory, True)
5940
 
        elif repository_trees == 'with-no-trees':
5941
 
            reconfiguration = reconfigure.Reconfigure.set_repository_trees(
5942
 
                directory, False)
5943
 
        if reconfiguration:
5944
 
            reconfiguration.apply(force)
5945
 
            reconfiguration = None
 
4423
        reconfiguration.apply(force)
5946
4424
 
5947
4425
 
5948
4426
class cmd_switch(Command):
5949
 
    __doc__ = """Set the branch of a checkout and update.
5950
 
 
 
4427
    """Set the branch of a checkout and update.
 
4428
    
5951
4429
    For lightweight checkouts, this changes the branch being referenced.
5952
4430
    For heavyweight checkouts, this checks that there are no local commits
5953
4431
    versus the current bound branch, then it makes the local branch a mirror
5954
4432
    of the new location and binds to it.
5955
 
 
 
4433
    
5956
4434
    In both cases, the working tree is updated and uncommitted changes
5957
4435
    are merged. The user can commit or revert these as they desire.
5958
4436
 
5959
4437
    Pending merges need to be committed or reverted before using switch.
5960
 
 
5961
 
    The path to the branch to switch to can be specified relative to the parent
5962
 
    directory of the current branch. For example, if you are currently in a
5963
 
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5964
 
    /path/to/newbranch.
5965
 
 
5966
 
    Bound branches use the nickname of its master branch unless it is set
5967
 
    locally, in which case switching will update the local nickname to be
5968
 
    that of the master.
5969
4438
    """
5970
4439
 
5971
 
    takes_args = ['to_location?']
5972
 
    takes_options = ['directory',
5973
 
                     Option('force',
5974
 
                        help='Switch even if local commits will be lost.'),
5975
 
                     'revision',
5976
 
                     Option('create-branch', short_name='b',
5977
 
                        help='Create the target branch from this one before'
5978
 
                             ' switching to it.'),
5979
 
                    ]
 
4440
    takes_args = ['to_location']
 
4441
    takes_options = [Option('force',
 
4442
                        help='Switch even if local commits will be lost.')
 
4443
                     ]
5980
4444
 
5981
 
    def run(self, to_location=None, force=False, create_branch=False,
5982
 
            revision=None, directory=u'.'):
 
4445
    def run(self, to_location, force=False):
5983
4446
        from bzrlib import switch
5984
 
        tree_location = directory
5985
 
        revision = _get_one_revision('switch', revision)
 
4447
        to_branch = Branch.open(to_location)
 
4448
        tree_location = '.'
5986
4449
        control_dir = bzrdir.BzrDir.open_containing(tree_location)[0]
5987
 
        if to_location is None:
5988
 
            if revision is None:
5989
 
                raise errors.BzrCommandError(gettext('You must supply either a'
5990
 
                                             ' revision or a location'))
5991
 
            to_location = tree_location
5992
 
        try:
5993
 
            branch = control_dir.open_branch()
5994
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
5995
 
        except errors.NotBranchError:
5996
 
            branch = None
5997
 
            had_explicit_nick = False
5998
 
        if create_branch:
5999
 
            if branch is None:
6000
 
                raise errors.BzrCommandError(gettext('cannot create branch without'
6001
 
                                             ' source branch'))
6002
 
            to_location = directory_service.directories.dereference(
6003
 
                              to_location)
6004
 
            if '/' not in to_location and '\\' not in to_location:
6005
 
                # This path is meant to be relative to the existing branch
6006
 
                this_url = self._get_branch_location(control_dir)
6007
 
                to_location = urlutils.join(this_url, '..', to_location)
6008
 
            to_branch = branch.bzrdir.sprout(to_location,
6009
 
                                 possible_transports=[branch.bzrdir.root_transport],
6010
 
                                 source_branch=branch).open_branch()
6011
 
        else:
6012
 
            try:
6013
 
                to_branch = Branch.open(to_location)
6014
 
            except errors.NotBranchError:
6015
 
                this_url = self._get_branch_location(control_dir)
6016
 
                to_branch = Branch.open(
6017
 
                    urlutils.join(this_url, '..', to_location))
6018
 
        if revision is not None:
6019
 
            revision = revision.as_revision_id(to_branch)
6020
 
        switch.switch(control_dir, to_branch, force, revision_id=revision)
6021
 
        if had_explicit_nick:
6022
 
            branch = control_dir.open_branch() #get the new branch!
6023
 
            branch.nick = to_branch.nick
6024
 
        note(gettext('Switched to branch: %s'),
 
4450
        switch.switch(control_dir, to_branch, force)
 
4451
        note('Switched to branch: %s',
6025
4452
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
6026
4453
 
6027
 
    def _get_branch_location(self, control_dir):
6028
 
        """Return location of branch for this control dir."""
6029
 
        try:
6030
 
            this_branch = control_dir.open_branch()
6031
 
            # This may be a heavy checkout, where we want the master branch
6032
 
            master_location = this_branch.get_bound_location()
6033
 
            if master_location is not None:
6034
 
                return master_location
6035
 
            # If not, use a local sibling
6036
 
            return this_branch.base
6037
 
        except errors.NotBranchError:
6038
 
            format = control_dir.find_branch_format()
6039
 
            if getattr(format, 'get_reference', None) is not None:
6040
 
                return format.get_reference(control_dir)
6041
 
            else:
6042
 
                return control_dir.root_transport.base
6043
 
 
6044
 
 
6045
 
class cmd_view(Command):
6046
 
    __doc__ = """Manage filtered views.
6047
 
 
6048
 
    Views provide a mask over the tree so that users can focus on
6049
 
    a subset of a tree when doing their work. After creating a view,
6050
 
    commands that support a list of files - status, diff, commit, etc -
6051
 
    effectively have that list of files implicitly given each time.
6052
 
    An explicit list of files can still be given but those files
6053
 
    must be within the current view.
6054
 
 
6055
 
    In most cases, a view has a short life-span: it is created to make
6056
 
    a selected change and is deleted once that change is committed.
6057
 
    At other times, you may wish to create one or more named views
6058
 
    and switch between them.
6059
 
 
6060
 
    To disable the current view without deleting it, you can switch to
6061
 
    the pseudo view called ``off``. This can be useful when you need
6062
 
    to see the whole tree for an operation or two (e.g. merge) but
6063
 
    want to switch back to your view after that.
6064
 
 
6065
 
    :Examples:
6066
 
      To define the current view::
6067
 
 
6068
 
        bzr view file1 dir1 ...
6069
 
 
6070
 
      To list the current view::
6071
 
 
6072
 
        bzr view
6073
 
 
6074
 
      To delete the current view::
6075
 
 
6076
 
        bzr view --delete
6077
 
 
6078
 
      To disable the current view without deleting it::
6079
 
 
6080
 
        bzr view --switch off
6081
 
 
6082
 
      To define a named view and switch to it::
6083
 
 
6084
 
        bzr view --name view-name file1 dir1 ...
6085
 
 
6086
 
      To list a named view::
6087
 
 
6088
 
        bzr view --name view-name
6089
 
 
6090
 
      To delete a named view::
6091
 
 
6092
 
        bzr view --name view-name --delete
6093
 
 
6094
 
      To switch to a named view::
6095
 
 
6096
 
        bzr view --switch view-name
6097
 
 
6098
 
      To list all views defined::
6099
 
 
6100
 
        bzr view --all
6101
 
 
6102
 
      To delete all views::
6103
 
 
6104
 
        bzr view --delete --all
6105
 
    """
6106
 
 
6107
 
    _see_also = []
6108
 
    takes_args = ['file*']
6109
 
    takes_options = [
6110
 
        Option('all',
6111
 
            help='Apply list or delete action to all views.',
6112
 
            ),
6113
 
        Option('delete',
6114
 
            help='Delete the view.',
6115
 
            ),
6116
 
        Option('name',
6117
 
            help='Name of the view to define, list or delete.',
6118
 
            type=unicode,
6119
 
            ),
6120
 
        Option('switch',
6121
 
            help='Name of the view to switch to.',
6122
 
            type=unicode,
6123
 
            ),
6124
 
        ]
6125
 
 
6126
 
    def run(self, file_list,
6127
 
            all=False,
6128
 
            delete=False,
6129
 
            name=None,
6130
 
            switch=None,
6131
 
            ):
6132
 
        tree, file_list = WorkingTree.open_containing_paths(file_list,
6133
 
            apply_view=False)
6134
 
        current_view, view_dict = tree.views.get_view_info()
6135
 
        if name is None:
6136
 
            name = current_view
6137
 
        if delete:
6138
 
            if file_list:
6139
 
                raise errors.BzrCommandError(gettext(
6140
 
                    "Both --delete and a file list specified"))
6141
 
            elif switch:
6142
 
                raise errors.BzrCommandError(gettext(
6143
 
                    "Both --delete and --switch specified"))
6144
 
            elif all:
6145
 
                tree.views.set_view_info(None, {})
6146
 
                self.outf.write(gettext("Deleted all views.\n"))
6147
 
            elif name is None:
6148
 
                raise errors.BzrCommandError(gettext("No current view to delete"))
6149
 
            else:
6150
 
                tree.views.delete_view(name)
6151
 
                self.outf.write(gettext("Deleted '%s' view.\n") % name)
6152
 
        elif switch:
6153
 
            if file_list:
6154
 
                raise errors.BzrCommandError(gettext(
6155
 
                    "Both --switch and a file list specified"))
6156
 
            elif all:
6157
 
                raise errors.BzrCommandError(gettext(
6158
 
                    "Both --switch and --all specified"))
6159
 
            elif switch == 'off':
6160
 
                if current_view is None:
6161
 
                    raise errors.BzrCommandError(gettext("No current view to disable"))
6162
 
                tree.views.set_view_info(None, view_dict)
6163
 
                self.outf.write(gettext("Disabled '%s' view.\n") % (current_view))
6164
 
            else:
6165
 
                tree.views.set_view_info(switch, view_dict)
6166
 
                view_str = views.view_display_str(tree.views.lookup_view())
6167
 
                self.outf.write(gettext("Using '{0}' view: {1}\n").format(switch, view_str))
6168
 
        elif all:
6169
 
            if view_dict:
6170
 
                self.outf.write(gettext('Views defined:\n'))
6171
 
                for view in sorted(view_dict):
6172
 
                    if view == current_view:
6173
 
                        active = "=>"
6174
 
                    else:
6175
 
                        active = "  "
6176
 
                    view_str = views.view_display_str(view_dict[view])
6177
 
                    self.outf.write('%s %-20s %s\n' % (active, view, view_str))
6178
 
            else:
6179
 
                self.outf.write(gettext('No views defined.\n'))
6180
 
        elif file_list:
6181
 
            if name is None:
6182
 
                # No name given and no current view set
6183
 
                name = 'my'
6184
 
            elif name == 'off':
6185
 
                raise errors.BzrCommandError(gettext(
6186
 
                    "Cannot change the 'off' pseudo view"))
6187
 
            tree.views.set_view(name, sorted(file_list))
6188
 
            view_str = views.view_display_str(tree.views.lookup_view())
6189
 
            self.outf.write(gettext("Using '{0}' view: {1}\n").format(name, view_str))
6190
 
        else:
6191
 
            # list the files
6192
 
            if name is None:
6193
 
                # No name given and no current view set
6194
 
                self.outf.write(gettext('No current view.\n'))
6195
 
            else:
6196
 
                view_str = views.view_display_str(tree.views.lookup_view(name))
6197
 
                self.outf.write(gettext("'{0}' view is: {1}\n").format(name, view_str))
6198
 
 
6199
4454
 
6200
4455
class cmd_hooks(Command):
6201
 
    __doc__ = """Show hooks."""
6202
 
 
6203
 
    hidden = True
6204
 
 
6205
 
    def run(self):
6206
 
        for hook_key in sorted(hooks.known_hooks.keys()):
6207
 
            some_hooks = hooks.known_hooks_key_to_object(hook_key)
6208
 
            self.outf.write("%s:\n" % type(some_hooks).__name__)
6209
 
            for hook_name, hook_point in sorted(some_hooks.items()):
6210
 
                self.outf.write("  %s:\n" % (hook_name,))
6211
 
                found_hooks = list(hook_point)
6212
 
                if found_hooks:
6213
 
                    for hook in found_hooks:
6214
 
                        self.outf.write("    %s\n" %
6215
 
                                        (some_hooks.get_hook_name(hook),))
6216
 
                else:
6217
 
                    self.outf.write(gettext("    <no hooks installed>\n"))
6218
 
 
6219
 
 
6220
 
class cmd_remove_branch(Command):
6221
 
    __doc__ = """Remove a branch.
6222
 
 
6223
 
    This will remove the branch from the specified location but 
6224
 
    will keep any working tree or repository in place.
6225
 
 
6226
 
    :Examples:
6227
 
 
6228
 
      Remove the branch at repo/trunk::
6229
 
 
6230
 
        bzr remove-branch repo/trunk
6231
 
 
6232
 
    """
6233
 
 
6234
 
    takes_args = ["location?"]
6235
 
 
6236
 
    aliases = ["rmbranch"]
6237
 
 
6238
 
    def run(self, location=None):
6239
 
        if location is None:
6240
 
            location = "."
6241
 
        branch = Branch.open_containing(location)[0]
6242
 
        branch.bzrdir.destroy_branch()
6243
 
 
6244
 
 
6245
 
class cmd_shelve(Command):
6246
 
    __doc__ = """Temporarily set aside some changes from the current tree.
6247
 
 
6248
 
    Shelve allows you to temporarily put changes you've made "on the shelf",
6249
 
    ie. out of the way, until a later time when you can bring them back from
6250
 
    the shelf with the 'unshelve' command.  The changes are stored alongside
6251
 
    your working tree, and so they aren't propagated along with your branch nor
6252
 
    will they survive its deletion.
6253
 
 
6254
 
    If shelve --list is specified, previously-shelved changes are listed.
6255
 
 
6256
 
    Shelve is intended to help separate several sets of changes that have
6257
 
    been inappropriately mingled.  If you just want to get rid of all changes
6258
 
    and you don't need to restore them later, use revert.  If you want to
6259
 
    shelve all text changes at once, use shelve --all.
6260
 
 
6261
 
    If filenames are specified, only the changes to those files will be
6262
 
    shelved. Other files will be left untouched.
6263
 
 
6264
 
    If a revision is specified, changes since that revision will be shelved.
6265
 
 
6266
 
    You can put multiple items on the shelf, and by default, 'unshelve' will
6267
 
    restore the most recently shelved changes.
6268
 
 
6269
 
    For complicated changes, it is possible to edit the changes in a separate
6270
 
    editor program to decide what the file remaining in the working copy
6271
 
    should look like.  To do this, add the configuration option
6272
 
 
6273
 
        change_editor = PROGRAM @new_path @old_path
6274
 
 
6275
 
    where @new_path is replaced with the path of the new version of the 
6276
 
    file and @old_path is replaced with the path of the old version of 
6277
 
    the file.  The PROGRAM should save the new file with the desired 
6278
 
    contents of the file in the working tree.
6279
 
        
6280
 
    """
6281
 
 
6282
 
    takes_args = ['file*']
6283
 
 
6284
 
    takes_options = [
6285
 
        'directory',
6286
 
        'revision',
6287
 
        Option('all', help='Shelve all changes.'),
6288
 
        'message',
6289
 
        RegistryOption('writer', 'Method to use for writing diffs.',
6290
 
                       bzrlib.option.diff_writer_registry,
6291
 
                       value_switches=True, enum_switch=False),
6292
 
 
6293
 
        Option('list', help='List shelved changes.'),
6294
 
        Option('destroy',
6295
 
               help='Destroy removed changes instead of shelving them.'),
6296
 
    ]
6297
 
    _see_also = ['unshelve', 'configuration']
6298
 
 
6299
 
    def run(self, revision=None, all=False, file_list=None, message=None,
6300
 
            writer=None, list=False, destroy=False, directory=None):
6301
 
        if list:
6302
 
            return self.run_for_list(directory=directory)
6303
 
        from bzrlib.shelf_ui import Shelver
6304
 
        if writer is None:
6305
 
            writer = bzrlib.option.diff_writer_registry.get()
6306
 
        try:
6307
 
            shelver = Shelver.from_args(writer(sys.stdout), revision, all,
6308
 
                file_list, message, destroy=destroy, directory=directory)
6309
 
            try:
6310
 
                shelver.run()
6311
 
            finally:
6312
 
                shelver.finalize()
6313
 
        except errors.UserAbort:
6314
 
            return 0
6315
 
 
6316
 
    def run_for_list(self, directory=None):
6317
 
        if directory is None:
6318
 
            directory = u'.'
6319
 
        tree = WorkingTree.open_containing(directory)[0]
6320
 
        self.add_cleanup(tree.lock_read().unlock)
6321
 
        manager = tree.get_shelf_manager()
6322
 
        shelves = manager.active_shelves()
6323
 
        if len(shelves) == 0:
6324
 
            note(gettext('No shelved changes.'))
6325
 
            return 0
6326
 
        for shelf_id in reversed(shelves):
6327
 
            message = manager.get_metadata(shelf_id).get('message')
6328
 
            if message is None:
6329
 
                message = '<no message>'
6330
 
            self.outf.write('%3d: %s\n' % (shelf_id, message))
6331
 
        return 1
6332
 
 
6333
 
 
6334
 
class cmd_unshelve(Command):
6335
 
    __doc__ = """Restore shelved changes.
6336
 
 
6337
 
    By default, the most recently shelved changes are restored. However if you
6338
 
    specify a shelf by id those changes will be restored instead.  This works
6339
 
    best when the changes don't depend on each other.
6340
 
    """
6341
 
 
6342
 
    takes_args = ['shelf_id?']
6343
 
    takes_options = [
6344
 
        'directory',
6345
 
        RegistryOption.from_kwargs(
6346
 
            'action', help="The action to perform.",
6347
 
            enum_switch=False, value_switches=True,
6348
 
            apply="Apply changes and remove from the shelf.",
6349
 
            dry_run="Show changes, but do not apply or remove them.",
6350
 
            preview="Instead of unshelving the changes, show the diff that "
6351
 
                    "would result from unshelving.",
6352
 
            delete_only="Delete changes without applying them.",
6353
 
            keep="Apply changes but don't delete them.",
6354
 
        )
6355
 
    ]
6356
 
    _see_also = ['shelve']
6357
 
 
6358
 
    def run(self, shelf_id=None, action='apply', directory=u'.'):
6359
 
        from bzrlib.shelf_ui import Unshelver
6360
 
        unshelver = Unshelver.from_args(shelf_id, action, directory=directory)
6361
 
        try:
6362
 
            unshelver.run()
6363
 
        finally:
6364
 
            unshelver.tree.unlock()
6365
 
 
6366
 
 
6367
 
class cmd_clean_tree(Command):
6368
 
    __doc__ = """Remove unwanted files from working tree.
6369
 
 
6370
 
    By default, only unknown files, not ignored files, are deleted.  Versioned
6371
 
    files are never deleted.
6372
 
 
6373
 
    Another class is 'detritus', which includes files emitted by bzr during
6374
 
    normal operations and selftests.  (The value of these files decreases with
6375
 
    time.)
6376
 
 
6377
 
    If no options are specified, unknown files are deleted.  Otherwise, option
6378
 
    flags are respected, and may be combined.
6379
 
 
6380
 
    To check what clean-tree will do, use --dry-run.
6381
 
    """
6382
 
    takes_options = ['directory',
6383
 
                     Option('ignored', help='Delete all ignored files.'),
6384
 
                     Option('detritus', help='Delete conflict files, merge and revert'
6385
 
                            ' backups, and failed selftest dirs.'),
6386
 
                     Option('unknown',
6387
 
                            help='Delete files unknown to bzr (default).'),
6388
 
                     Option('dry-run', help='Show files to delete instead of'
6389
 
                            ' deleting them.'),
6390
 
                     Option('force', help='Do not prompt before deleting.')]
6391
 
    def run(self, unknown=False, ignored=False, detritus=False, dry_run=False,
6392
 
            force=False, directory=u'.'):
6393
 
        from bzrlib.clean_tree import clean_tree
6394
 
        if not (unknown or ignored or detritus):
6395
 
            unknown = True
6396
 
        if dry_run:
6397
 
            force = True
6398
 
        clean_tree(directory, unknown=unknown, ignored=ignored,
6399
 
                   detritus=detritus, dry_run=dry_run, no_prompt=force)
6400
 
 
6401
 
 
6402
 
class cmd_reference(Command):
6403
 
    __doc__ = """list, view and set branch locations for nested trees.
6404
 
 
6405
 
    If no arguments are provided, lists the branch locations for nested trees.
6406
 
    If one argument is provided, display the branch location for that tree.
6407
 
    If two arguments are provided, set the branch location for that tree.
6408
 
    """
6409
 
 
6410
 
    hidden = True
6411
 
 
6412
 
    takes_args = ['path?', 'location?']
6413
 
 
6414
 
    def run(self, path=None, location=None):
6415
 
        branchdir = '.'
6416
 
        if path is not None:
6417
 
            branchdir = path
6418
 
        tree, branch, relpath =(
6419
 
            bzrdir.BzrDir.open_containing_tree_or_branch(branchdir))
6420
 
        if path is not None:
6421
 
            path = relpath
6422
 
        if tree is None:
6423
 
            tree = branch.basis_tree()
 
4456
    """Show a branch's currently registered hooks.
 
4457
    """
 
4458
 
 
4459
    hidden = True
 
4460
    takes_args = ['path?']
 
4461
 
 
4462
    def run(self, path=None):
6424
4463
        if path is None:
6425
 
            info = branch._get_all_reference_info().iteritems()
6426
 
            self._display_reference_info(tree, branch, info)
 
4464
            path = '.'
 
4465
        branch_hooks = Branch.open(path).hooks
 
4466
        for hook_type in branch_hooks:
 
4467
            hooks = branch_hooks[hook_type]
 
4468
            self.outf.write("%s:\n" % (hook_type,))
 
4469
            if hooks:
 
4470
                for hook in hooks:
 
4471
                    self.outf.write("  %s\n" %
 
4472
                                    (branch_hooks.get_hook_name(hook),))
 
4473
            else:
 
4474
                self.outf.write("  <no hooks installed>\n")
 
4475
 
 
4476
 
 
4477
def _create_prefix(cur_transport):
 
4478
    needed = [cur_transport]
 
4479
    # Recurse upwards until we can create a directory successfully
 
4480
    while True:
 
4481
        new_transport = cur_transport.clone('..')
 
4482
        if new_transport.base == cur_transport.base:
 
4483
            raise errors.BzrCommandError(
 
4484
                "Failed to create path prefix for %s."
 
4485
                % cur_transport.base)
 
4486
        try:
 
4487
            new_transport.mkdir('.')
 
4488
        except errors.NoSuchFile:
 
4489
            needed.append(new_transport)
 
4490
            cur_transport = new_transport
6427
4491
        else:
6428
 
            file_id = tree.path2id(path)
6429
 
            if file_id is None:
6430
 
                raise errors.NotVersionedError(path)
6431
 
            if location is None:
6432
 
                info = [(file_id, branch.get_reference_info(file_id))]
6433
 
                self._display_reference_info(tree, branch, info)
6434
 
            else:
6435
 
                branch.set_reference_info(file_id, path, location)
6436
 
 
6437
 
    def _display_reference_info(self, tree, branch, info):
6438
 
        ref_list = []
6439
 
        for file_id, (path, location) in info:
6440
 
            try:
6441
 
                path = tree.id2path(file_id)
6442
 
            except errors.NoSuchId:
6443
 
                pass
6444
 
            ref_list.append((path, location))
6445
 
        for path, location in sorted(ref_list):
6446
 
            self.outf.write('%s %s\n' % (path, location))
6447
 
 
6448
 
 
6449
 
class cmd_export_pot(Command):
6450
 
    __doc__ = """Export command helps and error messages in po format."""
6451
 
 
6452
 
    hidden = True
6453
 
 
6454
 
    def run(self):
6455
 
        from bzrlib.export_pot import export_pot
6456
 
        export_pot(self.outf)
6457
 
 
6458
 
 
6459
 
def _register_lazy_builtins():
6460
 
    # register lazy builtins from other modules; called at startup and should
6461
 
    # be only called once.
6462
 
    for (name, aliases, module_name) in [
6463
 
        ('cmd_bundle_info', [], 'bzrlib.bundle.commands'),
6464
 
        ('cmd_config', [], 'bzrlib.config'),
6465
 
        ('cmd_dpush', [], 'bzrlib.foreign'),
6466
 
        ('cmd_version_info', [], 'bzrlib.cmd_version_info'),
6467
 
        ('cmd_resolve', ['resolved'], 'bzrlib.conflicts'),
6468
 
        ('cmd_conflicts', [], 'bzrlib.conflicts'),
6469
 
        ('cmd_sign_my_commits', [], 'bzrlib.commit_signature_commands'),
6470
 
        ('cmd_verify_signatures', [],
6471
 
                                        'bzrlib.commit_signature_commands'),
6472
 
        ('cmd_test_script', [], 'bzrlib.cmd_test_script'),
6473
 
        ]:
6474
 
        builtin_command_registry.register_lazy(name, aliases, module_name)
 
4492
            break
 
4493
    # Now we only need to create child directories
 
4494
    while needed:
 
4495
        cur_transport = needed.pop()
 
4496
        cur_transport.ensure_base()
 
4497
 
 
4498
 
 
4499
def _get_mergeable_helper(location):
 
4500
    """Get a merge directive or bundle if 'location' points to one.
 
4501
 
 
4502
    Try try to identify a bundle and returns its mergeable form. If it's not,
 
4503
    we return the tried transport anyway so that it can reused to access the
 
4504
    branch
 
4505
 
 
4506
    :param location: can point to a bundle or a branch.
 
4507
 
 
4508
    :return: mergeable, transport
 
4509
    """
 
4510
    mergeable = None
 
4511
    url = urlutils.normalize_url(location)
 
4512
    url, filename = urlutils.split(url, exclude_trailing_slash=False)
 
4513
    location_transport = transport.get_transport(url)
 
4514
    if filename:
 
4515
        try:
 
4516
            # There may be redirections but we ignore the intermediate
 
4517
            # and final transports used
 
4518
            read = bundle.read_mergeable_from_transport
 
4519
            mergeable, t = read(location_transport, filename)
 
4520
        except errors.NotABundle:
 
4521
            # Continue on considering this url a Branch but adjust the
 
4522
            # location_transport
 
4523
            location_transport = location_transport.clone(filename)
 
4524
    return mergeable, location_transport
 
4525
 
 
4526
 
 
4527
# these get imported and then picked up by the scan for cmd_*
 
4528
# TODO: Some more consistent way to split command definitions across files;
 
4529
# we do need to load at least some information about them to know of 
 
4530
# aliases.  ideally we would avoid loading the implementation until the
 
4531
# details were needed.
 
4532
from bzrlib.cmd_version_info import cmd_version_info
 
4533
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4534
from bzrlib.bundle.commands import (
 
4535
    cmd_bundle_info,
 
4536
    )
 
4537
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4538
from bzrlib.weave_commands import cmd_versionedfile_list, cmd_weave_join, \
 
4539
        cmd_weave_plan_merge, cmd_weave_merge_text