/brz/remove-bazaar

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

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Vincent Ladeuil
  • Date: 2007-06-06 14:26:08 UTC
  • mto: (2485.8.44 bzr.connection.sharing)
  • mto: This revision was merged to the branch mainline in revision 2646.
  • Revision ID: v.ladeuil+lp@free.fr-20070606142608-i9ufaqewadslf1cn
Finish sftp refactoring. Test suite passing.

* bzrlib/transport/sftp.py:
(clear_connection_cache): Deprecated.
(_sftp_connect, _sftp_connect_uncached): Deleted.
(SFTPTransport.__init__): Simplified.
(SFTPTransport._create_connection): New method. Copied from
_sftp_connect_uncached
(SFTPTransport._get_sftp): New method. Ensures that the connection
is established.
(SFTPTransport.clone): Deleted.
(SFTPTransport.has, SFTPTransport.get, SFTPTransport.readv,
SFTPTransport._put,
SFTPTransport._put_non_atomic_helper._open_and_write_file,
SFTPTransport._mkdir, SFTPTransport.append_file,
SFTPTransport.rename, SFTPTransport._rename_and_overwrite,
SFTPTransport.delete, SFTPTransport.rmdir, SFTPTransport.stat):
Use _get_sftp.

* bzrlib/tests/test_transport_implementations.py:
(TransportTests.test_connection_error): Simplified now that sftp
does not connection on construction.

* bzrlib/tests/test_sftp_transport.py:
(SFTPLockTests.test_sftp_locks): Delete test_multiple_connections.
(FakeSFTPTransport): Deleted.
(SFTPNonServerTest.test_parse_url_with_home_dir,
SFTPNonServerTest.test_relpath,
SSHVendorBadConnection.test_bad_connection_paramiko): Delete the
from_transport parameter as it's not needed anymore.
(SFTPLatencyKnob.test_latency_knob_slows_transport,
SFTPLatencyKnob.test_default): Force connection by issuing a
request.

Show diffs side-by-side

added added

removed removed

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