/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

Make bzr info command work on both local and remote locations. Support
branches and repositories, next to working trees.

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
    takes_options = ['verbose']
 
754
    
 
755
    @display_command
 
756
    def run(self, branch=None, verbose=False):
 
757
        import bzrlib.info
 
758
        bzrlib.info.show_bzrdir_info(bzrdir.BzrDir.open_containing(branch)[0],
 
759
                                     verbose=verbose)
 
760
 
 
761
 
 
762
class cmd_remove(Command):
 
763
    """Make a file unversioned.
 
764
 
 
765
    This makes bzr stop tracking changes to a versioned file.  It does
 
766
    not delete the working copy.
 
767
    """
 
768
    takes_args = ['file+']
 
769
    takes_options = ['verbose']
 
770
    aliases = ['rm']
 
771
    
 
772
    def run(self, file_list, verbose=False):
 
773
        tree, file_list = tree_files(file_list)
 
774
        tree.remove(file_list, verbose=verbose)
 
775
 
 
776
 
 
777
class cmd_file_id(Command):
 
778
    """Print file_id of a particular file or directory.
 
779
 
 
780
    The file_id is assigned when the file is first added and remains the
 
781
    same through all revisions where the file exists, even when it is
 
782
    moved or renamed.
 
783
    """
 
784
    hidden = True
 
785
    takes_args = ['filename']
 
786
    @display_command
 
787
    def run(self, filename):
 
788
        tree, relpath = WorkingTree.open_containing(filename)
 
789
        i = tree.inventory.path2id(relpath)
 
790
        if i == None:
 
791
            raise BzrError("%r is not a versioned file" % filename)
 
792
        else:
 
793
            print i
 
794
 
 
795
 
 
796
class cmd_file_path(Command):
 
797
    """Print path of file_ids to a file or directory.
 
798
 
 
799
    This prints one line for each directory down to the target,
 
800
    starting at the branch root."""
 
801
    hidden = True
 
802
    takes_args = ['filename']
 
803
    @display_command
 
804
    def run(self, filename):
 
805
        tree, relpath = WorkingTree.open_containing(filename)
 
806
        inv = tree.inventory
 
807
        fid = inv.path2id(relpath)
 
808
        if fid == None:
 
809
            raise BzrError("%r is not a versioned file" % filename)
 
810
        for fip in inv.get_idpath(fid):
 
811
            print fip
 
812
 
 
813
 
 
814
class cmd_reconcile(Command):
 
815
    """Reconcile bzr metadata in a branch.
 
816
 
 
817
    This can correct data mismatches that may have been caused by
 
818
    previous ghost operations or bzr upgrades. You should only
 
819
    need to run this command if 'bzr check' or a bzr developer 
 
820
    advises you to run it.
 
821
 
 
822
    If a second branch is provided, cross-branch reconciliation is
 
823
    also attempted, which will check that data like the tree root
 
824
    id which was not present in very early bzr versions is represented
 
825
    correctly in both branches.
 
826
 
 
827
    At the same time it is run it may recompress data resulting in 
 
828
    a potential saving in disk space or performance gain.
 
829
 
 
830
    The branch *MUST* be on a listable system such as local disk or sftp.
 
831
    """
 
832
    takes_args = ['branch?']
 
833
 
 
834
    def run(self, branch="."):
 
835
        from bzrlib.reconcile import reconcile
 
836
        dir = bzrlib.bzrdir.BzrDir.open(branch)
 
837
        reconcile(dir)
 
838
 
 
839
 
 
840
class cmd_revision_history(Command):
 
841
    """Display list of revision ids on this branch."""
 
842
    hidden = True
 
843
    @display_command
 
844
    def run(self):
 
845
        branch = WorkingTree.open_containing(u'.')[0].branch
 
846
        for patchid in branch.revision_history():
 
847
            print patchid
 
848
 
 
849
 
 
850
class cmd_ancestry(Command):
 
851
    """List all revisions merged into this branch."""
 
852
    hidden = True
 
853
    @display_command
 
854
    def run(self):
 
855
        tree = WorkingTree.open_containing(u'.')[0]
 
856
        b = tree.branch
 
857
        # FIXME. should be tree.last_revision
 
858
        for revision_id in b.repository.get_ancestry(b.last_revision()):
 
859
            print revision_id
 
860
 
 
861
 
 
862
class cmd_init(Command):
 
863
    """Make a directory into a versioned branch.
 
864
 
 
865
    Use this to create an empty branch, or before importing an
 
866
    existing project.
 
867
 
 
868
    Recipe for importing a tree of files:
 
869
        cd ~/project
 
870
        bzr init
 
871
        bzr add .
 
872
        bzr status
 
873
        bzr commit -m 'imported project'
 
874
    """
 
875
    takes_args = ['location?']
 
876
    takes_options = [
 
877
                     Option('format', 
 
878
                            help='Create a specific format rather than the'
 
879
                                 ' current default format. Currently this '
 
880
                                 ' option only accepts =metadir',
 
881
                            type=get_format_type),
 
882
                     ]
 
883
    def run(self, location=None, format=None):
 
884
        from bzrlib.branch import Branch
 
885
        if location is None:
 
886
            location = u'.'
 
887
        else:
 
888
            # The path has to exist to initialize a
 
889
            # branch inside of it.
 
890
            # Just using os.mkdir, since I don't
 
891
            # believe that we want to create a bunch of
 
892
            # locations if the user supplies an extended path
 
893
            if not os.path.exists(location):
 
894
                os.mkdir(location)
 
895
        bzrdir.BzrDir.create_branch_convenience(location, format=format)
 
896
 
 
897
 
 
898
class cmd_init_repository(Command):
 
899
    """Create a shared repository to keep branches in."""
 
900
    takes_args = ["location"] 
 
901
    takes_options = [Option('format', 
 
902
                            help='Use a specific format rather than the'
 
903
                            ' current default format. Currently this'
 
904
                            ' option only accepts "metadir" and "knit"'
 
905
                            ' WARNING: the knit format is currently unstable'
 
906
                            ' and only for experimental use.',
 
907
                            type=get_format_type),
 
908
                     Option('trees',
 
909
                             help='Allows branches in repository to have'
 
910
                             ' a working tree')]
 
911
    aliases = ["init-repo"]
 
912
    def run(self, location, format=None, trees=False):
 
913
        from bzrlib.bzrdir import BzrDirMetaFormat1
 
914
        from bzrlib.transport import get_transport
 
915
        if format is None:
 
916
            format = BzrDirMetaFormat1()
 
917
        get_transport(location).mkdir('')
 
918
        newdir = format.initialize(location)
 
919
        repo = newdir.create_repository(shared=True)
 
920
        repo.set_make_working_trees(trees)
 
921
 
 
922
 
 
923
class cmd_diff(Command):
 
924
    """Show differences in working tree.
 
925
    
 
926
    If files are listed, only the changes in those files are listed.
 
927
    Otherwise, all changes for the tree are listed.
 
928
 
 
929
    examples:
 
930
        bzr diff
 
931
        bzr diff -r1
 
932
        bzr diff -r1..2
 
933
    """
 
934
    # TODO: Allow diff across branches.
 
935
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
936
    #       or a graphical diff.
 
937
 
 
938
    # TODO: Python difflib is not exactly the same as unidiff; should
 
939
    #       either fix it up or prefer to use an external diff.
 
940
 
 
941
    # TODO: If a directory is given, diff everything under that.
 
942
 
 
943
    # TODO: Selected-file diff is inefficient and doesn't show you
 
944
    #       deleted files.
 
945
 
 
946
    # TODO: This probably handles non-Unix newlines poorly.
 
947
    
 
948
    takes_args = ['file*']
 
949
    takes_options = ['revision', 'diff-options']
 
950
    aliases = ['di', 'dif']
 
951
 
 
952
    @display_command
 
953
    def run(self, revision=None, file_list=None, diff_options=None):
 
954
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
955
        try:
 
956
            tree1, file_list = internal_tree_files(file_list)
 
957
            tree2 = None
 
958
            b = None
 
959
            b2 = None
 
960
        except FileInWrongBranch:
 
961
            if len(file_list) != 2:
 
962
                raise BzrCommandError("Files are in different branches")
 
963
 
 
964
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
965
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
966
            if file1 != "" or file2 != "":
 
967
                # FIXME diff those two files. rbc 20051123
 
968
                raise BzrCommandError("Files are in different branches")
 
