← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2006-09-20 14:51:03 UTC
  • mfrom: (0.8.23 version_info)
  • mto: This revision was merged to the branch mainline in revision 2028.
  • Revision ID: john@arbash-meinel.com-20060920145103-02725c6d6c886040
[merge] version-info plugin, and cleanup for layout in bzr

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