/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2010-03-01 09:02:18 UTC
  • mto: (5064.1.1 integration)
  • mto: This revision was merged to the branch mainline in revision 5065.
  • Revision ID: v.ladeuil+lp@free.fr-20100301090218-pq3ib5y07dx3wbp6
Delete spurious spaces.

Show diffs side-by-side

added added

removed removed

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