← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin von Gagern
  • Date: 2010-04-20 08:47:38 UTC
  • mfrom: (5167 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5195.
  • Revision ID: martin.vgagern@gmx.net-20100420084738-ygymnqmdllzrhpfn
merge trunk

Show diffs side-by-side

added added

removed removed

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