/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

remove all trailing whitespace from bzr source

Show diffs side-by-side

added added

removed removed

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