← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Robert Collins
  • Date: 2007-07-04 01:39:50 UTC
  • mto: This revision was merged to the branch mainline in revision 2581.
  • Revision ID: robertc@robertcollins.net-20070704013950-7pp23plwyqjvgkxg
Review feedback.

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