/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: Jelmer Vernooij
  • Date: 2008-07-08 15:58:12 UTC
  • mfrom: (3353.1.4 paramiko-1.7.2-compat)
  • mto: This revision was merged to the branch mainline in revision 3531.
  • Revision ID: jelmer@samba.org-20080708155812-gacwrgs7d7n48a0d
Merge bashprompt script that prints the bzr branch nick.

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
1
 
# Copyright (C) 2005-2010 Canonical Ltd
 
1
# Copyright (C) 2004, 2005, 2006, 2007 Canonical Ltd
2
2
#
3
3
# This program is free software; you can redistribute it and/or modify
4
4
# it under the terms of the GNU General Public License as published by
12
12
#
13
13
# You should have received a copy of the GNU General Public License
14
14
# along with this program; if not, write to the Free Software
15
 
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
16
16
 
17
17
"""builtin bzr commands"""
18
18
 
19
19
import os
 
20
from StringIO import StringIO
20
21
 
21
22
from bzrlib.lazy_import import lazy_import
22
23
lazy_import(globals(), """
23
24
import codecs
24
 
import cStringIO
25
25
import sys
26
26
import time
27
27
 
29
29
from bzrlib import (
30
30
    bugtracker,
31
31
    bundle,
32
 
    btree_index,
33
32
    bzrdir,
34
 
    directory_service,
35
33
    delta,
36
34
    config,
37
35
    errors,
38
36
    globbing,
39
 
    hooks,
 
37
    ignores,
40
38
    log,
41
39
    merge as _mod_merge,
42
40
    merge_directive,
43
41
    osutils,
44
42
    reconfigure,
45
 
    rename_map,
46
43
    revision as _mod_revision,
47
 
    static_tuple,
48
44
    symbol_versioning,
49
 
    timestamp,
50
45
    transport,
 
46
    tree as _mod_tree,
51
47
    ui,
52
48
    urlutils,
53
 
    views,
54
49
    )
55
50
from bzrlib.branch import Branch
56
51
from bzrlib.conflicts import ConflictList
57
 
from bzrlib.transport import memory
58
 
from bzrlib.revisionspec import RevisionSpec, RevisionInfo
 
52
from bzrlib.revisionspec import RevisionSpec
59
53
from bzrlib.smtp_connection import SMTPConnection
60
54
from bzrlib.workingtree import WorkingTree
61
55
""")
62
56
 
63
 
from bzrlib.commands import (
64
 
    Command,
65
 
    builtin_command_registry,
66
 
    display_command,
67
 
    )
68
 
from bzrlib.option import (
69
 
    ListOption,
70
 
    Option,
71
 
    RegistryOption,
72
 
    custom_help,
73
 
    _parse_revision_str,
74
 
    )
75
 
from bzrlib.trace import mutter, note, warning, is_quiet, get_verbosity_level
76
 
 
77
 
 
78
 
def tree_files(file_list, default_branch=u'.', canonicalize=True,
79
 
    apply_view=True):
 
57
from bzrlib.commands import Command, display_command
 
58
from bzrlib.option import ListOption, Option, RegistryOption, custom_help
 
59
from bzrlib.trace import mutter, note, warning, is_quiet, info
 
60
 
 
61
 
 
62
def tree_files(file_list, default_branch=u'.'):
80
63
    try:
81
 
        return internal_tree_files(file_list, default_branch, canonicalize,
82
 
            apply_view)
 
64
        return internal_tree_files(file_list, default_branch)
83
65
    except errors.FileInWrongBranch, e:
84
66
        raise errors.BzrCommandError("%s is not in the same branch as %s" %
85
67
                                     (e.path, file_list[0]))
86
68
 
87
69
 
88
 
def tree_files_for_add(file_list):
89
 
    """
90
 
    Return a tree and list of absolute paths from a file list.
91
 
 
92
 
    Similar to tree_files, but add handles files a bit differently, so it a
93
 
    custom implementation.  In particular, MutableTreeTree.smart_add expects
94
 
    absolute paths, which it immediately converts to relative paths.
95
 
    """
96
 
    # FIXME Would be nice to just return the relative paths like
97
 
    # internal_tree_files does, but there are a large number of unit tests
98
 
    # that assume the current interface to mutabletree.smart_add
99
 
    if file_list:
100
 
        tree, relpath = WorkingTree.open_containing(file_list[0])
101
 
        if tree.supports_views():
102
 
            view_files = tree.views.lookup_view()
103
 
            if view_files:
104
 
                for filename in file_list:
105
 
                    if not osutils.is_inside_any(view_files, filename):
106
 
                        raise errors.FileOutsideView(filename, view_files)
107
 
        file_list = file_list[:]
108
 
        file_list[0] = tree.abspath(relpath)
109
 
    else:
110
 
        tree = WorkingTree.open_containing(u'.')[0]
111
 
        if tree.supports_views():
112
 
            view_files = tree.views.lookup_view()
113
 
            if view_files:
114
 
                file_list = view_files
115
 
                view_str = views.view_display_str(view_files)
116
 
                note("Ignoring files outside view. View is %s" % view_str)
117
 
    return tree, file_list
118
 
 
119
 
 
120
 
def _get_one_revision(command_name, revisions):
121
 
    if revisions is None:
122
 
        return None
123
 
    if len(revisions) != 1:
124
 
        raise errors.BzrCommandError(
125
 
            'bzr %s --revision takes exactly one revision identifier' % (
126
 
                command_name,))
127
 
    return revisions[0]
128
 
 
129
 
 
130
 
def _get_one_revision_tree(command_name, revisions, branch=None, tree=None):
131
 
    """Get a revision tree. Not suitable for commands that change the tree.
132
 
    
133
 
    Specifically, the basis tree in dirstate trees is coupled to the dirstate
134
 
    and doing a commit/uncommit/pull will at best fail due to changing the
135
 
    basis revision data.
136
 
 
137
 
    If tree is passed in, it should be already locked, for lifetime management
138
 
    of the trees internal cached state.
139
 
    """
140
 
    if branch is None:
141
 
        branch = tree.branch
142
 
    if revisions is None:
143
 
        if tree is not None:
144
 
            rev_tree = tree.basis_tree()
145
 
        else:
146
 
            rev_tree = branch.basis_tree()
147
 
    else:
148
 
        revision = _get_one_revision(command_name, revisions)
149
 
        rev_tree = revision.as_tree(branch)
150
 
    return rev_tree
151
 
 
152
 
 
153
70
# XXX: Bad function name; should possibly also be a class method of
154
71
# WorkingTree rather than a function.
155
 
def internal_tree_files(file_list, default_branch=u'.', canonicalize=True,
156
 
    apply_view=True):
 
72
def internal_tree_files(file_list, default_branch=u'.'):
157
73
    """Convert command-line paths to a WorkingTree and relative paths.
158
74
 
159
75
    This is typically used for command-line processors that take one or
161
77
 
162
78
    The filenames given are not required to exist.
163
79
 
164
 
    :param file_list: Filenames to convert.
 
80
    :param file_list: Filenames to convert.  
165
81
 
166
82
    :param default_branch: Fallback tree path to use if file_list is empty or
167
83
        None.
168
84
 
169
 
    :param apply_view: if True and a view is set, apply it or check that
170
 
        specified files are within it
171
 
 
172
85
    :return: workingtree, [relative_paths]
173
86
    """
174
87
    if file_list is None or len(file_list) == 0:
175
 
        tree = WorkingTree.open_containing(default_branch)[0]
176
 
        if tree.supports_views() and apply_view:
177
 
            view_files = tree.views.lookup_view()
178
 
            if view_files:
179
 
                file_list = view_files
180
 
                view_str = views.view_display_str(view_files)
181
 
                note("Ignoring files outside view. View is %s" % view_str)
182
 
        return tree, file_list
 
88
        return WorkingTree.open_containing(default_branch)[0], file_list
183
89
    tree = WorkingTree.open_containing(osutils.realpath(file_list[0]))[0]
184
 
    return tree, safe_relpath_files(tree, file_list, canonicalize,
185
 
        apply_view=apply_view)
186
 
 
187
 
 
188
 
def safe_relpath_files(tree, file_list, canonicalize=True, apply_view=True):
189
 
    """Convert file_list into a list of relpaths in tree.
190
 
 
191
 
    :param tree: A tree to operate on.
192
 
    :param file_list: A list of user provided paths or None.
193
 
    :param apply_view: if True and a view is set, apply it or check that
194
 
        specified files are within it
195
 
    :return: A list of relative paths.
196
 
    :raises errors.PathNotChild: When a provided path is in a different tree
197
 
        than tree.
198
 
    """
199
 
    if file_list is None:
200
 
        return None
201
 
    if tree.supports_views() and apply_view:
202
 
        view_files = tree.views.lookup_view()
203
 
    else:
204
 
        view_files = []
205
90
    new_list = []
206
 
    # tree.relpath exists as a "thunk" to osutils, but canonical_relpath
207
 
    # doesn't - fix that up here before we enter the loop.
208
 
    if canonicalize:
209
 
        fixer = lambda p: osutils.canonical_relpath(tree.basedir, p)
210
 
    else:
211
 
        fixer = tree.relpath
212
91
    for filename in file_list:
213
92
        try:
214
 
            relpath = fixer(osutils.dereference_path(filename))
215
 
            if  view_files and not osutils.is_inside_any(view_files, relpath):
216
 
                raise errors.FileOutsideView(filename, view_files)
217
 
            new_list.append(relpath)
 
93
            new_list.append(tree.relpath(osutils.dereference_path(filename)))
218
94
        except errors.PathNotChild:
219
95
            raise errors.FileInWrongBranch(tree.branch, filename)
220
 
    return new_list
221
 
 
222
 
 
223
 
def _get_view_info_for_change_reporter(tree):
224
 
    """Get the view information from a tree for change reporting."""
225
 
    view_info = None
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)
 
96
    return tree, new_list
241
97
 
242
98
 
243
99
# TODO: Make sure no commands unconditionally use the working directory as a
247
103
# opens the branch?)
248
104
 
249
105
class cmd_status(Command):
250
 
    __doc__ = """Display status summary.
 
106
    """Display status summary.
251
107
 
252
108
    This reports on versioned and unknown files, reporting them
253
109
    grouped by state.  Possible states are:
273
129
    unknown
274
130
        Not versioned and not matching an ignore pattern.
275
131
 
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
132
    To see ignored files use 'bzr ignored'.  For details on the
281
133
    changes to file texts, use 'bzr diff'.
282
 
 
 
134
    
283
135
    Note that --short or -S gives status flags for each item, similar
284
136
    to Subversion's status command. To get output similar to svn -q,
285
137
    use bzr status -SV.
289
141
    files or directories is reported.  If a directory is given, status
290
142
    is reported for everything inside that directory.
291
143
 
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
144
    If a revision argument is given, the status is calculated against
298
145
    that revision, or between two revisions if two are provided.
299
146
    """
300
 
 
 
147
    
301
148
    # TODO: --no-recurse, --recurse options
302
 
 
 
149
    
303
150
    takes_args = ['file*']
304
 
    takes_options = ['show-ids', 'revision', 'change', 'verbose',
 
151
    takes_options = ['show-ids', 'revision', 'change',
305
152
                     Option('short', help='Use short status indicators.',
306
153
                            short_name='S'),
307
154
                     Option('versioned', help='Only show versioned files.',
313
160
 
314
161
    encoding_type = 'replace'
315
162
    _see_also = ['diff', 'revert', 'status-flags']
316
 
 
 
163
    
317
164
    @display_command
318
165
    def run(self, show_ids=False, file_list=None, revision=None, short=False,
319
 
            versioned=False, no_pending=False, verbose=False):
 
166
            versioned=False, no_pending=False):
320
167
        from bzrlib.status import show_tree_status
321
168
 
322
169
        if revision and len(revision) > 2:
323
170
            raise errors.BzrCommandError('bzr status --revision takes exactly'
324
171
                                         ' one or two revision specifiers')
325
172
 
326
 
        tree, relfile_list = tree_files(file_list)
327
 
        # Avoid asking for specific files when that is not needed.
328
 
        if relfile_list == ['']:
329
 
            relfile_list = None
330
 
            # Don't disable pending merges for full trees other than '.'.
331
 
            if file_list == ['.']:
332
 
                no_pending = True
333
 
        # A specific path within a tree was given.
334
 
        elif relfile_list is not None:
335
 
            no_pending = True
 
173
        tree, file_list = tree_files(file_list)
 
174
            
336
175
        show_tree_status(tree, show_ids=show_ids,
337
 
                         specific_files=relfile_list, revision=revision,
 
176
                         specific_files=file_list, revision=revision,
338
177
                         to_file=self.outf, short=short, versioned=versioned,
339
 
                         show_pending=(not no_pending), verbose=verbose)
 
178
                         show_pending=not no_pending)
340
179
 
341
180
 
342
181
class cmd_cat_revision(Command):
343
 
    __doc__ = """Write out metadata for a revision.
344
 
 
 
182
    """Write out metadata for a revision.
 
183
    
345
184
    The revision to print can either be specified by a specific
346
185
    revision identifier, or you can use --revision.
347
186
    """
348
187
 
349
188
    hidden = True
350
189
    takes_args = ['revision_id?']
351
 
    takes_options = ['directory', 'revision']
 
190
    takes_options = ['revision']
352
191
    # cat-revision is more for frontends so should be exact
353
192
    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
 
 
 
193
    
363
194
    @display_command
364
 
    def run(self, revision_id=None, revision=None, directory=u'.'):
 
195
    def run(self, revision_id=None, revision=None):
365
196
        if revision_id is not None and revision is not None:
366
197
            raise errors.BzrCommandError('You can only supply one of'
367
198
                                         ' revision_id or --revision')
368
199
        if revision_id is None and revision is None:
369
200
            raise errors.BzrCommandError('You must supply either'
370
201
                                         ' --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])
471
 
            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
 
 
 
202
        b = WorkingTree.open_containing(u'.')[0].branch
 
203
 
 
204
        # TODO: jam 20060112 should cat-revision always output utf-8?
 
205
        if revision_id is not None:
 
206
            revision_id = osutils.safe_revision_id(revision_id, warn=False)
 
207
            self.outf.write(b.repository.get_revision_xml(revision_id).decode('utf-8'))
 
208
        elif revision is not None:
 
209
            for rev in revision:
 
210
                if rev is None:
 
211
                    raise errors.BzrCommandError('You cannot specify a NULL'
 
212
                                                 ' revision.')
 
213
                rev_id = rev.as_revision_id(b)
 
214
                self.outf.write(b.repository.get_revision_xml(rev_id).decode('utf-8'))
 
215
    
480
216
 
481
217
class cmd_remove_tree(Command):
482
 
    __doc__ = """Remove the working tree from a given branch/checkout.
 
218
    """Remove the working tree from a given branch/checkout.
483
219
 
484
220
    Since a lightweight checkout is little more than a working tree
485
221
    this will refuse to run against one.
487
223
    To re-create the working tree, use "bzr checkout".
488
224
    """
489
225
    _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
 
 
 
226
 
 
227
    takes_args = ['location?']
 
228
 
 
229
    def run(self, location='.'):
 
230
        d = bzrdir.BzrDir.open(location)
 
231
        
 
232
        try:
 
233
            working = d.open_workingtree()
 
234
        except errors.NoWorkingTree:
 
235
            raise errors.BzrCommandError("No working tree to remove")
 
236
        except errors.NotLocalUrl:
 
237
            raise errors.BzrCommandError("You cannot remove the working tree of a "
 
238
                                         "remote path")
 
239
        
 
240
        working_path = working.bzrdir.root_transport.base
 
241
        branch_path = working.branch.bzrdir.root_transport.base
 
242
        if working_path != branch_path:
 
243
            raise errors.BzrCommandError("You cannot remove the working tree from "
 
244
                                         "a lightweight checkout")
 
245
        
 
246
        d.destroy_workingtree()
 
247
        
521
248
 
522
249
class cmd_revno(Command):
523
 
    __doc__ = """Show current revision number.
 
250
    """Show current revision number.
524
251
 
525
252
    This is equal to the number of revisions on this branch.
526
253
    """
527
254
 
528
255
    _see_also = ['info']
529
256
    takes_args = ['location?']
530
 
    takes_options = [
531
 
        Option('tree', help='Show revno of working tree'),
532
 
        ]
533
257
 
534
258
    @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')
 
259
    def run(self, location=u'.'):
 
260
        self.outf.write(str(Branch.open_containing(location)[0].revno()))
 
261
        self.outf.write('\n')
554
262
 
555
263
 
556
264
class cmd_revision_info(Command):
557
 
    __doc__ = """Show revision number and revision id for a given revision identifier.
 
265
    """Show revision number and revision id for a given revision identifier.
558
266
    """
559
267
    hidden = True
560
268
    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
 
        ]
 
269
    takes_options = ['revision']
568
270
 
569
271
    @display_command
570
 
    def run(self, revision=None, directory=u'.', tree=False,
571
 
            revision_info_list=[]):
 
272
    def run(self, revision=None, revision_info_list=[]):
572
273
 
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 = []
 
274
        revs = []
582
275
        if revision is not None:
583
 
            revision_ids.extend(rev.as_revision_id(b) for rev in revision)
 
276
            revs.extend(revision)
584
277
        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:
 
278
            for rev in revision_info_list:
 
279
                revs.append(RevisionSpec.from_string(rev))
 
280
 
 
281
        b = Branch.open_containing(u'.')[0]
 
282
 
 
283
        if len(revs) == 0:
 
284
            revs.append(RevisionSpec.from_string('-1'))
 
285
 
 
286
        for rev in revs:
 
287
            revision_id = rev.as_revision_id(b)
600
288
            try:
601
 
                dotted_revno = b.revision_id_to_dotted_revno(revision_id)
602
 
                revno = '.'.join(str(i) for i in dotted_revno)
 
289
                revno = '%4d' % (b.revision_id_to_revno(revision_id))
603
290
            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
 
 
 
291
                dotted_map = b.get_revision_id_to_revno_map()
 
292
                revno = '.'.join(str(i) for i in dotted_map[revision_id])
 
293
            print '%s %s' % (revno, revision_id)
 
294
 
 
295
    
613
296
class cmd_add(Command):
614
 
    __doc__ = """Add specified files or directories.
 
297
    """Add specified files or directories.
615
298
 
616
299
    In non-recursive mode, all the named items are added, regardless
617
300
    of whether they were previously ignored.  A warning is given if
633
316
    you should never need to explicitly add a directory, they'll just
634
317
    get added when you add a file in the directory.
635
318
 
636
 
    --dry-run will show which files would be added, but not actually
 
319
    --dry-run will show which files would be added, but not actually 
637
320
    add them.
638
321
 
639
322
    --file-ids-from will try to use the file ids from the supplied path.
643
326
    branches that will be merged later (without showing the two different
644
327
    adds as a conflict). It is also useful when merging another project
645
328
    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
329
    """
650
330
    takes_args = ['file*']
651
331
    takes_options = [
659
339
               help='Lookup file ids from this tree.'),
660
340
        ]
661
341
    encoding_type = 'replace'
662
 
    _see_also = ['remove', 'ignore']
 
342
    _see_also = ['remove']
663
343
 
664
344
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False,
665
345
            file_ids_from=None):
682
362
                should_print=(not is_quiet()))
683
363
 
684
364
        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()
 
365
            base_tree.lock_read()
 
366
        try:
 
367
            file_list = self._maybe_expand_globs(file_list)
 
368
            if file_list:
 
369
                tree = WorkingTree.open_containing(file_list[0])[0]
 
370
            else:
 
371
                tree = WorkingTree.open_containing(u'.')[0]
 
372
            added, ignored = tree.smart_add(file_list, not
 
373
                no_recurse, action=action, save=not dry_run)
 
374
        finally:
 
375
            if base_tree is not None:
 
376
                base_tree.unlock()
690
377
        if len(ignored) > 0:
691
378
            if verbose:
692
379
                for glob in sorted(ignored.keys()):
693
380
                    for path in ignored[glob]:
