/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: 2009-02-10 04:10:44 UTC
  • mto: This revision was merged to the branch mainline in revision 3995.
  • Revision ID: jelmer@samba.org-20090210041044-42lmb09hskt9lt9l
Review from Ian.

Show diffs side-by-side

added added

removed removed

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