/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

Tweaks from merge review

Show diffs side-by-side

added added

removed removed

Lines of Context:
bzrlib/builtins.py
 
1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
 
2
 
 
3
# This program is free software; you can redistribute it and/or modify
 
4
# it under the terms of the GNU General Public License as published by
 
5
# the Free Software Foundation; either version 2 of the License, or
 
6
# (at your option) any later version.
 
7
 
 
8
# This program is distributed in the hope that it will be useful,
 
9
# but WITHOUT ANY WARRANTY; without even the implied warranty of
 
10
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
11
# GNU General Public License for more details.
 
12
 
 
13
# You should have received a copy of the GNU General Public License
 
14
# along with this program; if not, write to the Free Software
 
15
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 
16
 
 
17
"""builtin bzr commands"""
 
18
 
 
19
 
 
20
import errno
 
21
import os
 
22
from shutil import rmtree
 
23
import sys
 
24
 
 
25
import bzrlib
 
26
import bzrlib.branch
 
27
from bzrlib.branch import Branch
 
28
import bzrlib.bzrdir as bzrdir
 
29
from bzrlib.commands import Command, display_command
 
30
from bzrlib.revision import common_ancestor
 
31
import bzrlib.errors as errors
 
32
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
 
33
                           NotBranchError, DivergedBranches, NotConflicted,
 
34
                           NoSuchFile, NoWorkingTree, FileInWrongBranch,
 
35
                           NotVersionedError)
 
36
from bzrlib.log import show_one_log
 
37
from bzrlib.merge import Merge3Merger
 
38
from bzrlib.option import Option
 
39
from bzrlib.progress import DummyProgress, ProgressPhase
 
40
from bzrlib.revisionspec import RevisionSpec
 
41
import bzrlib.trace
 
42
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
 
43
from bzrlib.transport.local import LocalTransport
 
44
import bzrlib.ui
 
45
from bzrlib.workingtree import WorkingTree
 
46
 
 
47
 
 
48
def tree_files(file_list, default_branch=u'.'):
 
49
    try:
 
50
        return internal_tree_files(file_list, default_branch)
 
51
    except FileInWrongBranch, e:
 
52
        raise BzrCommandError("%s is not in the same branch as %s" %
 
53
                             (e.path, file_list[0]))
 
54
 
 
55
def internal_tree_files(file_list, default_branch=u'.'):
 
56
    """\
 
57
    Return a branch and list of branch-relative paths.
 
58
    If supplied file_list is empty or None, the branch default will be used,
 
59
    and returned file_list will match the original.
 
60
    """
 
61
    if file_list is None or len(file_list) == 0:
 
62
        return WorkingTree.open_containing(default_branch)[0], file_list
 
63
    tree = WorkingTree.open_containing(file_list[0])[0]
 
64
    new_list = []
 
65
    for filename in file_list:
 
66
        try:
 
67
            new_list.append(tree.relpath(filename))
 
68
        except errors.PathNotChild:
 
69
            raise FileInWrongBranch(tree.branch, filename)
 
70
    return tree, new_list
 
71
 
 
72
 
 
73
def get_format_type(typestring):
 
74
    """Parse and return a format specifier."""
 
75
    if typestring == "metadir":
 
76
        return bzrdir.BzrDirMetaFormat1()
 
77
    if typestring == "knit":
 
78
        format = bzrdir.BzrDirMetaFormat1()
 
79
        format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
 
80
        return format
 
81
    msg = "No known bzr-dir format %s. Supported types are: metadir\n" %\
 
82
        (typestring)
 
83
    raise BzrCommandError(msg)
 
84
 
 
85
 
 
86
# TODO: Make sure no commands unconditionally use the working directory as a
 
87
# branch.  If a filename argument is used, the first of them should be used to
 
88
# specify the branch.  (Perhaps this can be factored out into some kind of
 
89
# Argument class, representing a file in a branch, where the first occurrence
 
90
# opens the branch?)
 
91
 
 
92
class cmd_status(Command):
 
93
    """Display status summary.
 
94
 
 
95
    This reports on versioned and unknown files, reporting them
 
96
    grouped by state.  Possible states are:
 
97
 
 
98
    added
 
99
        Versioned in the working copy but not in the previous revision.
 
100
 
 
101
    removed
 
102
        Versioned in the previous revision but removed or deleted
 
103
        in the working copy.
 
104
 
 
105
    renamed
 
106
        Path of this file changed from the previous revision;
 
107
        the text may also have changed.  This includes files whose
 
108
        parent directory was renamed.
 
109
 
 
110
    modified
 
111
        Text has changed since the previous revision.
 
112
 
 
113
    unchanged
 
114
        Nothing about this file has changed since the previous revision.
 
115
        Only shown with --all.
 
116
 
 
117
    unknown
 
118
        Not versioned and not matching an ignore pattern.
 
119
 
 
120
    To see ignored files use 'bzr ignored'.  For details in the
 
121
    changes to file texts, use 'bzr diff'.
 
122
 
 
123
    If no arguments are specified, the status of the entire working
 
124
    directory is shown.  Otherwise, only the status of the specified
 
125
    files or directories is reported.  If a directory is given, status
 
126
    is reported for everything inside that directory.
 
127
 
 
128
    If a revision argument is given, the status is calculated against
 
129
    that revision, or between two revisions if two are provided.
 
130
    """
 
131
    
 
132
    # TODO: --no-recurse, --recurse options
 
133
    
 
134
    takes_args = ['file*']
 
135
    takes_options = ['all', 'show-ids', 'revision']
 
136
    aliases = ['st', 'stat']
 
137
    
 
138
    @display_command
 
139
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
140
        tree, file_list = tree_files(file_list)
 
141
            
 
142
        from bzrlib.status import show_tree_status
 
143
        show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
 
144
                         specific_files=file_list, revision=revision)
 
145
 
 
146
 
 
147
class cmd_cat_revision(Command):
 
148
    """Write out metadata for a revision.
 
149
    
 
150
    The revision to print can either be specified by a specific
 
151
    revision identifier, or you can use --revision.
 
152
    """
 
153
 
 
154
    hidden = True
 
155
    takes_args = ['revision_id?']
 
156
    takes_options = ['revision']
 
157
    
 
158
    @display_command
 
159
    def run(self, revision_id=None, revision=None):
 
160
 
 
161
        if revision_id is not None and revision is not None:
 
162
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
163
        if revision_id is None and revision is None:
 
164
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
165
        b = WorkingTree.open_containing(u'.')[0].branch
 
166
        if revision_id is not None:
 
167
            sys.stdout.write(b.repository.get_revision_xml(revision_id))
 
168
        elif revision is not None:
 
169
            for rev in revision:
 
170
                if rev is None:
 
171
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
172
                revno, rev_id = rev.in_history(b)
 
173
                sys.stdout.write(b.repository.get_revision_xml(rev_id))
 
174
    
 
175
 
 
176
class cmd_revno(Command):
 
177
    """Show current revision number.
 
178
 
 
179
    This is equal to the number of revisions on this branch."""
 
180
    takes_args = ['location?']
 
181
    @display_command
 
182
    def run(self, location=u'.'):
 
183
        print Branch.open_containing(location)[0].revno()
 
184
 
 
185
 
 
186
class cmd_revision_info(Command):
 
187
    """Show revision number and revision id for a given revision identifier.
 
188
    """
 
189
    hidden = True
 
190
    takes_args = ['revision_info*']
 
191
    takes_options = ['revision']
 
192
    @display_command
 
193
    def run(self, revision=None, revision_info_list=[]):
 
194
 
 
195
        revs = []
 
196
        if revision is not None:
 
197
            revs.extend(revision)
 
198
        if revision_info_list is not None:
 
199
            for rev in revision_info_list:
 
200
                revs.append(RevisionSpec(rev))
 
201
        if len(revs) == 0:
 
202
            raise BzrCommandError('You must supply a revision identifier')
 
203
 
 
204
        b = WorkingTree.open_containing(u'.')[0].branch
 
205
 
 
206
        for rev in revs:
 
207
            revinfo = rev.in_history(b)
 
208
            if revinfo.revno is None:
 
209
                print '     %s' % revinfo.rev_id
 
210
            else:
 
211
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
212
 
 
213
    
 
214
class cmd_add(Command):
 
215
    """Add specified files or directories.
 
216
 
 
217
    In non-recursive mode, all the named items are added, regardless
 
218
    of whether they were previously ignored.  A warning is given if
 
219
    any of the named files are already versioned.
 
220
 
 
221
    In recursive mode (the default), files are treated the same way
 
222
    but the behaviour for directories is different.  Directories that
 
223
    are already versioned do not give a warning.  All directories,
 
224
    whether already versioned or not, are searched for files or
 
225
    subdirectories that are neither versioned or ignored, and these
 
226
    are added.  This search proceeds recursively into versioned
 
227
    directories.  If no names are given '.' is assumed.
 
228
 
 
229
    Therefore simply saying 'bzr add' will version all files that
 
230
    are currently unknown.
 
231
 
 
232
    Adding a file whose parent directory is not versioned will
 
233
    implicitly add the parent, and so on up to the root. This means
 
234
    you should never need to explictly add a directory, they'll just
 
235
    get added when you add a file in the directory.
 
236
 
 
237
    --dry-run will show which files would be added, but not actually 
 
238
    add them.
 
239
    """
 
240
    takes_args = ['file*']
 
241
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
242
 
 
243
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
244
        import bzrlib.add
 
245
 
 
246
        if dry_run:
 
247
            if is_quiet():
 
248
                # This is pointless, but I'd rather not raise an error
 
249
                action = bzrlib.add.add_action_null
 
250
            else:
 
251
                action = bzrlib.add.add_action_print
 
252
        elif is_quiet():
 
253
            action = bzrlib.add.add_action_add
 
254
        else:
 
255
            action = bzrlib.add.add_action_add_and_print
 
256
 
 
257
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
 
258
                                              action)
 
259
        if len(ignored) > 0:
 
260
            for glob in sorted(ignored.keys()):
 
261
                match_len = len(ignored[glob])
 
262
                if verbose:
 
263
                    for path in ignored[glob]:
 
264
                        print "ignored %s matching \"%s\"" % (path, glob)
 
265
                else:
 
266
                    print "ignored %d file(s) matching \"%s\"" % (match_len,
 
267
                                                              glob)
 
268
            print "If you wish to add some of these files, please add them"\
 
269
                " by name."
 
270
 
 
271
 
 
272
class cmd_mkdir(Command):
 
273
    """Create a new versioned directory.
 
274
 
 
275
    This is equivalent to creating the directory and then adding it.
 
276
    """
 
277
    takes_args = ['dir+']
 
278
 
 
279
    def run(self, dir_list):
 
280
        for d in dir_list:
 
281
            os.mkdir(d)
 
282
            wt, dd = WorkingTree.open_containing(d)
 
283
            wt.add([dd])
 
284
            print 'added', d
 
285
 
 
286
 
 
287
class cmd_relpath(Command):
 
288
    """Show path of a file relative to root"""
 
289
    takes_args = ['filename']
 
290
    hidden = True
 
291
    
 
292
    @display_command
 
293
    def run(self, filename):
 
294
        tree, relpath = WorkingTree.open_containing(filename)
 
295
        print relpath
 
296
 
 
297
 
 
298
class cmd_inventory(Command):
 
299
    """Show inventory of the current working copy or a revision.
 
300
 
 
301
    It is possible to limit the output to a particular entry
 
302
    type using the --kind option.  For example; --kind file.
 
303
    """
 
304
    takes_options = ['revision', 'show-ids', 'kind']
 
305
    
 
306
    @display_command
 
307
    def run(self, revision=None, show_ids=False, kind=None):
 
308
        if kind and kind not in ['file', 'directory', 'symlink']:
 
309
            raise BzrCommandError('invalid kind specified')
 
310
        tree = WorkingTree.open_containing(u'.')[0]
 
311
        if revision is None:
 
312
            inv = tree.read_working_inventory()
 
