/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2010-05-11 08:44:59 UTC
  • mfrom: (5221 +trunk)
  • mto: This revision was merged to the branch mainline in revision 5223.
  • Revision ID: robertc@robertcollins.net-20100511084459-pb0uinna9zs3wu59
Merge trunk - resolve conflicts.

Show diffs side-by-side

added added

removed removed

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