/brz/remove-bazaar

To get this branch, use:
bzr branch http://gegoxaren.bato24.eu/bzr/brz/remove-bazaar

« back to all changes in this revision

Viewing changes to bzrlib/builtins.py

  • Committer: Martin Pool
  • Date: 2006-03-12 15:58:22 UTC
  • mto: This revision was merged to the branch mainline in revision 1611.
  • Revision ID: mbp@sourcefrog.net-20060312155822-94e98ec4d9c0c09a
Clean up test_setup code; avoid possible pipe jam

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