969
            file_list = None
 
970
        if revision is not None:
 
971
            if tree2 is not None:
 
972
                raise BzrCommandError("Can't specify -r with two branches")
 
973
            if (len(revision) == 1) or (revision[1].spec is None):
 
974
                return diff_cmd_helper(tree1, file_list, diff_options,
 
975
                                       revision[0])
 
976
            elif len(revision) == 2:
 
977
                return diff_cmd_helper(tree1, file_list, diff_options,
 
978
                                       revision[0], revision[1])
 
979
            else:
 
980
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
981
        else:
 
982
            if tree2 is not None:
 
983
                return show_diff_trees(tree1, tree2, sys.stdout, 
 
984
                                       specific_files=file_list,
 
985
                                       external_diff_options=diff_options)
 
986
            else:
 
987
                return diff_cmd_helper(tree1, file_list, diff_options)
 
988
 
 
989
 
 
990
class cmd_deleted(Command):
 
991
    """List files deleted in the working tree.
 
992
    """
 
993
    # TODO: Show files deleted since a previous revision, or
 
994
    # between two revisions.
 
995
    # TODO: Much more efficient way to do this: read in new
 
996
    # directories with readdir, rather than stating each one.  Same
 
997
    # level of effort but possibly much less IO.  (Or possibly not,
 
998
    # if the directories are very large...)
 
999
    @display_command
 
1000
    def run(self, show_ids=False):
 
1001
        tree = WorkingTree.open_containing(u'.')[0]
 
1002
        old = tree.basis_tree()
 
1003
        for path, ie in old.inventory.iter_entries():
 
1004
            if not tree.has_id(ie.file_id):
 
1005
                if show_ids:
 
1006
                    print '%-50s %s' % (path, ie.file_id)
 
1007
                else:
 
1008
                    print path
 
1009
 
 
1010
 
 
1011
class cmd_modified(Command):
 
1012
    """List files modified in working tree."""
 
1013
    hidden = True
 
1014
    @display_command
 
1015
    def run(self):
 
1016
        from bzrlib.delta import compare_trees
 
1017
 
 
1018
        tree = WorkingTree.open_containing(u'.')[0]
 
1019
        td = compare_trees(tree.basis_tree(), tree)
 
1020
 
 
1021
        for path, id, kind, text_modified, meta_modified in td.modified:
 
1022
            print path
 
1023
 
 
1024
 
 
1025
 
 
1026
class cmd_added(Command):
 
1027
    """List files added in working tree."""
 
1028
    hidden = True
 
1029
    @display_command
 
1030
    def run(self):
 
1031
        wt = WorkingTree.open_containing(u'.')[0]
 
1032
        basis_inv = wt.basis_tree().inventory
 
1033
        inv = wt.inventory
 
1034
        for file_id in inv:
 
1035
            if file_id in basis_inv:
 
1036
                continue
 
1037
            path = inv.id2path(file_id)
 
1038
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
1039
                continue
 
1040
            print path
 
1041
                
 
1042
        
 
1043
 
 
1044
class cmd_root(Command):
 
1045
    """Show the tree root directory.
 
1046
 
 
1047
    The root is the nearest enclosing directory with a .bzr control
 
1048
    directory."""
 
1049
    takes_args = ['filename?']
 
1050
    @display_command
 
1051
    def run(self, filename=None):
 
1052
        """Print the branch root."""
 
1053
        tree = WorkingTree.open_containing(filename)[0]
 
1054
        print tree.basedir
 
1055
 
 
1056
 
 
1057
class cmd_log(Command):
 
1058
    """Show log of this branch.
 
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
 
 
1065
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
1066
 
 
1067
    takes_args = ['filename?']
 
1068
    takes_options = [Option('forward', 
 
1069
                            help='show from oldest to newest'),
 
1070
                     'timezone', 'verbose', 
 
1071
                     'show-ids', 'revision',
 
1072
                     'log-format',
 
1073
                     'line', 'long', 
 
1074
                     Option('message',
 
1075
                            help='show revisions whose message matches this regexp',
 
1076
                            type=str),
 
1077
                     'short',
 
1078
                     ]
 
1079
    @display_command
 
1080
    def run(self, filename=None, timezone='original',
 
1081
            verbose=False,
 
1082
            show_ids=False,
 
1083
            forward=False,
 
1084
            revision=None,
 
1085
            log_format=None,
 
1086
            message=None,
 
1087
            long=False,
 
1088
            short=False,
 
1089
            line=False):
 
1090
        from bzrlib.log import log_formatter, show_log
 
1091
        import codecs
 
1092
        assert message is None or isinstance(message, basestring), \
 
1093
            "invalid message argument %r" % message
 
1094
        direction = (forward and 'forward') or 'reverse'
 
1095
        
 
1096
        # log everything
 
1097
        file_id = None
 
1098
        if filename:
 
1099
            # find the file id to log:
 
1100
 
 
1101
            dir, fp = bzrdir.BzrDir.open_containing(filename)
 
1102
            b = dir.open_branch()
 
1103
            if fp != '':
 
1104
                try:
 
1105
                    # might be a tree:
 
1106
                    inv = dir.open_workingtree().inventory
 
1107
                except (errors.NotBranchError, errors.NotLocalUrl):
 
1108
                    # either no tree, or is remote.
 
1109
                    inv = b.basis_tree().inventory
 
1110
                file_id = inv.path2id(fp)
 
1111
        else:
 
1112
            # local dir only
 
1113
            # FIXME ? log the current subdir only RBC 20060203 
 
1114
            dir, relpath = bzrdir.BzrDir.open_containing('.')
 
1115
            b = dir.open_branch()
 
1116
 
 
1117
        if revision is None:
 
1118
            rev1 = None
 
1119
            rev2 = None
 
1120
        elif len(revision) == 1:
 
1121
            rev1 = rev2 = revision[0].in_history(b).revno
 
1122
        elif len(revision) == 2:
 
1123
            if revision[0].spec is None:
 
1124
                # missing begin-range means first revision
 
1125
                rev1 = 1
 
1126
            else:
 
1127
                rev1 = revision[0].in_history(b).revno
 
1128
 
 
1129
            if revision[1].spec is None:
 
1130
                # missing end-range means last known revision
 
1131
                rev2 = b.revno()
 
1132
            else:
 
1133
                rev2 = revision[1].in_history(b).revno
 
1134
        else:
 
1135
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
1136
 
 
1137
        # By this point, the revision numbers are converted to the +ve
 
1138
        # form if they were supplied in the -ve form, so we can do
 
1139
        # this comparison in relative safety
 
1140
        if rev1 > rev2:
 
1141
            (rev2, rev1) = (rev1, rev2)
 
1142
 
 
1143
        mutter('encoding log as %r', bzrlib.user_encoding)
 
1144
 
 
1145
        # use 'replace' so that we don't abort if trying to write out
 
1146
        # in e.g. the default C locale.
 
1147
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
1148
 
 
1149
        if (log_format == None):
 
1150
            default = bzrlib.config.BranchConfig(b).log_format()
 
1151
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
1152
 
 
1153
        lf = log_formatter(log_format,
 
1154
                           show_ids=show_ids,
 
1155
                           to_file=outf,
 
1156
                           show_timezone=timezone)
 
1157
 
 
1158
        show_log(b,
 
1159
                 lf,
 
1160
                 file_id,
 
1161
                 verbose=verbose,
 
1162
                 direction=direction,
 
1163
                 start_revision=rev1,
 
1164
                 end_revision=rev2,
 
1165
                 search=message)
 
1166
 
 
1167
 
 
1168
def get_log_format(long=False, short=False, line=False, default='long'):
 
1169
    log_format = default
 
1170
    if long:
 
1171
        log_format = 'long'
 
1172
    if short:
 
1173
        log_format = 'short'
 
1174
    if line:
 
1175
        log_format = 'line'
 
1176
    return log_format
 
1177
 
 
1178
 
 
1179
class cmd_touching_revisions(Command):
 
1180
    """Return revision-ids which affected a particular file.
 
1181
 
 
1182
    A more user-friendly interface is "bzr log FILE"."""
 
1183
    hidden = True
 
1184
    takes_args = ["filename"]
 
1185
    @display_command
 
1186
    def run(self, filename):
 
1187
        tree, relpath = WorkingTree.open_containing(filename)
 
1188
        b = tree.branch
 
1189
        inv = tree.read_working_inventory()
 
1190
        file_id = inv.path2id(relpath)
 
1191
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
1192
            print "%6d %s" % (revno, what)
 
1193
 
 
1194
 
 
1195
class cmd_ls(Command):
 
1196
    """List files in a tree.
 
