/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: Robert Collins
  • Date: 2006-04-12 04:57:34 UTC
  • mto: This revision was merged to the branch mainline in revision 1654.
  • Revision ID: robertc@robertcollins.net-20060412045734-3e03b7af0860a5a9
 * 'pull' and 'push' now normalise the revision history, so that any two
   branches with the same tip revision will have the same output from 'log'.
   (Robert Collins)

Show diffs side-by-side

added added

removed removed

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