/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-06 11:08:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506110810-h3j07fh5gmw54s25
Cleaner matcher matching revised unlocking protocol.

Show diffs side-by-side

added added

removed removed

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