/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

Only chown() the .bzr.log when creating it, fixing NEWS entry to put it under 2.2b3

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