1197
    """
 
1198
    # TODO: Take a revision or remote path and list that tree instead.
 
1199
    hidden = True
 
1200
    takes_options = ['verbose', 'revision',
 
1201
                     Option('non-recursive',
 
1202
                            help='don\'t recurse into sub-directories'),
 
1203
                     Option('from-root',
 
1204
                            help='Print all paths from the root of the branch.'),
 
1205
                     Option('unknown', help='Print unknown files'),
 
1206
                     Option('versioned', help='Print versioned files'),
 
1207
                     Option('ignored', help='Print ignored files'),
 
1208
 
 
1209
                     Option('null', help='Null separate the files'),
 
1210
                    ]
 
1211
    @display_command
 
1212
    def run(self, revision=None, verbose=False, 
 
1213
            non_recursive=False, from_root=False,
 
1214
            unknown=False, versioned=False, ignored=False,
 
1215
            null=False):
 
1216
 
 
1217
        if verbose and null:
 
1218
            raise BzrCommandError('Cannot set both --verbose and --null')
 
1219
        all = not (unknown or versioned or ignored)
 
1220
 
 
1221
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
1222
 
 
1223
        tree, relpath = WorkingTree.open_containing(u'.')
 
1224
        if from_root:
 
1225
            relpath = u''
 
1226
        elif relpath:
 
1227
            relpath += '/'
 
1228
        if revision is not None:
 
1229
            tree = tree.branch.repository.revision_tree(
 
1230
                revision[0].in_history(tree.branch).rev_id)
 
1231
        for fp, fc, kind, fid, entry in tree.list_files():
 
1232
            if fp.startswith(relpath):
 
1233
                fp = fp[len(relpath):]
 
1234
                if non_recursive and '/' in fp:
 
1235
                    continue
 
1236
                if not all and not selection[fc]:
 
1237
                    continue
 
1238
                if verbose:
 
1239
                    kindch = entry.kind_character()
 
1240
                    print '%-8s %s%s' % (fc, fp, kindch)
 
1241
                elif null:
 
1242
                    sys.stdout.write(fp)
 
1243
                    sys.stdout.write('\0')
 
1244
                    sys.stdout.flush()
 
1245
                else:
 
1246
                    print fp
 
1247
 
 
1248
 
 
1249
class cmd_unknowns(Command):
 
1250
    """List unknown files."""
 
1251
    @display_command
 
1252
    def run(self):
 
1253
        from bzrlib.osutils import quotefn
 
1254
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
1255
            print quotefn(f)
 
1256
 
 
1257
 
 
1258
class cmd_ignore(Command):
 
1259
    """Ignore a command or pattern.
 
1260
 
 
1261
    To remove patterns from the ignore list, edit the .bzrignore file.
 
1262
 
 
1263
    If the pattern contains a slash, it is compared to the whole path
 
1264
    from the branch root.  Otherwise, it is compared to only the last
 
1265
    component of the path.  To match a file only in the root directory,
 
1266
    prepend './'.
 
1267
 
 
1268
    Ignore patterns are case-insensitive on case-insensitive systems.
 
1269
 
 
1270
    Note: wildcards must be quoted from the shell on Unix.
 
1271
 
 
1272
    examples:
 
1273
        bzr ignore ./Makefile
 
1274
        bzr ignore '*.class'
 
1275
    """
 
1276
    # TODO: Complain if the filename is absolute
 
1277
    takes_args = ['name_pattern']
 
1278
    
 
1279
    def run(self, name_pattern):
 
1280
        from bzrlib.atomicfile import AtomicFile
 
1281
        import os.path
 
1282
 
 
1283
        tree, relpath = WorkingTree.open_containing(u'.')
 
1284
        ifn = tree.abspath('.bzrignore')
 
1285
 
 
1286
        if os.path.exists(ifn):
 
1287
            f = open(ifn, 'rt')
 
1288
            try:
 
1289
                igns = f.read().decode('utf-8')
 
1290
            finally:
 
1291
                f.close()
 
1292
        else:
 
1293
            igns = ''
 
1294
 
 
1295
        # TODO: If the file already uses crlf-style termination, maybe
 
1296
        # we should use that for the newly added lines?
 
1297
 
 
1298
        if igns and igns[-1] != '\n':
 
1299
            igns += '\n'
 
1300
        igns += name_pattern + '\n'
 
1301
 
 
1302
        try:
 
1303
            f = AtomicFile(ifn, 'wt')
 
1304
            f.write(igns.encode('utf-8'))
 
1305
            f.commit()
 
1306
        finally:
 
1307
            f.close()
 
1308
 
 
1309
        inv = tree.inventory
 
1310
        if inv.path2id('.bzrignore'):
 
1311
            mutter('.bzrignore is already versioned')
 
1312
        else:
 
1313
            mutter('need to make new .bzrignore file versioned')
 
1314
            tree.add(['.bzrignore'])
 
1315
 
 
1316
 
 
1317
class cmd_ignored(Command):
 
1318
    """List ignored files and the patterns that matched them.
 
1319
 
 
1320
    See also: bzr ignore"""
 
1321
    @display_command
 
1322
    def run(self):
 
1323
        tree = WorkingTree.open_containing(u'.')[0]
 
1324
        for path, file_class, kind, file_id, entry in tree.list_files():
 
1325
            if file_class != 'I':
 
1326
                continue
 
1327
            ## XXX: Slightly inefficient since this was already calculated
 
1328
            pat = tree.is_ignored(path)
 
1329
            print '%-50s %s' % (path, pat)
 
1330
 
 
1331
 
 
1332
class cmd_lookup_revision(Command):
 
1333
    """Lookup the revision-id from a revision-number
 
1334
 
 
1335
    example:
 
1336
        bzr lookup-revision 33
 
1337
    """
 
1338
    hidden = True
 
1339
    takes_args = ['revno']
 
1340
    
 
1341
    @display_command
 
1342
    def run(self, revno):
 
1343
        try:
 
1344
            revno = int(revno)
 
1345
        except ValueError:
 
1346
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
1347
 
 
1348
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
1349
 
 
1350
 
 
1351
class cmd_export(Command):
 
1352
    """Export past revision to destination directory.
 
1353
 
 
1354
    If no revision is specified this exports the last committed revision.
 
1355
 
 
1356
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
1357
    given, try to find the format with the extension. If no extension
 
1358
    is found exports to a directory (equivalent to --format=dir).
 
1359
 
 
1360
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
1361
    is given, the top directory will be the root name of the file.
 
1362
 
 
1363
    Note: export of tree with non-ascii filenames to zip is not supported.
 
1364
 
 
1365
     Supported formats       Autodetected by extension
 
1366
     -----------------       -------------------------
 
1367
         dir                            -
 
1368
         tar                          .tar
 
1369
         tbz2                    .tar.bz2, .tbz2
 
1370
         tgz                      .tar.gz, .tgz
 
1371
         zip                          .zip
 
1372
    """
 
1373
    takes_args = ['dest']
 
1374
    takes_options = ['revision', 'format', 'root']
 
1375
    def run(self, dest, revision=None, format=None, root=None):
 
1376
        import os.path
 
1377
        from bzrlib.export import export
 
1378
        tree = WorkingTree.open_containing(u'.')[0]
 
1379
        b = tree.branch
 
1380
        if revision is None:
 
1381
            # should be tree.last_revision  FIXME
 
1382
            rev_id = b.last_revision()
 
1383
        else:
 
1384
            if len(revision) != 1:
 
1385
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
1386
            rev_id = revision[0].in_history(b).rev_id
 
1387
        t = b.repository.revision_tree(rev_id)
 
1388
        try:
 
1389
            export(t, dest, format, root)
 
1390
        except errors.NoSuchExportFormat, e:
 
1391
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
1392
 
 
1393
 
 
1394
class cmd_cat(Command):
 
1395
    """Write a file's text from a previous revision."""
 
1396
 
 
1397
    takes_options = ['revision']
 
1398
    takes_args = ['filename']
 
1399
 
 
1400
    @display_command
 
1401
    def run(self, filename, revision=None):
 
1402
        if revision is not None and len(revision) != 1:
 
1403
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
1404
        tree = None
 
1405
        try:
 
