← Back to branch summary

~bzr-pqm/bzr/bzr.dev

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: John Arbash Meinel
  • Date: 2007-12-18 18:25:12 UTC
  • mto: (3099.3.2 graph_optimization)
  • mto: This revision was merged to the branch mainline in revision 3124.
  • Revision ID: john@arbash-meinel.com-20071218182512-147g8dhwfd3gv7dh
find_previous_heads was deprecated in 0.91, not 0.93

Show diffs side-by-side

added added

removed removed

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