← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2011-02-25 02:01:51 UTC
  • mfrom: (5676.1.10 per_interrepo-extra)
  • Revision ID: pqm@pqm.ubuntu.com-20110225020151-tlqdjbxfv5byh7l7
(jelmer) Allow repositories to provide extra combinations to run
 bzrlib.tests.per_interrepo with. (Jelmer Vernooij)

Show diffs side-by-side

added added

removed removed

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