/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

Initial commit for russian version of documents.

Show diffs side-by-side

added added

removed removed

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