~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2009-06-16 04:28:19 UTC
  • mto: This revision was merged to the branch mainline in revision 4464.
  • Revision ID: mbp@sourcefrog.net-20090616042819-adz0sq9ct1ls8rrl
Move tools.doc_generate into bzrlib

Show diffs side-by-side

added added

removed removed

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