/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Canonical.com Patch Queue Manager
  • Date: 2008-09-06 10:25:39 UTC
  • mfrom: (3690.1.2 nicer-error)
  • Revision ID: pqm@pqm.ubuntu.com-20080906102539-ss1fkx2csdcalqlc
Do not traceback on unexpected error responses from a smart server.
        (Andrew Bennetts)

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