/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: Colin D Bennett
  • Date: 2009-02-12 16:57:39 UTC
  • mto: This revision was merged to the branch mainline in revision 4008.
  • Revision ID: colin@gibibit.com-20090212165739-02xv63odccfmxomw
Generate PDF version of the User Guide.

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