1406
            tree, relpath = WorkingTree.open_containing(filename)
 
1407
            b = tree.branch
 
1408
        except NotBranchError:
 
1409
            pass
 
1410
 
 
1411
        if tree is None:
 
1412
            b, relpath = Branch.open_containing(filename)
 
1413
        if revision is None:
 
1414
            revision_id = b.last_revision()
 
1415
        else:
 
1416
            revision_id = revision[0].in_history(b).rev_id
 
1417
        b.print_file(relpath, revision_id)
 
1418
 
 
1419
 
 
1420
class cmd_local_time_offset(Command):
 
1421
    """Show the offset in seconds from GMT to local time."""
 
1422
    hidden = True    
 
1423
    @display_command
 
1424
    def run(self):
 
1425
        print bzrlib.osutils.local_time_offset()
 
1426
 
 
1427
 
 
1428
 
 
1429
class cmd_commit(Command):
 
1430
    """Commit changes into a new revision.
 
1431
    
 
1432
    If no arguments are given, the entire tree is committed.
 
1433
 
 
1434
    If selected files are specified, only changes to those files are
 
1435
    committed.  If a directory is specified then the directory and everything 
 
1436
    within it is committed.
 
1437
 
 
1438
    A selected-file commit may fail in some cases where the committed
 
1439
    tree would be invalid, such as trying to commit a file in a
 
1440
    newly-added directory that is not itself committed.
 
1441
    """
 
1442
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
1443
 
 
1444
    # TODO: Strict commit that fails if there are deleted files.
 
1445
    #       (what does "deleted files" mean ??)
 
1446
 
 
1447
    # TODO: Give better message for -s, --summary, used by tla people
 
1448
 
 
1449
    # XXX: verbose currently does nothing
 
1450
 
 
1451
    takes_args = ['selected*']
 
1452
    takes_options = ['message', 'verbose', 
 
1453
                     Option('unchanged',
 
1454
                            help='commit even if nothing has changed'),
 
1455
                     Option('file', type=str, 
 
1456
                            argname='msgfile',
 
1457
                            help='file containing commit message'),
 
1458
                     Option('strict',
 
1459
                            help="refuse to commit if there are unknown "
 
1460
                            "files in the working tree."),
 
1461
                     Option('local',
 
1462
                            help="perform a local only commit in a bound "
 
1463
                                 "branch. Such commits are not pushed to "
 
1464
                                 "the master branch until a normal commit "
 
1465
                                 "is performed."
 
1466
                            ),
 
1467
                     ]
 
1468
    aliases = ['ci', 'checkin']
 
1469
 
 
1470
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
1471
            unchanged=False, strict=False, local=False):
 
1472
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
1473
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
1474
                StrictCommitFailed)
 
1475
        from bzrlib.msgeditor import edit_commit_message, \
 
1476
                make_commit_message_template
 
1477
        from tempfile import TemporaryFile
 
1478
        import codecs
 
1479
 
 
1480
        # TODO: Need a blackbox test for invoking the external editor; may be
 
1481
        # slightly problematic to run this cross-platform.
 
1482
 
 
1483
        # TODO: do more checks that the commit will succeed before 
 
1484
        # spending the user's valuable time typing a commit message.
 
1485
        #
 
1486
        # TODO: if the commit *does* happen to fail, then save the commit 
 
1487
        # message to a temporary file where it can be recovered
 
1488
        tree, selected_list = tree_files(selected_list)
 
1489
        if local and not tree.branch.get_bound_location():
 
1490
            raise errors.LocalRequiresBoundBranch()
 
1491
        if message is None and not file:
 
1492
            template = make_commit_message_template(tree, selected_list)
 
1493
            message = edit_commit_message(template)
 
1494
            if message is None:
 
1495
                raise BzrCommandError("please specify a commit message"
 
1496
                                      " with either --message or --file")
 
1497
        elif message and file:
 
1498
            raise BzrCommandError("please specify either --message or --file")
 
1499
        
 
1500
        if file:
 
1501
            import codecs
 
1502
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
1503
 
 
1504
        if message == "":
 
1505
                raise BzrCommandError("empty commit message specified")
 
1506
        
 
1507
        if verbose:
 
1508
            reporter = ReportCommitToLog()
 
1509
        else:
 
1510
            reporter = NullCommitReporter()
 
1511
        
 
1512
        try:
 
1513
            tree.commit(message, specific_files=selected_list,
 
1514
                        allow_pointless=unchanged, strict=strict, local=local,
 
1515
                        reporter=reporter)
 
1516
        except PointlessCommit:
 
1517
            # FIXME: This should really happen before the file is read in;
 
1518
            # perhaps prepare the commit; get the message; then actually commit
 
1519
            raise BzrCommandError("no changes to commit",
 
1520
                                  ["use --unchanged to commit anyhow"])
 
1521
        except ConflictsInTree:
 