313
        else:
 
314
            if len(revision) > 1:
 
315
                raise BzrCommandError('bzr inventory --revision takes'
 
316
                    ' exactly one revision identifier')
 
317
            inv = tree.branch.repository.get_revision_inventory(
 
318
                revision[0].in_history(tree.branch).rev_id)
 
319
 
 
320
        for path, entry in inv.entries():
 
321
            if kind and kind != entry.kind:
 
322
                continue
 
323
            if show_ids:
 
324
                print '%-50s %s' % (path, entry.file_id)
 
325
            else:
 
326
                print path
 
327
 
 
328
 
 
329
class cmd_mv(Command):
 
330
    """Move or rename a file.
 
331
 
 
332
    usage:
 
333
        bzr mv OLDNAME NEWNAME
 
334
        bzr mv SOURCE... DESTINATION
 
335
 
 
336
    If the last argument is a versioned directory, all the other names
 
337
    are moved into it.  Otherwise, there must be exactly two arguments
 
338
    and the file is changed to a new name, which must not already exist.
 
339
 
 
340
    Files cannot be moved between branches.
 
341
    """
 
342
    takes_args = ['names*']
 
343
    aliases = ['move', 'rename']
 
344
 
 
345
    def run(self, names_list):
 
346
        if len(names_list) < 2:
 
347
            raise BzrCommandError("missing file argument")
 
348
        tree, rel_names = tree_files(names_list)
 
349
        
 
350
        if os.path.isdir(names_list[-1]):
 
351
            # move into existing directory
 
352
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
 
353
                print "%s => %s" % pair
 
354
        else:
 
355
            if len(names_list) != 2:
 
356
                raise BzrCommandError('to mv multiple files the destination '
 
357
                                      'must be a versioned directory')
 
358
            tree.rename_one(rel_names[0], rel_names[1])
 
359
            print "%s => %s" % (rel_names[0], rel_names[1])
 
360
            
 
361
    
 
362
class cmd_pull(Command):
 
363
    """Pull any changes from another branch into the current one.
 
364
 
 
365
    If there is no default location set, the first pull will set it.  After
 
366
    that, you can omit the location to use the default.  To change the
 
367
    default, use --remember.
 
368
 
 
369
    This command only works on branches that have not diverged.  Branches are
 
370
    considered diverged if both branches have had commits without first
 
371
    pulling from the other.
 
372
 
 
373
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
374
    from one into the other.  Once one branch has merged, the other should
 
375
    be able to pull it again.
 
376
 
 
377
    If you want to forget your local changes and just update your branch to
 
378
    match the remote one, use --overwrite.
 
379
    """
 
380
    takes_options = ['remember', 'overwrite', 'revision', 'verbose']
 
381
    takes_args = ['location?']
 
382
 
 
383
    def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
 
384
        # FIXME: too much stuff is in the command class
 
385
        try:
 
386
            tree_to = WorkingTree.open_containing(u'.')[0]
 
387
            branch_to = tree_to.branch
 
388
        except NoWorkingTree:
 
389
            tree_to = None
 
390
            branch_to = Branch.open_containing(u'.')[0] 
 
391
        stored_loc = branch_to.get_parent()
 
392
        if location is None:
 
393
            if stored_loc is None:
 
394
                raise BzrCommandError("No pull location known or specified.")
 
395
            else:
 
396
                print "Using saved location: %s" % stored_loc
 
397
                location = stored_loc
 
398
 
 
399
        br_from = Branch.open(location)
 
400
 
 
401
        if revision is None:
 
402
            rev_id = None
 
403
        elif len(revision) == 1:
 
404
            rev_id = revision[0].in_history(br_from).rev_id
 
405
        else:
 
406
            raise BzrCommandError('bzr pull --revision takes one value.')
 
407
 
 
408
        old_rh = branch_to.revision_history()
 
409
        if tree_to is not None:
 
410
            count = tree_to.pull(br_from, overwrite, rev_id)
 
411
        else:
 
412
            count = branch_to.pull(br_from, overwrite, rev_id)
 
413
 
 
414
        if branch_to.get_parent() is None or remember:
 
415
            branch_to.set_parent(location)
 
416
        note('%d revision(s) pulled.' % (count,))
 
417
 
 
418
        if verbose:
 
419
            new_rh = branch_to.revision_history()
 
420
            if old_rh != new_rh:
 
421
                # Something changed
 
422
                from bzrlib.log import show_changed_revisions
 
423
                show_changed_revisions(branch_to, old_rh, new_rh)
 
424
 
 
425
 
 
426
class cmd_push(Command):
 
427
    """Push this branch into another branch.
 
428
    
 
429
    The remote branch will not have its working tree populated because this
 
430
    is both expensive, and may not be supported on the remote file system.
 
431
    
 
432
    Some smart servers or protocols *may* put the working tree in place.
 
433
 
 
434
    If there is no default push location set, the first push will set it.
 
435
    After that, you can omit the location to use the default.  To change the
 
436
    default, use --remember.
 
437
 
 
438
    This command only works on branches that have not diverged.  Branches are
 
439
    considered diverged if the branch being pushed to is not an older version
 
440
    of this branch.
 
441
 
 
442
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
443
    the other branch completely.
 
444
    
 
445
    If you want to ensure you have the different changes in the other branch,
 
446
    do a merge (see bzr help merge) from the other branch, and commit that
 
447
    before doing a 'push --overwrite'.
 
448
    """
 
449
    takes_options = ['remember', 'overwrite', 
 
450
                     Option('create-prefix', 
 
451
                            help='Create the path leading up to the branch '
 
452
                                 'if it does not already exist')]
 
453
    takes_args = ['location?']
 
454
 
 
455
    def run(self, location=None, remember=False, overwrite=False,
 
456
            create_prefix=False, verbose=False):
 
457
        # FIXME: Way too big!  Put this into a function called from the
 
458
        # command.
 
459
        from bzrlib.transport import get_transport
 
460
        
 
461
        tree_from = WorkingTree.open_containing(u'.')[0]
 
462
        br_from = tree_from.branch
 
463
        stored_loc = tree_from.branch.get_push_location()
 
464
        if location is None:
 
465
            if stored_loc is None:
 
466
                raise BzrCommandError("No push location known or specified.")
 
467
            else:
 
468
                print "Using saved location: %s" % stored_loc
 
469
                location = stored_loc
 
470
        try:
 
471
            dir_to = bzrlib.bzrdir.BzrDir.open(location)
 
472
            br_to = dir_to.open_branch()
 
473
        except NotBranchError:
 
474
            # create a branch.
 
475
            transport = get_transport(location).clone('..')
 
476
            if not create_prefix:
 
477
                try:
 
478
                    transport.mkdir(transport.relpath(location))
 
479
                except NoSuchFile:
 
480
                    raise BzrCommandError("Parent directory of %s "
 
481
                                          "does not exist." % location)
 
482
            else:
 
483
                current = transport.base
 
484
                needed = [(transport, transport.relpath(location))]
 
485
                while needed:
 
486
                    try:
 
487
                        transport, relpath = needed[-1]
 
488
                        transport.mkdir(relpath)
 
489
                        needed.pop()
 
490
                    except NoSuchFile:
 
491
                        new_transport = transport.clone('..')
 
492
                        needed.append((new_transport,
 
493
                                       new_transport.relpath(transport.base)))
 
494
                        if new_transport.base == transport.base:
 
495
                            raise BzrCommandError("Could not create "
 
496
                                                  "path prefix.")
 
497
            dir_to = br_from.bzrdir.clone(location)
 
498
            br_to = dir_to.open_branch()
 
499
        old_rh = br_to.revision_history()
 
500
        try:
 
501
            try:
 
502
                tree_to = dir_to.open_workingtree()
 
503
            except errors.NotLocalUrl:
 
504
                # TODO: This should be updated for branches which don't have a
 
505
                # working tree, as opposed to ones where we just couldn't 
 
506
                # update the tree.
 
507
                warning('This transport does not update the working '
 
508
                        'tree of: %s' % (br_to.base,))
 
509
                count = br_to.pull(br_from, overwrite)
 
510
            except NoWorkingTree:
 
511
                count = br_to.pull(br_from, overwrite)
 
512
            else:
 
513
                count = tree_to.pull(br_from, overwrite)
 
514
        except DivergedBranches:
 
515
            raise BzrCommandError("These branches have diverged."
 
516
                                  "  Try a merge then push with overwrite.")
 
517
        if br_from.get_push_location() is None or remember:
 
518
            br_from.set_push_location(location)
 
519
        note('%d revision(s) pushed.' % (count,))
 
520
 
 
521
        if verbose:
 
522
            new_rh = br_to.revision_history()
 
523
            if old_rh != new_rh:
 
524
                # Something changed
 
525
                from bzrlib.log import show_changed_revisions
 
526
                show_changed_revisions(br_to, old_rh, new_rh)
 
527
 
 
528
 
 
529
class cmd_branch(Command):
 
530
    """Create a new copy of a branch.
 
531
 
 
532
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
533
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
534
 
 
535
    To retrieve the branch as of a particular revision, supply the --revision
 
536
    parameter, as in "branch foo/bar -r 5".
 
537
 
 
538
    --basis is to speed up branching from remote branches.  When specified, it
 
539
    copies all the file-contents, inventory and revision data from the basis
 
540
    branch before copying anything from the remote branch.
 
541
    """
 
542
    takes_args = ['from_location', 'to_location?']
 
543
    takes_options = ['revision', 'basis']
 
544
    aliases = ['get', 'clone']
 
545
 
 
546
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
547
        if revision is None:
 
548
            revision = [None]
 
549
        elif len(revision) > 1:
 
550
            raise BzrCommandError(
 
551
                'bzr branch --revision takes exactly 1 revision value')
 
552
        try:
 
553
            br_from = Branch.open(from_location)
 
554
        except OSError, e:
 
555
            if e.errno == errno.ENOENT:
 
556
                raise BzrCommandError('Source location "%s" does not'
 
557
                                      ' exist.' % to_location)
 
558
            else:
 
559
                raise
 
560
        br_from.lock_read()
 
561
        try:
 
562
            if basis is not None:
 
563
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
564
            else:
 
565
                basis_dir = None
 
566
            if len(revision) == 1 and revision[0] is not None:
 
567
                revision_id = revision[0].in_history(br_from)[1]
 
568
            else:
 
569
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
570
                # None or perhaps NULL_REVISION to mean copy nothing
 
571
                # RBC 20060209
 
572
                revision_id = br_from.last_revision()
 
573
            if to_location is None:
 
574
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
575
                name = None
 
576
            else:
 
577
                name = os.path.basename(to_location) + '\n'
 
578
            try:
 
579
                os.mkdir(to_location)
 
580
            except OSError, e:
 
581
                if e.errno == errno.EEXIST:
 
582
                    raise BzrCommandError('Target directory "%s" already'
 
583
                                          ' exists.' % to_location)
 
584
                if e.errno == errno.ENOENT:
 
585
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
586
                                          to_location)
 
587
                else:
 
588
                    raise
 
589
            try:
 
590
                # preserve whatever source format we have.
 
591
                dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
 
592
                branch = dir.open_branch()
 
593
            except bzrlib.errors.NoSuchRevision:
 
594
                rmtree(to_location)
 
595
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
596
                raise BzrCommandError(msg)
 
597
            except bzrlib.errors.UnlistableBranch:
 
598
                rmtree(to_location)
 
599
                msg = "The branch %s cannot be used as a --basis" % (basis,)
 
600
                raise BzrCommandError(msg)
 
601
            if name:
 
602
                branch.control_files.put_utf8('branch-name', name)
 
603
 
 
604
            note('Branched %d revision(s).' % branch.revno())
 
605
        finally:
 
606
            br_from.unlock()
 
607
 
 
608
 
 
609
class cmd_checkout(Command):
 