694
 
                        self.outf.write("ignored %s matching \"%s\"\n"
 
381
                        self.outf.write("ignored %s matching \"%s\"\n" 
695
382
                                        % (path, glob))
 
383
            else:
 
384
                match_len = 0
 
385
                for glob, paths in ignored.items():
 
386
                    match_len += len(paths)
 
387
                self.outf.write("ignored %d file(s).\n" % match_len)
 
388
            self.outf.write("If you wish to add some of these files,"
 
389
                            " please add them by name.\n")
696
390
 
697
391
 
698
392
class cmd_mkdir(Command):
699
 
    __doc__ = """Create a new versioned directory.
 
393
    """Create a new versioned directory.
700
394
 
701
395
    This is equivalent to creating the directory and then adding it.
702
396
    """
706
400
 
707
401
    def run(self, dir_list):
708
402
        for d in dir_list:
 
403
            os.mkdir(d)
709
404
            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)
 
405
            wt.add([dd])
 
406
            self.outf.write('added %s\n' % d)
718
407
 
719
408
 
720
409
class cmd_relpath(Command):
721
 
    __doc__ = """Show path of a file relative to root"""
 
410
    """Show path of a file relative to root"""
722
411
 
723
412
    takes_args = ['filename']
724
413
    hidden = True
725
 
 
 
414
    
726
415
    @display_command
727
416
    def run(self, filename):
728
417
        # TODO: jam 20050106 Can relpath return a munged path if
733
422
 
734
423
 
735
424
class cmd_inventory(Command):
736
 
    __doc__ = """Show inventory of the current working copy or a revision.
 
425
    """Show inventory of the current working copy or a revision.
737
426
 
738
427
    It is possible to limit the output to a particular entry
739
428
    type using the --kind option.  For example: --kind file.
758
447
        if kind and kind not in ['file', 'directory', 'symlink']:
759
448
            raise errors.BzrCommandError('invalid kind %r specified' % (kind,))
760
449
 
761
 
        revision = _get_one_revision('inventory', revision)
762
450
        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()
 
451
        work_tree.lock_read()
 
452
        try:
 
453
            if revision is not None:
 
454
                if len(revision) > 1:
 
455
                    raise errors.BzrCommandError(
 
456
                        'bzr inventory --revision takes exactly one revision'
 
457
                        ' identifier')
 
458
                revision_id = revision[0].as_revision_id(work_tree.branch)
 
459
                tree = work_tree.branch.repository.revision_tree(revision_id)
 
460
 
 
461
                extra_trees = [work_tree]
 
462
                tree.lock_read()
 
463
            else:
 
464
                tree = work_tree
 
465
                extra_trees = []
 
466
 
 
467
            if file_list is not None:
 
468
                file_ids = tree.paths2ids(file_list, trees=extra_trees,
 
469
                                          require_versioned=True)
 
470
                # find_ids_across_trees may include some paths that don't
 
471
                # exist in 'tree'.
 
472
                entries = sorted((tree.id2path(file_id), tree.inventory[file_id])
 
473
                                 for file_id in file_ids if file_id in tree)
 
474
            else:
 
475
                entries = tree.inventory.entries()
 
476
        finally:
 
477
            tree.unlock()
 
478
            if tree is not work_tree:
 
479
                work_tree.unlock()
 
480
 
784
481
        for path, entry in entries:
785
482
            if kind and kind != entry.kind:
786
483
                continue
792
489
 
793
490
 
794
491
class cmd_mv(Command):
795
 
    __doc__ = """Move or rename a file.
 
492
    """Move or rename a file.
796
493
 
797
494
    :Usage:
798
495
        bzr mv OLDNAME NEWNAME
815
512
    takes_args = ['names*']
816
513
    takes_options = [Option("after", help="Move only the bzr identifier"
817
514
        " 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
515
        ]
821
516
    aliases = ['move', 'rename']
822
517
    encoding_type = 'replace'
823
518
 
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.')
 
519
    def run(self, names_list, after=False):
829
520
        if names_list is None:
830
521
            names_list = []
 
522
 
831
523
        if len(names_list) < 2:
832
524
            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)
 
525
        tree, rel_names = tree_files(names_list)
 
526
        tree.lock_write()
 
527
        try:
 
528
            self._run(tree, names_list, rel_names, after)
 
529
        finally:
 
530
            tree.unlock()
847
531
 
848
532
    def _run(self, tree, names_list, rel_names, after):
849
533
        into_existing = osutils.isdir(names_list[-1])
858
542
                into_existing = False
859
543
            else:
860
544
                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]))
 
545
                from_id = tree.path2id(rel_names[0])
864
546
                if (not osutils.lexists(names_list[0]) and
865
547
                    from_id and inv.get_file_kind(from_id) == "directory"):
866
548
                    into_existing = False
867
549
        # move/rename
868
550
        if into_existing:
869
551
            # 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))
 
552
            for pair in tree.move(rel_names[:-1], rel_names[-1], after=after):
 
553
                self.outf.write("%s => %s\n" % pair)
876
554
        else:
877
555
            if len(names_list) != 2:
878
556
                raise errors.BzrCommandError('to mv multiple files the'
879
557
                                             ' destination must be a versioned'
880
558
                                             ' 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))
 
559
            tree.rename_one(rel_names[0], rel_names[1], after=after)
 
560
            self.outf.write("%s => %s\n" % (rel_names[0], rel_names[1]))
927
561
 
928
562
 
929
563
class cmd_pull(Command):
930
 
    __doc__ = """Turn this branch into a mirror of another branch.
 
564
    """Turn this branch into a mirror of another branch.
931
565
 
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.
 
566
    This command only works on branches that have not diverged.  Branches are
 
567
    considered diverged if the destination branch's most recent commit is one
 
568
    that has not been merged (directly or indirectly) into the parent.
936
569
 
937
570
    If branches have diverged, you can use 'bzr merge' to integrate the changes
938
571
    from one into the other.  Once one branch has merged, the other should
939
572
    be able to pull it again.
940
573
 
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.
 
574
    If you want to forget your local changes and just update your branch to
 
575
    match the remote one, use pull --overwrite.
944
576
 
945
577
    If there is no default location set, the first pull will set it.  After
946
578
    that, you can omit the location to use the default.  To change the
952
584
    with bzr send.
953
585
    """
954
586
 
955
 
    _see_also = ['push', 'update', 'status-flags', 'send']
 
587
    _see_also = ['push', 'update', 'status-flags']
956
588
    takes_options = ['remember', 'overwrite', 'revision',
957
589
        custom_help('verbose',
958
590
            help='Show logs of pulled revisions.'),
959
 
        custom_help('directory',
 
591
        Option('directory',
960
592
            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."
 
593
                 'rather than the one containing the working directory.',
 
594
            short_name='d',
 
595
            type=unicode,
966
596
            ),
967
597
        ]
968
598
    takes_args = ['location?']
970
600
 
971
601
    def run(self, location=None, remember=False, overwrite=False,
972
602
            revision=None, verbose=False,
973
 
            directory=None, local=False):
 
603
            directory=None):
974
604
        # FIXME: too much stuff is in the command class
975
605
        revision_id = None
976
606
        mergeable = None
979
609
        try:
980
610
            tree_to = WorkingTree.open_containing(directory)[0]
981
611
            branch_to = tree_to.branch
982
 
            self.add_cleanup(tree_to.lock_write().unlock)
983
612
        except errors.NoWorkingTree:
984
613
            tree_to = None
985
614
            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
615
 
991
616
        possible_transports = []
992
617
        if location is not None:
1005
630
                display_url = urlutils.unescape_for_display(stored_loc,
1006
631
                        self.outf.encoding)
1007
632
                if not is_quiet():
1008
 
                    self.outf.write("Using saved parent location: %s\n" % display_url)
 
633
                    self.outf.write("Using saved location: %s\n" % display_url)
1009
634
                location = stored_loc
1010
635
 
1011
 
        revision = _get_one_revision('pull', revision)
1012
636
        if mergeable is not None:
1013
637
            if revision is not None:
1014
638
                raise errors.BzrCommandError(
1020
644
        else:
1021
645
            branch_from = Branch.open(location,
1022
646
                possible_transports=possible_transports)
1023
 
            self.add_cleanup(branch_from.lock_read().unlock)
1024
647
 
1025
648
            if branch_to.get_parent() is None or remember:
1026
649
                branch_to.set_parent(branch_from.base)
1027
650
 
1028
651
        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)
 
652
            if len(revision) == 1:
 
653
                revision_id = revision[0].as_revision_id(branch_from)
 
654
            else:
 
655
                raise errors.BzrCommandError(
 
656
                    'bzr pull --revision takes one value.')
 
657
 
 
658
        branch_to.lock_write()
 
659
        try:
 
660
            if tree_to is not None:
 
661
                change_reporter = delta._ChangeReporter(
 
662
                    unversioned_filter=tree_to.is_ignored)
 
663
                result = tree_to.pull(branch_from, overwrite, revision_id,
 
664
                                      change_reporter,
 
665
                                      possible_transports=possible_transports)
 
666
            else:
 
667
                result = branch_to.pull(branch_from, overwrite, revision_id)
 
668
 
 
669
            result.report(self.outf)
 
670
            if verbose and result.old_revid != result.new_revid:
 
671
                old_rh = list(
 
672
                    branch_to.repository.iter_reverse_revision_history(
 
673
                    result.old_revid))
 
674
                old_rh.reverse()
 
675
                new_rh = branch_to.revision_history()
 
676
                log.show_changed_revisions(branch_to, old_rh, new_rh,
 
677
                                           to_file=self.outf)
 
678
        finally:
 
679
            branch_to.unlock()
1048
680
 
1049
681
 
1050
682
class cmd_push(Command):
1051
 
    __doc__ = """Update a mirror of this branch.
1052
 
 
 
683
    """Update a mirror of this branch.
 
684
    
1053
685
    The target branch will not have its working tree populated because this
1054
686
    is both expensive, and is not supported on remote file systems.
1055
 
 
 
687
    
1056
688
    Some smart servers or protocols *may* put the working tree in place in
1057
689
    the future.
1058
690
 
1062
694
 
1063
695
    If branches have diverged, you can use 'bzr push --overwrite' to replace
1064
696
    the other branch completely, discarding its unmerged changes.
1065
 
 
 
697
    
1066
698
    If you want to ensure you have the different changes in the other branch,
1067
699
    do a merge (see bzr help merge) from the other branch, and commit that.
1068
700
    After that you will be able to do a push without '--overwrite'.
1078
710
        Option('create-prefix',
1079
711
               help='Create the path leading up to the branch '
1080
712
                    'if it does not already exist.'),
1081
 
        custom_help('directory',
 
713
        Option('directory',
1082
714
            help='Branch to push from, '
1083
 
                 'rather than the one containing the working directory.'),
 
715
                 'rather than the one containing the working directory.',
 
716
            short_name='d',
 
717
            type=unicode,
 
718
            ),
1084
719
        Option('use-existing-dir',
1085
720
               help='By default push will fail if the target'
1086
721
                    ' directory exists, but does not already'
1087
722
                    ' have a control directory.  This flag will'
1088
723
                    ' allow push to proceed.'),
1089
 
        Option('stacked',
1090
 
            help='Create a stacked branch that references the public location '
1091
 
                'of the parent branch.'),
1092
 
        Option('stacked-on',
1093
 
            help='Create a stacked branch that refers to another branch '
1094
 
                'for the commit history. Only the work not present in the '
1095
 
                'referenced branch is included in the branch created.',
1096
 
            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
724
        ]
1101
725
    takes_args = ['location?']
1102
726
    encoding_type = 'replace'
1103
727
 
1104
728
    def run(self, location=None, remember=False, overwrite=False,
1105
 
        create_prefix=False, verbose=False, revision=None,
1106
 
        use_existing_dir=False, directory=None, stacked_on=None,
1107
 
        stacked=False, strict=None):
1108
 
        from bzrlib.push import _show_push_branch
1109
 
 
 
729
            create_prefix=False, verbose=False, revision=None,
 
730
            use_existing_dir=False,
 
731
            directory=None):
 
732
        # FIXME: Way too big!  Put this into a function called from the
 
733
        # command.
1110
734
        if directory is None:
1111
735
            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)
1117
 
        if revision is not None:
1118
 
            revision_id = revision.in_history(br_from).rev_id
1119
 
        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.')
1126
 
        # Get the stacked_on branch, if any
1127
 
        if stacked_on is not None:
1128
 
            stacked_on = urlutils.normalize_url(stacked_on)
1129
 
        elif stacked:
1130
 
            parent_url = br_from.get_parent()
1131
 
            if parent_url:
1132
 
                parent = Branch.open(parent_url)
1133
 
                stacked_on = parent.get_public_branch()
1134
 
                if not stacked_on:
1135
 
                    # I considered excluding non-http url's here, thus forcing
1136
 
                    # 'public' branches only, but that only works for some
1137
 
                    # users, so it's best to just depend on the user spotting an
1138
 
                    # error by the feedback given to them. RBC 20080227.
1139
 
                    stacked_on = parent_url
1140
 
            if not stacked_on:
1141
 
                raise errors.BzrCommandError(
1142
 
                    "Could not determine branch to refer to.")
1143
 
 
1144
 
        # Get the destination location
 
736
        br_from = Branch.open_containing(directory)[0]
 
737
        stored_loc = br_from.get_push_location()
1145
738
        if location is None:
1146
 
            stored_loc = br_from.get_push_location()
1147
739
            if stored_loc is None:
1148
 
                raise errors.BzrCommandError(
1149
 
                    "No push location known or specified.")
 
740
                raise errors.BzrCommandError("No push location known or specified.")
1150
741
            else:
1151
742
                display_url = urlutils.unescape_for_display(stored_loc,
1152
743
                        self.outf.encoding)
1153
 
                self.outf.write("Using saved push location: %s\n" % display_url)
 
744
                self.outf.write("Using saved location: %s\n" % display_url)
1154
745
                location = stored_loc
1155
746
 
1156
 
        _show_push_branch(br_from, revision_id, location, self.outf,
1157
 
            verbose=verbose, overwrite=overwrite, remember=remember,
1158
 
            stacked_on=stacked_on, create_prefix=create_prefix,
1159
 
            use_existing_dir=use_existing_dir)
 
747
        to_transport = transport.get_transport(location)
 
748
 
 
749
        br_to = repository_to = dir_to = None
 
750
        try:
 
751
            dir_to = bzrdir.BzrDir.open_from_transport(to_transport)
 
752
        except errors.NotBranchError:
 
753
            pass # Didn't find anything
 
754
        else:
 
755
            # If we can open a branch, use its direct repository, otherwise see
 
756
            # if there is a repository without a branch.
 
757
            try:
 
758
                br_to = dir_to.open_branch()
 
759
            except errors.NotBranchError:
 
760
                # Didn't find a branch, can we find a repository?
 
761
                try:
 
762
                    repository_to = dir_to.find_repository()
 
763
                except errors.NoRepositoryPresent:
 
764
                    pass
 
765
            else:
 
766
                # Found a branch, so we must have found a repository
 
767
                repository_to = br_to.repository
 
768
 
 
769
        if revision is not None:
 
770
            if len(revision) == 1:
 
771
                revision_id = revision[0].in_history(br_from).rev_id
 
772
            else:
 
773
                raise errors.BzrCommandError(
 
774
                    'bzr push --revision takes one value.')
 
775
        else:
 
776
            revision_id = br_from.last_revision()
 
777
 
 
778
        push_result = None
 
779
        if verbose:
 
780
            old_rh = []
 
781
        if dir_to is None:
 
782
            # The destination doesn't exist; create it.
 
783
            # XXX: Refactor the create_prefix/no_create_prefix code into a
 
784
            #      common helper function
 
785
 
 
786
            def make_directory(transport):
 
787
                transport.mkdir('.')
 
788
                return transport
 
789
 
 
790
            def redirected(redirected_transport, e, redirection_notice):
 
791
                return transport.get_transport(e.get_target_url())
 
792
 
 
793
            try:
 
794
                to_transport = transport.do_catching_redirections(
 
795
                    make_directory, to_transport, redirected)
 
796
            except errors.FileExists:
 
797
                if not use_existing_dir:
 
798
                    raise errors.BzrCommandError("Target directory %s"
 
799
                         " already exists, but does not have a valid .bzr"
 
800
                         " directory. Supply --use-existing-dir to push"
 
801
                         " there anyway." % location)
 
802
            except errors.NoSuchFile:
 
803
                if not create_prefix:
 
804
                    raise errors.BzrCommandError("Parent directory of %s"
 
805
                        " does not exist."
 
806
                        "\nYou may supply --create-prefix to create all"
 
807
                        " leading parent directories."
 
808
                        % location)
 
809
                _create_prefix(to_transport)
 
810
            except errors.TooManyRedirections:
 
811
                raise errors.BzrCommandError("Too many redirections trying "
 
812
                                             "to make %s." % location)
 
813
 
 
814
            # Now the target directory exists, but doesn't have a .bzr
 
815
            # directory. So we need to create it, along with any work to create
 
816
            # all of the dependent branches, etc.
 
817
            dir_to = br_from.bzrdir.clone_on_transport(to_transport,
 
818
                                                       revision_id=revision_id)
 
819
            br_to = dir_to.open_branch()
 
820
            # TODO: Some more useful message about what was copied
 
821
            note('Created new branch.')
 
822
            # We successfully created the target, remember it
 
823
            if br_from.get_push_location() is None or remember:
 
824
                br_from.set_push_location(br_to.base)
 
825
        elif repository_to is None:
 
826
            # we have a bzrdir but no branch or repository
 
827
            # XXX: Figure out what to do other than complain.
 
828
            raise errors.BzrCommandError("At %s you have a valid .bzr control"
 
829
                " directory, but not a branch or repository. This is an"
 
830
                " unsupported configuration. Please move the target directory"
 
831
                " out of the way and try again."
 
832
                % location)
 
833
        elif br_to is None:
 
834
            # We have a repository but no branch, copy the revisions, and then
 
835
            # create a branch.
 
836
            repository_to.fetch(br_from.repository, revision_id=revision_id)
 
837
            br_to = br_from.clone(dir_to, revision_id=revision_id)
 
838
            note('Created new branch.')
 
839
            if br_from.get_push_location() is None or remember:
 
840
                br_from.set_push_location(br_to.base)
 
841
        else: # We have a valid to branch
 
842
            # We were able to connect to the remote location, so remember it
 
843
            # we don't need to successfully push because of possible divergence.
 
844
            if br_from.get_push_location() is None or remember:
 
845
                br_from.set_push_location(br_to.base)
 
846
            if verbose:
 
847
                old_rh = br_to.revision_history()
 
848
            try:
 
849
                try:
 
850
                    tree_to = dir_to.open_workingtree()
 
851
                except errors.NotLocalUrl:
 
852
                    warning("This transport does not update the working " 
 
853
                            "tree of: %s. See 'bzr help working-trees' for "
 
854
                            "more information." % br_to.base)
 
855
                    push_result = br_from.push(br_to, overwrite,
 
856
                                               stop_revision=revision_id)
 
857
                except errors.NoWorkingTree:
 
858
                    push_result = br_from.push(br_to, overwrite,
 
859
                                               stop_revision=revision_id)
 
860
                else:
 
861
                    tree_to.lock_write()
 
862
                    try:
 
863
                        push_result = br_from.push(tree_to.branch, overwrite,
 
864
                                                   stop_revision=revision_id)
 
865
                        tree_to.update()
 
866
                    finally:
 
867
                        tree_to.unlock()
 
868
            except errors.DivergedBranches:
 
869
                raise errors.BzrCommandError('These branches have diverged.'
 
870
                                        '  Try using "merge" and then "push".')
 
871
        if push_result is not None:
 
872
            push_result.report(self.outf)
 
873
        elif verbose:
 
874
            new_rh = br_to.revision_history()
 
875
            if old_rh != new_rh:
 
876
                # Something changed
 
877
                from bzrlib.log import show_changed_revisions
 
878
                show_changed_revisions(br_to, old_rh, new_rh,
 
879
                                       to_file=self.outf)
 
880
        else:
 
881
            # we probably did a clone rather than a push, so a message was
 
882
            # emitted above
 
883
            pass
1160
884
 
1161
885
 
1162
886
class cmd_branch(Command):
1163
 
    __doc__ = """Create a new branch that is a copy of an existing branch.
 
887
    """Create a new copy of a branch.
1164
888
 
1165
889
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
1166
890
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
1176
900
    _see_also = ['checkout']
1177
901
    takes_args = ['from_location', 'to_location?']
1178
902
    takes_options = ['revision', Option('hardlink',
1179
 
        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
 
        Option('stacked',
1186
 
            help='Create a stacked branch referring to the source branch. '
1187
 
                'The new branch will depend on the availability of the source '
1188
 
                '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
 
        ]
 
903
        help='Hard-link working tree files where possible.')]
1199
904
    aliases = ['get', 'clone']
1200
905
 
1201
906
    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
 
907
            hardlink=False):
1205
908
        from bzrlib.tag import _merge_tags_if_possible
 
909
        if revision is None:
 
910
            revision = [None]
 
911
        elif len(revision) > 1:
 
912
            raise errors.BzrCommandError(
 
913
                'bzr branch --revision takes exactly 1 revision value')
 
914
 
1206
915
        accelerator_tree, br_from = bzrdir.BzrDir.open_tree_or_branch(
1207
916
            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)
 
917
        br_from.lock_read()
1220
918
        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)
 
919
            if len(revision) == 1 and revision[0] is not None:
 
920
                revision_id = revision[0].as_revision_id(br_from)
1226
921
            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:
 
922
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
923
                # None or perhaps NULL_REVISION to mean copy nothing
 
924
                # RBC 20060209
 
925
                revision_id = br_from.last_revision()
 
926
            if to_location is None:
 
927
                to_location = urlutils.derive_to_location(from_location)
 
928
            to_transport = transport.get_transport(to_location)
 
929
            try:
 
930
                to_transport.mkdir('.')
 
931
            except errors.FileExists:
 
932
                raise errors.BzrCommandError('Target directory "%s" already'
 
933
                                             ' exists.' % to_location)
 
934
            except errors.NoSuchFile:
 
935
                raise errors.BzrCommandError('Parent of "%s" does not exist.'
 
936
                                             % to_location)
 
937
            try:
 
938
                # preserve whatever source format we have.
 
939
                dir = br_from.bzrdir.sprout(to_transport.base, revision_id,
 
940
                                            possible_transports=[to_transport],
 
941
                                            accelerator_tree=accelerator_tree,
 
942
                                            hardlink=hardlink)
 
943
                branch = dir.open_branch()
 
944
            except errors.NoSuchRevision:
 
945
                to_transport.delete_tree('.')
 
946
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
947
                raise errors.BzrCommandError(msg)
 
948
            _merge_tags_if_possible(br_from, branch)
1260
949
            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'))
 
950
        finally:
 
951
            br_from.unlock()
1272
952
 
1273
953
 
1274
954
class cmd_checkout(Command):
1275
 
    __doc__ = """Create a new checkout of an existing branch.
 
955
    """Create a new checkout of an existing branch.
1276
956
 
1277
957
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
1278
958
    the branch found in '.'. This is useful if you have removed the working tree
1279
959
    or if it was never created - i.e. if you pushed the branch to its current
1280
960
    location using SFTP.
1281
 
 
 
961
    
1282
962
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
1283
963
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
1284
964
    If the BRANCH_LOCATION has no / or path separator embedded, the TO_LOCATION
1312
992
 
1313
993
    def run(self, branch_location=None, to_location=None, revision=None,
1314
994
            lightweight=False, files_from=None, hardlink=False):
 
995
        if revision is None:
 
996
            revision = [None]
 
997
        elif len(revision) > 1:
 
998
            raise errors.BzrCommandError(
 
999
                'bzr checkout --revision takes exactly 1 revision value')
1315
1000
        if branch_location is None:
1316
1001
            branch_location = osutils.getcwd()
1317
1002
            to_location = branch_location
1318
1003
        accelerator_tree, source = bzrdir.BzrDir.open_tree_or_branch(
1319
1004
            branch_location)
1320
 
        revision = _get_one_revision('checkout', revision)
1321
1005
        if files_from is not None:
1322
1006
            accelerator_tree = WorkingTree.open(files_from)
1323
 
        if revision is not None:
1324
 
            revision_id = revision.as_revision_id(source)
 
1007
        if len(revision) == 1 and revision[0] is not None:
 
1008
            revision_id = revision[0].as_revision_id(source)
1325
1009
        else:
1326
1010
            revision_id = None
1327
1011
        if to_location is None:
1328
1012
            to_location = urlutils.derive_to_location(branch_location)