1522
            raise BzrCommandError("Conflicts detected in working tree.  "
 
1523
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
1524
        except StrictCommitFailed:
 
1525
            raise BzrCommandError("Commit refused because there are unknown "
 
1526
                                  "files in the working tree.")
 
1527
        except errors.BoundBranchOutOfDate, e:
 
1528
            raise BzrCommandError(str(e)
 
1529
                                  + ' Either unbind, update, or'
 
1530
                                    ' pass --local to commit.')
 
1531
 
 
1532
 
 
1533
class cmd_check(Command):
 
1534
    """Validate consistency of branch history.
 
1535
 
 
1536
    This command checks various invariants about the branch storage to
 
1537
    detect data corruption or bzr bugs.
 
1538
    """
 
1539
    takes_args = ['branch?']
 
1540
    takes_options = ['verbose']
 
1541
 
 
1542
    def run(self, branch=None, verbose=False):
 
1543
        from bzrlib.check import check
 
1544
        if branch is None:
 
1545
            tree = WorkingTree.open_containing()[0]
 
1546
            branch = tree.branch
 
1547
        else:
 
1548
            branch = Branch.open(branch)
 
1549
        check(branch, verbose)
 
1550
 
 
1551
 
 
1552
class cmd_scan_cache(Command):
 
1553
    hidden = True
 
1554
    def run(self):
 
1555
        from bzrlib.hashcache import HashCache
 
1556
 
 
1557
        c = HashCache(u'.')
 
1558
        c.read()
 
1559
        c.scan()
 
1560
            
 
1561
        print '%6d stats' % c.stat_count
 
1562
        print '%6d in hashcache' % len(c._cache)
 
1563
        print '%6d files removed from cache' % c.removed_count
 
1564
        print '%6d hashes updated' % c.update_count
 
1565
        print '%6d files changed too recently to cache' % c.danger_count
 
1566
 
 
1567
        if c.needs_write:
 
1568
            c.write()
 
1569
 
 
1570
 
 
1571
class cmd_upgrade(Command):
 
1572
    """Upgrade branch storage to current format.
 
1573
 
 
1574
    The check command or bzr developers may sometimes advise you to run
 
1575
    this command. When the default format has changed you may also be warned
 
1576
    during other operations to upgrade.
 
1577
    """
 
1578
    takes_args = ['url?']
 
1579
    takes_options = [
 
1580
                     Option('format', 
 
1581
                            help='Upgrade to a specific format rather than the'
 
1582
                                 ' current default format. Currently this'
 
1583
                                 ' option only accepts -metadir and -knit'
 
1584
                                 ' WARNING: the knit format is currently'
 
1585
                                 ' unstable and only for experimental use.',
 
1586
                            type=get_format_type),
 
1587
                    ]
 
1588
 
 
1589
 
 
1590
    def run(self, url='.', format=None):
 
1591
        from bzrlib.upgrade import upgrade
 
1592
        upgrade(url, format)
 
1593
 
 
1594
 
 
1595
class cmd_whoami(Command):
 
1596
    """Show bzr user id."""
 
1597
    takes_options = ['email']
 
1598
    
 
1599
    @display_command
 
1600
    def run(self, email=False):
 
1601
        try:
 
1602
            b = WorkingTree.open_containing(u'.')[0].branch
 
1603
            config = bzrlib.config.BranchConfig(b)
 
1604
        except NotBranchError:
 
1605
            config = bzrlib.config.GlobalConfig()
 
1606
        
 
1607
        if email:
 
1608
            print config.user_email()
 
1609
        else:
 
1610
            print config.username()
 
1611
 
 
1612
 
 
1613
class cmd_nick(Command):
 
1614
    """Print or set the branch nickname.  
 
1615
 
 
1616
    If unset, the tree root directory name is used as the nickname
 
1617
    To print the current nickname, execute with no argument.  
 
1618
    """
 
1619
    takes_args = ['nickname?']
 
1620
    def run(self, nickname=None):
 
1621
        branch = Branch.open_containing(u'.')[0]
 
1622
        if nickname is None:
 
1623
            self.printme(branch)
 
1624
        else:
 
1625
            branch.nick = nickname
 
1626
 
 
1627
    @display_command
 
1628
    def printme(self, branch):
 
1629
        print branch.nick 
 
1630
 
 
1631
 
 
1632
class cmd_selftest(Command):
 
1633
    """Run internal test suite.
 
1634
    
 
1635
    This creates temporary test directories in the working directory,
 
1636
    but not existing data is affected.  These directories are deleted
 
1637
    if the tests pass, or left behind to help in debugging if they
 
1638
    fail and --keep-output is specified.
 
1639
    
 
1640
    If arguments are given, they are regular expressions that say
 
1641
    which tests should run.
 
1642
 
 
1643
    If the global option '--no-plugins' is given, plugins are not loaded
 
1644
    before running the selftests.  This has two effects: features provided or
 
1645
    modified by plugins will not be tested, and tests provided by plugins will
 
1646
    not be run.
 
1647
 
 
1648
    examples:
 
1649
        bzr selftest ignore
 
1650
        bzr --no-plugins selftest -v
 
1651
    """
 
1652
    # TODO: --list should give a list of all available tests
 
1653
 
 
1654
    # NB: this is used from the class without creating an instance, which is
 
1655
    # why it does not have a self parameter.
 
1656
    def get_transport_type(typestring):
 
1657
        """Parse and return a transport specifier."""
 
1658
        if typestring == "sftp":
 
1659
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
1660
            return SFTPAbsoluteServer
 
1661
        if typestring == "memory":
 
1662
            from bzrlib.transport.memory import MemoryServer
 
1663
            return MemoryServer
 
1664
        if typestring == "fakenfs":
 
1665
            from bzrlib.transport.fakenfs import FakeNFSServer
 
1666
            return FakeNFSServer
 
1667
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
1668
            (typestring)
 
1669
        raise BzrCommandError(msg)
 
1670
 
 
1671
    hidden = True
 
1672
    takes_args = ['testspecs*']
 
1673
    takes_options = ['verbose',
 
1674
                     Option('one', help='stop when one test fails'),
 
1675
                     Option('keep-output', 
 
1676
                            help='keep output directories when tests fail'),
 
1677
                     Option('transport', 
 
1678
                            help='Use a different transport by default '
 
1679
                                 'throughout the test suite.',
 
1680
                            type=get_transport_type),
 
1681
                    ]
 
1682
 
 
1683
    def run(self, testspecs_list=None, verbose=False, one=False,
 
1684
            keep_output=False, transport=None):
 
1685
        import bzrlib.ui
 
1686
        from bzrlib.tests import selftest
 
1687
        # we don't want progress meters from the tests to go to the
 
1688
        # real output; and we don't want log messages cluttering up
 
1689
        # the real logs.
 
1690
        save_ui = bzrlib.ui.ui_factory
 
1691
        bzrlib.trace.info('running tests...')
 
1692
        try:
 
1693
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
1694
            if testspecs_list is not None:
 
1695
                pattern = '|'.join(testspecs_list)
 
1696
            else:
 
1697
                pattern = ".*"
 
1698
            result = selftest(verbose=verbose, 
 
1699
                              pattern=pattern,
 
1700
                              stop_on_failure=one, 
 
1701
                              keep_output=keep_output,
 
1702
                              transport=transport)
 
1703
            if result:
 
1704
                bzrlib.trace.info('tests passed')
 
1705
            else:
 
1706
                bzrlib.trace.info('tests failed')
 
1707
            return int(not result)
 
1708
        finally:
 
1709
            bzrlib.ui.ui_factory = save_ui
 
1710
 
 
1711
 
 
1712
def _get_bzr_branch():
 
1713
    """If bzr is run from a branch, return Branch or None"""
 
1714
    import bzrlib.errors
 
1715
    from bzrlib.branch import Branch
 
1716
    from bzrlib.osutils import abspath
 
1717
    from os.path import dirname
 
1718
    
 
1719
    try:
 
1720
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
1721
        return branch
 
1722
    except bzrlib.errors.BzrError:
 
1723
        return None
 
1724
    
 
1725
 
 
1726
def show_version():
 
1727
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
1728
    # is bzrlib itself in a branch?
 
1729
    branch = _get_bzr_branch()
 
1730
    if branch:
 
1731
        rh = branch.revision_history()
 
1732
        revno = len(rh)
 
1733
        print "  bzr checkout, revision %d" % (revno,)
 
1734
        print "  nick: %s" % (branch.nick,)
 
1735
        if rh:
 
1736
            print "  revid: %s" % (rh[-1],)
 
1737
    print bzrlib.__copyright__
 
1738
    print "http://bazaar-ng.org/"
 
1739
    print
 
1740
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
1741
    print "you may use, modify and redistribute it under the terms of the GNU"
 
1742
    print "General Public License version 2 or later."
 
1743
 
 
1744
 
 
1745
class cmd_version(Command):
 
1746
    """Show version of bzr."""
 
1747
    @display_command
 
1748
    def run(self):
 
1749
        show_version()
 
1750
 
 
1751
class cmd_rocks(Command):
 
1752
    """Statement of optimism."""
 
1753
    hidden = True
 
1754
    @display_command
 
1755
    def run(self):
 
1756
        print "it sure does!"
 
1757
 
 
1758
 
 
1759
class cmd_find_merge_base(Command):
 
1760
    """Find and print a base revision for merging two branches.
 
1761
    """
 
1762
    # TODO: Options to specify revisions on either side, as if
 
1763
    #       merging only part of the history.
 
1764
    takes_args = ['branch', 'other']
 
1765
    hidden = True
 
1766
    
 
1767
    @display_command
 
1768
    def run(self, branch, other):
 
1769
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
1770
        
 
1771
        branch1 = Branch.open_containing(branch)[0]
 
1772
        branch2 = Branch.open_containing(other)[0]
 
1773
 
 
1774
        history_1 = branch1.revision_history()
 
1775
        history_2 = branch2.revision_history()
 
1776
 
 
1777
        last1 = branch1.last_revision()
 
1778
        last2 = branch2.last_revision()
 
1779
 
 
1780
        source = MultipleRevisionSources(branch1.repository, 
 
1781
                                         branch2.repository)
 
1782
        
 
1783
        base_rev_id = common_ancestor(last1, last2, source)
 
1784
 
 
1785
        print 'merge base is revision %s' % base_rev_id
 
1786
        
 
1787
        return
 
1788
 
 
1789
        if base_revno is None:
 
1790
            raise bzrlib.errors.UnrelatedBranches()
 
1791
 
 
1792
        print ' r%-6d in %s' % (base_revno, branch)
 
1793
 
 
1794
        other_revno = branch2.revision_id_to_revno(base_revid)
 
1795
        
 
1796
        print ' r%-6d in %s' % (other_revno, other)
 
1797
 
 
1798
 
 
1799
 
 
1800
class cmd_merge(Command):
 
1801
    """Perform a three-way merge.
 
1802
    
 
1803
    The branch is the branch you will merge from.  By default, it will
 
1804
    merge the latest revision.  If you specify a revision, that
 
1805
    revision will be merged.  If you specify two revisions, the first
 
1806
    will be used as a BASE, and the second one as OTHER.  Revision
 
1807
    numbers are always relative to the specified branch.
 
1808
 
 
1809
    By default, bzr will try to merge in all new work from the other
 
1810
    branch, automatically determining an appropriate base.  If this
 
1811
    fails, you may need to give an explicit base.
 
1812
    
 
1813
    Merge will do its best to combine the changes in two branches, but there
 
1814
    are some kinds of problems only a human can fix.  When it encounters those,
 
1815
    it will mark a conflict.  A conflict means that you need to fix something,
 
1816
    before you should commit.
 
1817
 
 
1818
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
1819
 
 
1820
    Examples:
 
1821
 
 
1822
    To merge the latest revision from bzr.dev
 
1823
    bzr merge ../bzr.dev
 
1824
 
 
1825
    To merge changes up to and including revision 82 from bzr.dev
 
1826
    bzr merge -r 82 ../bzr.dev
 
1827
 
 
1828
    To merge the changes introduced by 82, without previous changes:
 
1829
    bzr merge -r 81..82 ../bzr.dev
 
1830
    
 
1831
    merge refuses to run if there are any uncommitted changes, unless
 
1832
    --force is given.
 
1833
    """
 
1834
    takes_args = ['branch?']
 
1835
    takes_options = ['revision', 'force', 'merge-type', 'reprocess',
 
1836
                     Option('show-base', help="Show base revision text in "
 
1837
                            "conflicts")]
 
1838
 
 
1839
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
1840
            show_base=False, reprocess=False):
 