610
    """Create a new checkout of an existing branch.
 
611
 
 
612
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
613
    the branch found in '.'. This is useful if you have removed the working tree
 
614
    or if it was never created - i.e. if you pushed the branch to its current
 
615
    location using SFTP.
 
616
    
 
617
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
618
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
619
 
 
620
    To retrieve the branch as of a particular revision, supply the --revision
 
621
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
622
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
623
    code.)
 
624
 
 
625
    --basis is to speed up checking out from remote branches.  When specified, it
 
626
    uses the inventory and file contents from the basis branch in preference to the
 
627
    branch being checked out. [Not implemented yet.]
 
628
    """
 
629
    takes_args = ['branch_location?', 'to_location?']
 
630
    takes_options = ['revision', # , 'basis']
 
631
                     Option('lightweight',
 
632
                            help="perform a lightweight checkout. Lightweight "
 
633
                                 "checkouts depend on access to the branch for "
 
634
                                 "every operation. Normal checkouts can perform "
 
635
                                 "common operations like diff and status without "
 
636
                                 "such access, and also support local commits."
 
637
                            ),
 
638
                     ]
 
639
 
 
640
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
 
641
            lightweight=False):
 
642
        if revision is None:
 
643
            revision = [None]
 
644
        elif len(revision) > 1:
 
645
            raise BzrCommandError(
 
646
                'bzr checkout --revision takes exactly 1 revision value')
 
647
        if branch_location is None:
 
648
            branch_location = bzrlib.osutils.getcwd()
 
649
            to_location = branch_location
 
650
        source = Branch.open(branch_location)
 
651
        if len(revision) == 1 and revision[0] is not None:
 
652
            revision_id = revision[0].in_history(source)[1]
 
653
        else:
 
654
            revision_id = None
 
655
        if to_location is None:
 
656
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
657
        # if the source and to_location are the same, 
 
658
        # and there is no working tree,
 
659
        # then reconstitute a branch
 
660
        if (bzrlib.osutils.abspath(to_location) == 
 
661
            bzrlib.osutils.abspath(branch_location)):
 
662
            try:
 
663
                source.bzrdir.open_workingtree()
 
664
            except errors.NoWorkingTree:
 
665
                source.bzrdir.create_workingtree()
 
666
                return
 
667
        try:
 
668
            os.mkdir(to_location)
 
669
        except OSError, e:
 
670
            if e.errno == errno.EEXIST:
 
671
                raise BzrCommandError('Target directory "%s" already'
 
672
                                      ' exists.' % to_location)
 
673
            if e.errno == errno.ENOENT:
 
674
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
675
                                      to_location)
 
676
            else:
 
677
                raise
 
678
        old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
679
        bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
 
680
        try:
 
681
            if lightweight:
 
682
                checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
 
683
                bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
 
684
            else:
 
685
                checkout_branch =  bzrlib.bzrdir.BzrDir.create_branch_convenience(
 
686
                    to_location, force_new_tree=False)
 
687
                checkout = checkout_branch.bzrdir
 
688
                checkout_branch.bind(source)
 
689
                if revision_id is not None:
 
690
                    rh = checkout_branch.revision_history()
 
691
                    checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
 
692
            checkout.create_workingtree(revision_id)
 
693
        finally:
 
694
            bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
 
695
 
 
696
 
 
697
class cmd_renames(Command):
 
698
    """Show list of renamed files.
 
699
    """
 
700
    # TODO: Option to show renames between two historical versions.
 
701
 
 
702
    # TODO: Only show renames under dir, rather than in the whole branch.
 
703
    takes_args = ['dir?']
 
704
 
 
705
    @display_command
 
706
    def run(self, dir=u'.'):
 
707
        tree = WorkingTree.open_containing(dir)[0]
 
708
        old_inv = tree.basis_tree().inventory
 
709
        new_inv = tree.read_working_inventory()
 
710
 
 
711
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
712
        renames.sort()
 
713
        for old_name, new_name in renames:
 
714
            print "%s => %s" % (old_name, new_name)        
 
715
 
 
716
 
 
717
class cmd_update(Command):
 
718
    """Update a tree to have the latest code committed to its branch.
 
719
    
 
720
    This will perform a merge into the working tree, and may generate
 
721
    conflicts. If you have any local changes, you will still 
 
722
    need to commit them after the update for the update to be complete.
 
723
    
 
724
    If you want to discard your local changes, you can just do a 
 
725
    'bzr revert' instead of 'bzr commit' after the update.
 
726
    """
 
727
    takes_args = ['dir?']
 
728
 
 
729
    def run(self, dir='.'):
 
730
        tree = WorkingTree.open_containing(dir)[0]
 
731
        tree.lock_write()
 
732
        try:
 
733
            if tree.last_revision() == tree.branch.last_revision():
 
734
                # may be up to date, check master too.
 
735
                master = tree.branch.get_master_branch()
 
736
                if master is None or master.last_revision == tree.last_revision():
 
737
                    note("Tree is up to date.")
 
738
                    return
 
739
            conflicts = tree.update()
 
740
            note('Updated to revision %d.' %
 
741
                 (tree.branch.revision_id_to_revno(tree.last_revision()),))
 
742
            if conflicts != 0:
 
743
                return 1
 
744
            else:
 
745
                return 0
 
746
        finally:
 
747
            tree.unlock()
 
748
 
 
749
 
 
750
class cmd_info(Command):
 
751
    """Show statistical information about a branch."""
 
752
    takes_args = ['branch?']
 
753
    
 
754
    @display_command
 
755
    def run(self, branch=None):
 
756
        import bzrlib.info
 
757
        bzrlib.info.show_bzrdir_info(bzrdir.BzrDir.open_containing(branch)[0])
 
758
 
 
759
 
 
760
class cmd_remove(Command):
 
761
    """Make a file unversioned.
 
762
 
 
763
    This makes bzr stop tracking changes to a versioned file.  It does
 
764
    not delete the working copy.
 
765
    """
 
766
    takes_args = ['file+']
 
767
    takes_options = ['verbose']
 
768
    aliases = ['rm']
 
769
    
 
770
    def run(self, file_list, verbose=False):
 
771
        tree, file_list = tree_files(file_list)
 
772
        tree.remove(file_list, verbose=verbose)
 
773
 
 
774
 
 
775
class cmd_file_id(Command):
 
776
    """Print file_id of a particular file or directory.
 
777
 
 
778
    The file_id is assigned when the file is first added and remains the
 
779
    same through all revisions where the file exists, even when it is
 
780
    moved or renamed.
 
781
    """
 
782
    hidden = True
 
783
    takes_args = ['filename']
 
784
    @display_command
 
785
    def run(self, filename):
 
786
        tree, relpath = WorkingTree.open_containing(filename)
 
787
        i = tree.inventory.path2id(relpath)
 
788
        if i == None:
 
789
            raise BzrError("%r is not a versioned file" % filename)
 
790
        else:
 
791
            print i
 
792
 
 
793
 
 
794
class cmd_file_path(Command):
 
795
    """Print path of file_ids to a file or directory.
 
796
 
 
797
    This prints one line for each directory down to the target,
 
798
    starting at the branch root."""
 
799
    hidden = True
 
800
    takes_args = ['filename']
 
801
    @display_command
 
802
    def run(self, filename):
 
803
        tree, relpath = WorkingTree.open_containing(filename)
 
804
        inv = tree.inventory
 
805
        fid = inv.path2id(relpath)
 
806
        if fid == None:
 
807
            raise BzrError("%r is not a versioned file" % filename)
 
808
        for fip in inv.get_idpath(fid):
 
809
            print fip
 
810
 
 
811
 
 
812
class cmd_reconcile(Command):
 
813
    """Reconcile bzr metadata in a branch.
 
814
 
 
815
    This can correct data mismatches that may have been caused by
 
816
    previous ghost operations or bzr upgrades. You should only
 
817
    need to run this command if 'bzr check' or a bzr developer 
 
818
    advises you to run it.
 
819
 
 
820
    If a second branch is provided, cross-branch reconciliation is
 
821
    also attempted, which will check that data like the tree root
 
822
    id which was not present in very early bzr versions is represented
 
823
    correctly in both branches.
 
824
 
 
825
    At the same time it is run it may recompress data resulting in 
 
826
    a potential saving in disk space or performance gain.
 
827
 
 
828
    The branch *MUST* be on a listable system such as local disk or sftp.
 
829
    """
 
830
    takes_args = ['branch?']
 
831
 
 
832
    def run(self, branch="."):
 
833
        from bzrlib.reconcile import reconcile
 
834
        dir = bzrlib.bzrdir.BzrDir.open(branch)
 
835
        reconcile(dir)
 
836
 
 
837
 
 
838
class cmd_revision_history(Command):
 
839
    """Display list of revision ids on this branch."""
 
840
    hidden = True
 
841
    @display_command
 
842
    def run(self):
 
843
        branch = WorkingTree.open_containing(u'.')[0].branch
 
844
        for patchid in branch.revision_history():
 
845
            print patchid
 
846
 
 
847
 
 
848
class cmd_ancestry(Command):
 
849
    """List all revisions merged into this branch."""
 
850
    hidden = True
 
851
    @display_command
 
852
    def run(self):
 
853
        tree = WorkingTree.open_containing(u'.')[0]
 
854
        b = tree.branch
 
855
        # FIXME. should be tree.last_revision
 
856
        for revision_id in b.repository.get_ancestry(b.last_revision()):
 
857
            print revision_id
 
858
 
 
859
 
 
860
class cmd_init(Command):
 
861
    """Make a directory into a versioned branch.
 
862
 
 
863
    Use this to create an empty branch, or before importing an
 
864
    existing project.
 
865
 
 
866
    Recipe for importing a tree of files:
 
867
        cd ~/project
 
868
        bzr init
 
869
        bzr add .
 
870
        bzr status
 
871
        bzr commit -m 'imported project'
 
872
    """
 
873
    takes_args = ['location?']
 
874
    takes_options = [
 
875
                     Option('format', 
 
876
                            help='Create a specific format rather than the'
 
877
                                 ' current default format. Currently this '
 
878
                                 ' option only accepts =metadir',
 
879
                            type=get_format_type),
 
880
                     ]
 
881
    def run(self, location=None, format=None):
 
882
        from bzrlib.branch import Branch
 
883
        if location is None:
 
884
            location = u'.'
 
885
        else:
 
886
            # The path has to exist to initialize a
 
887
            # branch inside of it.
 
888
            # Just using os.mkdir, since I don't
 
889
            # believe that we want to create a bunch of
 
890
            # locations if the user supplies an extended path
 
891
            if not os.path.exists(location):
 
892
                os.mkdir(location)
 
893
        bzrdir.BzrDir.create_branch_convenience(location, format=format)
 
894
 
 
895
 
 
896
class cmd_init_repository(Command):
 
897
    """Create a shared repository to keep branches in."""
 
898
    takes_args = ["location"] 
 
899
    takes_options = [Option('format', 
 
900
                            help='Use a specific format rather than the'
 
901
                            ' current default format. Currently this'
 
902
                            ' option only accepts "metadir" and "knit"'
 
903
                            ' WARNING: the knit format is currently unstable'
 
904
                            ' and only for experimental use.',
 
905
                            type=get_format_type),
 
906
                     Option('trees',
 
907
                             help='Allows branches in repository to have'
 
908
                             ' a working tree')]
 
909
    aliases = ["init-repo"]
 
910
    def run(self, location, format=None, trees=False):
 
911
        from bzrlib.bzrdir import BzrDirMetaFormat1
 
912
        from bzrlib.transport import get_transport
 
913
        if format is None:
 
914
            format = BzrDirMetaFormat1()
 
915
        get_transport(location).mkdir('')
 
916
        newdir = format.initialize(location)
 
917
        repo = newdir.create_repository(shared=True)
 
918
        repo.set_make_working_trees(trees)
 
919
 
 
920
 
 
921
class cmd_diff(Command):
 
