← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2007-06-18 06:54:24 UTC
  • mto: This revision was merged to the branch mainline in revision 2551.
  • Revision ID: mbp@sourcefrog.net-20070618065424-awsn4t4tv2bi4okt
Remove duplicated commit use case documentation

Show diffs side-by-side

added added

removed removed

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