1841
        if merge_type is None:
 
1842
            merge_type = Merge3Merger
 
1843
        if branch is None:
 
1844
            branch = WorkingTree.open_containing(u'.')[0].branch.get_parent()
 
1845
            if branch is None:
 
1846
                raise BzrCommandError("No merge location known or specified.")
 
1847
            else:
 
1848
                print "Using saved location: %s" % branch 
 
1849
        if revision is None or len(revision) < 1:
 
1850
            base = [None, None]
 
1851
            other = [branch, -1]
 
1852
        else:
 
1853
            if len(revision) == 1:
 
1854
                base = [None, None]
 
1855
                other_branch = Branch.open_containing(branch)[0]
 
1856
                revno = revision[0].in_history(other_branch).revno
 
1857
                other = [branch, revno]
 
1858
            else:
 
1859
                assert len(revision) == 2
 
1860
                if None in revision:
 
1861
                    raise BzrCommandError(
 
1862
                        "Merge doesn't permit that revision specifier.")
 
1863
                b = Branch.open_containing(branch)[0]
 
1864
 
 
1865
                base = [branch, revision[0].in_history(b).revno]
 
1866
                other = [branch, revision[1].in_history(b).revno]
 
1867
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1868
        try:
 
1869
            try:
 
1870
                conflict_count = merge(other, base, check_clean=(not force),
 
1871
                                       merge_type=merge_type, 
 
1872
                                       reprocess=reprocess,
 
1873
                                       show_base=show_base, 
 
1874
                                       pb=pb)
 
1875
            finally:
 
1876
                pb.finished()
 
1877
            if conflict_count != 0:
 
1878
                return 1
 
1879
            else:
 
1880
                return 0
 
1881
        except bzrlib.errors.AmbiguousBase, e:
 
1882
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
1883
                 "candidates are:\n  "
 
1884
                 + "\n  ".join(e.bases)
 
1885
                 + "\n"
 
1886
                 "please specify an explicit base with -r,\n"
 
1887
                 "and (if you want) report this to the bzr developers\n")
 
1888
            log_error(m)
 
1889
 
 
1890
 
 
1891
class cmd_remerge(Command):
 
1892
    """Redo a merge.
 
1893
    """
 
1894
    takes_args = ['file*']
 
1895
    takes_options = ['merge-type', 'reprocess',
 
1896
                     Option('show-base', help="Show base revision text in "
 
1897
                            "conflicts")]
 
1898
 
 
1899
    def run(self, file_list=None, merge_type=None, show_base=False,
 
1900
            reprocess=False):
 
1901
        from bzrlib.merge import merge_inner, transform_tree
 
1902
        if merge_type is None:
 
1903
            merge_type = Merge3Merger
 
1904
        tree, file_list = tree_files(file_list)
 
1905
        tree.lock_write()
 
1906
        try:
 
1907
            pending_merges = tree.pending_merges() 
 
1908
            if len(pending_merges) != 1:
 
1909
                raise BzrCommandError("Sorry, remerge only works after normal"
 
1910
                                      + " merges.  Not cherrypicking or"
 
1911
                                      + "multi-merges.")
 
1912
            repository = tree.branch.repository
 
1913
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
1914
                                            pending_merges[0], repository)
 
1915
            base_tree = repository.revision_tree(base_revision)
 
1916
            other_tree = repository.revision_tree(pending_merges[0])
 
1917
            interesting_ids = None
 
1918
            if file_list is not None:
 
1919
                interesting_ids = set()
 
1920
                for filename in file_list:
 
1921
                    file_id = tree.path2id(filename)
 
1922
                    if file_id is None:
 
1923
                        raise NotVersionedError(filename)
 
1924
                    interesting_ids.add(file_id)
 
1925
                    if tree.kind(file_id) != "directory":
 
1926
                        continue
 
1927
                    
 
1928
                    for name, ie in tree.inventory.iter_entries(file_id):
 
1929
                        interesting_ids.add(ie.file_id)
 
1930
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
1931
            if file_list is None:
 
1932
                restore_files = list(tree.iter_conflicts())
 
1933
            else:
 
1934
                restore_files = file_list
 
1935
            for filename in restore_files:
 
1936
                try:
 
1937
                    restore(tree.abspath(filename))
 
1938
                except NotConflicted:
 
1939
                    pass
 
1940
            conflicts =  merge_inner(tree.branch, other_tree, base_tree,
 
1941
                                     this_tree=tree,
 
1942
                                     interesting_ids = interesting_ids, 
 
1943
                                     other_rev_id=pending_merges[0], 
 
1944
                                     merge_type=merge_type, 
 
1945
                                     show_base=show_base,
 
1946
                                     reprocess=reprocess)
 
1947
        finally:
 
1948
            tree.unlock()
 
1949
        if conflicts > 0:
 
1950
            return 1
 
1951
        else:
 
1952
            return 0
 
1953
 
 
1954
class cmd_revert(Command):
 
1955
    """Reverse all changes since the last commit.
 
1956
 
 
1957
    Only versioned files are affected.  Specify filenames to revert only 
 
1958
    those files.  By default, any files that are changed will be backed up
 
1959
    first.  Backup files have a '~' appended to their name.
 
1960
    """
 
1961
    takes_options = ['revision', 'no-backup']
 
1962
    takes_args = ['file*']
 
1963
    aliases = ['merge-revert']
 
1964
 
 
1965
    def run(self, revision=None, no_backup=False, file_list=None):
 
1966
        from bzrlib.commands import parse_spec
 
1967
        if file_list is not None:
 
1968
            if len(file_list) == 0:
 
1969
                raise BzrCommandError("No files specified")
 
1970
        else:
 
1971
            file_list = []
 
1972
        
 
1973
        tree, file_list = tree_files(file_list)
 
1974
        if revision is None:
 
1975
            # FIXME should be tree.last_revision
 
1976
            rev_id = tree.last_revision()
 
1977
        elif len(revision) != 1:
 
1978
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
1979
        else:
 
1980
            rev_id = revision[0].in_history(tree.branch).rev_id
 
1981
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
1982
        try:
 
1983
            tree.revert(file_list, 
 
1984
                        tree.branch.repository.revision_tree(rev_id),
 
1985
                        not no_backup, pb)
 
1986
        finally:
 
1987
            pb.finished()
 
1988
 
 
1989
 
 
1990
class cmd_assert_fail(Command):
 
1991
    """Test reporting of assertion failures"""
 
1992
    hidden = True
 
1993
    def run(self):
 
1994
        assert False, "always fails"
 
1995
 
 
1996
 
 
1997
class cmd_help(Command):
 
1998
    """Show help on a command or other topic.
 
1999
 
 
2000
    For a list of all available commands, say 'bzr help commands'."""
 
2001
    takes_options = [Option('long', 'show help on all commands')]
 
2002
    takes_args = ['topic?']
 
2003
    aliases = ['?', '--help', '-?', '-h']
 
2004
    
 
2005
    @display_command
 
2006
    def run(self, topic=None, long=False):
 
2007
        import help
 
2008
        if topic is None and long:
 
2009
            topic = "commands"
 
2010
        help.help(topic)
 
2011
 
 
2012
 
 
2013
class cmd_shell_complete(Command):
 
2014
    """Show appropriate completions for context.
 
2015
 
 
2016
    For a list of all available commands, say 'bzr shell-complete'."""
 
2017
    takes_args = ['context?']
 
2018
    aliases = ['s-c']
 
2019
    hidden = True
 
2020
    
 
2021
    @display_command
 
2022
    def run(self, context=None):
 
2023
        import shellcomplete
 
2024
        shellcomplete.shellcomplete(context)
 
2025
 
 
2026
 
 
2027
class cmd_fetch(Command):
 