922
    """Show differences in working tree.
 
923
    
 
924
    If files are listed, only the changes in those files are listed.
 
925
    Otherwise, all changes for the tree are listed.
 
926
 
 
927
    examples:
 
928
        bzr diff
 
929
        bzr diff -r1
 
930
        bzr diff -r1..2
 
931
    """
 
932
    # TODO: Allow diff across branches.
 
933
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
934
    #       or a graphical diff.
 
935
 
 
936
    # TODO: Python difflib is not exactly the same as unidiff; should
 
937
    #       either fix it up or prefer to use an external diff.
 
938
 
 
939
    # TODO: If a directory is given, diff everything under that.
 
940
 
 
941
    # TODO: Selected-file diff is inefficient and doesn't show you
 
942
    #       deleted files.
 
943
 
 
944
    # TODO: This probably handles non-Unix newlines poorly.
 
945
    
 
946
    takes_args = ['file*']
 
947
    takes_options = ['revision', 'diff-options']
 
948
    aliases = ['di', 'dif']
 
949
 
 
950
    @display_command
 
951
    def run(self, revision=None, file_list=None, diff_options=None):
 
952
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
953
        try:
 
954
            tree1, file_list = internal_tree_files(file_list)
 
955
            tree2 = None
 
956
            b = None
 
957
            b2 = None
 
958
        except FileInWrongBranch:
 
959
            if len(file_list) != 2:
 
960
                raise BzrCommandError("Files are in different branches")
 
961
 
 
962
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
963
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
964
            if file1 != "" or file2 != "":
 
965
                # FIXME diff those two files. rbc 20051123
 
966
                raise BzrCommandError("Files are in different branches")
 
967
            file_list = None
 
968
        if revision is not None:
 
969
            if tree2 is not None:
 
970
                raise BzrCommandError("Can't specify -r with two branches")
 
971
            if (len(revision) == 1) or (revision[1].spec is None):
 
972
                return diff_cmd_helper(tree1, file_list, diff_options,
 
973
                                       revision[0])
 
974
            elif len(revision) == 2:
 
975
                return diff_cmd_helper(tree1, file_list, diff_options,
 
976
                                       revision[0], revision[1])
 
977
            else:
 
978
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
979
        else:
 
980
            if tree2 is not None:
 
981
                return show_diff_trees(tree1, tree2, sys.stdout, 
 
982
                                       specific_files=file_list,
 
983
                                       external_diff_options=diff_options)
 
984
            else:
 
985
                return diff_cmd_helper(tree1, file_list, diff_options)
 
986
 
 
987
 
 
988
class cmd_deleted(Command):
 
989
    """List files deleted in the working tree.
 
990
    """
 
991
    # TODO: Show files deleted since a previous revision, or
 
992
    # between two revisions.
 
993
    # TODO: Much more efficient way to do this: read in new
 
994
    # directories with readdir, rather than stating each one.  Same
 
995
    # level of effort but possibly much less IO.  (Or possibly not,
 
996
    # if the directories are very large...)
 
997
    @display_command
 
998
    def run(self, show_ids=False):
 
999
        tree = WorkingTree.open_containing(u'.')[0]
 
1000
        old = tree.basis_tree()
 
1001
        for path, ie in old.inventory.iter_entries():
 
1002
            if not tree.has_id(ie.file_id):
 
1003
                if show_ids:
 
1004
                    print '%-50s %s' % (path, ie.file_id)
 
1005
                else:
 
1006
                    print path
 
1007
 
 
1008
 
 
1009
class cmd_modified(Command):
 
1010
    """List files modified in working tree."""
 
1011
    hidden = True
 
1012
    @display_command
 
1013
    def run(self):
 
1014
        from bzrlib.delta import compare_trees
 
1015
 
 
1016
        tree = WorkingTree.open_containing(u'.')[0]
 
1017
        td = compare_trees(tree.basis_tree(), tree)
 
1018
 
 
1019
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1020
            print path
 
1021
 
 
1022
 
 
1023
 
 
1024
class cmd_added(Command):
 
1025
    """List files added in working tree."""
 
1026
    hidden = True
 
1027
    @display_command
 
1028
    def run(self):
 
1029
        wt = WorkingTree.open_containing(u'.')[0]
 
1030
        basis_inv = wt.basis_tree().inventory
 
1031
        inv = wt.inventory
 
1032
        for file_id in inv:
 
1033
            if file_id in basis_inv:
 
1034
                continue
 
1035
            path = inv.id2path(file_id)
 
1036
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
1037
                continue
 
1038
            print path
 
1039
                
 
1040
        
 
1041
 
 
1042
class cmd_root(Command):
 
1043
    """Show the tree root directory.
 
1044
 
 
1045
    The root is the nearest enclosing directory with a .bzr control
 
1046
    directory."""
 
1047
    takes_args = ['filename?']
 
1048
    @display_command
 
1049
    def run(self, filename=None):
 
1050
        """Print the branch root."""
 
1051
        tree = WorkingTree.open_containing(filename)[0]
 
1052
        print tree.basedir
 
1053
 
 
1054
 
 
1055
class cmd_log(Command):
 
1056
    """Show log of a branch, file, or directory.
 
1057
 
 
1058
    By default show the log of the branch containing the working directory.
 
1059
 
 
1060
    To request a range of logs, you can use the command -r begin..end
 
1061
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
1062
    also valid.
 
1063
 
 
1064
    examples:
 
1065
        bzr log
 
1066
        bzr log foo.c
 
1067
        bzr log -r -10.. http://server/branch
 
1068
    """
 
1069
 
 
1070
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1071
 
 
1072
    takes_args = ['location?']
 
1073
    takes_options = [Option('forward', 
 
1074
                            help='show from oldest to newest'),
 
1075
                     'timezone', 
 
1076
                     Option('verbose', 
 
1077
                             help='show files changed in each revision'),
 
1078
                     'show-ids', 'revision',
 
1079
                     'log-format',
 
1080
                     'line', 'long', 
 
1081
                     Option('message',
 
1082
                            help='show revisions whose message matches this regexp',
 
1083
                            type=str),
 
1084
                     'short',
 
1085
                     ]
 
1086
    @display_command
 
1087
    def run(self, location=None, timezone='original',
 
1088
            verbose=False,
 
1089
            show_ids=False,
 
1090
            forward=False,
 
1091
            revision=None,
 
1092
            log_format=None,
 
1093
            message=None,
 
1094
            long=False,
 
1095
            short=False,
 
1096
            line=False):
 
1097
        from bzrlib.log import log_formatter, show_log
 
1098
        import codecs
 
1099
        assert message is None or isinstance(message, basestring), \
 
1100
            "invalid message argument %r" % message
 
1101
        direction = (forward and 'forward') or 'reverse'
 
1102
        
 
1103
        # log everything
 
1104
        file_id = None
 
1105
        if location:
 
1106
            # find the file id to log:
 
1107
 
 
1108
            dir, fp = bzrdir.BzrDir.open_containing(location)
 
1109
            b = dir.open_branch()
 
1110
            if fp != '':
 
1111
                try:
 
1112
                    # might be a tree:
 
1113
                    inv = dir.open_workingtree().inventory
 
1114
                except (errors.NotBranchError, errors.NotLocalUrl):
 
1115
                    # either no tree, or is remote.
 
1116
                    inv = b.basis_tree().inventory
 
1117
                file_id = inv.path2id(fp)
 
1118
        else:
 
1119
            # local dir only
 
1120
            # FIXME ? log the current subdir only RBC 20060203 
 
1121
            dir, relpath = bzrdir.BzrDir.open_containing('.')
 
1122
            b = dir.open_branch()
 
1123
 
 
1124
        if revision is None:
 
1125
            rev1 = None
 
1126
            rev2 = None
 
1127
        elif len(revision) == 1:
 
1128
            rev1 = rev2 = revision[0].in_history(b).revno
 
1129
        elif len(revision) == 2:
 
1130
            if revision[0].spec is None:
 
1131
                # missing begin-range means first revision
 
1132
                rev1 = 1
 
1133
            else:
 
1134
                rev1 = revision[0].in_history(b).revno
 
1135
 
 
1136
            if revision[1].spec is None:
 
1137
                # missing end-range means last known revision
 
1138
                rev2 = b.revno()
 
1139
            else:
 
1140
                rev2 = revision[1].in_history(b).revno
 
1141
        else:
 
1142
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
1143
 
 
1144
        # By this point, the revision numbers are converted to the +ve
 
1145
        # form if they were supplied in the -ve form, so we can do
 
1146
        # this comparison in relative safety
 
1147
        if rev1 > rev2:
 
1148
            (rev2, rev1) = (rev1, rev2)
 
1149
 
 
1150
        mutter('encoding log as %r', bzrlib.user_encoding)
 
1151
 
 
1152
        # use 'replace' so that we don't abort if trying to write out
 
1153
        # in e.g. the default C locale.
 
1154
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1155
 
 
1156
        if (log_format == None):
 
1157
            default = bzrlib.config.BranchConfig(b).log_format()
 
1158
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
1159
 
 
1160
        lf = log_formatter(log_format,
 
1161
                           show_ids=show_ids,
 
1162
                           to_file=outf,
 
1163
                           show_timezone=timezone)
 
1164
 
 
1165
        show_log(b,
 
1166
                 lf,
 
1167
                 file_id,
 
1168
                 verbose=verbose,
 
1169
                 direction=direction,
 
1170
                 start_revision=rev1,
 
1171
                 end_revision=rev2,
 
1172
                 search=message)
 
1173
 
 
1174
 
 
1175
def get_log_format(long=False, short=False, line=False, default='long'):
 
1176
    log_format = default
 
1177
    if long:
 
1178
        log_format = 'long'
 
1179
    if short:
 
1180
        log_format = 'short'
 
1181
    if line:
 
1182
        log_format = 'line'
 
1183
    return log_format
 
1184
 
 
1185
 
 
1186
class cmd_touching_revisions(Command):
 
1187
    """Return revision-ids which affected a particular file.
 
1188
 
 
1189
    A more user-friendly interface is "bzr log FILE"."""
 
1190
    hidden = True
 
1191
    takes_args = ["filename"]
 
1192
    @display_command
 
1193
    def run(self, filename):
 
1194
        tree, relpath = WorkingTree.open_containing(filename)
 
1195
        b = tree.branch
 
1196
        inv = tree.read_working_inventory()
 
1197
        file_id = inv.path2id(relpath)
 
1198
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
1199
            print "%6d %s" % (revno, what)
 
1200
 
 
1201
 
 
1202
class cmd_ls(Command):
 
1203
    """List files in a tree.
 
1204
    """
 
1205
    # TODO: Take a revision or remote path and list that tree instead.
 
1206
    hidden = True
 
1207
    takes_options = ['verbose', 'revision',
 
1208
                     Option('non-recursive',
 
1209
                            help='don\'t recurse into sub-directories'),
 
1210
                     Option('from-root',
 
1211
                            help='Print all paths from the root of the branch.'),
 
1212
                     Option('unknown', help='Print unknown files'),
 
1213
                     Option('versioned', help='Print versioned files'),
 
1214
                     Option('ignored', help='Print ignored files'),
 
1215
 
 
1216
                     Option('null', help='Null separate the files'),
 
1217
                    ]
 
1218
    @display_command
 
1219
    def run(self, revision=None, verbose=False, 
 
1220
            non_recursive=False, from_root=False,
 
1221
            unknown=False, versioned=False, ignored=False,
 
1222
            null=False):
 
1223
 
 
1224
        if verbose and null:
 
1225
            raise BzrCommandError('Cannot set both --verbose and --null')
 
1226
        all = not (unknown or versioned or ignored)
 
1227
 
 
1228
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1229
 
 
1230
        tree, relpath = WorkingTree.open_containing(u'.')
 
1231
        if from_root:
 
1232
            relpath = u''
 
1233
        elif relpath:
 
1234
            relpath += '/'
 
1235
        if revision is not None:
 
1236
            tree = tree.branch.repository.revision_tree(
 
1237
                revision[0].in_history(tree.branch).rev_id)
 
