← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Andrew Bennetts
  • Date: 2010-10-08 04:25:10 UTC
  • mto: This revision was merged to the branch mainline in revision 5472.
  • Revision ID: andrew.bennetts@canonical.com-20101008042510-sg9vdhmnggilzxsk
Fix stray TAB in source.

Show diffs side-by-side

added added

removed removed

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