2028
    """Copy in history from another branch but don't merge it.
 
2029
 
 
2030
    This is an internal method used for pull and merge."""
 
2031
    hidden = True
 
2032
    takes_args = ['from_branch', 'to_branch']
 
2033
    def run(self, from_branch, to_branch):
 
2034
        from bzrlib.fetch import Fetcher
 
2035
        from bzrlib.branch import Branch
 
2036
        from_b = Branch.open(from_branch)
 
2037
        to_b = Branch.open(to_branch)
 
2038
        Fetcher(to_b, from_b)
 
2039
 
 
2040
 
 
2041
class cmd_missing(Command):
 
2042
    """Show unmerged/unpulled revisions between two branches.
 
2043
 
 
2044
    OTHER_BRANCH may be local or remote."""
 
2045
    takes_args = ['other_branch?']
 
2046
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
2047
                     Option('mine-only', 
 
2048
                            'Display changes in the local branch only'),
 
2049
                     Option('theirs-only', 
 
2050
                            'Display changes in the remote branch only'), 
 
2051
                     'log-format',
 
2052
                     'line',
 
2053
                     'long', 
 
2054
                     'short',
 
2055
                     'show-ids',
 
2056
                     'verbose'
 
2057
                     ]
 
2058
 
 
2059
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
2060
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
2061
            show_ids=False, verbose=False):
 
2062
        from bzrlib.missing import find_unmerged, iter_log_data
 
2063
        from bzrlib.log import log_formatter
 
2064
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
2065
        parent = local_branch.get_parent()
 
2066
        if other_branch is None:
 
2067
            other_branch = parent
 
2068
            if other_branch is None:
 
2069
                raise BzrCommandError("No missing location known or specified.")
 
2070
            print "Using last location: " + local_branch.get_parent()
 
2071
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
2072
        local_branch.lock_write()
 
2073
        if remote_branch.base == local_branch.base:
 
2074
            remote_branch = local_branch
 
2075
        try:
 
2076
            remote_branch.lock_read()
 
2077
            try:
 
2078
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
2079
                if (log_format == None):
 
2080
                    default = bzrlib.config.BranchConfig(local_branch).log_format()
 
2081
                    log_format = get_log_format(long=long, short=short, line=line, default=default)
 
2082
                lf = log_formatter(log_format, sys.stdout,
 
2083
                                   show_ids=show_ids,
 
2084
                                   show_timezone='original')
 
2085
                if reverse is False:
 
2086
                    local_extra.reverse()
 
2087
                    remote_extra.reverse()
 
2088
                if local_extra and not theirs_only:
 
2089
                    print "You have %d extra revision(s):" % len(local_extra)
 
2090
                    for data in iter_log_data(local_extra, local_branch.repository,
 
2091
                                              verbose):
 
2092
                        lf.show(*data)
 
2093
                    printed_local = True
 
2094
                else:
 
2095
                    printed_local = False
 
2096
                if remote_extra and not mine_only:
 
2097
                    if printed_local is True:
 
2098
                        print "\n\n"
 
2099
                    print "You are missing %d revision(s):" % len(remote_extra)
 
2100
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
2101
                                              verbose):
 
2102
                        lf.show(*data)
 
2103
                if not remote_extra and not local_extra:
 
2104
                    status_code = 0
 
2105
                    print "Branches are up to date."
 
2106
                else:
 
2107
                    status_code = 1
 
2108
                if parent is None and other_branch is not None:
 
2109
                    local_branch.set_parent(other_branch)
 
2110
                return status_code
 
2111
            finally:
 
2112
                local_branch.unlock()
 
2113
        finally:
 
2114
            remote_branch.unlock()
 
2115
 
 
2116
 
 
2117
class cmd_plugins(Command):
 
2118
    """List plugins"""
 
2119
    hidden = True
 
2120
    @display_command
 
2121
    def run(self):
 
2122
        import bzrlib.plugin
 
2123
        from inspect import getdoc
 
2124
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
2125
            if hasattr(plugin, '__path__'):
 
2126
                print plugin.__path__[0]
 
2127
            elif hasattr(plugin, '__file__'):
 
2128
                print plugin.__file__
 
2129
            else:
 
2130
                print `plugin`
 
2131
                
 
2132
            d = getdoc(plugin)
 
2133
            if d:
 
2134
                print '\t', d.split('\n')[0]
 
2135
 
 
2136
 
 
2137
class cmd_testament(Command):
 
2138
    """Show testament (signing-form) of a revision."""
 
2139
    takes_options = ['revision', 'long']
 
2140
    takes_args = ['branch?']
 
2141
    @display_command
 
2142
    def run(self, branch=u'.', revision=None, long=False):
 
2143
        from bzrlib.testament import Testament
 
2144
        b = WorkingTree.open_containing(branch)[0].branch
 
2145
        b.lock_read()
 
2146
        try:
 
2147
            if revision is None:
 
2148
                rev_id = b.last_revision()
 
2149
            else:
 
2150
                rev_id = revision[0].in_history(b).rev_id
 
2151
            t = Testament.from_revision(b.repository, rev_id)
 
2152
            if long:
 
2153
                sys.stdout.writelines(t.as_text_lines())
 
2154
            else:
 
2155
                sys.stdout.write(t.as_short_text())
 
2156
        finally:
 
2157
            b.unlock()
 
2158
 
 
2159
 
 
2160
class cmd_annotate(Command):
 
2161
    """Show the origin of each line in a file.
 
2162
 
 
2163
    This prints out the given file with an annotation on the left side
 
2164
    indicating which revision, author and date introduced the change.
 
2165
 
 
2166
    If the origin is the same for a run of consecutive lines, it is 
 
2167
    shown only at the top, unless the --all option is given.
 
2168
    """
 
2169
    # TODO: annotate directories; showing when each file was last changed
 
2170
    # TODO: annotate a previous version of a file
 
2171
    # TODO: if the working copy is modified, show annotations on that 
 
2172
    #       with new uncommitted lines marked
 
2173
    aliases = ['blame', 'praise']
 
2174
    takes_args = ['filename']
 
2175
    takes_options = [Option('all', help='show annotations on all lines'),
 
2176
                     Option('long', help='show date in annotations'),
 
2177
                     ]
 
2178
 
 
2179
    @display_command
 
2180
    def run(self, filename, all=False, long=False):
 
2181
        from bzrlib.annotate import annotate_file
 
2182
        tree, relpath = WorkingTree.open_containing(filename)
 
2183
        branch = tree.branch
 
2184
        branch.lock_read()
 
2185
        try:
 
2186
            file_id = tree.inventory.path2id(relpath)
 
2187
            tree = branch.repository.revision_tree(branch.last_revision())
 
2188
            file_version = tree.inventory[file_id].revision
 
2189
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
2190
        finally:
 
2191
            branch.unlock()
 
2192
 
 
2193
 
 
2194
class cmd_re_sign(Command):
 
2195
    """Create a digital signature for an existing revision."""
 
2196
    # TODO be able to replace existing ones.
 
2197
 
 
2198
    hidden = True # is this right ?
 
2199
    takes_args = ['revision_id*']
 
2200
    takes_options = ['revision']
 
2201
    
 
2202
    def run(self, revision_id_list=None, revision=None):
 
2203
        import bzrlib.config as config
 
2204
        import bzrlib.gpg as gpg
 
2205
        if revision_id_list is not None and revision is not None:
 
2206
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
2207
        if revision_id_list is None and revision is None:
 
2208
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
2209
        b = WorkingTree.open_containing(u'.')[0].branch
 
2210
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
2211
        if revision_id_list is not None:
 
2212
            for revision_id in revision_id_list:
 
2213
                b.repository.sign_revision(revision_id, gpg_strategy)
 
2214
        elif revision is not None:
 
2215
            if len(revision) == 1:
 
2216
                revno, rev_id = revision[0].in_history(b)
 
2217
                b.repository.sign_revision(rev_id, gpg_strategy)
 
2218
            elif len(revision) == 2:
 
2219
                # are they both on rh- if so we can walk between them
 
2220
                # might be nice to have a range helper for arbitrary
 
2221
                # revision paths. hmm.
 
2222
                from_revno, from_revid = revision[0].in_history(b)
 
2223
                to_revno, to_revid = revision[1].in_history(b)
 
2224
                if to_revid is None:
 
2225
                    to_revno = b.revno()
 
2226
                if from_revno is None or to_revno is None:
 