1238
        for fp, fc, kind, fid, entry in tree.list_files():
 
1239
            if fp.startswith(relpath):
 
1240
                fp = fp[len(relpath):]
 
1241
                if non_recursive and '/' in fp:
 
1242
                    continue
 
1243
                if not all and not selection[fc]:
 
1244
                    continue
 
1245
                if verbose:
 
1246
                    kindch = entry.kind_character()
 
1247
                    print '%-8s %s%s' % (fc, fp, kindch)
 
1248
                elif null:
 
1249
                    sys.stdout.write(fp)
 
1250
                    sys.stdout.write('\0')
 
1251
                    sys.stdout.flush()
 
1252
                else:
 
1253
                    print fp
 
1254
 
 
1255
 
 
1256
class cmd_unknowns(Command):
 
1257
    """List unknown files."""
 
1258
    @display_command
 
1259
    def run(self):
 
1260
        from bzrlib.osutils import quotefn
 
1261
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1262
            print quotefn(f)
 
1263
 
 
1264
 
 
1265
class cmd_ignore(Command):
 
1266
    """Ignore a command or pattern.
 
1267
 
 
1268
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1269
 
 
1270
    If the pattern contains a slash, it is compared to the whole path
 
1271
    from the branch root.  Otherwise, it is compared to only the last
 
1272
    component of the path.  To match a file only in the root directory,
 
1273
    prepend './'.
 
1274
 
 
1275
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1276
 
 
1277
    Note: wildcards must be quoted from the shell on Unix.
 
1278
 
 
1279
    examples:
 
1280
        bzr ignore ./Makefile
 
1281
        bzr ignore '*.class'
 
1282
    """
 
1283
    # TODO: Complain if the filename is absolute
 
1284
    takes_args = ['name_pattern']
 
1285
    
 
1286
    def run(self, name_pattern):
 
1287
        from bzrlib.atomicfile import AtomicFile
 
1288
        import os.path
 
1289
 
 
1290
        tree, relpath = WorkingTree.open_containing(u'.')
 
1291
        ifn = tree.abspath('.bzrignore')
 
1292
 
 
1293
        if os.path.exists(ifn):
 
1294
            f = open(ifn, 'rt')
 
1295
            try:
 
1296
                igns = f.read().decode('utf-8')
 
1297
            finally:
 
1298
                f.close()
 
1299
        else:
 
1300
            igns = ''
 
1301
 
 
1302
        # TODO: If the file already uses crlf-style termination, maybe
 
1303
        # we should use that for the newly added lines?
 
1304
 
 
1305
        if igns and igns[-1] != '\n':
 
1306
            igns += '\n'
 
1307
        igns += name_pattern + '\n'
 
1308
 
 
1309
        try:
 
1310
            f = AtomicFile(ifn, 'wt')
 
1311
            f.write(igns.encode('utf-8'))
 
1312
            f.commit()
 
1313
        finally:
 
1314
            f.close()
 
1315
 
 
1316
        inv = tree.inventory
 
1317
        if inv.path2id('.bzrignore'):
 
1318
            mutter('.bzrignore is already versioned')
 
1319
        else:
 
1320
            mutter('need to make new .bzrignore file versioned')
 
1321
            tree.add(['.bzrignore'])
 
1322
 
 
1323
 
 
1324
class cmd_ignored(Command):
 
1325
    """List ignored files and the patterns that matched them.
 
1326
 
 
1327
    See also: bzr ignore"""
 
1328
    @display_command
 
1329
    def run(self):
 
1330
        tree = WorkingTree.open_containing(u'.')[0]
 
1331
        for path, file_class, kind, file_id, entry in tree.list_files():
 
1332
            if file_class != 'I':
 
1333
                continue
 
1334
            ## XXX: Slightly inefficient since this was already calculated
 
1335
            pat = tree.is_ignored(path)
 
1336
            print '%-50s %s' % (path, pat)
 
1337
 
 
1338
 
 
1339
class cmd_lookup_revision(Command):
 
1340
    """Lookup the revision-id from a revision-number
 
1341
 
 
1342
    example:
 
1343
        bzr lookup-revision 33
 
1344
    """
 
1345
    hidden = True
 
1346
    takes_args = ['revno']
 
1347
    
 
1348
    @display_command
 
1349
    def run(self, revno):
 
1350
        try:
 
1351
            revno = int(revno)
 
1352
        except ValueError:
 
1353
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1354
 
 
1355
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1356
 
 
1357
 
 
1358
class cmd_export(Command):
 
1359
    """Export past revision to destination directory.
 
1360
 
 
1361
    If no revision is specified this exports the last committed revision.
 
1362
 
 
1363
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1364
    given, try to find the format with the extension. If no extension
 
1365
    is found exports to a directory (equivalent to --format=dir).
 
1366
 
 
1367
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1368
    is given, the top directory will be the root name of the file.
 
1369
 
 
1370
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1371
 
 
1372
     Supported formats       Autodetected by extension
 
1373
     -----------------       -------------------------
 
1374
         dir                            -
 
1375
         tar                          .tar
 
1376
         tbz2                    .tar.bz2, .tbz2
 
1377
         tgz                      .tar.gz, .tgz
 
1378
         zip                          .zip
 
1379
    """
 
1380
    takes_args = ['dest']
 
1381
    takes_options = ['revision', 'format', 'root']
 
1382
    def run(self, dest, revision=None, format=None, root=None):
 
1383
        import os.path
 
1384
        from bzrlib.export import export
 
1385
        tree = WorkingTree.open_containing(u'.')[0]
 
1386
        b = tree.branch
 
1387
        if revision is None:
 
1388
            # should be tree.last_revision  FIXME
 
1389
            rev_id = b.last_revision()
 
1390
        else:
 
1391
            if len(revision) != 1:
 
1392
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1393
            rev_id = revision[0].in_history(b).rev_id
 
1394
        t = b.repository.revision_tree(rev_id)
 
1395
        try:
 
1396
            export(t, dest, format, root)
 
1397
        except errors.NoSuchExportFormat, e:
 
1398
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
1399
 
 
1400
 
 
1401
class cmd_cat(Command):
 
1402
    """Write a file's text from a previous revision."""
 
1403
 
 
1404
    takes_options = ['revision']
 
1405
    takes_args = ['filename']
 
1406
 
 
1407
    @display_command
 
1408
    def run(self, filename, revision=None):
 
1409
        if revision is not None and len(revision) != 1:
 
1410
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1411
        tree = None
 
1412
        try:
 
1413
            tree, relpath = WorkingTree.open_containing(filename)
 
1414
            b = tree.branch
 
1415
        except NotBranchError:
 
1416
            pass
 
1417
 
 
1418
        if tree is None:
 
1419
            b, relpath = Branch.open_containing(filename)
 
1420
        if revision is None:
 
1421
            revision_id = b.last_revision()
 
1422
        else:
 
1423
            revision_id = revision[0].in_history(b).rev_id
 
1424
        b.print_file(relpath, revision_id)
 
1425
 
 
1426
 
 
1427
class cmd_local_time_offset(Command):
 
1428
    """Show the offset in seconds from GMT to local time."""
 
1429
    hidden = True    
 
1430
    @display_command
 
1431
    def run(self):
 
1432
        print bzrlib.osutils.local_time_offset()
 
1433
 
 
1434
 
 
1435
 
 
1436
class cmd_commit(Command):
 
1437
    """Commit changes into a new revision.
 
1438
    
 
1439
    If no arguments are given, the entire tree is committed.
 
1440
 
 
1441
    If selected files are specified, only changes to those files are
 
1442
    committed.  If a directory is specified then the directory and everything 
 
1443
    within it is committed.
 
1444
 
 
1445
    A selected-file commit may fail in some cases where the committed
 
1446
    tree would be invalid, such as trying to commit a file in a
 
1447
    newly-added directory that is not itself committed.
 
1448
    """
 
1449
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1450
 
 
1451
    # TODO: Strict commit that fails if there are deleted files.
 
1452
    #       (what does "deleted files" mean ??)
 
1453
 
 
1454
    # TODO: Give better message for -s, --summary, used by tla people
 
1455
 
 
1456
    # XXX: verbose currently does nothing
 
1457
 
 
1458
    takes_args = ['selected*']
 
1459
    takes_options = ['message', 'verbose', 
 
1460
                     Option('unchanged',
 
1461
                            help='commit even if nothing has changed'),
 
1462
                     Option('file', type=str, 
 
1463
                            argname='msgfile',
 
1464
                            help='file containing commit message'),
 
1465
                     Option('strict',
 
1466
                            help="refuse to commit if there are unknown "
 
1467
                            "files in the working tree."),
 
1468
                     Option('local',
 
1469
                            help="perform a local only commit in a bound "
 
1470
                                 "branch. Such commits are not pushed to "
 
1471
                                 "the master branch until a normal commit "
 
1472
                                 "is performed."
 
1473
                            ),
 
1474
                     ]
 
1475
    aliases = ['ci', 'checkin']
 
1476
 
 
1477
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1478
            unchanged=False, strict=False, local=False):
 
1479
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
1480
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1481
                StrictCommitFailed)
 
1482
        from bzrlib.msgeditor import edit_commit_message, \
 
1483
                make_commit_message_template
 
1484
        from tempfile import TemporaryFile
 
1485
        import codecs
 
1486
 
 
1487
        # TODO: Need a blackbox test for invoking the external editor; may be
 
1488
        # slightly problematic to run this cross-platform.
 
1489
 
 
1490
        # TODO: do more checks that the commit will succeed before 
 
1491
        # spending the user's valuable time typing a commit message.
 
1492
        #
 
1493
        # TODO: if the commit *does* happen to fail, then save the commit 
 
1494
        # message to a temporary file where it can be recovered
 
1495
        tree, selected_list = tree_files(selected_list)
 
1496
        if local and not tree.branch.get_bound_location():
 
1497
            raise errors.LocalRequiresBoundBranch()
 
1498
        if message is None and not file:
 
1499
            template = make_commit_message_template(tree, selected_list)
 
1500
            message = edit_commit_message(template)
 
1501
            if message is None:
 
1502
                raise BzrCommandError("please specify a commit message"
 
1503
                                      " with either --message or --file")
 
1504
        elif message and file:
 
1505
            raise BzrCommandError("please specify either --message or --file")
 
1506
        
 
1507
        if file:
 
1508
            import codecs
 
1509
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1510
 
 
1511
        if message == "":
 
1512
                raise BzrCommandError("empty commit message specified")
 
1513
        
 
1514
        if verbose:
 
1515
            reporter = ReportCommitToLog()
 
1516
        else:
 
1517
            reporter = NullCommitReporter()
 
1518
        
 
1519
        try:
 
1520
            tree.commit(message, specific_files=selected_list,
 
1521
                        allow_pointless=unchanged, strict=strict, local=local,
 
1522
                        reporter=reporter)
 
1523
        except PointlessCommit:
 
1524
            # FIXME: This should really happen before the file is read in;
 
1525
            # perhaps prepare the commit; get the message; then actually commit
 
1526
            raise BzrCommandError("no changes to commit",
 
1527
                                  ["use --unchanged to commit anyhow"])
 
1528
        except ConflictsInTree:
 
1529
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1530
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1531
        except StrictCommitFailed:
 
1532
            raise BzrCommandError("Commit refused because there are unknown "
 
1533
                                  "files in the working tree.")
 
1534
        except errors.BoundBranchOutOfDate, e:
 
1535
            raise BzrCommandError(str(e)
 
1536
                                  + ' Either unbind, update, or'
 
1537
                                    ' pass --local to commit.')
 
1538
 
 
1539
 
 
1540
class cmd_check(Command):
 
1541
    """Validate consistency of branch history.
 
1542
 
 
1543
    This command checks various invariants about the branch storage to
 
1544
    detect data corruption or bzr bugs.
 
1545
    """
 
1546
    takes_args = ['branch?']
 
1547
    takes_options = ['verbose']
 
