/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: Alexander Belchenko
  • Date: 2007-03-15 23:27:43 UTC
  • mto: (2353.4.10 locking)
  • mto: This revision was merged to the branch mainline in revision 2367.
  • Revision ID: bialix@ukr.net-20070315232743-ol8q5vyqzpvdkrjy
forgotten import of TestSkipped

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