2227
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
2228
                for revno in range(from_revno, to_revno + 1):
 
2229
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
2230
                                               gpg_strategy)
 
2231
            else:
 
2232
                raise BzrCommandError('Please supply either one revision, or a range.')
 
2233
 
 
2234
 
 
2235
class cmd_bind(Command):
 
2236
    """Bind the current branch to a master branch.
 
2237
 
 
2238
    After binding, commits must succeed on the master branch
 
2239
    before they are executed on the local one.
 
2240
    """
 
2241
 
 
2242
    takes_args = ['location']
 
2243
    takes_options = []
 
2244
 
 
2245
    def run(self, location=None):
 
2246
        b, relpath = Branch.open_containing(u'.')
 
2247
        b_other = Branch.open(location)
 
2248
        try:
 
2249
            b.bind(b_other)
 
2250
        except DivergedBranches:
 
2251
            raise BzrCommandError('These branches have diverged.'
 
2252
                                  ' Try merging, and then bind again.')
 
2253
 
 
2254
 
 
2255
class cmd_unbind(Command):
 
2256
    """Bind the current branch to its parent.
 
2257
 
 
2258
    After unbinding, the local branch is considered independent.
 
2259
    """
 
2260
 
 
2261
    takes_args = []
 
2262
    takes_options = []
 
2263
 
 
2264
    def run(self):
 
2265
        b, relpath = Branch.open_containing(u'.')
 
2266
        if not b.unbind():
 
2267
            raise BzrCommandError('Local branch is not bound')
 
2268
 
 
2269
 
 
2270
class cmd_uncommit(bzrlib.commands.Command):
 
2271
    """Remove the last committed revision.
 
2272
 
 
2273
    By supplying the --all flag, it will not only remove the entry 
 
2274
    from revision_history, but also remove all of the entries in the
 
2275
    stores.
 
2276
 
 
2277
    --verbose will print out what is being removed.
 
2278
    --dry-run will go through all the motions, but not actually
 
2279
    remove anything.
 
2280
    
 
2281
    In the future, uncommit will create a changeset, which can then
 
2282
    be re-applied.
 
2283
    """
 
2284
 
 
2285
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
2286
    # unreferenced information in 'branch-as-repostory' branches.
 
2287
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
2288
    # information in shared branches as well.
 
2289
    takes_options = ['verbose', 'revision',
 
2290
                    Option('dry-run', help='Don\'t actually make changes'),
 
2291
                    Option('force', help='Say yes to all questions.')]
 
2292
    takes_args = ['location?']
 
2293
    aliases = []
 
2294
 
 
2295
    def run(self, location=None, 
 
2296
            dry_run=False, verbose=False,
 
2297
            revision=None, force=False):
 
2298
        from bzrlib.branch import Branch
 
2299
        from bzrlib.log import log_formatter
 
2300
        import sys
 
2301
        from bzrlib.uncommit import uncommit
 
2302
 
 
2303
        if location is None:
 
2304
            location = u'.'
 
2305
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
2306
        try:
 
2307
            tree = control.open_workingtree()
 
2308
            b = tree.branch
 
2309
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
2310
            tree = None
 
2311
            b = control.open_branch()
 
2312
 
 
2313
        if revision is None:
 
2314
            revno = b.revno()
 
2315
            rev_id = b.last_revision()
 
2316
        else:
 
2317
            revno, rev_id = revision[0].in_history(b)
 
2318
        if rev_id is None:
 
2319
            print 'No revisions to uncommit.'
 
2320
 
 
2321
        for r in range(revno, b.revno()+1):
 
2322
            rev_id = b.get_rev_id(r)
 
2323
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
2324
            lf.show(r, b.repository.get_revision(rev_id), None)
 
2325
 
 
2326
        if dry_run:
 
2327
            print 'Dry-run, pretending to remove the above revisions.'
 
2328
            if not force:
 
2329
                val = raw_input('Press <enter> to continue')
 
2330
        else:
 
2331
            print 'The above revision(s) will be removed.'
 
2332
            if not force:
 
2333
                val = raw_input('Are you sure [y/N]? ')
 
2334
                if val.lower() not in ('y', 'yes'):
 
2335
                    print 'Canceled'
 
2336
                    return 0
 
2337
 
 
2338
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
2339
                revno=revno)
 
2340
 
 
2341
 
 
2342
class cmd_break_lock(Command):
 
2343
    """Break a dead lock on a repository, branch or working directory.
 
2344
 
 
2345
    CAUTION: Locks should only be broken when you are sure that the process
 
2346
    holding the lock has been stopped.
 
2347
    
 
2348
    example:
 
2349
        bzr break-lock .
 
2350
    """
 
2351
    takes_args = ['location']
 
2352
    takes_options = [Option('show',
 
2353
                            help="just show information on the lock, " \
 
2354
                                 "don't break it"),
 
2355
                    ]
 
2356
    def run(self, location, show=False):
 
2357
        raise NotImplementedError("sorry, break-lock is not complete yet; "
 
2358
                "you can remove the 'held' directory manually to break the lock")
 
2359
 
 
2360
 
 
2361
# command-line interpretation helper for merge-related commands
 
2362
def merge(other_revision, base_revision,
 
2363
          check_clean=True, ignore_zero=False,
 
2364
          this_dir=None, backup_files=False, merge_type=Merge3Merger,
 
2365
          file_list=None, show_base=False, reprocess=False,
 
2366
          pb=DummyProgress()):
 
2367
    """Merge changes into a tree.
 
2368
 
 
2369
    base_revision
 
2370
        list(path, revno) Base for three-way merge.  
 
2371
        If [None, None] then a base will be automatically determined.
 
2372
    other_revision
 
2373
        list(path, revno) Other revision for three-way merge.
 
2374
    this_dir
 
2375
        Directory to merge changes into; '.' by default.
 
2376
    check_clean
 
2377
        If true, this_dir must have no uncommitted changes before the
 
2378
        merge begins.
 
2379
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
2380
        there are no conflicts; should be set when doing something we expect
 
2381
        to complete perfectly.
 
2382
    file_list - If supplied, merge only changes to selected files.
 
2383
 
 
2384
    All available ancestors of other_revision and base_revision are
 
2385
    automatically pulled into the branch.
 
2386
 
 
2387
    The revno may be -1 to indicate the last revision on the branch, which is
 
2388
    the typical case.
 
2389
 
 
2390
    This function is intended for use from the command line; programmatic
 
2391
    clients might prefer to call merge.merge_inner(), which has less magic 
 
2392
    behavior.
 
2393
    """
 
2394
    from bzrlib.merge import Merger
 
2395
    if this_dir is None:
 
2396
        this_dir = u'.'
 
2397
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
2398
    if show_base and not merge_type is Merge3Merger:
 
2399
        raise BzrCommandError("Show-base is not supported for this merge"
 
2400
                              " type. %s" % merge_type)
 
2401
    if reprocess and not merge_type is Merge3Merger:
 
2402
        raise BzrCommandError("Reprocess is not supported for this merge"
 
2403
                              " type. %s" % merge_type)
 
2404
    if reprocess and show_base:
 
2405
        raise BzrCommandError("Cannot reprocess and show base.")
 
2406
    try:
 
2407
        merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
 
2408
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
2409
        merger.pp.next_phase()
 
2410
        merger.check_basis(check_clean)
 
2411
        merger.set_other(other_revision)
 
2412
        merger.pp.next_phase()
 
2413
        merger.set_base(base_revision)
 
2414
        if merger.base_rev_id == merger.other_rev_id:
 
2415
            note('Nothing to do.')
 
2416
            return 0
 
2417
        merger.backup_files = backup_files
 
2418
        merger.merge_type = merge_type 
 
2419
        merger.set_interesting_files(file_list)
 
2420
        merger.show_base = show_base 
 
2421
        merger.reprocess = reprocess
 
2422
        conflicts = merger.do_merge()
 
2423
        merger.set_pending()
 
2424
    finally:
 
2425
        pb.clear()
 
2426
    return conflicts
 
2427
 
 
2428
 
 
2429
# these get imported and then picked up by the scan for cmd_*
 
2430
# TODO: Some more consistent way to split command definitions across files;
 
2431
# we do need to load at least some information about them to know of 
 
2432
# aliases.  ideally we would avoid loading the implementation until the
 
2433
# details were needed.
 
2434
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
2435
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
2436
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
2437
        cmd_weave_plan_merge, cmd_weave_merge_text