1548
 
 
1549
    def run(self, branch=None, verbose=False):
 
1550
        from bzrlib.check import check
 
1551
        if branch is None:
 
1552
            tree = WorkingTree.open_containing()[0]
 
1553
            branch = tree.branch
 
1554
        else:
 
1555
            branch = Branch.open(branch)
 
1556
        check(branch, verbose)
 
1557
 
 
1558
 
 
1559
class cmd_scan_cache(Command):
 
1560
    hidden = True
 
1561
    def run(self):
 
1562
        from bzrlib.hashcache import HashCache
 
1563
 
 
1564
        c = HashCache(u'.')
 
1565
        c.read()
 
1566
        c.scan()
 
1567
            
 
1568
        print '%6d stats' % c.stat_count
 
1569
        print '%6d in hashcache' % len(c._cache)
 
1570
        print '%6d files removed from cache' % c.removed_count
 
1571
        print '%6d hashes updated' % c.update_count
 
1572
        print '%6d files changed too recently to cache' % c.danger_count
 
1573
 
 
1574
        if c.needs_write:
 
1575
            c.write()
 
1576
 
 
1577
 
 
1578
class cmd_upgrade(Command):
 
1579
    """Upgrade branch storage to current format.
 
1580
 
 
1581
    The check command or bzr developers may sometimes advise you to run
 
1582
    this command. When the default format has changed you may also be warned
 
1583
    during other operations to upgrade.
 
1584
    """
 
1585
    takes_args = ['url?']
 
1586
    takes_options = [
 
1587
                     Option('format', 
 
1588
                            help='Upgrade to a specific format rather than the'
 
1589
                                 ' current default format. Currently this'
 
1590
                                 ' option only accepts -metadir and -knit'
 
1591
                                 ' WARNING: the knit format is currently'
 
1592
                                 ' unstable and only for experimental use.',
 
1593
                            type=get_format_type),
 
1594
                    ]
 
1595
 
 
1596
 
 
1597
    def run(self, url='.', format=None):
 
1598
        from bzrlib.upgrade import upgrade
 
1599
        upgrade(url, format)
 
1600
 
 
1601
 
 
1602
class cmd_whoami(Command):
 
1603
    """Show bzr user id."""
 
1604
    takes_options = ['email']
 
1605
    
 
1606
    @display_command
 
1607
    def run(self, email=False):
 
1608
        try:
 
1609
            b = WorkingTree.open_containing(u'.')[0].branch
 
1610
            config = bzrlib.config.BranchConfig(b)
 
1611
        except NotBranchError:
 
1612
            config = bzrlib.config.GlobalConfig()
 
1613
        
 
1614
        if email:
 
1615
            print config.user_email()
 
1616
        else:
 
1617
            print config.username()
 
1618
 
 
1619
 
 
1620
class cmd_nick(Command):
 
1621
    """Print or set the branch nickname.  
 
1622
 
 
1623
    If unset, the tree root directory name is used as the nickname
 
1624
    To print the current nickname, execute with no argument.  
 
1625
    """
 
1626
    takes_args = ['nickname?']
 
1627
    def run(self, nickname=None):
 
1628
        branch = Branch.open_containing(u'.')[0]
 
1629
        if nickname is None:
 
1630
            self.printme(branch)
 
1631
        else:
 
1632
            branch.nick = nickname
 
1633
 
 
1634
    @display_command
 
1635
    def printme(self, branch):
 
1636
        print branch.nick 
 
1637
 
 
1638
 
 
1639
class cmd_selftest(Command):
 
1640
    """Run internal test suite.
 
1641
    
 
1642
    This creates temporary test directories in the working directory,
 
1643
    but not existing data is affected.  These directories are deleted
 
1644
    if the tests pass, or left behind to help in debugging if they
 
1645
    fail and --keep-output is specified.
 
1646
    
 
1647
    If arguments are given, they are regular expressions that say
 
1648
    which tests should run.
 
1649
 
 
1650
    If the global option '--no-plugins' is given, plugins are not loaded
 
1651
    before running the selftests.  This has two effects: features provided or
 
1652
    modified by plugins will not be tested, and tests provided by plugins will
 
1653
    not be run.
 
1654
 
 
1655
    examples:
 
1656
        bzr selftest ignore
 
1657
        bzr --no-plugins selftest -v
 
1658
    """
 
1659
    # TODO: --list should give a list of all available tests
 
1660
 
 
1661
    # NB: this is used from the class without creating an instance, which is
 
1662
    # why it does not have a self parameter.
 
1663
    def get_transport_type(typestring):
 
1664
        """Parse and return a transport specifier."""
 
1665
        if typestring == "sftp":
 
1666
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
1667
            return SFTPAbsoluteServer
 
1668
        if typestring == "memory":
 
1669
            from bzrlib.transport.memory import MemoryServer
 
1670
            return MemoryServer
 
1671
        if typestring == "fakenfs":
 
1672
            from bzrlib.transport.fakenfs import FakeNFSServer
 
1673
            return FakeNFSServer
 
1674
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
1675
            (typestring)
 
1676
        raise BzrCommandError(msg)
 
1677
 
 
1678
    hidden = True
 
1679
    takes_args = ['testspecs*']
 
1680
    takes_options = ['verbose',
 
1681
                     Option('one', help='stop when one test fails'),
 
1682
                     Option('keep-output', 
 
1683
                            help='keep output directories when tests fail'),
 
1684
                     Option('transport', 
 
1685
                            help='Use a different transport by default '
 
1686
                                 'throughout the test suite.',
 
1687
                            type=get_transport_type),
 
1688
                    ]
 
1689
 
 
1690
    def run(self, testspecs_list=None, verbose=False, one=False,
 
1691
            keep_output=False, transport=None):
 
1692
        import bzrlib.ui
 
1693
        from bzrlib.tests import selftest
 
1694
        # we don't want progress meters from the tests to go to the
 
1695
        # real output; and we don't want log messages cluttering up
 
1696
        # the real logs.
 
1697
        save_ui = bzrlib.ui.ui_factory
 
1698
        bzrlib.trace.info('running tests...')
 
1699
        try:
 
1700
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1701
            if testspecs_list is not None:
 
1702
                pattern = '|'.join(testspecs_list)
 
1703
            else:
 
1704
                pattern = ".*"
 
1705
            result = selftest(verbose=verbose, 
 
1706
                              pattern=pattern,
 
1707
                              stop_on_failure=one, 
 
1708
                              keep_output=keep_output,
 
1709
                              transport=transport)
 
1710
            if result:
 
1711
                bzrlib.trace.info('tests passed')
 
1712
            else:
 
1713
                bzrlib.trace.info('tests failed')
 
1714
            return int(not result)
 
1715
        finally:
 
1716
            bzrlib.ui.ui_factory = save_ui
 
1717
 
 
1718
 
 
1719
def _get_bzr_branch():
 
1720
    """If bzr is run from a branch, return Branch or None"""
 
1721
    import bzrlib.errors
 
1722
    from bzrlib.branch import Branch
 
1723
    from bzrlib.osutils import abspath
 
1724
    from os.path import dirname
 
1725
    
 
1726
    try:
 
1727
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
1728
        return branch
 
1729
    except bzrlib.errors.BzrError:
 
1730
        return None
 
1731
    
 
1732
 
 
1733
def show_version():
 
1734
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1735
    # is bzrlib itself in a branch?
 
1736
    branch = _get_bzr_branch()
 
1737
    if branch:
 
1738
        rh = branch.revision_history()
 
1739
        revno = len(rh)
 
1740
        print "  bzr checkout, revision %d" % (revno,)
 
1741
        print "  nick: %s" % (branch.nick,)
 
1742
        if rh:
 
1743
            print "  revid: %s" % (rh[-1],)
 
1744
    print bzrlib.__copyright__
 
1745
    print "http://bazaar-ng.org/"
 
1746
    print
 
1747
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1748
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1749
    print "General Public License version 2 or later."
 
1750
 
 
1751
 
 
1752
class cmd_version(Command):
 
1753
    """Show version of bzr."""
 
1754
    @display_command
 
1755
    def run(self):
 
1756
        show_version()
 
1757
 
 
1758
class cmd_rocks(Command):
 
1759
    """Statement of optimism."""
 
1760
    hidden = True
 
1761
    @display_command
 
1762
    def run(self):
 
1763
        print "it sure does!"
 
1764
 
 
1765
 
 
1766
class cmd_find_merge_base(Command):
 
1767
    """Find and print a base revision for merging two branches.
 
1768
    """
 
1769
    # TODO: Options to specify revisions on either side, as if
 
1770
    #       merging only part of the history.
 
1771
    takes_args = ['branch', 'other']
 
1772
    hidden = True
 
1773
    
 
1774
    @display_command
 
1775
    def run(self, branch, other):
 
1776
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1777
        
 
1778
        branch1 = Branch.open_containing(branch)[0]
 
1779
        branch2 = Branch.open_containing(other)[0]
 
1780
 
 
1781
        history_1 = branch1.revision_history()
 
1782
        history_2 = branch2.revision_history()
 
1783
 
 
1784
        last1 = branch1.last_revision()
 
1785
        last2 = branch2.last_revision()
 
1786
 
 
1787
        source = MultipleRevisionSources(branch1.repository, 
 
1788
                                         branch2.repository)
 
1789
        
 
1790
        base_rev_id = common_ancestor(last1, last2, source)
 
1791
 
 
1792
        print 'merge base is revision %s' % base_rev_id
 
1793
        
 
1794
        return
 
1795
 
 
1796
        if base_revno is None:
 
1797
            raise bzrlib.errors.UnrelatedBranches()
 
1798
 
 
1799
        print ' r%-6d in %s' % (base_revno, branch)
 
1800
 
 
1801
        other_revno = branch2.revision_id_to_revno(base_revid)
 
1802
        
 
1803
        print ' r%-6d in %s' % (other_revno, other)
 
1804
 
 
1805
 
 
1806
 
 
1807
class cmd_merge(Command):
 
1808
    """Perform a three-way merge.
 
1809
    
 
1810
    The branch is the branch you will merge from.  By default, it will
 
1811
    merge the latest revision.  If you specify a revision, that
 
1812
    revision will be merged.  If you specify two revisions, the first
 
1813
    will be used as a BASE, and the second one as OTHER.  Revision
 
1814
    numbers are always relative to the specified branch.
 
1815
 
 
1816
    By default, bzr will try to merge in all new work from the other
 
1817
    branch, automatically determining an appropriate base.  If this
 
1818
    fails, you may need to give an explicit base.
 
1819
    
 
1820
    Merge will do its best to combine the changes in two branches, but there
 
1821
    are some kinds of problems only a human can fix.  When it encounters those,
 
1822
    it will mark a conflict.  A conflict means that you need to fix something,
 
1823
    before you should commit.
 
1824
 
 
1825
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
1826
 
 
1827
    Examples:
 
1828
 
 
1829
    To merge the latest revision from bzr.dev
 
1830
    bzr merge ../bzr.dev
 
1831
 
 
1832
    To merge changes up to and including revision 82 from bzr.dev
 
1833
    bzr merge -r 82 ../bzr.dev
 
1834
 
 
1835
    To merge the changes introduced by 82, without previous changes:
 
1836
    bzr merge -r 81..82 ../bzr.dev
 
1837
    
 
1838
    merge refuses to run if there are any uncommitted changes, unless
 
1839
    --force is given.
 
1840
    """
 
1841
    takes_args = ['branch?']
 
1842
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
 
1843
                     Option('show-base', help="Show base revision text in "
 
1844
                            "conflicts")]
 
1845
 
 
1846
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1847
            show_base=False, reprocess=False):
 
1848
        if merge_type is None:
 
1849
            merge_type = Merge3Merger
 
1850
        if branch is None:
 
1851
            branch = WorkingTree.open_containing(u'.')[0].branch.get_parent()
 
1852
            if branch is None:
 
1853
                raise BzrCommandError("No merge location known or specified.")
 
1854
            else:
 