1329
 
        # if the source and to_location are the same,
 
1013
        # if the source and to_location are the same, 
1330
1014
        # and there is no working tree,
1331
1015
        # then reconstitute a branch
1332
1016
        if (osutils.abspath(to_location) ==
1336
1020
            except errors.NoWorkingTree:
1337
1021
                source.bzrdir.create_workingtree(revision_id)
1338
1022
                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
1023
        source.create_checkout(to_location, revision_id, lightweight,
1345
1024
                               accelerator_tree, hardlink)
1346
1025
 
1347
1026
 
1348
1027
class cmd_renames(Command):
1349
 
    __doc__ = """Show list of renamed files.
 
1028
    """Show list of renamed files.
1350
1029
    """
1351
1030
    # TODO: Option to show renames between two historical versions.
1352
1031
 
1357
1036
    @display_command
1358
1037
    def run(self, dir=u'.'):
1359
1038
        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))
 
1039
        tree.lock_read()
 
1040
        try:
 
1041
            new_inv = tree.inventory
 
1042
            old_tree = tree.basis_tree()
 
1043
            old_tree.lock_read()
 
1044
            try:
 
1045
                old_inv = old_tree.inventory
 
1046
                renames = list(_mod_tree.find_renames(old_inv, new_inv))
 
1047
                renames.sort()
 
1048
                for old_name, new_name in renames:
 
1049
                    self.outf.write("%s => %s\n" % (old_name, new_name))
 
1050
            finally:
 
1051
                old_tree.unlock()
 
1052
        finally:
 
1053
            tree.unlock()
1376
1054
 
1377
1055
 
1378
1056
class cmd_update(Command):
1379
 
    __doc__ = """Update a tree to have the latest code committed to its branch.
1380
 
 
 
1057
    """Update a tree to have the latest code committed to its branch.
 
1058
    
1381
1059
    This will perform a merge into the working tree, and may generate
1382
 
    conflicts. If you have any local changes, you will still
 
1060
    conflicts. If you have any local changes, you will still 
1383
1061
    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
 
1062
    
 
1063
    If you want to discard your local changes, you can just do a 
1386
1064
    '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
1065
    """
1391
1066
 
1392
1067
    _see_also = ['pull', 'working-trees', 'status-flags']
1393
1068
    takes_args = ['dir?']
1394
 
    takes_options = ['revision']
1395
1069
    aliases = ['up']
1396
1070
 
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")
 
1071
    def run(self, dir='.'):
1401
1072
        tree = WorkingTree.open_containing(dir)[0]
1402
 
        branch = tree.branch
1403
1073
        possible_transports = []
1404
 
        master = branch.get_master_branch(
 
1074
        master = tree.branch.get_master_branch(
1405
1075
            possible_transports=possible_transports)
1406
1076
        if master is not None:
1407
 
            branch_location = master.base
1408
1077
            tree.lock_write()
1409
1078
        else:
1410
 
            branch_location = tree.branch.base
1411
1079
            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
1080
        try:
 
1081
            existing_pending_merges = tree.get_parent_ids()[1:]
 
1082
            last_rev = _mod_revision.ensure_null(tree.last_revision())
 
1083
            if last_rev == _mod_revision.ensure_null(
 
1084
                tree.branch.last_revision()):
 
1085
                # may be up to date, check master too.
 
1086
                if master is None or last_rev == _mod_revision.ensure_null(
 
1087
                    master.last_revision()):
 
1088
                    revno = tree.branch.revision_id_to_revno(last_rev)
 
1089
                    note("Tree is up to date at revision %d." % (revno,))
 
1090
                    return 0
1439
1091
            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
 
1092
                delta._ChangeReporter(unversioned_filter=tree.is_ignored),
 
1093
                possible_transports=possible_transports)
 
1094
            revno = tree.branch.revision_id_to_revno(
 
1095
                _mod_revision.ensure_null(tree.last_revision()))
 
1096
            note('Updated to revision %d.' % (revno,))
 
1097
            if tree.get_parent_ids()[1:] != existing_pending_merges:
 
1098
                note('Your local commits will now show as pending merges with '
 
1099
                     "'bzr status', and can be committed with 'bzr commit'.")
 
1100
            if conflicts != 0:
 
1101
                return 1
 
1102
            else:
 
1103
                return 0
 
1104
        finally:
 
1105
            tree.unlock()
1462
1106
 
1463
1107
 
1464
1108
class cmd_info(Command):
1465
 
    __doc__ = """Show information about a working tree, branch or repository.
 
1109
    """Show information about a working tree, branch or repository.
1466
1110
 
1467
1111
    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.
 
1112
    tree, branch or repository.  Statistical information is included with
 
1113
    each report.
1473
1114
 
1474
1115
    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
1116
    """
1492
1117
    _see_also = ['revno', 'working-trees', 'repositories']
1493
1118
    takes_args = ['location?']
1497
1122
    @display_command
1498
1123
    def run(self, location=None, verbose=False):
1499
1124
        if verbose:
1500
 
            noise_level = get_verbosity_level()
 
1125
            noise_level = 2
1501
1126
        else:
1502
1127
            noise_level = 0
1503
1128
        from bzrlib.info import show_bzrdir_info
1506
1131
 
1507
1132
 
1508
1133
class cmd_remove(Command):
1509
 
    __doc__ = """Remove files or directories.
1510
 
 
1511
 
    This makes bzr stop tracking changes to the specified files. bzr will delete
1512
 
    them if they can easily be recovered using revert. If no options or
1513
 
    parameters are given bzr will scan for files that are being tracked by bzr
1514
 
    but missing in your tree and stop tracking them for you.
 
1134
    """Remove files or directories.
 
1135
 
 
1136
    This makes bzr stop tracking changes to the specified files and
 
1137
    delete them if they can easily be recovered using revert.
 
1138
 
 
1139
    You can specify one or more files, and/or --new.  If you specify --new,
 
1140
    only 'added' files will be removed.  If you specify both, then new files
 
1141
    in the specified directories will be removed.  If the directories are
 
1142
    also new, they will also be removed.
1515
1143
    """
1516
1144
    takes_args = ['file*']
1517
1145
    takes_options = ['verbose',
1518
 
        Option('new', help='Only remove files that have never been committed.'),
 
1146
        Option('new', help='Remove newly-added files.'),
1519
1147
        RegistryOption.from_kwargs('file-deletion-strategy',
1520
1148
            'The file deletion mode to be used.',
1521
1149
            title='Deletion Strategy', value_switches=True, enum_switch=False,
1522
1150
            safe='Only delete files if they can be'
1523
1151
                 ' safely recovered (default).',
1524
 
            keep='Delete from bzr but leave the working copy.',
 
1152
            keep="Don't delete any files.",
1525
1153
            force='Delete all the specified files, even if they can not be '
1526
1154
                'recovered and even if they are non-empty directories.')]
1527
 
    aliases = ['rm', 'del']
 
1155
    aliases = ['rm']
1528
1156
    encoding_type = 'replace'
1529
1157
 
1530
1158
    def run(self, file_list, verbose=False, new=False,
1533
1161
 
1534
1162
        if file_list is not None:
1535
1163
            file_list = [f for f in file_list]
 
1164
        elif not new:
 
1165
            raise errors.BzrCommandError('Specify one or more files to'
 
1166
            ' remove, or use --new.')
1536
1167
 
1537
 
        self.add_cleanup(tree.lock_write().unlock)
1538
 
        # Heuristics should probably all move into tree.remove_smart or
1539
 
        # some such?
1540
1168
        if new:
1541
1169
            added = tree.changes_from(tree.basis_tree(),
1542
1170
                specific_files=file_list).added
1543
1171
            file_list = sorted([f[0] for f in added], reverse=True)
1544
1172
            if len(file_list) == 0:
1545
1173
                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
1174
        tree.remove(file_list, verbose=verbose, to_file=self.outf,
1557
1175
            keep_files=file_deletion_strategy=='keep',
1558
1176
            force=file_deletion_strategy=='force')
1559
1177
 
1560
1178
 
1561
1179
class cmd_file_id(Command):
1562
 
    __doc__ = """Print file_id of a particular file or directory.
 
1180
    """Print file_id of a particular file or directory.
1563
1181
 
1564
1182
    The file_id is assigned when the file is first added and remains the
1565
1183
    same through all revisions where the file exists, even when it is
1581
1199
 
1582
1200
 
1583
1201
class cmd_file_path(Command):
1584
 
    __doc__ = """Print path of file_ids to a file or directory.
 
1202
    """Print path of file_ids to a file or directory.
1585
1203
 
1586
1204
    This prints one line for each directory down to the target,
1587
1205
    starting at the branch root.
1603
1221
 
1604
1222
 
1605
1223
class cmd_reconcile(Command):
1606
 
    __doc__ = """Reconcile bzr metadata in a branch.
 
1224
    """Reconcile bzr metadata in a branch.
1607
1225
 
1608
1226
    This can correct data mismatches that may have been caused by
1609
1227
    previous ghost operations or bzr upgrades. You should only
1610
 
    need to run this command if 'bzr check' or a bzr developer
 
1228
    need to run this command if 'bzr check' or a bzr developer 
1611
1229
    advises you to run it.
1612
1230
 
1613
1231
    If a second branch is provided, cross-branch reconciliation is
1615
1233
    id which was not present in very early bzr versions is represented
1616
1234
    correctly in both branches.
1617
1235
 
1618
 
    At the same time it is run it may recompress data resulting in
 
1236
    At the same time it is run it may recompress data resulting in 
1619
1237
    a potential saving in disk space or performance gain.
1620
1238
 
1621
1239
    The branch *MUST* be on a listable system such as local disk or sftp.
1631
1249
 
1632
1250
 
1633
1251
class cmd_revision_history(Command):
1634
 
    __doc__ = """Display the list of revision ids on a branch."""
 
1252
    """Display the list of revision ids on a branch."""
1635
1253
 
1636
1254
    _see_also = ['log']
1637
1255
    takes_args = ['location?']
1647
1265
 
1648
1266
 
1649
1267
class cmd_ancestry(Command):
1650
 
    __doc__ = """List all revisions merged into this branch."""
 
1268
    """List all revisions merged into this branch."""
1651
1269
 
1652
1270
    _see_also = ['log', 'revision-history']
1653
1271
    takes_args = ['location?']
1672
1290
 
1673
1291
 
1674
1292
class cmd_init(Command):
1675
 
    __doc__ = """Make a directory into a versioned branch.
 
1293
    """Make a directory into a versioned branch.
1676
1294
 
1677
1295
    Use this to create an empty branch, or before importing an
1678
1296
    existing project.
1679
1297
 
1680
 
    If there is a repository in a parent directory of the location, then
 
1298
    If there is a repository in a parent directory of the location, then 
1681
1299
    the history of the branch will be stored in the repository.  Otherwise
1682
1300
    init creates a standalone branch which carries its own history
1683
1301
    in the .bzr directory.
1703
1321
         RegistryOption('format',
1704
1322
                help='Specify a format for this branch. '
1705
1323
                'See "help formats".',
1706
 
                lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1707
 
                converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1324
                registry=bzrdir.format_registry,
 
1325
                converter=bzrdir.format_registry.make_bzrdir,
1708
1326
                value_switches=True,
1709
 
                title="Branch format",
 
1327
                title="Branch Format",
1710
1328
                ),
1711
1329
         Option('append-revisions-only',
1712
1330
                help='Never change revnos or the existing log.'
1735
1353
                    "\nYou may supply --create-prefix to create all"
1736
1354
                    " leading parent directories."
1737
1355
                    % location)
1738
 
            to_transport.create_prefix()
 
1356
            _create_prefix(to_transport)
1739
1357
 
1740
1358
        try:
1741
 
            a_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
 
1359
            existing_bzrdir = bzrdir.BzrDir.open_from_transport(to_transport)
1742
1360
        except errors.NotBranchError:
1743
1361
            # really a NotBzrDir error...
1744
1362
            create_branch = bzrdir.BzrDir.create_branch_convenience
1745
1363
            branch = create_branch(to_transport.base, format=format,
1746
1364
                                   possible_transports=[to_transport])
1747
 
            a_bzrdir = branch.bzrdir
1748
1365
        else:
1749
1366
            from bzrlib.transport.local import LocalTransport
1750
 
            if a_bzrdir.has_branch():
 
1367
            if existing_bzrdir.has_branch():
1751
1368
                if (isinstance(to_transport, LocalTransport)
1752
 
                    and not a_bzrdir.has_workingtree()):
 
1369
                    and not existing_bzrdir.has_workingtree()):
1753
1370
                        raise errors.BranchExistsWithoutWorkingTree(location)
1754
1371
                raise errors.AlreadyBranchError(location)
1755
 
            branch = a_bzrdir.create_branch()
1756
 
            a_bzrdir.create_workingtree()
 
1372
            else:
 
1373
                branch = existing_bzrdir.create_branch()
 
1374
                existing_bzrdir.create_workingtree()
1757
1375
        if append_revisions_only:
1758
1376
            try:
1759
1377
                branch.set_append_revisions_only(True)
1760
1378
            except errors.UpgradeRequired:
1761
1379
                raise errors.BzrCommandError('This branch format cannot be set'
1762
 
                    ' to append-revisions-only.  Try --default.')
1763
 
        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)
 
1380
                    ' to append-revisions-only.  Try --experimental-branch6')
1781
1381
 
1782
1382
 
1783
1383
class cmd_init_repository(Command):
1784
 
    __doc__ = """Create a shared repository for branches to share storage space.
 
1384
    """Create a shared repository to hold branches.
1785
1385
 
1786
1386
    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.
 
1387
    revisions in the repository, not in the branch directory.
1790
1388
 
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.
 
1389
    If the --no-trees option is used then the branches in the repository
 
1390
    will not have working trees by default.
1797
1391
 
1798
1392
    :Examples:
1799
 
        Create a shared repository holding just branches::
 
1393
        Create a shared repositories holding just branches::
1800
1394
 
1801
1395
            bzr init-repo --no-trees repo
1802
1396
            bzr init repo/trunk
1813
1407
    takes_options = [RegistryOption('format',
1814
1408
                            help='Specify a format for this repository. See'
1815
1409
                                 ' "bzr help formats" for details.',
1816
 
                            lazy_registry=('bzrlib.bzrdir', 'format_registry'),
1817
 
                            converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
1410
                            registry=bzrdir.format_registry,
 
1411
                            converter=bzrdir.format_registry.make_bzrdir,
1818
1412
                            value_switches=True, title='Repository format'),
1819
1413
                     Option('no-trees',
1820
1414
                             help='Branches in the repository will default to'
1835
1429
        newdir = format.initialize_on_transport(to_transport)
1836
1430
        repo = newdir.create_repository(shared=True)
1837
1431
        repo.set_make_working_trees(not no_trees)
1838
 
        if not is_quiet():
1839
 
            from bzrlib.info import show_bzrdir_info
1840
 
            show_bzrdir_info(repo.bzrdir, verbose=0, outfile=self.outf)
1841
1432
 
1842
1433
 
1843
1434
class cmd_diff(Command):
1844
 
    __doc__ = """Show differences in the working tree, between revisions or branches.
1845
 
 
 
1435
    """Show differences in the working tree, between revisions or branches.
 
1436
    
1846
1437
    If no arguments are given, all changes for the current tree are listed.
1847
1438
    If files are given, only the changes in those files are listed.
1848
1439
    Remote and multiple branches can be compared by using the --old and
1868
1459
 
1869
1460
            bzr diff -r1
1870
1461
 
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
 
1462
        Difference between revision 2 and revision 1::
 
1463
 
 
1464
            bzr diff -r1..2
 
1465
 
 
1466
        Difference between revision 2 and revision 1 for branch xxx::
 
1467
 
 
1468
            bzr diff -r1..2 xxx
1892
1469
 
1893
1470
        Show just the differences for file NEWS::
1894
1471
 
1933
1510
            help='Use this command to compare files.',
1934
1511
            type=unicode,
1935
1512
            ),
1936
 
        RegistryOption('format',
1937
 
            help='Diff format to use.',
1938
 
            lazy_registry=('bzrlib.diff', 'format_registry'),
1939
 
            value_switches=False, title='Diff format'),
1940
1513
        ]
1941
1514
    aliases = ['di', 'dif']
1942
1515
    encoding_type = 'exact'
1943
1516
 
1944
1517
    @display_command
1945
1518
    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)
 
1519
            prefix=None, old=None, new=None, using=None):
 
1520
        from bzrlib.diff import _get_trees_to_diff, show_diff_trees
1949
1521
 
1950
1522
        if (prefix is None) or (prefix == '0'):
1951
1523
            # diff -p0 format
1965
1537
            raise errors.BzrCommandError('bzr diff --revision takes exactly'
1966
1538
                                         ' one or two revision specifiers')
1967
1539
 
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,
 
1540
        old_tree, new_tree, specific_files, extra_trees = \
 
1541
                _get_trees_to_diff(file_list, revision, old, new)
 
1542
        return show_diff_trees(old_tree, new_tree, sys.stdout, 
1977
1543
                               specific_files=specific_files,
1978
1544
                               external_diff_options=diff_options,
1979
1545
                               old_label=old_label, new_label=new_label,
1980
 
                               extra_trees=extra_trees, using=using,
1981
 
                               format_cls=format)
 
1546
                               extra_trees=extra_trees, using=using)
1982
1547
 
1983
1548
 
1984
1549
class cmd_deleted(Command):
1985
 
    __doc__ = """List files deleted in the working tree.
 
1550
    """List files deleted in the working tree.
1986
1551
    """
1987
1552
    # TODO: Show files deleted since a previous revision, or
1988
1553
    # between two revisions.
1991
1556
    # level of effort but possibly much less IO.  (Or possibly not,
1992
1557
    # if the directories are very large...)
1993
1558
    _see_also = ['status', 'ls']
1994
 
    takes_options = ['directory', 'show-ids']
 
1559
    takes_options = ['show-ids']
1995
1560
 
1996
1561
    @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')
 
1562
    def run(self, show_ids=False):
 
1563
        tree = WorkingTree.open_containing(u'.')[0]
 
1564
        tree.lock_read()
 
1565
        try:
 
1566
            old = tree.basis_tree()
 
1567
            old.lock_read()
 
1568
            try:
 
1569
                for path, ie in old.inventory.iter_entries():
 
1570
                    if not tree.has_id(ie.file_id):
 
1571
                        self.outf.write(path)
 
1572
                        if show_ids:
 
1573
                            self.outf.write(' ')
 
1574
                            self.outf.write(ie.file_id)
 
1575
                        self.outf.write('\n')
 
1576
            finally:
 
1577
                old.unlock()
 
1578
        finally:
 
1579
            tree.unlock()
2009
1580
 
2010
1581
 
2011
1582
class cmd_modified(Command):
2012
 
    __doc__ = """List files modified in working tree.
 
1583
    """List files modified in working tree.
2013
1584
    """
2014
1585
 
2015
1586
    hidden = True
2016
1587
    _see_also = ['status', 'ls']
2017
 
    takes_options = ['directory', 'null']
 
1588
    takes_options = [
 
1589
            Option('null',
 
1590
                   help='Write an ascii NUL (\\0) separator '
 
1591
                   'between files rather than a newline.')
 
1592
            ]
2018
1593
 
2019
1594
    @display_command
2020
 
    def run(self, null=False, directory=u'.'):
2021
 
        tree = WorkingTree.open_containing(directory)[0]
 
1595
    def run(self, null=False):
 
1596
        tree = WorkingTree.open_containing(u'.')[0]
2022
1597
        td = tree.changes_from(tree.basis_tree())
2023
1598
        for path, id, kind, text_modified, meta_modified in td.modified:
2024
1599
            if null:
2028
1603
 
2029
1604
 
2030
1605
class cmd_added(Command):
2031
 
    __doc__ = """List files added in working tree.
 
1606
    """List files added in working tree.
2032
1607
    """
2033
1608
 
2034
1609
    hidden = True
2035
1610
    _see_also = ['status', 'ls']
2036
 
    takes_options = ['directory', 'null']
 
1611
    takes_options = [
 
1612
            Option('null',
 
1613
                   help='Write an ascii NUL (\\0) separator '
 
1614
                   'between files rather than a newline.')
 
1615
            ]
2037
1616
 
2038
1617
    @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')
 
1618
    def run(self, null=False):
 
1619
        wt = WorkingTree.open_containing(u'.')[0]
 
1620
        wt.lock_read()
 
1621
        try:
 
1622
            basis = wt.basis_tree()
 
1623
            basis.lock_read()
 
1624
            try:
 
1625
                basis_inv = basis.inventory
 
1626
                inv = wt.inventory
 
1627
                for file_id in inv:
 
1628
                    if file_id in basis_inv:
 
1629
                        continue
 
1630
                    if inv.is_root(file_id) and len(basis_inv) == 0:
 
1631
                        continue
 
1632
                    path = inv.id2path(file_id)
 
1633
                    if not os.access(osutils.abspath(path), os.F_OK):
 
1634
                        continue
 
1635
                    if null:
 
1636
                        self.outf.write(path + '\0')
 
1637
                    else:
 
1638
                        self.outf.write(osutils.quotefn(path) + '\n')
 
1639
            finally:
 
1640
                basis.unlock()
 
1641
        finally:
 
1642
            wt.unlock()
2058
1643
 
2059
1644
 
2060
1645
class cmd_root(Command):
2061
 
    __doc__ = """Show the tree root directory.
 
1646
    """Show the tree root directory.
2062
1647
 
2063
1648
    The root is the nearest enclosing directory with a .bzr control
2064
1649
    directory."""
2079
1664
        raise errors.BzrCommandError(msg)
2080
1665
 
2081
1666
 
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
1667
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.
 
1668
    """Show log of a branch, file, or directory.
 
1669
 
 
1670
    By default show the log of the branch containing the working directory.
 
1671
 
 
1672
    To request a range of logs, you can use the command -r begin..end
 
1673
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1674
    also valid.
 
1675
 
 
1676
    :Examples:
 
1677
        Log the current branch::
 
1678
 
 
1679
            bzr log
 
1680
 
 
1681
        Log a file::
 
1682
 
 
1683
            bzr log foo.c
 
1684
 
 
1685
        Log the last 10 revisions of a branch::
 
1686
 
 
1687
            bzr log -r -10.. http://server/branch
2241
1688
    """
