/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

merge bzr.dev

Show diffs side-by-side

added added

removed removed

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