1855
                print "Using saved location: %s" % branch 
 
1856
        if revision is None or len(revision) < 1:
 
1857
            base = [None, None]
 
1858
            other = [branch, -1]
 
1859
        else:
 
1860
            if len(revision) == 1:
 
1861
                base = [None, None]
 
1862
                other_branch = Branch.open_containing(branch)[0]
 
1863
                revno = revision[0].in_history(other_branch).revno
 
1864
                other = [branch, revno]
 
1865
            else:
 
1866
                assert len(revision) == 2
 
1867
                if None in revision:
 
1868
                    raise BzrCommandError(
 
1869
                        "Merge doesn't permit that revision specifier.")
 
1870
                b = Branch.open_containing(branch)[0]
 
1871
 
 
1872
                base = [branch, revision[0].in_history(b).revno]
 
1873
                other = [branch, revision[1].in_history(b).revno]
 
1874
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1875
        try:
 
1876
            try:
 
1877
                conflict_count = merge(other, base, check_clean=(not force),
 
1878
                                       merge_type=merge_type, 
 
1879
                                       reprocess=reprocess,
 
1880
                                       show_base=show_base, 
 
1881
                                       pb=pb)
 
1882
            finally:
 
1883
                pb.finished()
 
1884
            if conflict_count != 0:
 
1885
                return 1
 
1886
            else:
 
1887
                return 0
 
1888
        except bzrlib.errors.AmbiguousBase, e:
 
1889
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
1890
                 "candidates are:\n  "
 
1891
                 + "\n  ".join(e.bases)
 
1892
                 + "\n"
 
1893
                 "please specify an explicit base with -r,\n"
 
1894
                 "and (if you want) report this to the bzr developers\n")
 
1895
            log_error(m)
 
1896
 
 
1897
 
 
1898
class cmd_remerge(Command):
 
1899
    """Redo a merge.
 
1900
    """
 
1901
    takes_args = ['file*']
 
1902
    takes_options = ['merge-type', 'reprocess',
 
1903
                     Option('show-base', help="Show base revision text in "
 
1904
                            "conflicts")]
 
1905
 
 
1906
    def run(self, file_list=None, merge_type=None, show_base=False,
 
1907
            reprocess=False):
 
1908
        from bzrlib.merge import merge_inner, transform_tree
 
1909
        if merge_type is None:
 
1910
            merge_type = Merge3Merger
 
1911
        tree, file_list = tree_files(file_list)
 
1912
        tree.lock_write()
 
1913
        try:
 
1914
            pending_merges = tree.pending_merges() 
 
1915
            if len(pending_merges) != 1:
 
1916
                raise BzrCommandError("Sorry, remerge only works after normal"
 
1917
                                      + " merges.  Not cherrypicking or"
 
1918
                                      + "multi-merges.")
 
1919
            repository = tree.branch.repository
 
1920
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
1921
                                            pending_merges[0], repository)
 
1922
            base_tree = repository.revision_tree(base_revision)
 
1923
            other_tree = repository.revision_tree(pending_merges[0])
 
1924
            interesting_ids = None
 
1925
            if file_list is not None:
 
1926
                interesting_ids = set()
 
1927
                for filename in file_list:
 
1928
                    file_id = tree.path2id(filename)
 
1929
                    if file_id is None:
 
1930
                        raise NotVersionedError(filename)
 
1931
                    interesting_ids.add(file_id)
 
1932
                    if tree.kind(file_id) != "directory":
 
1933
                        continue
 
1934
                    
 
1935
                    for name, ie in tree.inventory.iter_entries(file_id):
 
1936
                        interesting_ids.add(ie.file_id)
 
1937
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
1938
            if file_list is None:
 
1939
                restore_files = list(tree.iter_conflicts())
 
1940
            else:
 
1941
                restore_files = file_list
 
1942
            for filename in restore_files:
 
1943
                try:
 
1944
                    restore(tree.abspath(filename))
 
1945
                except NotConflicted:
 
1946
                    pass
 
1947
            conflicts =  merge_inner(tree.branch, other_tree, base_tree,
 
1948
                                     this_tree=tree,
 
1949
                                     interesting_ids = interesting_ids, 
 
1950
                                     other_rev_id=pending_merges[0], 
 
1951
                                     merge_type=merge_type, 
 
1952
                                     show_base=show_base,
 
1953
                                     reprocess=reprocess)
 
1954
        finally:
 
1955
            tree.unlock()
 
1956
        if conflicts > 0:
 
1957
            return 1
 
1958
        else:
 
1959
            return 0
 
1960
 
 
1961
class cmd_revert(Command):
 
1962
    """Reverse all changes since the last commit.
 
1963
 
 
1964
    Only versioned files are affected.  Specify filenames to revert only 
 
1965
    those files.  By default, any files that are changed will be backed up
 
1966
    first.  Backup files have a '~' appended to their name.
 
1967
    """
 
1968
    takes_options = ['revision', 'no-backup']
 
1969
    takes_args = ['file*']
 
1970
    aliases = ['merge-revert']
 
1971
 
 
1972
    def run(self, revision=None, no_backup=False, file_list=None):
 
1973
        from bzrlib.commands import parse_spec
 
1974
        if file_list is not None:
 
1975
            if len(file_list) == 0:
 
1976
                raise BzrCommandError("No files specified")
 
1977
        else:
 
1978
            file_list = []
 
1979
        
 
1980
        tree, file_list = tree_files(file_list)
 
1981
        if revision is None:
 
1982
            # FIXME should be tree.last_revision
 
1983
            rev_id = tree.last_revision()
 
1984
        elif len(revision) != 1:
 
1985
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1986
        else:
 
1987
            rev_id = revision[0].in_history(tree.branch).rev_id
 
1988
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1989
        try:
 
1990
            tree.revert(file_list, 
 
1991
                        tree.branch.repository.revision_tree(rev_id),
 
1992
                        not no_backup, pb)
 
1993
        finally:
 
1994
            pb.finished()
 
1995
 
 
1996
 
 
1997
class cmd_assert_fail(Command):
 
1998
    """Test reporting of assertion failures"""
 
1999
    hidden = True
 
2000
    def run(self):
 
2001
        assert False, "always fails"
 
2002
 
 
2003
 
 
2004
class cmd_help(Command):
 
2005
    """Show help on a command or other topic.
 
2006
 
 
2007
    For a list of all available commands, say 'bzr help commands'."""
 
2008
    takes_options = [Option('long', 'show help on all commands')]
 
2009
    takes_args = ['topic?']
 
2010
    aliases = ['?', '--help', '-?', '-h']
 
2011
    
 
2012
    @display_command
 
2013
    def run(self, topic=None, long=False):
 
2014
        import help
 
2015
        if topic is None and long:
 
2016
            topic = "commands"
 
2017
        help.help(topic)
 
2018
 
 
2019
 
 
2020
class cmd_shell_complete(Command):
 
2021
    """Show appropriate completions for context.
 
2022
 
 
2023
    For a list of all available commands, say 'bzr shell-complete'."""
 
2024
    takes_args = ['context?']
 
2025
    aliases = ['s-c']
 
2026
    hidden = True
 
2027
    
 
2028
    @display_command
 
2029
    def run(self, context=None):
 
2030
        import shellcomplete
 
2031
        shellcomplete.shellcomplete(context)
 
2032
 
 
2033
 
 
2034
class cmd_fetch(Command):
 
2035
    """Copy in history from another branch but don't merge it.
 
2036
 
 
2037
    This is an internal method used for pull and merge."""
 
2038
    hidden = True
 
2039
    takes_args = ['from_branch', 'to_branch']
 
2040
    def run(self, from_branch, to_branch):
 
2041
        from bzrlib.fetch import Fetcher
 
2042
        from bzrlib.branch import Branch
 
2043
        from_b = Branch.open(from_branch)
 
2044
        to_b = Branch.open(to_branch)
 
2045
        Fetcher(to_b, from_b)
 
2046
 
 
2047
 
 
2048
class cmd_missing(Command):
 
2049
    """Show unmerged/unpulled revisions between two branches.
 
2050
 
 
2051
    OTHER_BRANCH may be local or remote."""
 
2052
    takes_args = ['other_branch?']
 
2053
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2054
                     Option('mine-only', 
 
2055
                            'Display changes in the local branch only'),
 
2056
                     Option('theirs-only', 
 
2057
                            'Display changes in the remote branch only'), 
 
2058
                     'log-format',
 
2059
                     'line',
 
2060
                     'long', 
 
2061
                     'short',
 
2062
                     'show-ids',
 
2063
                     'verbose'
 
2064
                     ]
 
2065
 
 
2066
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2067
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2068
            show_ids=False, verbose=False):
 
2069
        from bzrlib.missing import find_unmerged, iter_log_data
 
2070
        from bzrlib.log import log_formatter
 
2071
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
2072
        parent = local_branch.get_parent()
 
2073
        if other_branch is None:
 
2074
            other_branch = parent
 
2075
            if other_branch is None:
 
2076
                raise BzrCommandError("No missing location known or specified.")
 
2077
            print "Using last location: " + local_branch.get_parent()
 
2078
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
2079
        local_branch.lock_write()
 
2080
        if remote_branch.base == local_branch.base:
 
2081
            remote_branch = local_branch
 
2082
        try:
 
2083
            remote_branch.lock_read()
 
2084
            try:
 
2085
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2086
                if (log_format == None):
 
2087
                    default = bzrlib.config.BranchConfig(local_branch).log_format()
 
2088
                    log_format = get_log_format(long=long, short=short, line=line, default=default)
 
2089
                lf = log_formatter(log_format, sys.stdout,
 
2090
                                   show_ids=show_ids,
 
2091
                                   show_timezone='original')
 
2092
                if reverse is False:
 
2093
                    local_extra.reverse()
 
2094
                    remote_extra.reverse()
 
2095
                if local_extra and not theirs_only:
 
2096
                    print "You have %d extra revision(s):" % len(local_extra)
 
2097
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2098
                                              verbose):
 
2099
                        lf.show(*data)
 
2100
                    printed_local = True
 
2101
                else:
 
2102
                    printed_local = False
 
2103
                if remote_extra and not mine_only:
 
2104
                    if printed_local is True:
 
2105
                        print "\n\n"
 
2106
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2107
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2108
                                              verbose):
 
2109
                        lf.show(*data)
 
2110
                if not remote_extra and not local_extra:
 
2111
                    status_code = 0
 
2112
                    print "Branches are up to date."
 
2113
                else:
 
2114
                    status_code = 1
 
2115
                if parent is None and other_branch is not None:
 
2116
                    local_branch.set_parent(other_branch)
 
2117
                return status_code
 
2118
            finally:
 
2119
                local_branch.unlock()
 
2120
        finally:
 
2121
            remote_branch.unlock()
 
2122
 
 
2123
 
 
2124
class cmd_plugins(Command):
 
2125
    """List plugins"""
 
2126
    hidden = True
 
2127
    @display_command
 
2128
    def run(self):
 
2129
        import bzrlib.plugin
 
2130
        from inspect import getdoc
 
2131
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2132
            if hasattr(plugin, '__path__'):
 
2133
                print plugin.__path__[0]
 
2134
            elif hasattr(plugin, '__file__'):
 
2135
                print plugin.__file__
 
2136
            else:
 
2137
                print `plugin`
 
2138
                
 
2139
            d = getdoc(plugin)
 
2140
            if d:
 
2141
                print '\t', d.split('\n')[0]
 
2142
 
 
2143
 
 
2144
class cmd_testament(Command):
 
2145
    """Show testament (signing-form) of a revision."""
 
2146
    takes_options = ['revision', 'long']
 
2147
    takes_args = ['branch?']
 
2148
    @display_command
 
2149
    def run(self, branch=u'.', revision=None, long=False):
 
2150
        from bzrlib.testament import Testament
 
2151
        b = WorkingTree.open_containing(branch)[0].branch
 
2152
        b.lock_read()
 
2153
        try:
 