2242
 
    takes_args = ['file*']
2243
 
    _see_also = ['log-formats', 'revisionspec']
 
1689
 
 
1690
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1691
 
 
1692
    takes_args = ['location?']
2244
1693
    takes_options = [
2245
1694
            Option('forward',
2246
1695
                   help='Show from oldest to newest.'),
2247
 
            'timezone',
 
1696
            Option('timezone',
 
1697
                   type=str,
 
1698
                   help='Display timezone as local, original, or utc.'),
2248
1699
            custom_help('verbose',
2249
1700
                   help='Show files changed in each revision.'),
2250
1701
            'show-ids',
2251
1702
            '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
1703
            '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
1704
            Option('message',
2269
1705
                   short_name='m',
2270
1706
                   help='Show revisions whose message matches this '
2275
1711
                   help='Limit the output to the first N revisions.',
2276
1712
                   argname='N',
2277
1713
                   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
1714
            ]
2288
1715
    encoding_type = 'replace'
2289
1716
 
2290
1717
    @display_command
2291
 
    def run(self, file_list=None, timezone='original',
 
1718
    def run(self, location=None, timezone='original',
2292
1719
            verbose=False,
2293
1720
            show_ids=False,
2294
1721
            forward=False,
2295
1722
            revision=None,
2296
 
            change=None,
2297
1723
            log_format=None,
2298
 
            levels=None,
2299
1724
            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
 
            )
 
1725
            limit=None):
 
1726
        from bzrlib.log import show_log
2311
1727
        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:
 
1728
        
 
1729
        # log everything
 
1730
        file_id = None
 
1731
        if location:
 
1732
            # find the file id to log:
 
1733
 
 
1734
            tree, b, fp = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1735
                location)
 
1736
            if fp != '':
 
1737
                if tree is None:
 
1738
                    tree = b.basis_tree()
 
1739
                file_id = tree.path2id(fp)
2339
1740
                if file_id is None:
2340
1741
                    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'])
 
1742
                        "Path does not have any revision history: %s" %
 
1743
                        location)
2351
1744
        else:
2352
 
            # log everything
2353
 
            # FIXME ? log the current subdir only RBC 20060203
 
1745
            # local dir only
 
1746
            # FIXME ? log the current subdir only RBC 20060203 
2354
1747
            if revision is not None \
2355
1748
                    and len(revision) > 0 and revision[0].get_branch():
2356
1749
                location = revision[0].get_branch()
2358
1751
                location = '.'
2359
1752
            dir, relpath = bzrdir.BzrDir.open_containing(location)
2360
1753
            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
 
1754
 
 
1755
        b.lock_read()
 
1756
        try:
 
1757
            if revision is None:
 
1758
                rev1 = None
 
1759
                rev2 = None
 
1760
            elif len(revision) == 1:
 
1761
                rev1 = rev2 = revision[0].in_history(b)
 
1762
            elif len(revision) == 2:
 
1763
                if revision[1].get_branch() != revision[0].get_branch():
 
1764
                    # b is taken from revision[0].get_branch(), and
 
1765
                    # show_log will use its revision_history. Having
 
1766
                    # different branches will lead to weird behaviors.
 
1767
                    raise errors.BzrCommandError(
 
1768
                        "Log doesn't accept two revisions in different"
 
1769
                        " branches.")
 
1770
                rev1 = revision[0].in_history(b)
 
1771
                rev2 = revision[1].in_history(b)
 
1772
            else:
 
1773
                raise errors.BzrCommandError(
 
1774
                    'bzr log --revision takes one or two values.')
 
1775
 
 
1776
            if log_format is None:
 
1777
                log_format = log.log_formatter_registry.get_default(b)
 
1778
 
 
1779
            lf = log_format(show_ids=show_ids, to_file=self.outf,
 
1780
                            show_timezone=timezone)
 
1781
 
 
1782
            show_log(b,
 
1783
                     lf,
 
1784
                     file_id,
 
1785
                     verbose=verbose,
 
1786
                     direction=direction,
 
1787
                     start_revision=rev1,
 
1788
                     end_revision=rev2,
 
1789
                     search=message,
 
1790
                     limit=limit)
 
1791
        finally:
 
1792
            b.unlock()
 
1793
 
2466
1794
 
2467
1795
def get_log_format(long=False, short=False, line=False, default='long'):
2468
1796
    log_format = default
2476
1804
 
2477
1805
 
2478
1806
class cmd_touching_revisions(Command):
2479
 
    __doc__ = """Return revision-ids which affected a particular file.
 
1807
    """Return revision-ids which affected a particular file.
2480
1808
 
2481
1809
    A more user-friendly interface is "bzr log FILE".
2482
1810
    """
2487
1815
    @display_command
2488
1816
    def run(self, filename):
2489
1817
        tree, relpath = WorkingTree.open_containing(filename)
 
1818
        b = tree.branch
2490
1819
        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:
 
1820
        for revno, revision_id, what in log.find_touching_revisions(b, file_id):
2495
1821
            self.outf.write("%6d %s\n" % (revno, what))
2496
1822
 
2497
1823
 
2498
1824
class cmd_ls(Command):
2499
 
    __doc__ = """List files in a tree.
 
1825
    """List files in a tree.
2500
1826
    """
2501
1827
 
2502
1828
    _see_also = ['status', 'cat']
2503
1829
    takes_args = ['path?']
 
1830
    # TODO: Take a revision or remote path and list that tree instead.
2504
1831
    takes_options = [
2505
1832
            'verbose',
2506
1833
            'revision',
2507
 
            Option('recursive', short_name='R',
2508
 
                   help='Recurse into subdirectories.'),
 
1834
            Option('non-recursive',
 
1835
                   help='Don\'t recurse into subdirectories.'),
2509
1836
            Option('from-root',
2510
1837
                   help='Print paths relative to the root of the branch.'),
2511
 
            Option('unknown', short_name='u',
2512
 
                help='Print unknown files.'),
 
1838
            Option('unknown', help='Print unknown files.'),
2513
1839
            Option('versioned', help='Print versioned files.',
2514
1840
                   short_name='V'),
2515
 
            Option('ignored', short_name='i',
2516
 
                help='Print ignored files.'),
2517
 
            Option('kind', short_name='k',
 
1841
            Option('ignored', help='Print ignored files.'),
 
1842
            Option('null',
 
1843
                   help='Write an ascii NUL (\\0) separator '
 
1844
                   'between files rather than a newline.'),
 
1845
            Option('kind',
2518
1846
                   help='List entries of a particular kind: file, directory, symlink.',
2519
1847
                   type=unicode),
2520
 
            'null',
2521
1848
            'show-ids',
2522
 
            'directory',
2523
1849
            ]
2524
1850
    @display_command
2525
1851
    def run(self, revision=None, verbose=False,
2526
 
            recursive=False, from_root=False,
 
1852
            non_recursive=False, from_root=False,
2527
1853
            unknown=False, versioned=False, ignored=False,
2528
 
            null=False, kind=None, show_ids=False, path=None, directory=None):
 
1854
            null=False, kind=None, show_ids=False, path=None):
2529
1855
 
2530
1856
        if kind and kind not in ('file', 'directory', 'symlink'):
2531
1857
            raise errors.BzrCommandError('invalid kind specified')
2538
1864
 
2539
1865
        if path is None:
2540
1866
            fs_path = '.'
 
1867
            prefix = ''
2541
1868
        else:
2542
1869
            if from_root:
2543
1870
                raise errors.BzrCommandError('cannot specify both --from-root'
2544
1871
                                             ' and PATH')
2545
1872
            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
 
1873
            prefix = path
 
1874
        tree, branch, relpath = bzrdir.BzrDir.open_containing_tree_or_branch(
 
1875
            fs_path)
2551
1876
        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')
 
1877
            relpath = u''
 
1878
        elif relpath:
 
1879
            relpath += '/'
 
1880
        if revision is not None:
 
1881
            tree = branch.repository.revision_tree(
 
1882
                revision[0].as_revision_id(branch))
 
1883
        elif tree is None:
 
1884
            tree = branch.basis_tree()
 
1885
 
 
1886
        tree.lock_read()
 
1887
        try:
 
1888
            for fp, fc, fkind, fid, entry in tree.list_files(include_root=False):
 
1889
                if fp.startswith(relpath):
 
1890
                    fp = osutils.pathjoin(prefix, fp[len(relpath):])
 
1891
                    if non_recursive and '/' in fp:
 
1892
                        continue
 
1893
                    if not all and not selection[fc]:
 
1894
                        continue
 
1895
                    if kind is not None and fkind != kind:
 
1896
                        continue
 
1897
                    if verbose:
 
1898
                        kindch = entry.kind_character()
 
1899
                        outstring = '%-8s %s%s' % (fc, fp, kindch)
 
1900
                        if show_ids and fid is not None:
 
1901
                            outstring = "%-50s %s" % (outstring, fid)
 
1902
                        self.outf.write(outstring + '\n')
 
1903
                    elif null:
 
1904
                        self.outf.write(fp + '\0')
 
1905
                        if show_ids:
 
1906
                            if fid is not None:
 
1907
                                self.outf.write(fid)
 
1908
                            self.outf.write('\0')
 
1909
                        self.outf.flush()
 
1910
                    else:
 
1911
                        if fid is not None:
 
1912
                            my_id = fid
 
1913
                        else:
 
1914
                            my_id = ''
 
1915
                        if show_ids:
 
1916
                            self.outf.write('%-50s %s\n' % (fp, my_id))
 
1917
                        else:
 
1918
                            self.outf.write(fp + '\n')
 
1919
        finally:
 
1920
            tree.unlock()
2613
1921
 
2614
1922
 
2615
1923
class cmd_unknowns(Command):
2616
 
    __doc__ = """List unknown files.
 
1924
    """List unknown files.
2617
1925
    """
2618
1926
 
2619
1927
    hidden = True
2620
1928
    _see_also = ['ls']
2621
 
    takes_options = ['directory']
2622
1929
 
2623
1930
    @display_command
2624
 
    def run(self, directory=u'.'):
2625
 
        for f in WorkingTree.open_containing(directory)[0].unknowns():
 
1931
    def run(self):
 
1932
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
2626
1933
            self.outf.write(osutils.quotefn(f) + '\n')
2627
1934
 
2628
1935
 
2629
1936
class cmd_ignore(Command):
2630
 
    __doc__ = """Ignore specified files or patterns.
 
1937
    """Ignore specified files or patterns.
2631
1938
 
2632
1939
    See ``bzr help patterns`` for details on the syntax of patterns.
2633
1940
 
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
1941
    To remove patterns from the ignore list, edit the .bzrignore file.
2641
1942
    After adding, editing or deleting that file either indirectly by
2642
1943
    using this command or directly by using an editor, be sure to commit
2643
1944
    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
 
1945
 
 
1946
    Note: ignore patterns containing shell wildcards must be quoted from 
2659
1947
    the shell on Unix.
2660
1948
 
2661
1949
    :Examples:
2663
1951
 
2664
1952
            bzr ignore ./Makefile
2665
1953
 
2666
 
        Ignore .class files in all directories...::
 
1954
        Ignore class files in all directories::
2667
1955
 
2668
1956
            bzr ignore "*.class"
2669
1957
 
2670
 
        ...but do not ignore "special.class"::
2671
 
 
2672
 
            bzr ignore "!special.class"
2673
 
 
2674
1958
        Ignore .o files under the lib directory::
2675
1959
 
2676
1960
            bzr ignore "lib/**/*.o"
2682
1966
        Ignore everything but the "debian" toplevel directory::
2683
1967
 
2684
1968
            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
1969
    """
2693
1970
 
2694
1971
    _see_also = ['status', 'ignored', 'patterns']
2695
1972
    takes_args = ['name_pattern*']
2696
 
    takes_options = ['directory',
2697
 
        Option('default-rules',
2698
 
               help='Display the default ignore rules that bzr uses.')
 
1973
    takes_options = [
 
1974
        Option('old-default-rules',
 
1975
               help='Write out the ignore rules bzr < 0.9 always used.')
2699
1976
        ]
2700
 
 
2701
 
    def run(self, name_pattern_list=None, default_rules=None,
2702
 
            directory=u'.'):
2703
 
        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)
 
1977
    
 
1978
    def run(self, name_pattern_list=None, old_default_rules=None):
 
1979
        from bzrlib.atomicfile import AtomicFile
 
1980
        if old_default_rules is not None:
 
1981
            # dump the rules and exit
 
1982
            for pattern in ignores.OLD_DEFAULTS:
 
1983
                print pattern
2708
1984
            return
2709
1985
        if not name_pattern_list:
2710
1986
            raise errors.BzrCommandError("ignore requires at least one "
2711
 
                "NAME_PATTERN or --default-rules.")
2712
 
        name_pattern_list = [globbing.normalize_pattern(p)
 
1987
                                  "NAME_PATTERN or --old-default-rules")
 
1988
        name_pattern_list = [globbing.normalize_pattern(p) 
2713
1989
                             for p in name_pattern_list]
2714
1990
        for name_pattern in name_pattern_list:
2715
 
            if (name_pattern[0] == '/' or
 
1991
            if (name_pattern[0] == '/' or 
2716
1992
                (len(name_pattern) > 1 and name_pattern[1] == ':')):
2717
1993
                raise errors.BzrCommandError(
2718
1994
                    "NAME_PATTERN should not be an absolute path")
2719
 
        tree, relpath = WorkingTree.open_containing(directory)
2720
 
        ignores.tree_ignores_add_patterns(tree, name_pattern_list)
 
1995
        tree, relpath = WorkingTree.open_containing(u'.')
 
1996
        ifn = tree.abspath('.bzrignore')
 
1997
        if os.path.exists(ifn):
 
1998
            f = open(ifn, 'rt')
 
1999
            try:
 
2000
                igns = f.read().decode('utf-8')
 
2001
            finally:
 
2002
                f.close()
 
2003
        else:
 
2004
            igns = ''
 
2005
 
 
2006
        # TODO: If the file already uses crlf-style termination, maybe
 
2007
        # we should use that for the newly added lines?
 
2008
 
 
2009
        if igns and igns[-1] != '\n':
 
2010
            igns += '\n'
 
2011
        for name_pattern in name_pattern_list:
 
2012
            igns += name_pattern + '\n'
 
2013
 
 
2014
        f = AtomicFile(ifn, 'wb')
 
2015
        try:
 
2016
            f.write(igns.encode('utf-8'))
 
2017
            f.commit()
 
2018
        finally:
 
2019
            f.close()
 
2020
 
 
2021
        if not tree.path2id('.bzrignore'):
 
2022
            tree.add(['.bzrignore'])
 
2023
 
2721
2024
        ignored = globbing.Globster(name_pattern_list)
2722
2025
        matches = []
2723
2026
        tree.lock_read()
2726
2029
            if id is not None:
2727
2030
                filename = entry[0]
2728
2031
                if ignored.match(filename):
2729
 
                    matches.append(filename)
 
2032
                    matches.append(filename.encode('utf-8'))
2730
2033
        tree.unlock()
2731
2034
        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),))
2736
 
 
 
2035
            print "Warning: the following files are version controlled and" \
 
2036
                  " match your ignore pattern:\n%s" % ("\n".join(matches),)
2737
2037
 
2738
2038
class cmd_ignored(Command):
2739
 
    __doc__ = """List ignored files and the patterns that matched them.
2740
 
 
2741
 
    List all the ignored files and the ignore pattern that caused the file to
2742
 
    be ignored.
2743
 
 
2744
 
    Alternatively, to list just the files::
2745
 
 
2746
 
        bzr ls --ignored
 
2039
    """List ignored files and the patterns that matched them.
2747
2040
    """
2748
2041
 
2749
2042
    encoding_type = 'replace'
2750
 
    _see_also = ['ignore', 'ls']
2751
 
    takes_options = ['directory']
 
2043
    _see_also = ['ignore']
2752
2044
 
2753
2045
    @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))
 
2046
    def run(self):
 
2047
        tree = WorkingTree.open_containing(u'.')[0]
 
2048
        tree.lock_read()
 
2049
        try:
 
2050
            for path, file_class, kind, file_id, entry in tree.list_files():
 
2051
                if file_class != 'I':
 
2052
                    continue
 
2053
                ## XXX: Slightly inefficient since this was already calculated
 
2054
                pat = tree.is_ignored(path)
 
2055
                self.outf.write('%-50s %s\n' % (path, pat))
 
2056
        finally:
 
2057
            tree.unlock()
2763
2058
 
2764
2059
 
2765
2060
class cmd_lookup_revision(Command):
2766
 
    __doc__ = """Lookup the revision-id from a revision-number
 
2061
    """Lookup the revision-id from a revision-number
2767
2062
 
2768
2063
    :Examples:
2769
2064
        bzr lookup-revision 33
2770
2065
    """
2771
2066
    hidden = True
2772
2067
    takes_args = ['revno']
2773
 
    takes_options = ['directory']
2774
 
 
 
2068
    
2775
2069
    @display_command
2776
 
    def run(self, revno, directory=u'.'):
 
2070
    def run(self, revno):
2777
2071
        try:
2778
2072
            revno = int(revno)
2779
2073
        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)
 
2074
            raise errors.BzrCommandError("not a valid revision-number: %r" % revno)
 
2075
 
 
2076
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
2784
2077
 
2785
2078
 
2786
2079
class cmd_export(Command):
2787
 
    __doc__ = """Export current or past revision to a destination directory or archive.
 
2080
    """Export current or past revision to a destination directory or archive.
2788
2081
 
2789
2082
    If no revision is specified this exports the last committed revision.
2790
2083
 
2811
2104
         zip                          .zip
2812
2105
      =================       =========================
2813
2106
    """
2814
 
    takes_args = ['dest', 'branch_or_subdir?']
2815
 
    takes_options = ['directory',
 
2107
    takes_args = ['dest', 'branch?']
 
2108
    takes_options = [
2816
2109
        Option('format',
2817
2110
               help="Type of file to export to.",
2818
2111
               type=unicode),
2819
2112
        'revision',
2820
 
        Option('filters', help='Apply content filters to export the '
2821
 
                'convenient form.'),
2822
2113
        Option('root',
2823
2114
               type=str,
2824
2115
               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
2116
        ]
2829
 
    def run(self, dest, branch_or_subdir=None, revision=None, format=None,
2830
 
        root=None, filters=False, per_file_timestamps=False, directory=u'.'):
 
2117
    def run(self, dest, branch=None, revision=None, format=None, root=None):
2831
2118
        from bzrlib.export import export
2832
2119
 
2833
 
        if branch_or_subdir is None:
2834
 
            tree = WorkingTree.open_containing(directory)[0]
 
2120
        if branch is None:
 
2121
            tree = WorkingTree.open_containing(u'.')[0]
2835
2122
            b = tree.branch
2836
 
            subdir = None
2837
 
        else:
2838
 
            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)
 
2123
        else:
 
2124
            b = Branch.open(branch)
 
2125
            
 
2126
        if revision is None:
 
2127
            # should be tree.last_revision  FIXME
 
2128
            rev_id = b.last_revision()
 
2129
        else:
 
2130
            if len(revision) != 1:
 
2131
                raise errors.BzrCommandError('bzr export --revision takes exactly 1 argument')
 
2132
            rev_id = revision[0].as_revision_id(b)
 
2133
        t = b.repository.revision_tree(rev_id)
2842
2134
        try:
2843
 
            export(rev_tree, dest, format, root, subdir, filtered=filters,
2844
 
                   per_file_timestamps=per_file_timestamps)
 
2135
            export(t, dest, format, root)
2845
2136
        except errors.NoSuchExportFormat, e:
2846
2137
            raise errors.BzrCommandError('Unsupported export format: %s' % e.format)
2847
2138
 
2848
2139
 
2849
2140
class cmd_cat(Command):
2850
 
    __doc__ = """Write the contents of a file as of a given revision to standard output.
 
2141
    """Write the contents of a file as of a given revision to standard output.
2851
2142
 
2852
2143
    If no revision is nominated, the last revision is used.
2853
2144
 
2854
2145
    Note: Take care to redirect standard output when using this command on a
2855
 
    binary file.
 
2146
    binary file. 
2856
2147
    """
2857
2148
 
2858
2149
    _see_also = ['ls']
2859
 
    takes_options = ['directory',
 
2150
    takes_options = [
2860
2151
        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
2152
        'revision',
2864
2153
        ]
2865
2154
    takes_args = ['filename']
2866
2155
    encoding_type = 'exact'
2867
2156
 
2868
2157
    @display_command
2869
 
    def run(self, filename, revision=None, name_from_revision=False,
2870
 
            filters=False, directory=None):
 
2158
    def run(self, filename, revision=None, name_from_revision=False):
2871
2159
        if revision is not None and len(revision) != 1:
2872
2160
            raise errors.BzrCommandError("bzr cat --revision takes exactly"
2873
2161
                                         " one revision specifier")
2874
2162
        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)
 
2163
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
2164
        branch.lock_read()
 
2165
        try:
 
2166
            return self._run(tree, branch, relpath, filename, revision,
 
2167
                             name_from_revision)
 
2168
        finally:
 
2169
            branch.unlock()
2879
2170
 
2880
 
    def _run(self, tree, b, relpath, filename, revision, name_from_revision,
2881
 
        filtered):
 
2171
    def _run(self, tree, b, relpath, filename, revision, name_from_revision):
2882
2172
        if tree is None:
2883
2173
            tree = b.basis_tree()
2884
 
        rev_tree = _get_one_revision_tree('cat', revision, branch=b)
2885
 
        self.add_cleanup(rev_tree.lock_read().unlock)
 
2174
        if revision is None:
 
2175
            revision_id = b.last_revision()
 
2176
        else:
 
2177
            revision_id = revision[0].as_revision_id(b)
2886
2178
 
 
2179
        cur_file_id = tree.path2id(relpath)
 
2180
        rev_tree = b.repository.revision_tree(revision_id)
2887
2181
        old_file_id = rev_tree.path2id(relpath)
2888
 
 
 
2182
        
2889
2183
        if name_from_revision:
2890
 
            # Try in revision if requested
2891
2184
            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()))
 
2185
                raise errors.BzrCommandError("%r is not present in revision %s"
 
2186
                                                % (filename, revision_id))
2895
2187
            else:
2896
2188
                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)
 
2189
        elif cur_file_id is not None:
 
