← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Danny van Heumen
  • Date: 2010-03-09 21:42:11 UTC
  • mto: (4634.139.5 2.0)
  • mto: This revision was merged to the branch mainline in revision 5160.
  • Revision ID: danny@dannyvanheumen.nl-20100309214211-iqh42x6qcikgd9p3
Reverted now-useless TODO list.

Show diffs side-by-side

added added

removed removed

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