2154
            if revision is None:
 
2155
                rev_id = b.last_revision()
 
2156
            else:
 
2157
                rev_id = revision[0].in_history(b).rev_id
 
2158
            t = Testament.from_revision(b.repository, rev_id)
 
2159
            if long:
 
2160
                sys.stdout.writelines(t.as_text_lines())
 
2161
            else:
 
2162
                sys.stdout.write(t.as_short_text())
 
2163
        finally:
 
2164
            b.unlock()
 
2165
 
 
2166
 
 
2167
class cmd_annotate(Command):
 
2168
    """Show the origin of each line in a file.
 
2169
 
 
2170
    This prints out the given file with an annotation on the left side
 
2171
    indicating which revision, author and date introduced the change.
 
2172
 
 
2173
    If the origin is the same for a run of consecutive lines, it is 
 
2174
    shown only at the top, unless the --all option is given.
 
2175
    """
 
2176
    # TODO: annotate directories; showing when each file was last changed
 
2177
    # TODO: annotate a previous version of a file
 
2178
    # TODO: if the working copy is modified, show annotations on that 
 
2179
    #       with new uncommitted lines marked
 
2180
    aliases = ['blame', 'praise']
 
2181
    takes_args = ['filename']
 
2182
    takes_options = [Option('all', help='show annotations on all lines'),
 
2183
                     Option('long', help='show date in annotations'),
 
2184
                     ]
 
2185
 
 
2186
    @display_command
 
2187
    def run(self, filename, all=False, long=False):
 
2188
        from bzrlib.annotate import annotate_file
 
2189
        tree, relpath = WorkingTree.open_containing(filename)
 
2190
        branch = tree.branch
 
2191
        branch.lock_read()
 
2192
        try:
 
2193
            file_id = tree.inventory.path2id(relpath)
 
2194
            tree = branch.repository.revision_tree(branch.last_revision())
 
2195
            file_version = tree.inventory[file_id].revision
 
2196
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
2197
        finally:
 
2198
            branch.unlock()
 
2199
 
 
2200
 
 
2201
class cmd_re_sign(Command):
 
2202
    """Create a digital signature for an existing revision."""
 
2203
    # TODO be able to replace existing ones.
 
2204
 
 
2205
    hidden = True # is this right ?
 
2206
    takes_args = ['revision_id*']
 
2207
    takes_options = ['revision']
 
2208
    
 
2209
    def run(self, revision_id_list=None, revision=None):
 
2210
        import bzrlib.config as config
 
2211
        import bzrlib.gpg as gpg
 
2212
        if revision_id_list is not None and revision is not None:
 
2213
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
2214
        if revision_id_list is None and revision is None:
 
2215
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
2216
        b = WorkingTree.open_containing(u'.')[0].branch
 
2217
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
2218
        if revision_id_list is not None:
 
2219
            for revision_id in revision_id_list:
 
2220
                b.repository.sign_revision(revision_id, gpg_strategy)
 
2221
        elif revision is not None:
 
2222
            if len(revision) == 1:
 
2223
                revno, rev_id = revision[0].in_history(b)
 
2224
                b.repository.sign_revision(rev_id, gpg_strategy)
 
2225
            elif len(revision) == 2:
 
2226
                # are they both on rh- if so we can walk between them
 
2227
                # might be nice to have a range helper for arbitrary
 
2228
                # revision paths. hmm.
 
2229
                from_revno, from_revid = revision[0].in_history(b)
 
2230
                to_revno, to_revid = revision[1].in_history(b)
 
2231
                if to_revid is None:
 
2232
                    to_revno = b.revno()
 
2233
                if from_revno is None or to_revno is None:
 
2234
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
2235
                for revno in range(from_revno, to_revno + 1):
 
2236
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
2237
                                               gpg_strategy)
 
2238
            else:
 
2239
                raise BzrCommandError('Please supply either one revision, or a range.')
 
2240
 
 
2241
 
 
2242
class cmd_bind(Command):
 
2243
    """Bind the current branch to a master branch.
 
2244
 
 
2245
    After binding, commits must succeed on the master branch
 
2246
    before they are executed on the local one.
 
2247
    """
 
2248
 
 
2249
    takes_args = ['location']
 
2250
    takes_options = []
 
2251
 
 
2252
    def run(self, location=None):
 
2253
        b, relpath = Branch.open_containing(u'.')
 
2254
        b_other = Branch.open(location)
 
2255
        try:
 
2256
            b.bind(b_other)
 
2257
        except DivergedBranches:
 
2258
            raise BzrCommandError('These branches have diverged.'
 
2259
                                  ' Try merging, and then bind again.')
 
2260
 
 
2261
 
 
2262
class cmd_unbind(Command):
 
2263
    """Bind the current branch to its parent.
 
2264
 
 
2265
    After unbinding, the local branch is considered independent.
 
2266
    """
 
2267
 
 
2268
    takes_args = []
 
2269
    takes_options = []
 
2270
 
 
2271
    def run(self):
 
2272
        b, relpath = Branch.open_containing(u'.')
 
2273
        if not b.unbind():
 
2274
            raise BzrCommandError('Local branch is not bound')
 
2275
 
 
2276
 
 
2277
class cmd_uncommit(bzrlib.commands.Command):
 
2278
    """Remove the last committed revision.
 
2279
 
 
2280
    By supplying the --all flag, it will not only remove the entry 
 
2281
    from revision_history, but also remove all of the entries in the
 
2282
    stores.
 
2283
 
 
2284
    --verbose will print out what is being removed.
 
2285
    --dry-run will go through all the motions, but not actually
 
2286
    remove anything.
 
2287
    
 
2288
    In the future, uncommit will create a changeset, which can then
 
2289
    be re-applied.
 
2290
    """
 
2291
 
 
2292
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
2293
    # unreferenced information in 'branch-as-repostory' branches.
 
2294
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
2295
    # information in shared branches as well.
 
2296
    takes_options = ['verbose', 'revision',
 
2297
                    Option('dry-run', help='Don\'t actually make changes'),
 
2298
                    Option('force', help='Say yes to all questions.')]
 
2299
    takes_args = ['location?']
 
2300
    aliases = []
 
2301
 
 
2302
    def run(self, location=None, 
 
2303
            dry_run=False, verbose=False,
 
2304
            revision=None, force=False):
 
2305
        from bzrlib.branch import Branch
 
2306
        from bzrlib.log import log_formatter
 
2307
        import sys
 
2308
        from bzrlib.uncommit import uncommit
 
2309
 
 
2310
        if location is None:
 
2311
            location = u'.'
 
2312
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
2313
        try:
 
2314
            tree = control.open_workingtree()
 
2315
            b = tree.branch
 
2316
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2317
            tree = None
 
2318
            b = control.open_branch()
 
2319
 
 
2320
        if revision is None:
 
2321
            revno = b.revno()
 
2322
            rev_id = b.last_revision()
 
2323
        else:
 
2324
            revno, rev_id = revision[0].in_history(b)
 
2325
        if rev_id is None:
 
2326
            print 'No revisions to uncommit.'
 
2327
 
 
2328
        for r in range(revno, b.revno()+1):
 
2329
            rev_id = b.get_rev_id(r)
 
2330
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
2331
            lf.show(r, b.repository.get_revision(rev_id), None)
 
2332
 
 
2333
        if dry_run:
 
2334
            print 'Dry-run, pretending to remove the above revisions.'
 
2335
            if not force:
 
2336
                val = raw_input('Press <enter> to continue')
 
2337
        else:
 
2338
            print 'The above revision(s) will be removed.'
 
2339
            if not force:
 
2340
                val = raw_input('Are you sure [y/N]? ')
 
2341
                if val.lower() not in ('y', 'yes'):
 
2342
                    print 'Canceled'
 
2343
                    return 0
 
2344
 
 
2345
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
2346
                revno=revno)
 
2347
 
 
2348
 
 
2349
class cmd_break_lock(Command):
 
2350
    """Break a dead lock on a repository, branch or working directory.
 
2351
 
 
2352
    CAUTION: Locks should only be broken when you are sure that the process
 
2353
    holding the lock has been stopped.
 
2354
    
 
2355
    example:
 
2356
        bzr break-lock .
 
2357
    """
 
2358
    takes_args = ['location']
 
2359
    takes_options = [Option('show',
 
2360
                            help="just show information on the lock, " \
 
2361
                                 "don't break it"),
 
2362
                    ]
 
2363
    def run(self, location, show=False):
 
2364
        raise NotImplementedError("sorry, break-lock is not complete yet; "
 
2365
                "you can remove the 'held' directory manually to break the lock")
 
2366
 
 
2367
 
 
2368
# command-line interpretation helper for merge-related commands
 
2369
def merge(other_revision, base_revision,
 
2370
          check_clean=True, ignore_zero=False,
 
2371
          this_dir=None, backup_files=False, merge_type=Merge3Merger,
 
2372
          file_list=None, show_base=False, reprocess=False,
 
2373
          pb=DummyProgress()):
 
2374
    """Merge changes into a tree.
 
2375
 
 
2376
    base_revision
 
2377
        list(path, revno) Base for three-way merge.  
 
2378
        If [None, None] then a base will be automatically determined.
 
2379
    other_revision
 
2380
        list(path, revno) Other revision for three-way merge.
 
2381
    this_dir
 
2382
        Directory to merge changes into; '.' by default.
 
2383
    check_clean
 
2384
        If true, this_dir must have no uncommitted changes before the
 
2385
        merge begins.
 
2386
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
2387
        there are no conflicts; should be set when doing something we expect
 
2388
        to complete perfectly.
 
2389
    file_list - If supplied, merge only changes to selected files.
 
2390
 
 
2391
    All available ancestors of other_revision and base_revision are
 
2392
    automatically pulled into the branch.
 
2393
 
 
2394
    The revno may be -1 to indicate the last revision on the branch, which is
 
2395
    the typical case.
 
2396
 
 
2397
    This function is intended for use from the command line; programmatic
 
2398
    clients might prefer to call merge.merge_inner(), which has less magic 
 
2399
    behavior.
 
2400
    """
 
2401
    from bzrlib.merge import Merger
 
2402
    if this_dir is None:
 
2403
        this_dir = u'.'
 
2404
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
2405
    if show_base and not merge_type is Merge3Merger:
 
2406
        raise BzrCommandError("Show-base is not supported for this merge"
 
2407
                              " type. %s" % merge_type)
 
2408
    if reprocess and not merge_type.supports_reprocess:
 
2409
        raise BzrCommandError("Conflict reduction is not supported for merge"
 
2410
                              " type %s." % merge_type)
 
2411
    if reprocess and show_base:
 
2412
        raise BzrCommandError("Cannot do conflict reduction and show base.")
 
2413
    try:
 
2414
        merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
 
2415
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
2416
        merger.pp.next_phase()
 
2417
        merger.check_basis(check_clean)
 
2418
        merger.set_other(other_revision)
 
2419
        merger.pp.next_phase()
 
2420
        merger.set_base(base_revision)
 
2421
        if merger.base_rev_id == merger.other_rev_id:
 
2422
            note('Nothing to do.')
 
2423
            return 0
 
2424
        merger.backup_files = backup_files
 
2425
        merger.merge_type = merge_type 
 
2426
        merger.set_interesting_files(file_list)
 
2427
        merger.show_base = show_base 
 
2428
        merger.reprocess = reprocess
 
2429
        conflicts = merger.do_merge()
 
2430
        merger.set_pending()
 
2431
    finally:
 
2432
        pb.clear()
 
2433
    return conflicts
 
2434
 
 
2435
 
 
2436
# these get imported and then picked up by the scan for cmd_*
 
2437
# TODO: Some more consistent way to split command definitions across files;
 
2438
# we do need to load at least some information about them to know of 
 
2439
# aliases.  ideally we would avoid loading the implementation until the
 
2440
# details were needed.
 
2441
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
2442
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
2443
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
2444
        cmd_weave_plan_merge, cmd_weave_merge_text