2190
            content = rev_tree.get_file_text(cur_file_id)
 
2191
        elif old_file_id is not None:
 
2192
            content = rev_tree.get_file_text(old_file_id)
 
2193
        else:
 
2194
            raise errors.BzrCommandError("%r is not present in revision %s" %
 
2195
                                         (filename, revision_id))
 
2196
        self.outf.write(content)
2931
2197
 
2932
2198
 
2933
2199
class cmd_local_time_offset(Command):
2934
 
    __doc__ = """Show the offset in seconds from GMT to local time."""
2935
 
    hidden = True
 
2200
    """Show the offset in seconds from GMT to local time."""
 
2201
    hidden = True    
2936
2202
    @display_command
2937
2203
    def run(self):
2938
 
        self.outf.write("%s\n" % osutils.local_time_offset())
 
2204
        print osutils.local_time_offset()
2939
2205
 
2940
2206
 
2941
2207
 
2942
2208
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.)
 
2209
    """Commit changes into a new revision.
 
2210
    
 
2211
    If no arguments are given, the entire tree is committed.
 
2212
 
 
2213
    If selected files are specified, only changes to those files are
 
2214
    committed.  If a directory is specified then the directory and everything 
 
2215
    within it is committed.
 
2216
 
 
2217
    If author of the change is not the same person as the committer, you can
 
2218
    specify the author's name using the --author option. The name should be
 
2219
    in the same format as a committer-id, e.g. "John Doe <jdoe@example.com>".
 
2220
 
 
2221
    A selected-file commit may fail in some cases where the committed
 
2222
    tree would be invalid. Consider::
 
2223
 
 
2224
      bzr init foo
 
2225
      mkdir foo/bar
 
2226
      bzr add foo/bar
 
2227
      bzr commit foo -m "committing foo"
 
2228
      bzr mv foo/bar foo/baz
 
2229
      mkdir foo/bar
 
2230
      bzr add foo/bar
 
2231
      bzr commit foo/bar -m "committing bar but not baz"
 
2232
 
 
2233
    In the example above, the last commit will fail by design. This gives
 
2234
    the user the opportunity to decide whether they want to commit the
 
2235
    rename at the same time, separately first, or not at all. (As a general
 
2236
    rule, when in doubt, Bazaar has a policy of Doing the Safe Thing.)
 
2237
 
 
2238
    Note: A selected-file commit after a merge is not yet supported.
3014
2239
    """
3015
2240
    # TODO: Run hooks on tree to-be-committed, and after commit.
3016
2241
 
3021
2246
 
3022
2247
    # XXX: verbose currently does nothing
3023
2248
 
3024
 
    _see_also = ['add', 'bugs', 'hooks', 'uncommit']
 
2249
    _see_also = ['bugs', 'uncommit']
3025
2250
    takes_args = ['selected*']
3026
2251
    takes_options = [
3027
 
            ListOption('exclude', type=str, short_name='x',
3028
 
                help="Do not consider changes made to a given path."),
3029
2252
            Option('message', type=unicode,
3030
2253
                   short_name='m',
3031
2254
                   help="Description of the new revision."),
3039
2262
             Option('strict',
3040
2263
                    help="Refuse to commit if there are unknown "
3041
2264
                    "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
2265
             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,
 
2266
                    help="Mark a bug as being fixed by this revision."),
 
2267
             Option('author', type=unicode,
3049
2268
                    help="Set the author's name, if it's different "
3050
2269
                         "from the committer."),
3051
2270
             Option('local',
3054
2273
                         "the master branch until a normal commit "
3055
2274
                         "is performed."
3056
2275
                    ),
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.'),
 
2276
              Option('show-diff',
 
2277
                     help='When no message is supplied, show the diff along'
 
2278
                     ' with the status summary in the message editor.'),
3060
2279
             ]
3061
2280
    aliases = ['ci', 'checkin']
3062
2281
 
3063
 
    def _iter_bug_fix_urls(self, fixes, branch):
 
2282
    def _get_bug_fix_properties(self, fixes, branch):
 
2283
        properties = []
3064
2284
        # Configure the properties for bug fixing attributes.
3065
2285
        for fixed_bug in fixes:
3066
2286
            tokens = fixed_bug.split(':')
3067
2287
            if len(tokens) != 2:
3068
2288
                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)
 
2289
                    "Invalid bug %s. Must be in the form of 'tag:id'. "
 
2290
                    "Commit refused." % fixed_bug)
3072
2291
            tag, bug_id = tokens
3073
2292
            try:
3074
 
                yield bugtracker.get_bug_url(tag, branch, bug_id)
 
2293
                bug_url = bugtracker.get_bug_url(tag, branch, bug_id)
3075
2294
            except errors.UnknownBugTrackerAbbreviation:
3076
2295
                raise errors.BzrCommandError(
3077
2296
                    'Unrecognized bug %s. Commit refused.' % fixed_bug)
3078
 
            except errors.MalformedBugIdentifier, e:
 
2297
            except errors.MalformedBugIdentifier:
3079
2298
                raise errors.BzrCommandError(
3080
 
                    "%s\nCommit refused." % (str(e),))
 
2299
                    "Invalid bug identifier for %s. Commit refused."
 
2300
                    % fixed_bug)
 
2301
            properties.append('%s fixed' % bug_url)
 
2302
        return '\n'.join(properties)
3081
2303
 
3082
2304
    def run(self, message=None, file=None, verbose=False, selected_list=None,
3083
2305
            unchanged=False, strict=False, local=False, fixes=None,
3084
 
            author=None, show_diff=False, exclude=None, commit_time=None):
 
2306
            author=None, show_diff=False):
3085
2307
        from bzrlib.errors import (
3086
2308
            PointlessCommit,
3087
2309
            ConflictsInTree,
3089
2311
        )
3090
2312
        from bzrlib.msgeditor import (
3091
2313
            edit_commit_message_encoded,
3092
 
            generate_commit_message_template,
3093
2314
            make_commit_message_template_encoded
3094
2315
        )
3095
2316
 
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
2317
        # TODO: Need a blackbox test for invoking the external editor; may be
3105
2318
        # slightly problematic to run this cross-platform.
3106
2319
 
3107
 
        # TODO: do more checks that the commit will succeed before
 
2320
        # TODO: do more checks that the commit will succeed before 
3108
2321
        # spending the user's valuable time typing a commit message.
3109
2322
 
3110
2323
        properties = {}
3118
2331
 
3119
2332
        if fixes is None:
3120
2333
            fixes = []
3121
 
        bug_property = bugtracker.encode_fixes_bug_urls(
3122
 
            self._iter_bug_fix_urls(fixes, tree.branch))
 
2334
        bug_property = self._get_bug_fix_properties(fixes, tree.branch)
3123
2335
        if bug_property:
3124
2336
            properties['bugs'] = bug_property
3125
2337
 
3126
2338
        if local and not tree.branch.get_bound_location():
3127
2339
            raise errors.LocalRequiresBoundBranch()
3128
2340
 
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
2341
        def get_message(commit_obj):
3151
2342
            """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,
 
2343
            my_message = message
 
2344
            if my_message is None and not file:
 
2345
                t = make_commit_message_template_encoded(tree,
3161
2346
                        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)
 
2347
                        output_encoding=bzrlib.user_encoding)
 
2348
                my_message = edit_commit_message_encoded(t)
3171
2349
                if my_message is None:
3172
2350
                    raise errors.BzrCommandError("please specify a commit"
3173
2351
                        " message with either --message or --file")
 
2352
            elif my_message and file:
 
2353
                raise errors.BzrCommandError(
 
2354
                    "please specify either --message or --file")
 
2355
            if file:
 
2356
                my_message = codecs.open(file, 'rt', 
 
2357
                                         bzrlib.user_encoding).read()
3174
2358
            if my_message == "":
3175
2359
                raise errors.BzrCommandError("empty commit message specified")
3176
2360
            return my_message
3177
2361
 
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
2362
        try:
3183
2363
            tree.commit(message_callback=get_message,
3184
2364
                        specific_files=selected_list,
3185
2365
                        allow_pointless=unchanged, strict=strict, local=local,
3186
2366
                        reporter=None, verbose=verbose, revprops=properties,
3187
 
                        authors=author, timestamp=commit_stamp,
3188
 
                        timezone=offset,
3189
 
                        exclude=safe_relpath_files(tree, exclude))
 
2367
                        author=author)
3190
2368
        except PointlessCommit:
3191
 
            raise errors.BzrCommandError("No changes to commit."
3192
 
                              " Use --unchanged to commit anyhow.")
 
2369
            # FIXME: This should really happen before the file is read in;
 
2370
            # perhaps prepare the commit; get the message; then actually commit
 
2371
            raise errors.BzrCommandError("no changes to commit."
 
2372
                              " use --unchanged to commit anyhow")
3193
2373
        except ConflictsInTree:
3194
2374
            raise errors.BzrCommandError('Conflicts detected in working '
3195
2375
                'tree.  Use "bzr conflicts" to list, "bzr resolve FILE" to'
3198
2378
            raise errors.BzrCommandError("Commit refused because there are"
3199
2379
                              " unknown files in the working tree.")
3200
2380
        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
 
2381
            raise errors.BzrCommandError(str(e) + "\n"
 
2382
            'To commit to master branch, run update and then commit.\n'
 
2383
            'You can also pass --local to commit to continue working '
 
2384
            'disconnected.')
3206
2385
 
3207
2386
 
3208
2387
class cmd_check(Command):
3209
 
    __doc__ = """Validate working tree structure, branch consistency and repository history.
 
2388
    """Validate working tree structure, branch consistency and repository
 
2389
    history.
3210
2390
 
3211
2391
    This command checks various invariants about branch and repository storage
3212
2392
    to detect data corruption or bzr bugs.
3214
2394
    The working tree and branch checks will only give output if a problem is
3215
2395
    detected. The output fields of the repository check are:
3216
2396
 
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.
3239
 
 
3240
 
    If no restrictions are specified, all Bazaar data that is found at the given
3241
 
    location will be checked.
3242
 
 
3243
 
    :Examples:
3244
 
 
3245
 
        Check the tree and branch at 'foo'::
3246
 
 
3247
 
            bzr check --tree --branch foo
3248
 
 
3249
 
        Check only the repository at 'bar'::
3250
 
 
3251
 
            bzr check --repo bar
3252
 
 
3253
 
        Check everything at 'baz'::
3254
 
 
3255
 
            bzr check baz
 
2397
        revisions: This is just the number of revisions checked.  It doesn't
 
2398
            indicate a problem.
 
2399
        versionedfiles: This is just the number of versionedfiles checked.  It
 
2400
            doesn't indicate a problem.
 
2401
        unreferenced ancestors: Texts that are ancestors of other texts, but
 
2402
            are not properly referenced by the revision ancestry.  This is a
 
2403
            subtle problem that Bazaar can work around.
 
2404
        unique file texts: This is the total number of unique file contents
 
2405
            seen in the checked revisions.  It does not indicate a problem.
 
2406
        repeated file texts: This is the total number of repeated texts seen
 
2407
            in the checked revisions.  Texts can be repeated when their file
 
2408
            entries are modified, but the file contents are not.  It does not
 
2409
            indicate a problem.
3256
2410
    """
3257
2411
 
3258
2412
    _see_also = ['reconcile']
3259
2413
    takes_args = ['path?']
3260
 
    takes_options = ['verbose',
3261
 
                     Option('branch', help="Check the branch related to the"
3262
 
                                           " current directory."),
3263
 
                     Option('repo', help="Check the repository related to the"
3264
 
                                         " current directory."),
3265
 
                     Option('tree', help="Check the working tree related to"
3266
 
                                         " the current directory.")]
 
2414
    takes_options = ['verbose']
3267
2415
 
3268
 
    def run(self, path=None, verbose=False, branch=False, repo=False,
3269
 
            tree=False):
 
2416
    def run(self, path=None, verbose=False):
3270
2417
        from bzrlib.check import check_dwim
3271
2418
        if path is None:
3272
2419
            path = '.'
3273
 
        if not branch and not repo and not tree:
3274
 
            branch = repo = tree = True
3275
 
        check_dwim(path, verbose, do_branch=branch, do_repo=repo, do_tree=tree)
 
2420
        check_dwim(path, verbose)
3276
2421
 
3277
2422
 
3278
2423
class cmd_upgrade(Command):
3279
 
    __doc__ = """Upgrade branch storage to current format.
 
2424
    """Upgrade branch storage to current format.
3280
2425
 
3281
2426
    The check command or bzr developers may sometimes advise you to run
3282
2427
    this command. When the default format has changed you may also be warned
3289
2434
                    RegistryOption('format',
3290
2435
                        help='Upgrade to a specific format.  See "bzr help'
3291
2436
                             ' formats" for details.',
3292
 
                        lazy_registry=('bzrlib.bzrdir', 'format_registry'),
3293
 
                        converter=lambda name: bzrdir.format_registry.make_bzrdir(name),
 
2437
                        registry=bzrdir.format_registry,
 
2438
                        converter=bzrdir.format_registry.make_bzrdir,
3294
2439
                        value_switches=True, title='Branch format'),
3295
2440
                    ]
3296
2441
 
3297
2442
    def run(self, url='.', format=None):
3298
2443
        from bzrlib.upgrade import upgrade
 
2444
        if format is None:
 
2445
            format = bzrdir.format_registry.make_bzrdir('default')
3299
2446
        upgrade(url, format)
3300
2447
 
3301
2448
 
3302
2449
class cmd_whoami(Command):
3303
 
    __doc__ = """Show or set bzr user id.
3304
 
 
 
2450
    """Show or set bzr user id.
 
2451
    
3305
2452
    :Examples:
3306
2453
        Show the email of the current user::
3307
2454
 
3319
2466
                    ]
3320
2467
    takes_args = ['name?']
3321
2468
    encoding_type = 'replace'
3322
 
 
 
2469
    
3323
2470
    @display_command
3324
2471
    def run(self, email=False, branch=False, name=None):
3325
2472
        if name is None:
3340
2487
        except errors.NoEmailInUsername, e:
3341
2488
            warning('"%s" does not seem to contain an email address.  '
3342
2489
                    'This is allowed, but not recommended.', name)
3343
 
 
 
2490
        
3344
2491
        # use global config unless --branch given
3345
2492
        if branch:
3346
2493
            c = Branch.open_containing('.')[0].get_config()
3350
2497
 
3351
2498
 
3352
2499
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.
 
2500
    """Print or set the branch nickname.  
 
2501
 
 
2502
    If unset, the tree root directory name is used as the nickname
 
2503
    To print the current nickname, execute with no argument.  
3360
2504
    """
3361
2505
 
3362
2506
    _see_also = ['info']
3363
2507
    takes_args = ['nickname?']
3364
 
    takes_options = ['directory']
3365
 
    def run(self, nickname=None, directory=u'.'):
3366
 
        branch = Branch.open_containing(directory)[0]
 
2508
    def run(self, nickname=None):
 
2509
        branch = Branch.open_containing(u'.')[0]
3367
2510
        if nickname is None:
3368
2511
            self.printme(branch)
3369
2512
        else:
3371
2514
 
3372
2515
    @display_command
3373
2516
    def printme(self, branch):
3374
 
        self.outf.write('%s\n' % branch.nick)
 
2517
        print branch.nick
3375
2518
 
3376
2519
 
3377
2520
class cmd_alias(Command):
3378
 
    __doc__ = """Set/unset and display aliases.
 
2521
    """Set/unset and display aliases.
3379
2522
 
3380
2523
    :Examples:
3381
2524
        Show the current aliases::
3445
2588
 
3446
2589
 
3447
2590
class cmd_selftest(Command):
3448
 
    __doc__ = """Run internal test suite.
3449
 
 
 
2591
    """Run internal test suite.
 
2592
    
3450
2593
    If arguments are given, they are regular expressions that say which tests
3451
2594
    should run.  Tests matching any expression are run, and other tests are
3452
2595
    not run.
3475
2618
    modified by plugins will not be tested, and tests provided by plugins will
3476
2619
    not be run.
3477
2620
 
3478
 
    Tests that need working space on disk use a common temporary directory,
 
2621
    Tests that need working space on disk use a common temporary directory, 
3479
2622
    typically inside $TMPDIR or /tmp.
3480
2623
 
3481
 
    If you set BZR_TEST_PDB=1 when running selftest, failing tests will drop
3482
 
    into a pdb postmortem session.
3483
 
 
3484
2624
    :Examples:
3485
2625
        Run only tests relating to 'ignore'::
3486
2626
 
3495
2635
    def get_transport_type(typestring):
3496
2636
        """Parse and return a transport specifier."""
3497
2637
        if typestring == "sftp":
3498
 
            from bzrlib.tests import stub_sftp
3499
 
            return stub_sftp.SFTPAbsoluteServer
 
2638
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
2639
            return SFTPAbsoluteServer
3500
2640
        if typestring == "memory":
3501
 
            from bzrlib.tests import test_server
3502
 
            return memory.MemoryServer
 
2641
            from bzrlib.transport.memory import MemoryServer
 
2642
            return MemoryServer
3503
2643
        if typestring == "fakenfs":
3504
 
            from bzrlib.tests import test_server
3505
 
            return test_server.FakeNFSServer
 
2644
            from bzrlib.transport.fakenfs import FakeNFSServer
 
2645
            return FakeNFSServer
3506
2646
        msg = "No known transport type %s. Supported types are: sftp\n" %\
3507
2647
            (typestring)
3508
2648
        raise errors.BzrCommandError(msg)
3523
2663
                     Option('lsprof-timed',
3524
2664
                            help='Generate lsprof output for benchmarked'
3525
2665
                                 ' sections of code.'),
3526
 
                     Option('lsprof-tests',
3527
 
                            help='Generate lsprof output for each test.'),
3528
2666
                     Option('cache-dir', type=str,
3529
2667
                            help='Cache intermediate benchmark output in this '
3530
2668
                                 'directory.'),
3534
2672
                            ),
3535
2673
                     Option('list-only',
3536
2674
                            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
2675
                     Option('randomize', type=str, argname="SEED",
3543
2676
                            help='Randomize the order of tests using the given'
3544
2677
                                 ' seed or "now" for the current time.'),
3546
2679
                            short_name='x',
3547
2680
                            help='Exclude tests that match this regular'
3548
2681
                                 ' expression.'),
3549
 
                     Option('subunit',
3550
 
                        help='Output test progress via subunit.'),
3551
2682
                     Option('strict', help='Fail on missing dependencies or '
3552
2683
                            'known failures.'),
3553
2684
                     Option('load-list', type=str, argname='TESTLISTFILE',
3554
2685
                            help='Load a test id list from a text file.'),
3555
2686
                     ListOption('debugflag', type=str, short_name='E',
3556
2687
                                help='Turn on a selftest debug flag.'),
3557
 
                     ListOption('starting-with', type=str, argname='TESTID',
3558
 
                                param_name='starting_with', short_name='s',
3559
 
                                help=
3560
 
                                'Load only the tests starting with TESTID.'),
 
2688
                     Option('starting-with', type=str, argname='TESTID',
 
2689
                            short_name='s',
 
2690
                            help='Load only the tests starting with TESTID.'),
3561
2691
                     ]
3562
2692
    encoding_type = 'replace'
3563
2693
 
3564
 
    def __init__(self):
3565
 
        Command.__init__(self)
3566
 
        self.additional_selftest_args = {}
3567
 
 
3568
2694
    def run(self, testspecs_list=None, verbose=False, one=False,
3569
2695
            transport=None, benchmark=None,
3570
2696
            lsprof_timed=None, cache_dir=None,
3571
2697
            first=False, list_only=False,
3572
2698
            randomize=None, exclude=None, strict=False,
3573
 
            load_list=None, debugflag=None, starting_with=None, subunit=False,
3574
 
            parallel=None, lsprof_tests=False):
 
2699
            load_list=None, debugflag=None, starting_with=None):
 
2700
        import bzrlib.ui
3575
2701
        from bzrlib.tests import selftest
3576
2702
        import bzrlib.benchmarks as benchmarks
3577
2703
        from bzrlib.benchmarks import tree_creator
3581
2707
 
3582
2708
        if cache_dir is not None:
3583
2709
            tree_creator.TreeCreator.CACHE_ROOT = osutils.abspath(cache_dir)
 
2710
        if not list_only:
 
2711
            print 'testing: %s' % (osutils.realpath(sys.argv[0]),)
 
2712
            print '   %s (%s python%s)' % (
 
2713
                    bzrlib.__path__[0],
 
2714
                    bzrlib.version_string,
 
2715
                    bzrlib._format_version_tuple(sys.version_info),
 
2716
                    )
 
2717
        print
3584
2718
        if testspecs_list is not None:
3585
2719
            pattern = '|'.join(testspecs_list)
3586
2720
        else:
3587
2721
            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
2722
        if benchmark:
3604
2723
            test_suite_factory = benchmarks.test_suite
3605
2724
            # Unless user explicitly asks for quiet, be verbose in benchmarks
3606
2725
            verbose = not is_quiet()
3607
2726
            # TODO: should possibly lock the history file...
3608
2727
            benchfile = open(".perf_history", "at", buffering=1)
3609
 
            self.add_cleanup(benchfile.close)
3610
2728
        else:
3611
2729
            test_suite_factory = None
3612
2730
            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)
 
2731
        try:
 
2732
            result = selftest(verbose=verbose,
 
2733
                              pattern=pattern,
 
2734
                              stop_on_failure=one,
 
2735
                              transport=transport,
 
2736
                              test_suite_factory=test_suite_factory,
 
2737
                              lsprof_timed=lsprof_timed,
 
2738
                              bench_history=benchfile,
 
2739
                              matching_tests_first=first,
 
2740
                              list_only=list_only,
 
2741
                              random_seed=randomize,
 
2742
                              exclude_pattern=exclude,
 
2743
                              strict=strict,
 
2744
                              load_list=load_list,
 
2745
                              debug_flags=debugflag,
 
2746
                              starting_with=starting_with,
 
2747
                              )
 
2748
        finally:
 
2749
            if benchfile is not None:
 
2750
                benchfile.close()
 
2751
        if result:
 
2752
            note('tests passed')
 
2753
        else:
 
2754
            note('tests failed')
3632
2755
        return int(not result)
3633
2756
 
3634
2757
 
3635
2758
class cmd_version(Command):
3636
 
    __doc__ = """Show version of bzr."""
 
