← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-06 23:54:05 UTC
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100506235405-wii4elupfhzl3jvy
Add __str__ to the new helper classes.

Show diffs side-by-side

added added

removed removed

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