2759
    """Show version of bzr."""
3637
2760
 
3638
2761
    encoding_type = 'replace'
3639
2762
    takes_options = [
3650
2773
 
3651
2774
 
3652
2775
class cmd_rocks(Command):
3653
 
    __doc__ = """Statement of optimism."""
 
2776
    """Statement of optimism."""
3654
2777
 
3655
2778
    hidden = True
3656
2779
 
3657
2780
    @display_command
3658
2781
    def run(self):
3659
 
        self.outf.write("It sure does!\n")
 
2782
        print "It sure does!"
3660
2783
 
3661
2784
 
3662
2785
class cmd_find_merge_base(Command):
3663
 
    __doc__ = """Find and print a base revision for merging two branches."""
 
2786
    """Find and print a base revision for merging two branches."""
3664
2787
    # TODO: Options to specify revisions on either side, as if
3665
2788
    #       merging only part of the history.
3666
2789
    takes_args = ['branch', 'other']
3667
2790
    hidden = True
3668
 
 
 
2791
    
3669
2792
    @display_command
3670
2793
    def run(self, branch, other):
3671
2794
        from bzrlib.revision import ensure_null
3672
 
 
 
2795
        
3673
2796
        branch1 = Branch.open_containing(branch)[0]
3674
2797
        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)
 
2798
        branch1.lock_read()
 
2799
        try:
 
2800
            branch2.lock_read()
 
2801
            try:
 
2802
                last1 = ensure_null(branch1.last_revision())
 
2803
                last2 = ensure_null(branch2.last_revision())
 
2804
 
 
2805
                graph = branch1.repository.get_graph(branch2.repository)
 
2806
                base_rev_id = graph.find_unique_lca(last1, last2)
 
2807
 
 
2808
                print 'merge base is revision %s' % base_rev_id
 
2809
            finally:
 
2810
                branch2.unlock()
 
2811
        finally:
 
2812
            branch1.unlock()
3684
2813
 
3685
2814
 
3686
2815
class cmd_merge(Command):
3687
 
    __doc__ = """Perform a three-way merge.
3688
 
 
 
2816
    """Perform a three-way merge.
 
2817
    
3689
2818
    The source of the merge can be specified either in the form of a branch,
3690
2819
    or in the form of a path to a file containing a merge directive generated
3691
2820
    with bzr send. If neither is specified, the default is the upstream branch
3701
2830
    By default, bzr will try to merge in all new work from the other
3702
2831
    branch, automatically determining an appropriate base.  If this
3703
2832
    fails, you may need to give an explicit base.
3704
 
 
 
2833
    
3705
2834
    Merge will do its best to combine the changes in two branches, but there
3706
2835
    are some kinds of problems only a human can fix.  When it encounters those,
3707
2836
    it will mark a conflict.  A conflict means that you need to fix something,
3717
2846
    The results of the merge are placed into the destination working
3718
2847
    directory, where they can be reviewed (with bzr diff), tested, and then
3719
2848
    committed to record the result of the merge.
3720
 
 
 
2849
    
3721
2850
    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".
 
2851
    --force is given.
3731
2852
 
3732
2853
    :Examples:
3733
2854
        To merge the latest revision from bzr.dev::
3742
2863
 
3743
2864
            bzr merge -r 81..82 ../bzr.dev
3744
2865
 
3745
 
        To apply a merge directive contained in /tmp/merge::
 
2866
        To apply a merge directive contained in in /tmp/merge:
3746
2867
 
3747
2868
            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
2869
    """
3756
2870
 
3757
2871
    encoding_type = 'exact'
3758
 
    _see_also = ['update', 'remerge', 'status-flags', 'send']
 
2872
    _see_also = ['update', 'remerge', 'status-flags']
3759
2873
    takes_args = ['location?']
3760
2874
    takes_options = [
3761
2875
        'change',
3773
2887
                ' completely merged into the source, pull from the'
3774
2888
                ' source rather than merging.  When this happens,'
3775
2889
                ' you do not need to commit the result.'),
3776
 
        custom_help('directory',
 
2890
        Option('directory',
3777
2891
               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')
 
2892
                    'rather than the one containing the working directory.',
 
2893
               short_name='d',
 
2894
               type=unicode,
 
2895
               ),
 
2896
        Option('preview', help='Instead of merging, show a diff of the merge.')
3783
2897
    ]
3784
2898
 
3785
2899
    def run(self, location=None, revision=None, force=False,
3786
 
            merge_type=None, show_base=False, reprocess=None, remember=False,
 
2900
            merge_type=None, show_base=False, reprocess=False, remember=False,
3787
2901
            uncommitted=False, pull=False,
3788
2902
            directory=None,
3789
2903
            preview=False,
3790
 
            interactive=False,
3791
2904
            ):
3792
2905
        if merge_type is None:
3793
2906
            merge_type = _mod_merge.Merge3Merger
3798
2911
        allow_pending = True
3799
2912
        verified = 'inapplicable'
3800
2913
        tree = WorkingTree.open_containing(directory)[0]
3801
 
 
 
2914
        change_reporter = delta._ChangeReporter(
 
2915
            unversioned_filter=tree.is_ignored)
 
2916
        cleanups = []
3802
2917
        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
 
2918
            pb = ui.ui_factory.nested_progress_bar()
 
2919
            cleanups.append(pb.finished)
 
2920
            tree.lock_write()
 
2921
            cleanups.append(tree.unlock)
 
2922
            if location is not None:
 
2923
                try:
 
2924
                    mergeable = bundle.read_mergeable_from_url(location,
 
2925
                        possible_transports=possible_transports)
 
2926
                except errors.NotABundle:
 
2927
                    mergeable = None
 
2928
                else:
 
2929
                    if uncommitted:
 
2930
                        raise errors.BzrCommandError('Cannot use --uncommitted'
 
2931
                            ' with bundles or merge directives.')
 
2932
 
 
2933
                    if revision is not None:
 
2934
                        raise errors.BzrCommandError(
 
2935
                            'Cannot use -r with merge directives or bundles')
 
2936
                    merger, verified = _mod_merge.Merger.from_mergeable(tree,
 
2937
                       mergeable, pb)
 
2938
 
 
2939
            if merger is None and uncommitted:
 
2940
                if revision is not None and len(revision) > 0:
 
2941
                    raise errors.BzrCommandError('Cannot use --uncommitted and'
 
2942
                        ' --revision at the same time.')
 
2943
                location = self._select_branch_location(tree, location)[0]
 
2944
                other_tree, other_path = WorkingTree.open_containing(location)
 
2945
                merger = _mod_merge.Merger.from_uncommitted(tree, other_tree,
 
2946
                    pb)
 
2947
                allow_pending = False
 
2948
                if other_path != '':
 
2949
                    merger.interesting_files = [other_path]
 
2950
 
 
2951
            if merger is None:
 
2952
                merger, allow_pending = self._get_merger_from_branch(tree,
 
2953
                    location, revision, remember, possible_transports, pb)
 
2954
 
 
2955
            merger.merge_type = merge_type
 
2956
            merger.reprocess = reprocess
 
2957
            merger.show_base = show_base
 
2958
            self.sanity_check_merger(merger)
 
2959
            if (merger.base_rev_id == merger.other_rev_id and
 
2960
                merger.other_rev_id is not None):
 
2961
                note('Nothing to do.')
 
2962
                return 0
 
2963
            if pull:
 
2964
                if merger.interesting_files is not None:
 
2965
                    raise errors.BzrCommandError('Cannot pull individual files')
 
2966
                if (merger.base_rev_id == tree.last_revision()):
 
2967
                    result = tree.pull(merger.other_branch, False,
 
2968
                                       merger.other_rev_id)
 
2969
                    result.report(self.outf)
 
2970
                    return 0
 
2971
            merger.check_basis(not force)
 
2972
            if preview:
 
2973
                return self._do_preview(merger)
3824
2974
            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):
 
2975
                return self._do_merge(merger, change_reporter, allow_pending,
 
2976
                                      verified)
 
2977
        finally:
 
2978
            for cleanup in reversed(cleanups):
 
2979
                cleanup()
 
2980
 
 
2981
    def _do_preview(self, merger):
 
2982
        from bzrlib.diff import show_diff_trees
3875
2983
        tree_merger = merger.make_merger()
3876
2984
        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='')
 
2985
        try:
 
2986
            result_tree = tt.get_preview_tree()
 
2987
            show_diff_trees(merger.this_tree, result_tree, self.outf,
 
2988
                            old_label='', new_label='')
 
2989
        finally:
 
2990
            tt.finalize()
3886
2991
 
3887
2992
    def _do_merge(self, merger, change_reporter, allow_pending, verified):
3888
2993
        merger.change_reporter = change_reporter
3896
3001
        else:
3897
3002
            return 0
3898
3003
 
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
3004
    def sanity_check_merger(self, merger):
3918
3005
        if (merger.show_base and
3919
3006
            not merger.merge_type is _mod_merge.Merge3Merger):
3920
3007
            raise errors.BzrCommandError("Show-base is not supported for this"
3921
3008
                                         " 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
3009
        if merger.reprocess and not merger.merge_type.supports_reprocess:
3929
3010
            raise errors.BzrCommandError("Conflict reduction is not supported"
3930
3011
                                         " for merge type %s." %
3954
3035
            base_branch, base_path = Branch.open_containing(base_loc,
3955
3036
                possible_transports)
3956
3037
        # 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:
 
3038
        if revision is None or len(revision) < 1 or revision[-1] is None:
3965
3039
            other_revision_id = _mod_revision.ensure_null(
3966
3040
                other_branch.last_revision())
 
3041
        else:
 
3042
            other_revision_id = revision[-1].as_revision_id(other_branch)
 
3043
        if (revision is not None and len(revision) == 2
 
3044
            and revision[0] is not None):
 
3045
            base_revision_id = revision[0].as_revision_id(base_branch)
 
3046
        else:
 
3047
            base_revision_id = None
3967
3048
        # Remember where we merge from
3968
3049
        if ((remember or tree.branch.get_submit_branch() is None) and
3969
3050
             user_location is not None):
3978
3059
            allow_pending = True
3979
3060
        return merger, allow_pending
3980
3061
 
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
3062
    def _select_branch_location(self, tree, user_location, revision=None,
3996
3063
                                index=None):
3997
3064
        """Select a branch location, according to possible inputs.
4027
3094
        Report if the remembered location was used.
4028
3095
        """
4029
3096
        stored_location = tree.branch.get_submit_branch()
4030
 
        stored_location_type = "submit"
4031
3097
        if stored_location is None:
4032
3098
            stored_location = tree.branch.get_parent()
4033
 
            stored_location_type = "parent"
4034
3099
        mutter("%s", stored_location)
4035
3100
        if stored_location is None:
4036
3101
            raise errors.BzrCommandError("No location specified or remembered")
4037
3102
        display_url = urlutils.unescape_for_display(stored_location, 'utf-8')
4038
 
        note(u"%s remembered %s location %s", verb_string,
4039
 
                stored_location_type, display_url)
 
3103
        note(u"%s remembered location %s", verb_string, display_url)
4040
3104
        return stored_location
4041
3105
 
4042
3106
 
4043
3107
class cmd_remerge(Command):
4044
 
    __doc__ = """Redo a merge.
 
3108
    """Redo a merge.
4045
3109
 
4046
3110
    Use this if you want to try a different merge technique while resolving
4047
 
    conflicts.  Some merge techniques are better than others, and remerge
 
3111
    conflicts.  Some merge techniques are better than others, and remerge 
4048
3112
    lets you try different ones on different files.
4049
3113
 
4050
3114
    The options for remerge have the same meaning and defaults as the ones for
4054
3118
    :Examples:
4055
3119
        Re-do the merge of all conflicted files, and show the base text in
4056
3120
        conflict regions, in addition to the usual THIS and OTHER texts::
4057
 
 
 
3121
      
4058
3122
            bzr remerge --show-base
4059
3123
 
4060
3124
        Re-do the merge of "foobar", using the weave merge algorithm, with
4061
3125
        additional processing to reduce the size of conflict regions::
4062
 
 
 
3126
      
4063
3127
            bzr remerge --merge-type weave --reprocess foobar
4064
3128
    """
4065
3129
    takes_args = ['file*']
4072
3136
 
4073
3137
    def run(self, file_list=None, merge_type=None, show_base=False,
4074
3138
            reprocess=False):
4075
 
        from bzrlib.conflicts import restore
4076
3139
        if merge_type is None:
4077
3140
            merge_type = _mod_merge.Merge3Merger
4078
3141
        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:
 
3142
        tree.lock_write()
 
3143
        try:
 
3144
            parents = tree.get_parent_ids()
 
3145
            if len(parents) != 2:
 
3146
                raise errors.BzrCommandError("Sorry, remerge only works after normal"
 
3147
                                             " merges.  Not cherrypicking or"
 
3148
                                             " multi-merges.")
 
3149
            repository = tree.branch.repository
 
3150
            interesting_ids = None
 
3151
            new_conflicts = []
 
3152
            conflicts = tree.conflicts()
 
3153
            if file_list is not None:
 
3154
                interesting_ids = set()
 
3155
                for filename in file_list:
 
3156
                    file_id = tree.path2id(filename)
 
3157
                    if file_id is None:
 
3158
                        raise errors.NotVersionedError(filename)
 
3159
                    interesting_ids.add(file_id)
 
3160
                    if tree.kind(file_id) != "directory":
 
3161
                        continue
 
3162
                    
 
3163
                    for name, ie in tree.inventory.iter_entries(file_id):
 
3164
                        interesting_ids.add(ie.file_id)
 
3165
                new_conflicts = conflicts.select_conflicts(tree, file_list)[0]
 
3166
            else:
 
3167
                # Remerge only supports resolving contents conflicts
 
3168
                allowed_conflicts = ('text conflict', 'contents conflict')
 
3169
                restore_files = [c.path for c in conflicts
 
3170
                                 if c.typestring in allowed_conflicts]
 
3171
            _mod_merge.transform_tree(tree, tree.basis_tree(), interesting_ids)
 
3172
            tree.set_conflicts(ConflictList(new_conflicts))
 
3173
            if file_list is not None:
 
3174
                restore_files = file_list
 
3175
            for filename in restore_files:
 
3176
                try:
 
3177
                    restore(tree.abspath(filename))
 
3178
                except errors.NotConflicted:
 
3179
                    pass
 
3180
            # Disable pending merges, because the file texts we are remerging
 
3181
            # have not had those merges performed.  If we use the wrong parents
 
3182
            # list, we imply that the working tree text has seen and rejected
 
3183
            # all the changes from the other tree, when in fact those changes
 
3184
            # have not yet been seen.
 
3185
            pb = ui.ui_factory.nested_progress_bar()
 
3186
            tree.set_parent_ids(parents[:1])
4112
3187
            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()
 
3188
                merger = _mod_merge.Merger.from_revision_ids(pb,
 
3189
                                                             tree, parents[1])
 
3190
                merger.interesting_ids = interesting_ids
 
3191
                merger.merge_type = merge_type
 
3192
                merger.show_base = show_base
 
3193
                merger.reprocess = reprocess
 
3194
                conflicts = merger.do_merge()
 
3195
            finally:
 
3196
                tree.set_parent_ids(parents)
 
3197
                pb.finished()
4129
3198
        finally:
4130
 
            tree.set_parent_ids(parents)
 
3199
            tree.unlock()
4131
3200
        if conflicts > 0:
4132
3201
            return 1
4133
3202
        else:
4135
3204
 
4136
3205
 
4137
3206
class cmd_revert(Command):
4138
 
    __doc__ = """Revert files to a previous revision.
 
3207
    """Revert files to a previous revision.
4139
3208
 
4140
3209
    Giving a list of files will revert only those files.  Otherwise, all files
4141
3210
    will be reverted.  If the revision is not specified with '--revision', the
4145
3214
    merge instead.  For example, "merge . --revision -2..-3" will remove the
4146
3215
    changes introduced by -2, without affecting the changes introduced by -1.
4147
3216
    Or to remove certain changes on a hunk-by-hunk basis, see the Shelf plugin.
4148
 
 
 
3217
    
4149
3218
    By default, any files that have been manually changed will be backed up
4150
3219
    first.  (Files changed only by merge are not backed up.)  Backup files have
4151
3220
    '.~#~' appended to their name, where # is a number.
4155
3224
    name.  If you name a directory, all the contents of that directory will be
4156
3225
    reverted.
4157
3226
 
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.
 
3227
    Any files that have been newly added since that revision will be deleted,
 
3228
    with a backup kept if appropriate.  Directories containing unknown files
 
3229
    will not be deleted.
4162
3230
 
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
 
3231
    The working tree contains a list of pending merged revisions, which will
 
3232
    be included as parents in the next commit.  Normally, revert clears that
 
3233
    list as well as reverting the files.  If any files are specified, revert
 
3234
    leaves the pending merge list alone and reverts only the files.  Use "bzr
 
3235
    revert ." in the tree root to revert all files but keep the merge record,
 
3236
    and "bzr revert --forget-merges" to clear the pending merge list without
4170
3237
    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
3238
    """
4182
3239
 
4183
3240
    _see_also = ['cat', 'export']
4192
3249
    def run(self, revision=None, no_backup=False, file_list=None,
4193
3250
            forget_merges=None):
4194
3251
        tree, file_list = tree_files(file_list)
4195
 
        self.add_cleanup(tree.lock_tree_write().unlock)
4196
3252
        if forget_merges:
4197
3253
            tree.set_parent_ids(tree.get_parent_ids()[:1])
4198
3254
        else:
4200
3256
 
4201
3257
    @staticmethod
4202
3258
    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)
 
3259
        if revision is None:
 
3260
            rev_id = tree.last_revision()
 
3261
        elif len(revision) != 1:
 
3262
            raise errors.BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
3263
        else:
 
3264
            rev_id = revision[0].as_revision_id(tree.branch)
 
3265
        pb = ui.ui_factory.nested_progress_bar()
 
3266
        try:
 
3267
            tree.revert(file_list,
 
3268
                        tree.branch.repository.revision_tree(rev_id),
 
3269
                        not no_backup, pb, report_changes=True)
 
3270
        finally:
 
3271
            pb.finished()
4206
3272
 
4207
3273
 
4208
3274
class cmd_assert_fail(Command):
4209
 
    __doc__ = """Test reporting of assertion failures"""
 
3275
    """Test reporting of assertion failures"""
4210
3276
    # intended just for use in testing
4211
3277
 
4212
3278
    hidden = True
4216
3282
 
4217
3283
 
4218
3284
class cmd_help(Command):
4219
 
    __doc__ = """Show help on a command or other topic.
 
3285
    """Show help on a command or other topic.
4220
3286
    """
4221
3287
 
4222
3288
    _see_also = ['topics']
4225
3291
            ]
4226
3292
    takes_args = ['topic?']
4227
3293
    aliases = ['?', '--help', '-?', '-h']
4228
 
 
 
3294
    
4229
3295
    @display_command
4230
3296
    def run(self, topic=None, long=False):
4231
3297
        import bzrlib.help
4235
3301
 
4236
3302
 
4237
3303
class cmd_shell_complete(Command):
4238
 
    __doc__ = """Show appropriate completions for context.
 
3304
    """Show appropriate completions for context.
4239
3305
 
4240
3306
    For a list of all available commands, say 'bzr shell-complete'.
4241
3307
    """
4242
3308
    takes_args = ['context?']
4243
3309
    aliases = ['s-c']
4244
3310
    hidden = True
4245
 
 
 
3311
    
4246
3312
    @display_command
4247
3313
    def run(self, context=None):
4248
3314
        import shellcomplete
4250
3316
 
4251
3317
 
4252
3318
class cmd_missing(Command):
4253
 
    __doc__ = """Show unmerged/unpulled revisions between two branches.
4254
 
 
 
3319
    """Show unmerged/unpulled revisions between two branches.
 
3320
    
4255
3321
    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
3322
    """
4286
3323
 
4287
3324
    _see_also = ['merge', 'pull']
4288
3325
    takes_args = ['other_branch?']
4289
3326
    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
 
        ]
 
3327
            Option('reverse', 'Reverse the order of revisions.'),
 
3328
            Option('mine-only',
 
3329
                   'Display changes in the local branch only.'),
 
3330
            Option('this' , 'Same as --mine-only.'),
 
3331
            Option('theirs-only',
 
3332
                   'Display changes in the remote branch only.'),
 
3333
            Option('other', 'Same as --theirs-only.'),
 
3334
            'log-format',
 
3335
            'show-ids',
 
3336
            'verbose'
 
3337
            ]
4310
3338
    encoding_type = 'replace'
4311
3339
 
4312
3340
    @display_command
4313
3341
    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):
 
3342
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
3343
            show_ids=False, verbose=False, this=False, other=False):
4318
3344
        from bzrlib.missing import find_unmerged, iter_log_revisions
4319
 
        def message(s):
4320
 
            if not is_quiet():
4321
 
                self.outf.write(s)
4322
3345
 
4323
3346
        if this:
4324
3347
            mine_only = this
4334
3357
            restrict = 'remote'
4335
3358
 
4336
3359
        local_branch = Branch.open_containing(u".")[0]
4337
 
        self.add_cleanup(local_branch.lock_read().unlock)
4338
 
 
4339
3360
        parent = local_branch.get_parent()
4340
3361
        if other_branch is None:
4341
3362
            other_branch = parent
4344
3365
                                             " or specified.")
4345
3366
            display_url = urlutils.unescape_for_display(parent,
4346
3367
                                                        self.outf.encoding)
4347
 
            message("Using saved parent location: "
4348
 
                    + display_url + "\n")
 
3368
            self.outf.write("Using last location: " + display_url + "\n")
4349
3369
 
4350
3370
        remote_branch = Branch.open(other_branch)
4351
3371
        if remote_branch.base == local_branch.base:
4352
3372
            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()
 
3373
        local_branch.lock_read()
 
3374
        try:
 
3375
            remote_branch.lock_read()
 
3376
            try:
 
3377
                local_extra, remote_extra = find_unmerged(
 
3378
                    local_branch, remote_branch, restrict)
 
3379
 
 
3380
                if log_format is None:
 
3381
                    registry = log.log_formatter_registry
 
3382
                    log_format = registry.get_default(local_branch)
 
3383
                lf = log_format(to_file=self.outf,
 
3384
                                show_ids=show_ids,
 
3385
                                show_timezone='original')
 
3386
                if reverse is False:
 
3387
                    if local_extra is not None:
 
3388
                        local_extra.reverse()
 
3389
                    if remote_extra is not None:
 
3390
                        remote_extra.reverse()
 
3391
 
 
3392
                status_code = 0
 
3393
                if local_extra and not theirs_only:
 
3394
                    self.outf.write("You have %d extra revision(s):\n" %
 
3395
                                    len(local_extra))
 
3396
                    for revision in iter_log_revisions(local_extra,
 
3397
                                        local_branch.repository,
 
3398
                                        verbose):
 
3399
                        lf.log_revision(revision)
 
3400
                    printed_local = True
 
3401
                    status_code = 1
 
3402
                else:
 
3403
                    printed_local = False
 
3404
 
 
3405
                if remote_extra and not mine_only:
 
3406
                    if printed_local is True:
 
3407
                        self.outf.write("\n\n\n")
 
3408
                    self.outf.write("You are missing %d revision(s):\n" %
 
3409
                                    len(remote_extra))
 
3410
                    for revision in iter_log_revisions(remote_extra,
 
3411
                                        remote_branch.repository,
 
3412
                                        verbose):
 
3413
                        lf.log_revision(revision)
 
3414
                    status_code = 1
 
3415
 
 
3416
                if mine_only and not local_extra:
 
3417
                    # We checked local, and found nothing extra
 
3418
                    self.outf.write('This branch is up to date.\n')
 
3419
                elif theirs_only and not remote_extra:
 
3420
                    # We checked remote, and found nothing extra
 
3421
                    self.outf.write('Other branch is up to date.\n')
 
3422
                elif not (mine_only or theirs_only or local_extra or
 
3423
                          remote_extra):
 
3424
                    # We checked both branches, and neither one had extra
 
3425
                    # revisions
 
3426
                    self.outf.write("Branches are up to date.\n")
 
3427
            finally:
 
3428
                remote_branch.unlock()
 
3429
        finally:
 
3430
            local_branch.unlock()
4414
3431
        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)
 
3432
            local_branch.lock_write()
 
3433
            try:
 
3434
                # handle race conditions - a parent might be set while we run.
 
3435
                if local_branch.get_parent() is None:
 
3436
                    local_branch.set_parent(remote_branch.base)
 
3437
            finally:
 
3438
                local_branch.unlock()
4419
3439
        return status_code
4420
3440
 
4421
3441
 
4422
3442
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
 
    """
 
3443
    """Compress the data within a repository."""
4440
3444
 
4441
3445
    _see_also = ['repositories']
4442
3446
    takes_args = ['branch_or_repo?']
4443
 
    takes_options = [
4444
 
        Option('clean-obsolete-packs', 'Delete obsolete packs to save disk space.'),
4445
 
        ]
4446
3447
 
4447
 
    def run(self, branch_or_repo='.', clean_obsolete_packs=False):
 
3448
    def run(self, branch_or_repo='.'):
4448
3449
        dir = bzrdir.BzrDir.open_containing(branch_or_repo)[0]
4449
3450
        try:
4450
3451
            branch = dir.open_branch()
4451
3452
            repository = branch.repository
4452
3453
        except errors.NotBranchError:
4453
3454
            repository = dir.open_repository()
4454
 
        repository.pack(clean_obsolete_packs=clean_obsolete_packs)
 
3455
        repository.pack()
4455
3456
 
4456
3457
 
4457
3458
class cmd_plugins(Command):
4458
 
    __doc__ = """List the installed plugins.
4459
 
 
 
3459
    """List the installed plugins.
 
3460
    
4460
3461
    This command displays the list of installed plugins including
4461
3462
    version of plugin and a short description of each.
4462
3463
 
4468
3469
    adding new commands, providing additional network transports and
4469
3470
    customizing log output.
4470
3471
 
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.
 
3472
    See the Bazaar web site, http://bazaar-vcs.org, for further
 
3473
    information on plugins including where to find them and how to
 
3474
    install them. Instructions are also provided there on how to
 
3475
    write new plugins using the Python programming language.
4475
3476
    """
4476
3477
    takes_options = ['verbose']
4477
3478
 
4492
3493
                doc = '(no description)'
4493
3494
            result.append((name_ver, doc, plugin.path()))
4494
3495
        for name_ver, doc, path in sorted(result):
4495
 
            self.outf.write("%s\n" % name_ver)
4496
 
            self.outf.write("   %s\n" % doc)
 
3496
            print name_ver
 
3497
            print '   ', doc
4497
3498
            if verbose:
4498
 
                self.outf.write("   %s\n" % path)
4499
 
            self.outf.write("\n")
 
3499
                print '   ', path
 
3500
            print
4500
3501
 
4501
3502
 
4502
3503
class cmd_testament(Command):
4503
 
    __doc__ = """Show testament (signing-form) of a revision."""
 
3504
    """Show testament (signing-form) of a revision."""
4504
3505
    takes_options = [
4505
3506
            'revision',
4506
3507
            Option('long', help='Produce long-format testament.'),
4514
3515
            testament_class = StrictTestament
4515
3516
        else:
4516
3517
            testament_class = Testament
4517
 
        if branch == '.':
4518
 
            b = Branch.open_containing(branch)[0]
4519
 
        else:
4520
 
            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())
 
3518
        b = WorkingTree.open_containing(branch)[0].branch
 
3519
        b.lock_read()
 
3520
        try:
 
3521
            if revision is None:
 
3522
                rev_id = b.last_revision()
 
3523
            else:
 
3524
                rev_id = revision[0].as_revision_id(b)
 
3525
            t = testament_class.from_revision(b.repository, rev_id)
 
3526
            if long:
 
3527
                sys.stdout.writelines(t.as_text_lines())
 
3528
            else:
 
3529
                sys.stdout.write(t.as_short_text())
 
3530
        finally:
 
3531
            b.unlock()
4531
3532
 
4532
3533
 
4533
3534
class cmd_annotate(Command):
4534
 
    __doc__ = """Show the origin of each line in a file.
 
3535
    """Show the origin of each line in a file.
4535
3536
 
4536
3537
    This prints out the given file with an annotation on the left side
4537
3538
    indicating which revision, author and date introduced the change.
4538
3539
 
4539
 
    If the origin is the same for a run of consecutive lines, it is
 
3540
    If the origin is the same for a run of consecutive lines, it is 
4540
3541
    shown only at the top, unless the --all option is given.
4541
3542
    """
4542
3543
    # TODO: annotate directories; showing when each file was last changed
4543
 
    # TODO: if the working copy is modified, show annotations on that
 
3544
    # TODO: if the working copy is modified, show annotations on that 
4544
3545
    #       with new uncommitted lines marked
4545
3546
    aliases = ['ann', 'blame', 'praise']
4546
3547
    takes_args = ['filename']
4548
3549
                     Option('long', help='Show commit date in annotations.'),
4549
3550
                     'revision',
4550
3551
                     'show-ids',
4551
 
                     'directory',
4552
3552
                     ]
4553
3553
    encoding_type = 'exact'
4554
3554
 
4555
3555
    @display_command
4556
3556
    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
 
3557
            show_ids=False):
 
3558
        from bzrlib.annotate import annotate_file
4559
3559
        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:
 
3560
            bzrdir.BzrDir.open_containing_tree_or_branch(filename)
 
3561
        if wt is not None:
 
3562
            wt.lock_read()
 
3563
        else:
 
3564
            branch.lock_read()
 
3565
        try:
 
3566
            if revision is None:
 
3567
                revision_id = branch.last_revision()
 
3568
            elif len(revision) != 1:
 
3569
                raise errors.BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
3570
            else:
 
3571
                revision_id = revision[0].as_revision_id(branch)
 
3572
            tree = branch.repository.revision_tree(revision_id)
 
3573
            if wt is not None:
 
3574
                file_id = wt.path2id(relpath)
 
3575
            else:
 
3576
                file_id = tree.path2id(relpath)
 
3577
            if file_id is None:
 
3578
                raise errors.NotVersionedError(filename)
 
3579
            file_version = tree.inventory[file_id].revision
4580
3580
            annotate_file(branch, file_version, file_id, long, all, self.outf,
4581
3581
                          show_ids=show_ids)
 
3582
        finally:
 
3583
            if wt is not None:
 
3584
                wt.unlock()
 
3585
            else:
 
3586
                branch.unlock()
4582
3587
 
4583
3588
 
4584
3589
class cmd_re_sign(Command):
4585
 
    __doc__ = """Create a digital signature for an existing revision."""
 
3590
    """Create a digital signature for an existing revision."""
4586
3591
    # TODO be able to replace existing ones.
4587
3592
 
4588
3593
    hidden = True # is this right ?
4589
3594
    takes_args = ['revision_id*']
4590
 
    takes_options = ['directory', 'revision']
4591
 
 
4592
 
    def run(self, revision_id_list=None, revision=None, directory=u'.'):
 
3595
    takes_options = ['revision']
 
3596
    
 
3597
    def run(self, revision_id_list=None, revision=None):
4593
3598
        if revision_id_list is not None and revision is not None:
4594
3599
            raise errors.BzrCommandError('You can only supply one of revision_id or --revision')
4595
3600
        if revision_id_list is None and revision is None:
4596
3601
            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)
 
3602
        b = WorkingTree.open_containing(u'.')[0].branch
 
3603
        b.lock_write()
 
3604
        try:
 
3605
            return self._run(b, revision_id_list, revision)
 
3606
        finally:
 
3607
            b.unlock()
4600
3608
 
4601
3609
    def _run(self, b, revision_id_list, revision):
4602
3610
        import bzrlib.gpg as gpg
4647
3655
 
4648
3656
 
4649
3657
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.
 
3658
    """Convert the current branch into a checkout of the supplied branch.
4652
3659
 
4653
3660
    Once converted into a checkout, commits must succeed on the master branch
4654
3661
    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
3662
    """
4660
3663
 
4661
3664
    _see_also = ['checkouts', 'unbind']
4662
3665
    takes_args = ['location?']
4663
 
    takes_options = ['directory']
 
3666
    takes_options = []
4664
3667
 
4665
 
    def run(self, location=None, directory=u'.'):
4666
 
        b, relpath = Branch.open_containing(directory)
 
3668
    def run(self, location=None):
 
3669
        b, relpath = Branch.open_containing(u'.')
4667
3670
        if location is None:
4668
3671
            try:
4669
3672
                location = b.get_old_bound_location()
4672
3675
                    'This format does not remember old locations.')
4673
3676
            else:
4674
3677
                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')
 
3678
                    raise errors.BzrCommandError('No location supplied and no '
 
3679
                        'previous location known')
4680
3680
        b_other = Branch.open(location)
4681
3681
        try:
4682
3682
            b.bind(b_other)
4683
3683
        except errors.DivergedBranches:
4684
3684
            raise errors.BzrCommandError('These branches have diverged.'
4685
3685
                                         ' Try merging, and then bind again.')
4686
 
        if b.get_config().has_explicit_nickname():
4687
 
            b.nick = b_other.nick
4688
3686
 
4689
3687
 
4690
3688
class cmd_unbind(Command):
4691
 
    __doc__ = """Convert the current checkout into a regular branch.
 
3689
    """Convert the current checkout into a regular branch.
4692
3690
 
4693
3691
    After unbinding, the local branch is considered independent and subsequent
4694
3692
    commits will be local only.
4696
3694
 
4697
3695
    _see_also = ['checkouts', 'bind']
4698
3696
    takes_args = []
4699
 
    takes_options = ['directory']
 
3697
    takes_options = []
4700
3698
 
4701
 
    def run(self, directory=u'.'):
4702
 
        b, relpath = Branch.open_containing(directory)
 
3699
    def run(self):
 
3700
        b, relpath = Branch.open_containing(u'.')
4703
3701
        if not b.unbind():
4704
3702
            raise errors.BzrCommandError('Local branch is not bound')
4705
3703
 
4706
3704
 
4707
3705
class cmd_uncommit(Command):
4708
 
    __doc__ = """Remove the last committed revision.
 
3706
    """Remove the last committed revision.
4709
3707
 
4710
3708
    --verbose will print out what is being removed.
4711
3709
    --dry-run will go through all the motions, but not actually
4751
3749
            b = control.open_branch()
4752
3750
 
4753
3751
        if tree is not None:
4754
 
            self.add_cleanup(tree.lock_write().unlock)
 
3752
            tree.lock_write()
4755
3753
        else:
4756
 
            self.add_cleanup(b.lock_write().unlock)
4757
 
        return self._run(b, tree, dry_run, verbose, revision, force, local=local)
 
3754
            b.lock_write()
 
3755
        try:
 
3756
            return self._run(b, tree, dry_run, verbose, revision, force,
 
3757
                             local=local)
 
3758
        finally:
 
3759
            if tree is not None:
 
3760
                tree.unlock()
 
3761
            else:
 
3762
                b.unlock()
4758
3763
 
4759
3764
    def _run(self, b, tree, dry_run, verbose, revision, force, local=False):
4760
3765
        from bzrlib.log import log_formatter, show_log
4792
3797
                 end_revision=last_revno)
4793
3798
 
4794
3799
        if dry_run:
4795
 
            self.outf.write('Dry-run, pretending to remove'
4796
 
                            ' the above revisions.\n')
 
3800
            print 'Dry-run, pretending to remove the above revisions.'
 
3801
            if not force:
 
3802
                val = raw_input('Press <enter> to continue')
4797
3803
        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
4804
 
 
4805
 
        mutter('Uncommitting from {%s} to {%s}',
4806
 
               last_rev_id, rev_id)
 
3804
            print 'The above revision(s) will be removed.'
 
3805
            if not force:
 
3806
                val = raw_input('Are you sure [y/N]? ')
 
3807
                if val.lower() not in ('y', 'yes'):
 
3808
                    print 'Canceled'
 
3809
                    return 0
 
3810
 
4807
3811
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
4808
3812
                 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)
4811
3813
 
4812
3814
 
4813
3815
class cmd_break_lock(Command):
4814
 
    __doc__ = """Break a dead lock on a repository, branch or working directory.
 
3816
    """Break a dead lock on a repository, branch or working directory.
4815
3817
 
4816
3818
    CAUTION: Locks should only be broken when you are sure that the process
4817
3819
    holding the lock has been stopped.
4818
3820
 
4819
 
    You can get information on what locks are open via the 'bzr info
4820
 
    [location]' command.
4821
 
 
 
3821
    You can get information on what locks are open via the 'bzr info' command.
 
3822
    
4822
3823
    :Examples:
4823
3824
        bzr break-lock
4824
 
        bzr break-lock bzr+ssh://example.com/bzr/foo
4825
3825
    """
4826
3826
    takes_args = ['location?']
4827
3827
 
4833
3833
            control.break_lock()
4834
3834
        except NotImplementedError:
4835
3835
            pass
4836
 
 
 
3836
        
4837
3837
 
4838
3838
class cmd_wait_until_signalled(Command):
4839
 
    __doc__ = """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
 
3839
    """Test helper for test_start_and_stop_bzr_subprocess_send_signal.
4840
3840
 
4841
3841
    This just prints a line to signal when it is ready, then blocks on stdin.
4842
3842
    """
4850
3850
 
4851
3851
 
4852
3852
class cmd_serve(Command):
4853
 
    __doc__ = """Run the bzr server."""
 
3853
    """Run the bzr server."""
4854
3854
 
4855
3855
    aliases = ['server']
4856
3856
 
4857
3857
    takes_options = [
4858
3858
        Option('inet',
4859
3859
               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
3860
        Option('port',
4865
3861
               help='Listen for connections on nominated port of the form '
4866
3862
                    '[hostname:]portnumber.  Passing 0 as the port number will '
4867
 
                    'result in a dynamically allocated port.  The default port '
4868
 
                    'depends on the protocol.',
 
3863
                    'result in a dynamically allocated port.  The default port is '
 
3864
                    '4155.',
4869
3865
               type=str),
4870
 
        custom_help('directory',
4871
 
               help='Serve contents of this directory.'),
 
3866
        Option('directory',
 
3867
               help='Serve contents of this directory.',
 
3868
               type=unicode),
4872
3869
        Option('allow-writes',
4873
3870
               help='By default the server is a readonly server.  Supplying '
4874
3871
                    '--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.'
 
3872
                    'the served directory and below.'
4880
3873
                ),
4881
3874
        ]
4882
3875
 
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
 
3876
    def run(self, port=None, inet=False, directory=None, allow_writes=False):
 
3877
        from bzrlib import lockdir
 
3878
        from bzrlib.smart import medium, server
 
3879
        from bzrlib.transport import get_transport
 
3880
        from bzrlib.transport.chroot import ChrootServer
4905
3881
        if directory is None:
4906
3882
            directory = os.getcwd()
4907
 
        if protocol is None:
4908
 
            protocol = transport_server_registry.get()
4909
 
        host, port = self.get_host_and_port(port)
4910
3883
        url = urlutils.local_path_to_url(directory)
4911
3884
        if not allow_writes:
4912
3885
            url = 'readonly+' + url
4913
 
        transport = get_transport(url)
4914
 
        protocol(transport, host, port, inet)
 
3886
        chroot_server = ChrootServer(get_transport(url))
 
3887
        chroot_server.setUp()
 
3888
        t = get_transport(chroot_server.get_url())
 
3889
        if inet:
 
3890
            smart_server = medium.SmartServerPipeStreamMedium(
 
3891
                sys.stdin, sys.stdout, t)
 
3892
        else:
 
3893
            host = medium.BZR_DEFAULT_INTERFACE
 
3894
            if port is None:
 
3895
                port = medium.BZR_DEFAULT_PORT
 
3896
            else:
 
3897
                if ':' in port:
 
3898
                    host, port = port.split(':')
 
3899
                port = int(port)
 
3900
            smart_server = server.SmartTCPServer(t, host=host, port=port)
 
3901
            print 'listening on port: ', smart_server.port
 
3902
            sys.stdout.flush()
 
3903
        # for the duration of this server, no UI output is permitted.
 
3904
        # note that this may cause problems with blackbox tests. This should
 
3905
        # be changed with care though, as we dont want to use bandwidth sending
 
3906
        # progress over stderr to smart server clients!
 
3907
        old_factory = ui.ui_factory
 
3908
        old_lockdir_timeout = lockdir._DEFAULT_TIMEOUT_SECONDS
 
3909
        try:
 
3910
            ui.ui_factory = ui.SilentUIFactory()
 
3911
            lockdir._DEFAULT_TIMEOUT_SECONDS = 0
 
3912
            smart_server.serve()
 
3913
        finally:
 
3914
            ui.ui_factory = old_factory
 
3915
            lockdir._DEFAULT_TIMEOUT_SECONDS = old_lockdir_timeout
4915
3916
 
4916
3917
 
4917
3918
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.
 
3919
    """Combine a subtree into its containing tree.
 
3920
    
 
3921
    This command is for experimental use only.  It requires the target tree
 
3922
    to be in dirstate-with-subtree format, which cannot be converted into
 
3923
    earlier formats.
4921
3924
 
4922
3925
    The TREE argument should be an independent tree, inside another tree, but
4923
3926
    not part of it.  (Such trees can be produced by "bzr split", but also by
4926
3929
    The result is a combined tree, with the subtree no longer an independant
4927
3930
    part.  This is marked as a merge of the subtree into the containing tree,
4928
3931
    and all history is preserved.
 
3932
 
 
3933
    If --reference is specified, the subtree retains its independence.  It can
 
3934
    be branched by itself, and can be part of multiple projects at the same
 
3935
    time.  But operations performed in the containing tree, such as commit
 
3936
    and merge, will recurse into the subtree.
4929
3937
    """
4930
3938
 
4931
3939
    _see_also = ['split']
4932
3940
    takes_args = ['tree']
4933
3941
    takes_options = [
4934
 
            Option('reference', help='Join by reference.', hidden=True),
 
3942
            Option('reference', help='Join by reference.'),
4935
3943
            ]
 
3944
    hidden = True
4936
3945
 
4937
3946
    def run(self, tree, reference=False):
4938
3947
        sub_tree = WorkingTree.open(tree)
4956
3965
            try:
4957
3966
                containing_tree.subsume(sub_tree)
4958
3967
            except errors.BadSubsumeSource, e:
4959
 
                raise errors.BzrCommandError("Cannot join %s.  %s" %
 
3968
                raise errors.BzrCommandError("Cannot join %s.  %s" % 
4960
3969
                                             (tree, e.reason))
4961
3970
 
4962
3971
 
4963
3972
class cmd_split(Command):
4964
 
    __doc__ = """Split a subdirectory of a tree into a separate tree.
 
3973
    """Split a subdirectory of a tree into a separate tree.
4965
3974
 
4966
3975
    This command will produce a target tree in a format that supports
4967
3976
    rich roots, like 'rich-root' or 'rich-root-pack'.  These formats cannot be
4972
3981
    branch.  Commits in the top-level tree will not apply to the new subtree.
4973
3982
    """
4974
3983
 
4975
 
    _see_also = ['join']
 
3984
    # join is not un-hidden yet
 
3985
    #_see_also = ['join']
4976
3986
    takes_args = ['tree']
4977
3987
 
4978
3988
    def run(self, tree):
4983
3993
        try:
4984
3994
            containing_tree.extract(sub_id)
4985
3995
        except errors.RootNotRich:
4986
 
            raise errors.RichRootUpgradeRequired(containing_tree.branch.base)
 
3996
            raise errors.UpgradeRequired(containing_tree.branch.base)
4987
3997
 
4988
3998
 
4989
3999
class cmd_merge_directive(Command):
4990
 
    __doc__ = """Generate a merge directive for auto-merge tools.
 
4000
    """Generate a merge directive for auto-merge tools.
4991
4001
 
4992
4002
    A directive requests a merge to be performed, and also provides all the
4993
4003
    information necessary to do so.  This means it must either include a
5086
4096
 
5087
4097
 
5088
4098
class cmd_send(Command):
5089
 
    __doc__ = """Mail or create a merge-directive for submitting changes.
 
4099
    """Mail or create a merge-directive for submiting changes.
5090
4100
 
5091
4101
    A merge directive provides many things needed for requesting merges:
5092
4102
 
5098
4108
      directly from the merge directive, without retrieving data from a
5099
4109
      branch.
5100
4110
 
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.
 
4111
    If --no-bundle is specified, then public_branch is needed (and must be
 
4112
    up-to-date), so that the receiver can perform the merge using the
 
4113
    public_branch.  The public_branch is always included if known, so that
 
4114
    people can check it later.
 
4115
 
 
4116
    The submit branch defaults to the parent, but can be overridden.  Both
 
4117
    submit branch and public branch will be remembered if supplied.
 
4118
 
 
4119
    If a public_branch is known for the submit_branch, that public submit
 
4120
    branch is used in the merge instructions.  This means that a local mirror
 
4121
    can be used as your actual submit branch, once you have set public_branch
 
4122
    for that mirror.
5127
4123
 
5128
4124
    Mail is sent using your preferred mail program.  This should be transparent
5129
4125
    on Windows (it uses MAPI).  On Linux, it requires the xdg-email utility.
5130
4126
    If the preferred client can't be found (or used), your editor will be used.
5131
 
 
 
4127
    
5132
4128
    To use a specific mail program, set the mail_client configuration option.
5133
4129
    (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.
 
4130
    specific clients are "evolution", "kmail", "mutt", and "thunderbird";
 
4131
    generic options are "default", "editor", "mapi", and "xdg-email".
5138
4132
 
5139
4133
    If mail is being sent, a to address is required.  This can be supplied
5140
4134
    either on the commandline, by setting the submit_to configuration
5141
 
    option in the branch itself or the child_submit_to configuration option
 
4135
    option in the branch itself or the child_submit_to configuration option 
5142
4136
    in the submit branch.
5143
4137
 
5144
4138
    Two formats are currently supported: "4" uses revision bundle format 4 and
5146
4140
    older formats.  It is compatible with Bazaar 0.19 and later.  It is the
5147
4141
    default.  "0.9" uses revision bundle format 0.9 and merge directive
5148
4142
    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.
 
4143
    
 
4144
    Merge directives are applied using the merge command or the pull command.
5156
4145
    """
5157
4146
 
5158
4147
    encoding_type = 'exact'
5174
4163
               short_name='f',
5175
4164
               type=unicode),
5176
4165
        Option('output', short_name='o',
5177
 
               help='Write merge directive to this file or directory; '
 
4166
               help='Write merge directive to this file; '
5178
4167
                    'use - for stdout.',
5179
4168
               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
4169
        Option('mail-to', help='Mail the request to this address.',
5184
4170
               type=unicode),
5185
4171
        'revision',
5186
4172
        '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')),
 
4173
        RegistryOption.from_kwargs('format',
 
4174
        'Use the specified output format.',
 
4175
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4176
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5191
4177
        ]
5192
4178
 
5193
4179
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5194
4180
            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)
 
4181
            format='4', mail_to=None, message=None, **kwargs):
 
4182
        return self._run(submit_branch, revision, public_branch, remember,
 
4183
                         format, no_bundle, no_patch, output,
 
4184
                         kwargs.get('from', '.'), mail_to, message)
 
4185
 
 
4186
    def _run(self, submit_branch, revision, public_branch, remember, format,
 
4187
             no_bundle, no_patch, output, from_, mail_to, message):
 
4188
        from bzrlib.revision import NULL_REVISION
 
4189
        branch = Branch.open_containing(from_)[0]
 
4190
        if output is None:
 
4191
            outfile = StringIO()
 
4192
        elif output == '-':
 
4193
            outfile = self.outf
 
4194
        else:
 
4195
            outfile = open(output, 'wb')
 
4196
        # we may need to write data into branch's repository to calculate
 
4197
        # the data to send.
 
4198
        branch.lock_write()
 
4199
        try:
 
4200
            if output is None:
 
4201
                config = branch.get_config()
 
4202
                if mail_to is None:
 
4203
                    mail_to = config.get_user_option('submit_to')
 
4204
                mail_client = config.get_mail_client()
 
4205
            if remember and submit_branch is None:
 
4206
                raise errors.BzrCommandError(
 
4207
                    '--remember requires a branch to be specified.')
 
4208
            stored_submit_branch = branch.get_submit_branch()
 
4209
            remembered_submit_branch = False
 
4210
            if submit_branch is None:
 
4211
                submit_branch = stored_submit_branch
 
4212
                remembered_submit_branch = True
 
4213
            else:
 
4214
                if stored_submit_branch is None or remember:
 
4215
                    branch.set_submit_branch(submit_branch)
 
4216
            if submit_branch is None:
 
4217
                submit_branch = branch.get_parent()
 
4218
                remembered_submit_branch = True
 
4219
            if submit_branch is None:
 
4220
                raise errors.BzrCommandError('No submit branch known or'
 
4221
                                             ' specified')
 
4222
            if remembered_submit_branch:
 
4223
                note('Using saved location: %s', submit_branch)
 
4224
 
 
4225
            if mail_to is None:
 
4226
                submit_config = Branch.open(submit_branch).get_config()
 
4227
                mail_to = submit_config.get_user_option("child_submit_to")
 
4228
 
 
4229
            stored_public_branch = branch.get_public_branch()
 
4230
            if public_branch is None:
 
4231
                public_branch = stored_public_branch
 
4232
            elif stored_public_branch is None or remember:
 
4233
                branch.set_public_branch(public_branch)
 
4234
            if no_bundle and public_branch is None:
 
4235
                raise errors.BzrCommandError('No public branch specified or'
 
4236
                                             ' known')
 
4237
            base_revision_id = None
 
4238
            revision_id = None
 
4239
            if revision is not None:
 
4240
                if len(revision) > 2:
 
4241
                    raise errors.BzrCommandError('bzr send takes '
 
4242
                        'at most two one revision identifiers')
 
4243
                revision_id = revision[-1].as_revision_id(branch)
 
4244
                if len(revision) == 2:
 
4245
                    base_revision_id = revision[0].as_revision_id(branch)
 
4246
            if revision_id is None:
 
4247
                revision_id = branch.last_revision()
 
4248
            if revision_id == NULL_REVISION:
 
4249
                raise errors.BzrCommandError('No revisions to submit.')
 
4250
            if format == '4':
 
4251
                directive = merge_directive.MergeDirective2.from_objects(
 
4252
                    branch.repository, revision_id, time.time(),
 
4253
                    osutils.local_time_offset(), submit_branch,
 
4254
                    public_branch=public_branch, include_patch=not no_patch,
 
4255
                    include_bundle=not no_bundle, message=message,
 
4256
                    base_revision_id=base_revision_id)
 
4257
            elif format == '0.9':
 
4258
                if not no_bundle:
 
4259
                    if not no_patch:
 
4260
                        patch_type = 'bundle'
 
4261
                    else:
 
4262
                        raise errors.BzrCommandError('Format 0.9 does not'
 
4263
                            ' permit bundle with no patch')
 
4264
                else:
 
4265
                    if not no_patch:
 
4266
                        patch_type = 'diff'
 
4267
                    else:
 
4268
                        patch_type = None
 
4269
                directive = merge_directive.MergeDirective.from_objects(
 
4270
                    branch.repository, revision_id, time.time(),
 
4271
                    osutils.local_time_offset(), submit_branch,
 
4272
                    public_branch=public_branch, patch_type=patch_type,
 
4273
                    message=message)
 
4274
 
 
4275
            outfile.writelines(directive.to_lines())
 
4276
            if output is None:
 
4277
                subject = '[MERGE] '
 
4278
                if message is not None:
 
4279
                    subject += message
 
4280
                else:
 
4281
                    revision = branch.repository.get_revision(revision_id)
 
4282
                    subject += revision.get_summary()
 
4283
                basename = directive.get_disk_name(branch)
 
4284
                mail_client.compose_merge_request(mail_to, subject,
 
4285
                                                  outfile.getvalue(), basename)
 
4286
        finally:
 
4287
            if output != '-':
 
4288
                outfile.close()
 
4289
            branch.unlock()
5203
4290
 
5204
4291
 
5205
4292
class cmd_bundle_revisions(cmd_send):
5206
 
    __doc__ = """Create a merge-directive for submitting changes.
 
4293
 
 
4294
    """Create a merge-directive for submiting changes.
5207
4295
 
5208
4296
    A merge directive provides many things needed for requesting merges:
5209
4297
 
5249
4337
               type=unicode),
5250
4338
        Option('output', short_name='o', help='Write directive to this file.',
5251
4339
               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
4340
        'revision',
5256
 
        RegistryOption('format',
5257
 
                       help='Use the specified output format.',
5258
 
                       lazy_registry=('bzrlib.send', 'format_registry')),
 
4341
        RegistryOption.from_kwargs('format',
 
4342
        'Use the specified output format.',
 
4343
        **{'4': 'Bundle format 4, Merge Directive 2 (default)',
 
4344
           '0.9': 'Bundle format 0.9, Merge Directive 1',})
5259
4345
        ]
5260
4346
    aliases = ['bundle']
5261
4347
 
5265
4351
 
5266
4352
    def run(self, submit_branch=None, public_branch=None, no_bundle=False,
5267
4353
            no_patch=False, revision=None, remember=False, output=None,
5268
 
            format=None, strict=None, **kwargs):
 
4354
            format='4', **kwargs):
5269
4355
        if output is None:
5270
4356
            output = '-'
5271
 
        from bzrlib.send import send
5272
 
        return send(submit_branch, revision, public_branch, remember,
 
4357
        return self._run(submit_branch, revision, public_branch, remember,
5273
4358
                         format, no_bundle, no_patch, output,
5274
 
                         kwargs.get('from', '.'), None, None, None,
5275
 
                         self.outf, strict=strict)
 
4359
                         kwargs.get('from', '.'), None, None)
5276
4360
 
5277
4361
 
5278
4362
class cmd_tag(Command):
5279
 
    __doc__ = """Create, remove or modify a tag naming a revision.
5280
 
 
 
4363
    """Create, remove or modify a tag naming a revision.
 
4364
    
5281
4365
    Tags give human-meaningful names to revisions.  Commands that take a -r
5282
4366
    (--revision) option can be given -rtag:X, where X is any previously
5283
4367
    created tag.
5285
4369
    Tags are stored in the branch.  Tags are copied from one branch to another
5286
4370
    along when you branch, push, pull or merge.
5287
4371
 
5288
 
    It is an error to give a tag name that already exists unless you pass
 
4372
    It is an error to give a tag name that already exists unless you pass 
5289
4373
    --force, in which case the tag is moved to point to the new revision.
5290
 
 
5291
 
    To rename a tag (change the name but keep it on the same revsion), run ``bzr
5292
 
    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
4374
    """
5299
4375
 
5300
4376
    _see_also = ['commit', 'tags']
5301
 
    takes_args = ['tag_name?']
 
4377
    takes_args = ['tag_name']
5302
4378
    takes_options = [
5303
4379
        Option('delete',
5304
4380
            help='Delete this tag rather than placing it.',
5305
4381
            ),
5306
 
        custom_help('directory',
5307
 
            help='Branch in which to place the tag.'),
 
4382
        Option('directory',
 
4383
            help='Branch in which to place the tag.',
 
4384
            short_name='d',
 
4385
            type=unicode,
 
4386
            ),
5308
4387
        Option('force',
5309
4388
            help='Replace existing tags.',
5310
4389
            ),
5311
4390
        'revision',
5312
4391
        ]
5313
4392
 
5314
 
    def run(self, tag_name=None,
 
4393
    def run(self, tag_name,
5315
4394
            delete=None,
5316
4395
            directory='.',
5317
4396
            force=None,
5318
4397
            revision=None,
5319
4398
            ):
5320
4399
        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)
 
4400
        branch.lock_write()
 
4401
        try:
 
4402
            if delete:
 
4403
                branch.tags.delete_tag(tag_name)
 
4404
                self.outf.write('Deleted tag %s.\n' % tag_name)
5334
4405
            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)
 
4406
                if revision:
 
4407
                    if len(revision) != 1:
 
4408
                        raise errors.BzrCommandError(
 
4409
                            "Tags can only be placed on a single revision, "
 
4410
                            "not on a range")
 
4411
                    revision_id = revision[0].as_revision_id(branch)
 
4412
                else:
 
4413
                    revision_id = branch.last_revision()
 
4414
                if (not force) and branch.tags.has_tag(tag_name):
 
4415
                    raise errors.TagAlreadyExists(tag_name)
 
4416
                branch.tags.set_tag(tag_name, revision_id)
 
4417
                self.outf.write('Created tag %s.\n' % tag_name)
 
4418
        finally:
 
4419
            branch.unlock()
5345
4420
 
5346
4421
 
5347
4422
class cmd_tags(Command):
5348
 
    __doc__ = """List tags.
 
4423
    """List tags.
5349
4424
 
5350
4425
    This command shows a table of tag names and the revisions they reference.
5351
4426
    """
5352
4427
 
5353
4428
    _see_also = ['tag']
5354
4429
    takes_options = [
5355
 
        custom_help('directory',
5356
 
            help='Branch whose tags should be displayed.'),
 
4430
        Option('directory',
 
4431
            help='Branch whose tags should be displayed.',
 
4432
            short_name='d',
 
4433
            type=unicode,
 
4434
            ),
5357
4435
        RegistryOption.from_kwargs('sort',
5358
4436
            'Sort tags by different criteria.', title='Sorting',
5359
4437
            alpha='Sort tags lexicographically (default).',
5360
4438
            time='Sort tags chronologically.',
5361
4439
            ),
5362
4440
        'show-ids',
5363
 
        'revision',
5364
4441
    ]
5365
4442
 
5366
4443
    @display_command
5368
4445
            directory='.',
5369
4446
            sort='alpha',
5370
4447
            show_ids=False,
5371
 
            revision=None,
5372
4448
            ):
5373
4449
        branch, relpath = Branch.open_containing(directory)
5374
 
 
5375
4450
        tags = branch.tags.get_tag_dict().items()
5376
 
        if not tags:
5377
 
            return
5378
 
 
5379
 
        self.add_cleanup(branch.lock_read().unlock)
5380
 
        if revision:
5381
 
            graph = branch.repository.get_graph()
5382
 
            rev1, rev2 = _get_revision_range(revision, branch, self.name())
5383
 
            revid1, revid2 = rev1.rev_id, rev2.rev_id
5384
 
            # only show revisions between revid1 and revid2 (inclusive)
5385
 
            tags = [(tag, revid) for tag, revid in tags if
5386
 
                graph.is_between(revid, revid1, revid2)]
5387
4451
        if sort == 'alpha':
5388
4452
            tags.sort()
5389
4453
        elif sort == 'time':
5399
4463
            tags.sort(key=lambda x: timestamps[x[1]])
5400
4464
        if not show_ids:
5401
4465
            # [ (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()
 
4466
            revno_map = branch.get_revision_id_to_revno_map()
 
4467
            tags = [ (tag, '.'.join(map(str, revno_map.get(revid, ('?',)))))
 
4468
                        for tag, revid in tags ]
5413
4469
        for tag, revspec in tags:
5414
4470
            self.outf.write('%-20s %s\n' % (tag, revspec))
5415
4471
 
5416
4472
 
5417
4473
class cmd_reconfigure(Command):
5418
 
    __doc__ = """Reconfigure the type of a bzr directory.
 
4474
    """Reconfigure the type of a bzr directory.
5419
4475
 
5420
4476
    A target configuration must be specified.
5421
4477
 
5428
4484
    If none of these is available, --bind-to must be specified.
5429
4485
    """
5430
4486
 
5431
 
    _see_also = ['branches', 'checkouts', 'standalone-trees', 'working-trees']
5432
4487
    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
 
        ]
 
4488
    takes_options = [RegistryOption.from_kwargs('target_type',
 
4489
                     title='Target type',
 
4490
                     help='The type to reconfigure the directory to.',
 
4491
                     value_switches=True, enum_switch=False,
 
4492
                     branch='Reconfigure to a branch.',
 
4493
                     tree='Reconfigure to a tree.',
 
4494
                     checkout='Reconfigure to a checkout.',
 
4495
                     lightweight_checkout='Reconfigure to a lightweight'
 
4496
                     ' checkout.',
 
4497
                     standalone='Reconfigure to be standalone.',
 
4498
                     use_shared='Reconfigure to use a shared repository.'),
 
4499
                     Option('bind-to', help='Branch to bind checkout to.',
 
4500
                            type=str),
 
4501
                     Option('force',
 
4502
                        help='Perform reconfiguration even if local changes'
 
4503
                        ' will be lost.')
 
4504
                     ]
5465
4505
 
5466
 
    def run(self, location=None, target_type=None, bind_to=None, force=False,
5467
 
            stacked_on=None,
5468
 
            unstacked=None):
 
4506
    def run(self, location=None, target_type=None, bind_to=None, force=False):
5469
4507
        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
4508
        if target_type is None:
5480
 
            if stacked_on or unstacked:
5481
 
                return
5482
 
            else:
5483
 
                raise errors.BzrCommandError('No target configuration '
5484
 
                    'specified')
 
4509
            raise errors.BzrCommandError('No target configuration specified')
5485
4510
        elif target_type == 'branch':
5486
4511
            reconfiguration = reconfigure.Reconfigure.to_branch(directory)
5487
4512
        elif target_type == 'tree':
5488
4513
            reconfiguration = reconfigure.Reconfigure.to_tree(directory)
5489
4514
        elif target_type == 'checkout':
5490
 
            reconfiguration = reconfigure.Reconfigure.to_checkout(
5491
 
                directory, bind_to)
 
4515
            reconfiguration = reconfigure.Reconfigure.to_checkout(directory,
 
4516
                                                                  bind_to)
5492
4517
        elif target_type == 'lightweight-checkout':
5493
4518
            reconfiguration = reconfigure.Reconfigure.to_lightweight_checkout(
5494
4519
                directory, bind_to)
5496
4521
            reconfiguration = reconfigure.Reconfigure.to_use_shared(directory)
5497
4522
        elif target_type == 'standalone':
5498
4523
            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
4524
        reconfiguration.apply(force)
5506
4525
 
5507
4526
 
5508
4527
class cmd_switch(Command):
5509
 
    __doc__ = """Set the branch of a checkout and update.
5510
 
 
 
4528
    """Set the branch of a checkout and update.
 
4529
    
5511
4530
    For lightweight checkouts, this changes the branch being referenced.
5512
4531
    For heavyweight checkouts, this checks that there are no local commits
5513
4532
    versus the current bound branch, then it makes the local branch a mirror
5514
4533
    of the new location and binds to it.
5515
 
 
 
4534
    
5516
4535
    In both cases, the working tree is updated and uncommitted changes
5517
4536
    are merged. The user can commit or revert these as they desire.
5518
4537
 
5522
4541
    directory of the current branch. For example, if you are currently in a
5523
4542
    checkout of /path/to/branch, specifying 'newbranch' will find a branch at
5524
4543
    /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
4544
    """
5530
4545
 
5531
 
    takes_args = ['to_location?']
 
4546
    takes_args = ['to_location']
5532
4547
    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
 
                    ]
 
4548
                        help='Switch even if local commits will be lost.')
 
4549
                     ]
5539
4550
 
5540
 
    def run(self, to_location=None, force=False, create_branch=False,
5541
 
            revision=None):
 
4551
    def run(self, to_location, force=False):
5542
4552
        from bzrlib import switch
5543
4553
        tree_location = '.'
5544
 
        revision = _get_one_revision('switch', revision)
5545
4554
        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
4555
        try:
5552
 
            branch = control_dir.open_branch()
5553
 
            had_explicit_nick = branch.get_config().has_explicit_nickname()
 
4556
            to_branch = Branch.open(to_location)
5554
4557
        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
 
4558
            to_branch = Branch.open(
 
4559
                control_dir.open_branch().base + '../' + to_location)
 
4560
        switch.switch(control_dir, to_branch, force)
5583
4561
        note('Switched to branch: %s',
5584
4562
            urlutils.unescape_for_display(to_branch.base, 'utf-8'))
5585
4563
 
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
4564
 
5758
4565
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()
 
4566
    """Show a branch's currently registered hooks.
 
4567
    """
 
4568
 
 
4569
    hidden = True
 
4570
    takes_args = ['path?']
 
4571
 
 
4572
    def run(self, path=None):
5966
4573
        if path is None:
5967
 
            info = branch._get_all_reference_info().iteritems()
5968
 
            self._display_reference_info(tree, branch, info)
 
4574
            path = '.'
 
4575
        branch_hooks = Branch.open(path).hooks
 
4576
        for hook_type in branch_hooks:
 
4577
            hooks = branch_hooks[hook_type]
 
4578
            self.outf.write("%s:\n" % (hook_type,))
 
4579
            if hooks:
 
4580
                for hook in hooks:
 
4581
                    self.outf.write("  %s\n" %
 
4582
                                    (branch_hooks.get_hook_name(hook),))
 
4583
            else:
 
4584
                self.outf.write("  <no hooks installed>\n")
 
4585
 
 
4586
 
 
4587
def _create_prefix(cur_transport):
 
4588
    needed = [cur_transport]
 
4589
    # Recurse upwards until we can create a directory successfully
 
4590
    while True:
 
4591
        new_transport = cur_transport.clone('..')
 
4592
        if new_transport.base == cur_transport.base:
 
4593
            raise errors.BzrCommandError(
 
4594
                "Failed to create path prefix for %s."
 
4595
                % cur_transport.base)
 
4596
        try:
 
4597
            new_transport.mkdir('.')
 
4598
        except errors.NoSuchFile:
 
4599
            needed.append(new_transport)
 
4600
            cur_transport = new_transport
5969
4601
        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)
 
4602
            break
 
4603
    # Now we only need to create child directories
 
4604
    while needed:
 
4605
        cur_transport = needed.pop()
 
4606
        cur_transport.ensure_base()
 
4607
 
 
4608
 
 
4609
# these get imported and then picked up by the scan for cmd_*
 
4610
# TODO: Some more consistent way to split command definitions across files;
 
4611
# we do need to load at least some information about them to know of 
 
4612
# aliases.  ideally we would avoid loading the implementation until the
 
4613
# details were needed.
 
4614
from bzrlib.cmd_version_info import cmd_version_info
 
4615
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
4616
from bzrlib.bundle.commands import (
 
4617
    cmd_bundle_info,
 
4618
    )
 
4619
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
4620
from bzrlib.weave_commands import cmd_versionedfile_list, \
 
4621
        cmd_weave_plan_merge, cmd_weave_merge_text