1
# Copyright (C) 2004, 2005, 2006 by Canonical Ltd
 
 
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.
 
 
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.
 
 
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
 
 
17
"""builtin bzr commands"""
 
 
26
from bzrlib.branch import Branch
 
 
27
import bzrlib.bzrdir as bzrdir
 
 
28
from bzrlib.bundle.read_bundle import BundleReader
 
 
29
from bzrlib.bundle.apply_bundle import merge_bundle
 
 
30
from bzrlib.commands import Command, display_command
 
 
31
import bzrlib.errors as errors
 
 
32
from bzrlib.errors import (BzrError, BzrCheckError, BzrCommandError, 
 
 
33
                           NotBranchError, DivergedBranches, NotConflicted,
 
 
34
                           NoSuchFile, NoWorkingTree, FileInWrongBranch,
 
 
35
                           NotVersionedError, BadBundle)
 
 
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.revision import common_ancestor
 
 
41
from bzrlib.revisionspec import RevisionSpec
 
 
43
from bzrlib.trace import mutter, note, log_error, warning, is_quiet
 
 
44
from bzrlib.transport.local import LocalTransport
 
 
46
from bzrlib.workingtree import WorkingTree
 
 
49
def tree_files(file_list, default_branch=u'.'):
 
 
51
        return internal_tree_files(file_list, default_branch)
 
 
52
    except FileInWrongBranch, e:
 
 
53
        raise BzrCommandError("%s is not in the same branch as %s" %
 
 
54
                             (e.path, file_list[0]))
 
 
57
# XXX: Bad function name; should possibly also be a class method of
 
 
58
# WorkingTree rather than a function.
 
 
59
def internal_tree_files(file_list, default_branch=u'.'):
 
 
60
    """Convert command-line paths to a WorkingTree and relative paths.
 
 
62
    This is typically used for command-line processors that take one or
 
 
63
    more filenames, and infer the workingtree that contains them.
 
 
65
    The filenames given are not required to exist.
 
 
67
    :param file_list: Filenames to convert.  
 
 
69
    :param default_branch: Fallback tree path to use if file_list is empty or None.
 
 
71
    :return: workingtree, [relative_paths]
 
 
73
    if file_list is None or len(file_list) == 0:
 
 
74
        return WorkingTree.open_containing(default_branch)[0], file_list
 
 
75
    tree = WorkingTree.open_containing(file_list[0])[0]
 
 
77
    for filename in file_list:
 
 
79
            new_list.append(tree.relpath(filename))
 
 
80
        except errors.PathNotChild:
 
 
81
            raise FileInWrongBranch(tree.branch, filename)
 
 
85
def get_format_type(typestring):
 
 
86
    """Parse and return a format specifier."""
 
 
87
    if typestring == "weave":
 
 
88
        return bzrdir.BzrDirFormat6()
 
 
89
    if typestring == "default":
 
 
90
        return bzrdir.BzrDirMetaFormat1()
 
 
91
    if typestring == "metaweave":
 
 
92
        format = bzrdir.BzrDirMetaFormat1()
 
 
93
        format.repository_format = bzrlib.repository.RepositoryFormat7()
 
 
95
    if typestring == "knit":
 
 
96
        format = bzrdir.BzrDirMetaFormat1()
 
 
97
        format.repository_format = bzrlib.repository.RepositoryFormatKnit1()
 
 
99
    msg = "Unknown bzr format %s. Current formats are: default, knit,\n" \
 
 
100
          "metaweave and weave" % typestring
 
 
101
    raise BzrCommandError(msg)
 
 
104
# TODO: Make sure no commands unconditionally use the working directory as a
 
 
105
# branch.  If a filename argument is used, the first of them should be used to
 
 
106
# specify the branch.  (Perhaps this can be factored out into some kind of
 
 
107
# Argument class, representing a file in a branch, where the first occurrence
 
 
110
class cmd_status(Command):
 
 
111
    """Display status summary.
 
 
113
    This reports on versioned and unknown files, reporting them
 
 
114
    grouped by state.  Possible states are:
 
 
117
        Versioned in the working copy but not in the previous revision.
 
 
120
        Versioned in the previous revision but removed or deleted
 
 
124
        Path of this file changed from the previous revision;
 
 
125
        the text may also have changed.  This includes files whose
 
 
126
        parent directory was renamed.
 
 
129
        Text has changed since the previous revision.
 
 
132
        Nothing about this file has changed since the previous revision.
 
 
133
        Only shown with --all.
 
 
136
        Not versioned and not matching an ignore pattern.
 
 
138
    To see ignored files use 'bzr ignored'.  For details in the
 
 
139
    changes to file texts, use 'bzr diff'.
 
 
141
    If no arguments are specified, the status of the entire working
 
 
142
    directory is shown.  Otherwise, only the status of the specified
 
 
143
    files or directories is reported.  If a directory is given, status
 
 
144
    is reported for everything inside that directory.
 
 
146
    If a revision argument is given, the status is calculated against
 
 
147
    that revision, or between two revisions if two are provided.
 
 
150
    # TODO: --no-recurse, --recurse options
 
 
152
    takes_args = ['file*']
 
 
153
    takes_options = ['all', 'show-ids', 'revision']
 
 
154
    aliases = ['st', 'stat']
 
 
157
    def run(self, all=False, show_ids=False, file_list=None, revision=None):
 
 
158
        tree, file_list = tree_files(file_list)
 
 
160
        from bzrlib.status import show_tree_status
 
 
161
        show_tree_status(tree, show_unchanged=all, show_ids=show_ids,
 
 
162
                         specific_files=file_list, revision=revision)
 
 
165
class cmd_cat_revision(Command):
 
 
166
    """Write out metadata for a revision.
 
 
168
    The revision to print can either be specified by a specific
 
 
169
    revision identifier, or you can use --revision.
 
 
173
    takes_args = ['revision_id?']
 
 
174
    takes_options = ['revision']
 
 
177
    def run(self, revision_id=None, revision=None):
 
 
179
        if revision_id is not None and revision is not None:
 
 
180
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
 
181
        if revision_id is None and revision is None:
 
 
182
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
 
183
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
184
        if revision_id is not None:
 
 
185
            sys.stdout.write(b.repository.get_revision_xml(revision_id))
 
 
186
        elif revision is not None:
 
 
189
                    raise BzrCommandError('You cannot specify a NULL revision.')
 
 
190
                revno, rev_id = rev.in_history(b)
 
 
191
                sys.stdout.write(b.repository.get_revision_xml(rev_id))
 
 
194
class cmd_revno(Command):
 
 
195
    """Show current revision number.
 
 
197
    This is equal to the number of revisions on this branch."""
 
 
198
    takes_args = ['location?']
 
 
200
    def run(self, location=u'.'):
 
 
201
        print Branch.open_containing(location)[0].revno()
 
 
204
class cmd_revision_info(Command):
 
 
205
    """Show revision number and revision id for a given revision identifier.
 
 
208
    takes_args = ['revision_info*']
 
 
209
    takes_options = ['revision']
 
 
211
    def run(self, revision=None, revision_info_list=[]):
 
 
214
        if revision is not None:
 
 
215
            revs.extend(revision)
 
 
216
        if revision_info_list is not None:
 
 
217
            for rev in revision_info_list:
 
 
218
                revs.append(RevisionSpec(rev))
 
 
220
            raise BzrCommandError('You must supply a revision identifier')
 
 
222
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
225
            revinfo = rev.in_history(b)
 
 
226
            if revinfo.revno is None:
 
 
227
                print '     %s' % revinfo.rev_id
 
 
229
                print '%4d %s' % (revinfo.revno, revinfo.rev_id)
 
 
232
class cmd_add(Command):
 
 
233
    """Add specified files or directories.
 
 
235
    In non-recursive mode, all the named items are added, regardless
 
 
236
    of whether they were previously ignored.  A warning is given if
 
 
237
    any of the named files are already versioned.
 
 
239
    In recursive mode (the default), files are treated the same way
 
 
240
    but the behaviour for directories is different.  Directories that
 
 
241
    are already versioned do not give a warning.  All directories,
 
 
242
    whether already versioned or not, are searched for files or
 
 
243
    subdirectories that are neither versioned or ignored, and these
 
 
244
    are added.  This search proceeds recursively into versioned
 
 
245
    directories.  If no names are given '.' is assumed.
 
 
247
    Therefore simply saying 'bzr add' will version all files that
 
 
248
    are currently unknown.
 
 
250
    Adding a file whose parent directory is not versioned will
 
 
251
    implicitly add the parent, and so on up to the root. This means
 
 
252
    you should never need to explictly add a directory, they'll just
 
 
253
    get added when you add a file in the directory.
 
 
255
    --dry-run will show which files would be added, but not actually 
 
 
258
    takes_args = ['file*']
 
 
259
    takes_options = ['no-recurse', 'dry-run', 'verbose']
 
 
261
    def run(self, file_list, no_recurse=False, dry_run=False, verbose=False):
 
 
266
                # This is pointless, but I'd rather not raise an error
 
 
267
                action = bzrlib.add.add_action_null
 
 
269
                action = bzrlib.add.add_action_print
 
 
271
            action = bzrlib.add.add_action_add
 
 
273
            action = bzrlib.add.add_action_add_and_print
 
 
275
        added, ignored = bzrlib.add.smart_add(file_list, not no_recurse, 
 
 
279
                for glob in sorted(ignored.keys()):
 
 
280
                    for path in ignored[glob]:
 
 
281
                        print "ignored %s matching \"%s\"" % (path, glob)
 
 
284
                for glob, paths in ignored.items():
 
 
285
                    match_len += len(paths)
 
 
286
                print "ignored %d file(s)." % match_len
 
 
287
            print "If you wish to add some of these files, please add them"\
 
 
291
class cmd_mkdir(Command):
 
 
292
    """Create a new versioned directory.
 
 
294
    This is equivalent to creating the directory and then adding it.
 
 
296
    takes_args = ['dir+']
 
 
298
    def run(self, dir_list):
 
 
301
            wt, dd = WorkingTree.open_containing(d)
 
 
306
class cmd_relpath(Command):
 
 
307
    """Show path of a file relative to root"""
 
 
308
    takes_args = ['filename']
 
 
312
    def run(self, filename):
 
 
313
        tree, relpath = WorkingTree.open_containing(filename)
 
 
317
class cmd_inventory(Command):
 
 
318
    """Show inventory of the current working copy or a revision.
 
 
320
    It is possible to limit the output to a particular entry
 
 
321
    type using the --kind option.  For example; --kind file.
 
 
323
    takes_options = ['revision', 'show-ids', 'kind']
 
 
326
    def run(self, revision=None, show_ids=False, kind=None):
 
 
327
        if kind and kind not in ['file', 'directory', 'symlink']:
 
 
328
            raise BzrCommandError('invalid kind specified')
 
 
329
        tree = WorkingTree.open_containing(u'.')[0]
 
 
331
            inv = tree.read_working_inventory()
 
 
333
            if len(revision) > 1:
 
 
334
                raise BzrCommandError('bzr inventory --revision takes'
 
 
335
                    ' exactly one revision identifier')
 
 
336
            inv = tree.branch.repository.get_revision_inventory(
 
 
337
                revision[0].in_history(tree.branch).rev_id)
 
 
339
        for path, entry in inv.entries():
 
 
340
            if kind and kind != entry.kind:
 
 
343
                print '%-50s %s' % (path, entry.file_id)
 
 
348
class cmd_mv(Command):
 
 
349
    """Move or rename a file.
 
 
352
        bzr mv OLDNAME NEWNAME
 
 
353
        bzr mv SOURCE... DESTINATION
 
 
355
    If the last argument is a versioned directory, all the other names
 
 
356
    are moved into it.  Otherwise, there must be exactly two arguments
 
 
357
    and the file is changed to a new name, which must not already exist.
 
 
359
    Files cannot be moved between branches.
 
 
361
    takes_args = ['names*']
 
 
362
    aliases = ['move', 'rename']
 
 
364
    def run(self, names_list):
 
 
365
        if len(names_list) < 2:
 
 
366
            raise BzrCommandError("missing file argument")
 
 
367
        tree, rel_names = tree_files(names_list)
 
 
369
        if os.path.isdir(names_list[-1]):
 
 
370
            # move into existing directory
 
 
371
            for pair in tree.move(rel_names[:-1], rel_names[-1]):
 
 
372
                print "%s => %s" % pair
 
 
374
            if len(names_list) != 2:
 
 
375
                raise BzrCommandError('to mv multiple files the destination '
 
 
376
                                      'must be a versioned directory')
 
 
377
            tree.rename_one(rel_names[0], rel_names[1])
 
 
378
            print "%s => %s" % (rel_names[0], rel_names[1])
 
 
381
class cmd_pull(Command):
 
 
382
    """Turn this branch into a mirror of another branch.
 
 
384
    This command only works on branches that have not diverged.  Branches are
 
 
385
    considered diverged if the destination branch's most recent commit is one
 
 
386
    that has not been merged (directly or indirectly) into the parent.
 
 
388
    If branches have diverged, you can use 'bzr merge' to integrate the changes
 
 
389
    from one into the other.  Once one branch has merged, the other should
 
 
390
    be able to pull it again.
 
 
392
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
 
393
    from one into the other.  Once one branch has merged, the other should
 
 
394
    be able to pull it again.
 
 
396
    If you want to forget your local changes and just update your branch to
 
 
397
    match the remote one, use pull --overwrite.
 
 
399
    If there is no default location set, the first pull will set it.  After
 
 
400
    that, you can omit the location to use the default.  To change the
 
 
401
    default, use --remember.
 
 
403
    takes_options = ['remember', 'overwrite', 'revision', 'verbose']
 
 
404
    takes_args = ['location?']
 
 
406
    def run(self, location=None, remember=False, overwrite=False, revision=None, verbose=False):
 
 
407
        # FIXME: too much stuff is in the command class
 
 
409
            tree_to = WorkingTree.open_containing(u'.')[0]
 
 
410
            branch_to = tree_to.branch
 
 
411
        except NoWorkingTree:
 
 
413
            branch_to = Branch.open_containing(u'.')[0] 
 
 
414
        stored_loc = branch_to.get_parent()
 
 
416
            if stored_loc is None:
 
 
417
                raise BzrCommandError("No pull location known or specified.")
 
 
419
                print "Using saved location: %s" % stored_loc
 
 
420
                location = stored_loc
 
 
422
        if branch_to.get_parent() is None or remember:
 
 
423
            branch_to.set_parent(location)
 
 
425
        branch_from = Branch.open(location)
 
 
429
        elif len(revision) == 1:
 
 
430
            rev_id = revision[0].in_history(branch_from).rev_id
 
 
432
            raise BzrCommandError('bzr pull --revision takes one value.')
 
 
434
        old_rh = branch_to.revision_history()
 
 
435
        if tree_to is not None:
 
 
436
            count = tree_to.pull(branch_from, overwrite, rev_id)
 
 
438
            count = branch_to.pull(branch_from, overwrite, rev_id)
 
 
439
        note('%d revision(s) pulled.' % (count,))
 
 
442
            new_rh = branch_to.revision_history()
 
 
445
                from bzrlib.log import show_changed_revisions
 
 
446
                show_changed_revisions(branch_to, old_rh, new_rh)
 
 
449
class cmd_push(Command):
 
 
450
    """Update a mirror of this branch.
 
 
452
    The target branch will not have its working tree populated because this
 
 
453
    is both expensive, and is not supported on remote file systems.
 
 
455
    Some smart servers or protocols *may* put the working tree in place in
 
 
458
    This command only works on branches that have not diverged.  Branches are
 
 
459
    considered diverged if the destination branch's most recent commit is one
 
 
460
    that has not been merged (directly or indirectly) by the source branch.
 
 
462
    If branches have diverged, you can use 'bzr push --overwrite' to replace
 
 
463
    the other branch completely, discarding its unmerged changes.
 
 
465
    If you want to ensure you have the different changes in the other branch,
 
 
466
    do a merge (see bzr help merge) from the other branch, and commit that.
 
 
467
    After that you will be able to do a push without '--overwrite'.
 
 
469
    If there is no default push location set, the first push will set it.
 
 
470
    After that, you can omit the location to use the default.  To change the
 
 
471
    default, use --remember.
 
 
473
    takes_options = ['remember', 'overwrite', 
 
 
474
                     Option('create-prefix', 
 
 
475
                            help='Create the path leading up to the branch '
 
 
476
                                 'if it does not already exist')]
 
 
477
    takes_args = ['location?']
 
 
479
    def run(self, location=None, remember=False, overwrite=False,
 
 
480
            create_prefix=False, verbose=False):
 
 
481
        # FIXME: Way too big!  Put this into a function called from the
 
 
483
        from bzrlib.transport import get_transport
 
 
485
        br_from = Branch.open_containing('.')[0]
 
 
486
        stored_loc = br_from.get_push_location()
 
 
488
            if stored_loc is None:
 
 
489
                raise BzrCommandError("No push location known or specified.")
 
 
491
                print "Using saved location: %s" % stored_loc
 
 
492
                location = stored_loc
 
 
493
        if br_from.get_push_location() is None or remember:
 
 
494
            br_from.set_push_location(location)
 
 
496
            dir_to = bzrlib.bzrdir.BzrDir.open(location)
 
 
497
            br_to = dir_to.open_branch()
 
 
498
        except NotBranchError:
 
 
500
            transport = get_transport(location).clone('..')
 
 
501
            if not create_prefix:
 
 
503
                    transport.mkdir(transport.relpath(location))
 
 
505
                    raise BzrCommandError("Parent directory of %s "
 
 
506
                                          "does not exist." % location)
 
 
508
                current = transport.base
 
 
509
                needed = [(transport, transport.relpath(location))]
 
 
512
                        transport, relpath = needed[-1]
 
 
513
                        transport.mkdir(relpath)
 
 
516
                        new_transport = transport.clone('..')
 
 
517
                        needed.append((new_transport,
 
 
518
                                       new_transport.relpath(transport.base)))
 
 
519
                        if new_transport.base == transport.base:
 
 
520
                            raise BzrCommandError("Could not create "
 
 
522
            dir_to = br_from.bzrdir.clone(location,
 
 
523
                revision_id=br_from.last_revision())
 
 
524
            br_to = dir_to.open_branch()
 
 
525
            count = len(br_to.revision_history())
 
 
527
            old_rh = br_to.revision_history()
 
 
530
                    tree_to = dir_to.open_workingtree()
 
 
531
                except errors.NotLocalUrl:
 
 
532
                    warning('This transport does not update the working '
 
 
533
                            'tree of: %s' % (br_to.base,))
 
 
534
                    count = br_to.pull(br_from, overwrite)
 
 
535
                except NoWorkingTree:
 
 
536
                    count = br_to.pull(br_from, overwrite)
 
 
538
                    count = tree_to.pull(br_from, overwrite)
 
 
539
            except DivergedBranches:
 
 
540
                raise BzrCommandError("These branches have diverged."
 
 
541
                                      "  Try a merge then push with overwrite.")
 
 
542
        note('%d revision(s) pushed.' % (count,))
 
 
545
            new_rh = br_to.revision_history()
 
 
548
                from bzrlib.log import show_changed_revisions
 
 
549
                show_changed_revisions(br_to, old_rh, new_rh)
 
 
552
class cmd_branch(Command):
 
 
553
    """Create a new copy of a branch.
 
 
555
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
 
556
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
 
558
    To retrieve the branch as of a particular revision, supply the --revision
 
 
559
    parameter, as in "branch foo/bar -r 5".
 
 
561
    --basis is to speed up branching from remote branches.  When specified, it
 
 
562
    copies all the file-contents, inventory and revision data from the basis
 
 
563
    branch before copying anything from the remote branch.
 
 
565
    takes_args = ['from_location', 'to_location?']
 
 
566
    takes_options = ['revision', 'basis']
 
 
567
    aliases = ['get', 'clone']
 
 
569
    def run(self, from_location, to_location=None, revision=None, basis=None):
 
 
570
        from bzrlib.osutils import rmtree
 
 
573
        elif len(revision) > 1:
 
 
574
            raise BzrCommandError(
 
 
575
                'bzr branch --revision takes exactly 1 revision value')
 
 
577
            br_from = Branch.open(from_location)
 
 
579
            if e.errno == errno.ENOENT:
 
 
580
                raise BzrCommandError('Source location "%s" does not'
 
 
581
                                      ' exist.' % to_location)
 
 
586
            if basis is not None:
 
 
587
                basis_dir = bzrdir.BzrDir.open_containing(basis)[0]
 
 
590
            if len(revision) == 1 and revision[0] is not None:
 
 
591
                revision_id = revision[0].in_history(br_from)[1]
 
 
593
                # FIXME - wt.last_revision, fallback to branch, fall back to
 
 
594
                # None or perhaps NULL_REVISION to mean copy nothing
 
 
596
                revision_id = br_from.last_revision()
 
 
597
            if to_location is None:
 
 
598
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
 
601
                name = os.path.basename(to_location) + '\n'
 
 
603
                os.mkdir(to_location)
 
 
605
                if e.errno == errno.EEXIST:
 
 
606
                    raise BzrCommandError('Target directory "%s" already'
 
 
607
                                          ' exists.' % to_location)
 
 
608
                if e.errno == errno.ENOENT:
 
 
609
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
614
                # preserve whatever source format we have.
 
 
615
                dir = br_from.bzrdir.sprout(to_location, revision_id, basis_dir)
 
 
616
                branch = dir.open_branch()
 
 
617
            except bzrlib.errors.NoSuchRevision:
 
 
619
                msg = "The branch %s has no revision %s." % (from_location, revision[0])
 
 
620
                raise BzrCommandError(msg)
 
 
621
            except bzrlib.errors.UnlistableBranch:
 
 
623
                msg = "The branch %s cannot be used as a --basis" % (basis,)
 
 
624
                raise BzrCommandError(msg)
 
 
626
                branch.control_files.put_utf8('branch-name', name)
 
 
628
            note('Branched %d revision(s).' % branch.revno())
 
 
633
class cmd_checkout(Command):
 
 
634
    """Create a new checkout of an existing branch.
 
 
636
    If BRANCH_LOCATION is omitted, checkout will reconstitute a working tree for
 
 
637
    the branch found in '.'. This is useful if you have removed the working tree
 
 
638
    or if it was never created - i.e. if you pushed the branch to its current
 
 
641
    If the TO_LOCATION is omitted, the last component of the BRANCH_LOCATION will
 
 
642
    be used.  In other words, "checkout ../foo/bar" will attempt to create ./bar.
 
 
644
    To retrieve the branch as of a particular revision, supply the --revision
 
 
645
    parameter, as in "checkout foo/bar -r 5". Note that this will be immediately
 
 
646
    out of date [so you cannot commit] but it may be useful (i.e. to examine old
 
 
649
    --basis is to speed up checking out from remote branches.  When specified, it
 
 
650
    uses the inventory and file contents from the basis branch in preference to the
 
 
651
    branch being checked out.
 
 
653
    takes_args = ['branch_location?', 'to_location?']
 
 
654
    takes_options = ['revision', # , 'basis']
 
 
655
                     Option('lightweight',
 
 
656
                            help="perform a lightweight checkout. Lightweight "
 
 
657
                                 "checkouts depend on access to the branch for "
 
 
658
                                 "every operation. Normal checkouts can perform "
 
 
659
                                 "common operations like diff and status without "
 
 
660
                                 "such access, and also support local commits."
 
 
664
    def run(self, branch_location=None, to_location=None, revision=None, basis=None,
 
 
668
        elif len(revision) > 1:
 
 
669
            raise BzrCommandError(
 
 
670
                'bzr checkout --revision takes exactly 1 revision value')
 
 
671
        if branch_location is None:
 
 
672
            branch_location = bzrlib.osutils.getcwd()
 
 
673
            to_location = branch_location
 
 
674
        source = Branch.open(branch_location)
 
 
675
        if len(revision) == 1 and revision[0] is not None:
 
 
676
            revision_id = revision[0].in_history(source)[1]
 
 
679
        if to_location is None:
 
 
680
            to_location = os.path.basename(branch_location.rstrip("/\\"))
 
 
681
        # if the source and to_location are the same, 
 
 
682
        # and there is no working tree,
 
 
683
        # then reconstitute a branch
 
 
684
        if (bzrlib.osutils.abspath(to_location) == 
 
 
685
            bzrlib.osutils.abspath(branch_location)):
 
 
687
                source.bzrdir.open_workingtree()
 
 
688
            except errors.NoWorkingTree:
 
 
689
                source.bzrdir.create_workingtree()
 
 
692
            os.mkdir(to_location)
 
 
694
            if e.errno == errno.EEXIST:
 
 
695
                raise BzrCommandError('Target directory "%s" already'
 
 
696
                                      ' exists.' % to_location)
 
 
697
            if e.errno == errno.ENOENT:
 
 
698
                raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
702
        old_format = bzrlib.bzrdir.BzrDirFormat.get_default_format()
 
 
703
        bzrlib.bzrdir.BzrDirFormat.set_default_format(bzrdir.BzrDirMetaFormat1())
 
 
706
                checkout = bzrdir.BzrDirMetaFormat1().initialize(to_location)
 
 
707
                bzrlib.branch.BranchReferenceFormat().initialize(checkout, source)
 
 
709
                checkout_branch =  bzrlib.bzrdir.BzrDir.create_branch_convenience(
 
 
710
                    to_location, force_new_tree=False)
 
 
711
                checkout = checkout_branch.bzrdir
 
 
712
                checkout_branch.bind(source)
 
 
713
                if revision_id is not None:
 
 
714
                    rh = checkout_branch.revision_history()
 
 
715
                    checkout_branch.set_revision_history(rh[:rh.index(revision_id) + 1])
 
 
716
            checkout.create_workingtree(revision_id)
 
 
718
            bzrlib.bzrdir.BzrDirFormat.set_default_format(old_format)
 
 
721
class cmd_renames(Command):
 
 
722
    """Show list of renamed files.
 
 
724
    # TODO: Option to show renames between two historical versions.
 
 
726
    # TODO: Only show renames under dir, rather than in the whole branch.
 
 
727
    takes_args = ['dir?']
 
 
730
    def run(self, dir=u'.'):
 
 
731
        tree = WorkingTree.open_containing(dir)[0]
 
 
732
        old_inv = tree.basis_tree().inventory
 
 
733
        new_inv = tree.read_working_inventory()
 
 
735
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
737
        for old_name, new_name in renames:
 
 
738
            print "%s => %s" % (old_name, new_name)        
 
 
741
class cmd_update(Command):
 
 
742
    """Update a tree to have the latest code committed to its branch.
 
 
744
    This will perform a merge into the working tree, and may generate
 
 
745
    conflicts. If you have any local changes, you will still 
 
 
746
    need to commit them after the update for the update to be complete.
 
 
748
    If you want to discard your local changes, you can just do a 
 
 
749
    'bzr revert' instead of 'bzr commit' after the update.
 
 
751
    takes_args = ['dir?']
 
 
753
    def run(self, dir='.'):
 
 
754
        tree = WorkingTree.open_containing(dir)[0]
 
 
757
            if tree.last_revision() == tree.branch.last_revision():
 
 
758
                # may be up to date, check master too.
 
 
759
                master = tree.branch.get_master_branch()
 
 
760
                if master is None or master.last_revision == tree.last_revision():
 
 
761
                    note("Tree is up to date.")
 
 
763
            conflicts = tree.update()
 
 
764
            note('Updated to revision %d.' %
 
 
765
                 (tree.branch.revision_id_to_revno(tree.last_revision()),))
 
 
774
class cmd_info(Command):
 
 
775
    """Show information about a working tree, branch or repository.
 
 
777
    This command will show all known locations and formats associated to the
 
 
778
    tree, branch or repository.  Statistical information is included with
 
 
781
    Branches and working trees will also report any missing revisions.
 
 
783
    takes_args = ['location?']
 
 
784
    takes_options = ['verbose']
 
 
787
    def run(self, location=None, verbose=False):
 
 
788
        from bzrlib.info import show_bzrdir_info
 
 
789
        show_bzrdir_info(bzrdir.BzrDir.open_containing(location)[0],
 
 
793
class cmd_remove(Command):
 
 
794
    """Make a file unversioned.
 
 
796
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
797
    not delete the working copy.
 
 
799
    You can specify one or more files, and/or --new.  If you specify --new,
 
 
800
    only 'added' files will be removed.  If you specify both, then new files
 
 
801
    in the specified directories will be removed.  If the directories are
 
 
802
    also new, they will also be removed.
 
 
804
    takes_args = ['file*']
 
 
805
    takes_options = ['verbose', Option('new', help='remove newly-added files')]
 
 
808
    def run(self, file_list, verbose=False, new=False):
 
 
809
        tree, file_list = tree_files(file_list)
 
 
811
            if file_list is None:
 
 
812
                raise BzrCommandError('Specify one or more files to remove, or'
 
 
815
            from bzrlib.delta import compare_trees
 
 
816
            added = [compare_trees(tree.basis_tree(), tree,
 
 
817
                                   specific_files=file_list).added]
 
 
818
            file_list = sorted([f[0] for f in added[0]], reverse=True)
 
 
819
            if len(file_list) == 0:
 
 
820
                raise BzrCommandError('No matching files.')
 
 
821
        tree.remove(file_list, verbose=verbose)
 
 
824
class cmd_file_id(Command):
 
 
825
    """Print file_id of a particular file or directory.
 
 
827
    The file_id is assigned when the file is first added and remains the
 
 
828
    same through all revisions where the file exists, even when it is
 
 
832
    takes_args = ['filename']
 
 
834
    def run(self, filename):
 
 
835
        tree, relpath = WorkingTree.open_containing(filename)
 
 
836
        i = tree.inventory.path2id(relpath)
 
 
838
            raise BzrError("%r is not a versioned file" % filename)
 
 
843
class cmd_file_path(Command):
 
 
844
    """Print path of file_ids to a file or directory.
 
 
846
    This prints one line for each directory down to the target,
 
 
847
    starting at the branch root."""
 
 
849
    takes_args = ['filename']
 
 
851
    def run(self, filename):
 
 
852
        tree, relpath = WorkingTree.open_containing(filename)
 
 
854
        fid = inv.path2id(relpath)
 
 
856
            raise BzrError("%r is not a versioned file" % filename)
 
 
857
        for fip in inv.get_idpath(fid):
 
 
861
class cmd_reconcile(Command):
 
 
862
    """Reconcile bzr metadata in a branch.
 
 
864
    This can correct data mismatches that may have been caused by
 
 
865
    previous ghost operations or bzr upgrades. You should only
 
 
866
    need to run this command if 'bzr check' or a bzr developer 
 
 
867
    advises you to run it.
 
 
869
    If a second branch is provided, cross-branch reconciliation is
 
 
870
    also attempted, which will check that data like the tree root
 
 
871
    id which was not present in very early bzr versions is represented
 
 
872
    correctly in both branches.
 
 
874
    At the same time it is run it may recompress data resulting in 
 
 
875
    a potential saving in disk space or performance gain.
 
 
877
    The branch *MUST* be on a listable system such as local disk or sftp.
 
 
879
    takes_args = ['branch?']
 
 
881
    def run(self, branch="."):
 
 
882
        from bzrlib.reconcile import reconcile
 
 
883
        dir = bzrlib.bzrdir.BzrDir.open(branch)
 
 
887
class cmd_revision_history(Command):
 
 
888
    """Display list of revision ids on this branch."""
 
 
892
        branch = WorkingTree.open_containing(u'.')[0].branch
 
 
893
        for patchid in branch.revision_history():
 
 
897
class cmd_ancestry(Command):
 
 
898
    """List all revisions merged into this branch."""
 
 
902
        tree = WorkingTree.open_containing(u'.')[0]
 
 
904
        # FIXME. should be tree.last_revision
 
 
905
        revision_ids = b.repository.get_ancestry(b.last_revision())
 
 
906
        assert revision_ids[0] == None
 
 
908
        for revision_id in revision_ids:
 
 
912
class cmd_init(Command):
 
 
913
    """Make a directory into a versioned branch.
 
 
915
    Use this to create an empty branch, or before importing an
 
 
918
    If there is a repository in a parent directory of the location, then 
 
 
919
    the history of the branch will be stored in the repository.  Otherwise
 
 
920
    init creates a standalone branch which carries its own history in 
 
 
923
    If there is already a branch at the location but it has no working tree,
 
 
924
    the tree can be populated with 'bzr checkout'.
 
 
926
    Recipe for importing a tree of files:
 
 
931
        bzr commit -m 'imported project'
 
 
933
    takes_args = ['location?']
 
 
936
                            help='Specify a format for this branch. Current'
 
 
937
                                 ' formats are: default, knit, metaweave and'
 
 
938
                                 ' weave. Default is knit; metaweave and'
 
 
939
                                 ' weave are deprecated',
 
 
940
                            type=get_format_type),
 
 
942
    def run(self, location=None, format=None):
 
 
943
        from bzrlib.branch import Branch
 
 
945
            format = get_format_type('default')
 
 
949
            # The path has to exist to initialize a
 
 
950
            # branch inside of it.
 
 
951
            # Just using os.mkdir, since I don't
 
 
952
            # believe that we want to create a bunch of
 
 
953
            # locations if the user supplies an extended path
 
 
954
            if not os.path.exists(location):
 
 
957
            existing_bzrdir = bzrdir.BzrDir.open(location)
 
 
958
        except NotBranchError:
 
 
959
            # really a NotBzrDir error...
 
 
960
            bzrdir.BzrDir.create_branch_convenience(location, format=format)
 
 
962
            if existing_bzrdir.has_branch():
 
 
963
                if existing_bzrdir.has_workingtree():
 
 
964
                    raise errors.AlreadyBranchError(location)
 
 
966
                    raise errors.BranchExistsWithoutWorkingTree(location)
 
 
968
                existing_bzrdir.create_branch()
 
 
969
                existing_bzrdir.create_workingtree()
 
 
972
class cmd_init_repository(Command):
 
 
973
    """Create a shared repository to hold branches.
 
 
975
    New branches created under the repository directory will store their revisions
 
 
976
    in the repository, not in the branch directory, if the branch format supports
 
 
982
        bzr checkout --lightweight repo/trunk trunk-checkout
 
 
986
    takes_args = ["location"] 
 
 
987
    takes_options = [Option('format', 
 
 
988
                            help='Specify a format for this repository.'
 
 
989
                                 ' Current formats are: default, knit,'
 
 
990
                                 ' metaweave and weave. Default is knit;'
 
 
991
                                 ' metaweave and weave are deprecated',
 
 
992
                            type=get_format_type),
 
 
994
                             help='Allows branches in repository to have'
 
 
996
    aliases = ["init-repo"]
 
 
997
    def run(self, location, format=None, trees=False):
 
 
998
        from bzrlib.transport import get_transport
 
 
1000
            format = get_format_type('default')
 
 
1001
        transport = get_transport(location)
 
 
1002
        if not transport.has('.'):
 
 
1004
        newdir = format.initialize_on_transport(transport)
 
 
1005
        repo = newdir.create_repository(shared=True)
 
 
1006
        repo.set_make_working_trees(trees)
 
 
1009
class cmd_diff(Command):
 
 
1010
    """Show differences in working tree.
 
 
1012
    If files are listed, only the changes in those files are listed.
 
 
1013
    Otherwise, all changes for the tree are listed.
 
 
1015
    "bzr diff -p1" is equivalent to "bzr diff --prefix old/:new/", and
 
 
1016
    produces patches suitable for "patch -p1".
 
 
1022
        bzr diff --diff-prefix old/:new/
 
 
1023
        bzr diff bzr.mine bzr.dev
 
 
1026
    # TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
1027
    #       or a graphical diff.
 
 
1029
    # TODO: Python difflib is not exactly the same as unidiff; should
 
 
1030
    #       either fix it up or prefer to use an external diff.
 
 
1032
    # TODO: Selected-file diff is inefficient and doesn't show you
 
 
1035
    # TODO: This probably handles non-Unix newlines poorly.
 
 
1037
    takes_args = ['file*']
 
 
1038
    takes_options = ['revision', 'diff-options', 'prefix']
 
 
1039
    aliases = ['di', 'dif']
 
 
1042
    def run(self, revision=None, file_list=None, diff_options=None,
 
 
1044
        from bzrlib.diff import diff_cmd_helper, show_diff_trees
 
 
1046
        if (prefix is None) or (prefix == '0'):
 
 
1054
            if not ':' in prefix:
 
 
1055
                 raise BzrError("--diff-prefix expects two values separated by a colon")
 
 
1056
            old_label, new_label = prefix.split(":")
 
 
1059
            tree1, file_list = internal_tree_files(file_list)
 
 
1063
        except FileInWrongBranch:
 
 
1064
            if len(file_list) != 2:
 
 
1065
                raise BzrCommandError("Files are in different branches")
 
 
1067
            tree1, file1 = WorkingTree.open_containing(file_list[0])
 
 
1068
            tree2, file2 = WorkingTree.open_containing(file_list[1])
 
 
1069
            if file1 != "" or file2 != "":
 
 
1070
                # FIXME diff those two files. rbc 20051123
 
 
1071
                raise BzrCommandError("Files are in different branches")
 
 
1073
        if revision is not None:
 
 
1074
            if tree2 is not None:
 
 
1075
                raise BzrCommandError("Can't specify -r with two branches")
 
 
1076
            if (len(revision) == 1) or (revision[1].spec is None):
 
 
1077
                return diff_cmd_helper(tree1, file_list, diff_options,
 
 
1079
                                       old_label=old_label, new_label=new_label)
 
 
1080
            elif len(revision) == 2:
 
 
1081
                return diff_cmd_helper(tree1, file_list, diff_options,
 
 
1082
                                       revision[0], revision[1],
 
 
1083
                                       old_label=old_label, new_label=new_label)
 
 
1085
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
 
1087
            if tree2 is not None:
 
 
1088
                return show_diff_trees(tree1, tree2, sys.stdout, 
 
 
1089
                                       specific_files=file_list,
 
 
1090
                                       external_diff_options=diff_options,
 
 
1091
                                       old_label=old_label, new_label=new_label)
 
 
1093
                return diff_cmd_helper(tree1, file_list, diff_options,
 
 
1094
                                       old_label=old_label, new_label=new_label)
 
 
1097
class cmd_deleted(Command):
 
 
1098
    """List files deleted in the working tree.
 
 
1100
    # TODO: Show files deleted since a previous revision, or
 
 
1101
    # between two revisions.
 
 
1102
    # TODO: Much more efficient way to do this: read in new
 
 
1103
    # directories with readdir, rather than stating each one.  Same
 
 
1104
    # level of effort but possibly much less IO.  (Or possibly not,
 
 
1105
    # if the directories are very large...)
 
 
1107
    def run(self, show_ids=False):
 
 
1108
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1109
        old = tree.basis_tree()
 
 
1110
        for path, ie in old.inventory.iter_entries():
 
 
1111
            if not tree.has_id(ie.file_id):
 
 
1113
                    print '%-50s %s' % (path, ie.file_id)
 
 
1118
class cmd_modified(Command):
 
 
1119
    """List files modified in working tree."""
 
 
1123
        from bzrlib.delta import compare_trees
 
 
1125
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1126
        td = compare_trees(tree.basis_tree(), tree)
 
 
1128
        for path, id, kind, text_modified, meta_modified in td.modified:
 
 
1133
class cmd_added(Command):
 
 
1134
    """List files added in working tree."""
 
 
1138
        wt = WorkingTree.open_containing(u'.')[0]
 
 
1139
        basis_inv = wt.basis_tree().inventory
 
 
1142
            if file_id in basis_inv:
 
 
1144
            if inv.is_root(file_id) and len(basis_inv) == 0:
 
 
1146
            path = inv.id2path(file_id)
 
 
1147
            if not os.access(bzrlib.osutils.abspath(path), os.F_OK):
 
 
1153
class cmd_root(Command):
 
 
1154
    """Show the tree root directory.
 
 
1156
    The root is the nearest enclosing directory with a .bzr control
 
 
1158
    takes_args = ['filename?']
 
 
1160
    def run(self, filename=None):
 
 
1161
        """Print the branch root."""
 
 
1162
        tree = WorkingTree.open_containing(filename)[0]
 
 
1166
class cmd_log(Command):
 
 
1167
    """Show log of a branch, file, or directory.
 
 
1169
    By default show the log of the branch containing the working directory.
 
 
1171
    To request a range of logs, you can use the command -r begin..end
 
 
1172
    -r revision requests a specific revision, -r ..end or -r begin.. are
 
 
1178
        bzr log -r -10.. http://server/branch
 
 
1181
    # TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
1183
    takes_args = ['location?']
 
 
1184
    takes_options = [Option('forward', 
 
 
1185
                            help='show from oldest to newest'),
 
 
1188
                             help='show files changed in each revision'),
 
 
1189
                     'show-ids', 'revision',
 
 
1193
                            help='show revisions whose message matches this regexp',
 
 
1198
    def run(self, location=None, timezone='original',
 
 
1208
        from bzrlib.log import log_formatter, show_log
 
 
1210
        assert message is None or isinstance(message, basestring), \
 
 
1211
            "invalid message argument %r" % message
 
 
1212
        direction = (forward and 'forward') or 'reverse'
 
 
1217
            # find the file id to log:
 
 
1219
            dir, fp = bzrdir.BzrDir.open_containing(location)
 
 
1220
            b = dir.open_branch()
 
 
1224
                    inv = dir.open_workingtree().inventory
 
 
1225
                except (errors.NotBranchError, errors.NotLocalUrl):
 
 
1226
                    # either no tree, or is remote.
 
 
1227
                    inv = b.basis_tree().inventory
 
 
1228
                file_id = inv.path2id(fp)
 
 
1231
            # FIXME ? log the current subdir only RBC 20060203 
 
 
1232
            dir, relpath = bzrdir.BzrDir.open_containing('.')
 
 
1233
            b = dir.open_branch()
 
 
1235
        if revision is None:
 
 
1238
        elif len(revision) == 1:
 
 
1239
            rev1 = rev2 = revision[0].in_history(b).revno
 
 
1240
        elif len(revision) == 2:
 
 
1241
            if revision[0].spec is None:
 
 
1242
                # missing begin-range means first revision
 
 
1245
                rev1 = revision[0].in_history(b).revno
 
 
1247
            if revision[1].spec is None:
 
 
1248
                # missing end-range means last known revision
 
 
1251
                rev2 = revision[1].in_history(b).revno
 
 
1253
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
 
1255
        # By this point, the revision numbers are converted to the +ve
 
 
1256
        # form if they were supplied in the -ve form, so we can do
 
 
1257
        # this comparison in relative safety
 
 
1259
            (rev2, rev1) = (rev1, rev2)
 
 
1261
        mutter('encoding log as %r', bzrlib.user_encoding)
 
 
1263
        # use 'replace' so that we don't abort if trying to write out
 
 
1264
        # in e.g. the default C locale.
 
 
1265
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
 
1267
        if (log_format == None):
 
 
1268
            default = bzrlib.config.BranchConfig(b).log_format()
 
 
1269
            log_format = get_log_format(long=long, short=short, line=line, default=default)
 
 
1271
        lf = log_formatter(log_format,
 
 
1274
                           show_timezone=timezone)
 
 
1280
                 direction=direction,
 
 
1281
                 start_revision=rev1,
 
 
1286
def get_log_format(long=False, short=False, line=False, default='long'):
 
 
1287
    log_format = default
 
 
1291
        log_format = 'short'
 
 
1297
class cmd_touching_revisions(Command):
 
 
1298
    """Return revision-ids which affected a particular file.
 
 
1300
    A more user-friendly interface is "bzr log FILE"."""
 
 
1302
    takes_args = ["filename"]
 
 
1304
    def run(self, filename):
 
 
1305
        tree, relpath = WorkingTree.open_containing(filename)
 
 
1307
        inv = tree.read_working_inventory()
 
 
1308
        file_id = inv.path2id(relpath)
 
 
1309
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
1310
            print "%6d %s" % (revno, what)
 
 
1313
class cmd_ls(Command):
 
 
1314
    """List files in a tree.
 
 
1316
    # TODO: Take a revision or remote path and list that tree instead.
 
 
1318
    takes_options = ['verbose', 'revision',
 
 
1319
                     Option('non-recursive',
 
 
1320
                            help='don\'t recurse into sub-directories'),
 
 
1322
                            help='Print all paths from the root of the branch.'),
 
 
1323
                     Option('unknown', help='Print unknown files'),
 
 
1324
                     Option('versioned', help='Print versioned files'),
 
 
1325
                     Option('ignored', help='Print ignored files'),
 
 
1327
                     Option('null', help='Null separate the files'),
 
 
1330
    def run(self, revision=None, verbose=False, 
 
 
1331
            non_recursive=False, from_root=False,
 
 
1332
            unknown=False, versioned=False, ignored=False,
 
 
1335
        if verbose and null:
 
 
1336
            raise BzrCommandError('Cannot set both --verbose and --null')
 
 
1337
        all = not (unknown or versioned or ignored)
 
 
1339
        selection = {'I':ignored, '?':unknown, 'V':versioned}
 
 
1341
        tree, relpath = WorkingTree.open_containing(u'.')
 
 
1346
        if revision is not None:
 
 
1347
            tree = tree.branch.repository.revision_tree(
 
 
1348
                revision[0].in_history(tree.branch).rev_id)
 
 
1349
        for fp, fc, kind, fid, entry in tree.list_files():
 
 
1350
            if fp.startswith(relpath):
 
 
1351
                fp = fp[len(relpath):]
 
 
1352
                if non_recursive and '/' in fp:
 
 
1354
                if not all and not selection[fc]:
 
 
1357
                    kindch = entry.kind_character()
 
 
1358
                    print '%-8s %s%s' % (fc, fp, kindch)
 
 
1360
                    sys.stdout.write(fp)
 
 
1361
                    sys.stdout.write('\0')
 
 
1367
class cmd_unknowns(Command):
 
 
1368
    """List unknown files."""
 
 
1371
        from bzrlib.osutils import quotefn
 
 
1372
        for f in WorkingTree.open_containing(u'.')[0].unknowns():
 
 
1376
class cmd_ignore(Command):
 
 
1377
    """Ignore a command or pattern.
 
 
1379
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
1381
    If the pattern contains a slash, it is compared to the whole path
 
 
1382
    from the branch root.  Otherwise, it is compared to only the last
 
 
1383
    component of the path.  To match a file only in the root directory,
 
 
1386
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
1388
    Note: wildcards must be quoted from the shell on Unix.
 
 
1391
        bzr ignore ./Makefile
 
 
1392
        bzr ignore '*.class'
 
 
1394
    # TODO: Complain if the filename is absolute
 
 
1395
    takes_args = ['name_pattern']
 
 
1397
    def run(self, name_pattern):
 
 
1398
        from bzrlib.atomicfile import AtomicFile
 
 
1401
        tree, relpath = WorkingTree.open_containing(u'.')
 
 
1402
        ifn = tree.abspath('.bzrignore')
 
 
1404
        if os.path.exists(ifn):
 
 
1407
                igns = f.read().decode('utf-8')
 
 
1413
        # TODO: If the file already uses crlf-style termination, maybe
 
 
1414
        # we should use that for the newly added lines?
 
 
1416
        if igns and igns[-1] != '\n':
 
 
1418
        igns += name_pattern + '\n'
 
 
1420
        f = AtomicFile(ifn, 'wt')
 
 
1422
            f.write(igns.encode('utf-8'))
 
 
1427
        inv = tree.inventory
 
 
1428
        if inv.path2id('.bzrignore'):
 
 
1429
            mutter('.bzrignore is already versioned')
 
 
1431
            mutter('need to make new .bzrignore file versioned')
 
 
1432
            tree.add(['.bzrignore'])
 
 
1435
class cmd_ignored(Command):
 
 
1436
    """List ignored files and the patterns that matched them.
 
 
1438
    See also: bzr ignore"""
 
 
1441
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1442
        for path, file_class, kind, file_id, entry in tree.list_files():
 
 
1443
            if file_class != 'I':
 
 
1445
            ## XXX: Slightly inefficient since this was already calculated
 
 
1446
            pat = tree.is_ignored(path)
 
 
1447
            print '%-50s %s' % (path, pat)
 
 
1450
class cmd_lookup_revision(Command):
 
 
1451
    """Lookup the revision-id from a revision-number
 
 
1454
        bzr lookup-revision 33
 
 
1457
    takes_args = ['revno']
 
 
1460
    def run(self, revno):
 
 
1464
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
1466
        print WorkingTree.open_containing(u'.')[0].branch.get_rev_id(revno)
 
 
1469
class cmd_export(Command):
 
 
1470
    """Export past revision to destination directory.
 
 
1472
    If no revision is specified this exports the last committed revision.
 
 
1474
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
 
1475
    given, try to find the format with the extension. If no extension
 
 
1476
    is found exports to a directory (equivalent to --format=dir).
 
 
1478
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
 
1479
    is given, the top directory will be the root name of the file.
 
 
1481
    Note: export of tree with non-ascii filenames to zip is not supported.
 
 
1483
     Supported formats       Autodetected by extension
 
 
1484
     -----------------       -------------------------
 
 
1487
         tbz2                    .tar.bz2, .tbz2
 
 
1491
    takes_args = ['dest']
 
 
1492
    takes_options = ['revision', 'format', 'root']
 
 
1493
    def run(self, dest, revision=None, format=None, root=None):
 
 
1495
        from bzrlib.export import export
 
 
1496
        tree = WorkingTree.open_containing(u'.')[0]
 
 
1498
        if revision is None:
 
 
1499
            # should be tree.last_revision  FIXME
 
 
1500
            rev_id = b.last_revision()
 
 
1502
            if len(revision) != 1:
 
 
1503
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
 
1504
            rev_id = revision[0].in_history(b).rev_id
 
 
1505
        t = b.repository.revision_tree(rev_id)
 
 
1507
            export(t, dest, format, root)
 
 
1508
        except errors.NoSuchExportFormat, e:
 
 
1509
            raise BzrCommandError('Unsupported export format: %s' % e.format)
 
 
1512
class cmd_cat(Command):
 
 
1513
    """Write a file's text from a previous revision."""
 
 
1515
    takes_options = ['revision']
 
 
1516
    takes_args = ['filename']
 
 
1519
    def run(self, filename, revision=None):
 
 
1520
        if revision is not None and len(revision) != 1:
 
 
1521
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
 
1524
            tree, relpath = WorkingTree.open_containing(filename)
 
 
1526
        except NotBranchError:
 
 
1530
            b, relpath = Branch.open_containing(filename)
 
 
1531
        if revision is None:
 
 
1532
            revision_id = b.last_revision()
 
 
1534
            revision_id = revision[0].in_history(b).rev_id
 
 
1535
        b.print_file(relpath, revision_id)
 
 
1538
class cmd_local_time_offset(Command):
 
 
1539
    """Show the offset in seconds from GMT to local time."""
 
 
1543
        print bzrlib.osutils.local_time_offset()
 
 
1547
class cmd_commit(Command):
 
 
1548
    """Commit changes into a new revision.
 
 
1550
    If no arguments are given, the entire tree is committed.
 
 
1552
    If selected files are specified, only changes to those files are
 
 
1553
    committed.  If a directory is specified then the directory and everything 
 
 
1554
    within it is committed.
 
 
1556
    A selected-file commit may fail in some cases where the committed
 
 
1557
    tree would be invalid, such as trying to commit a file in a
 
 
1558
    newly-added directory that is not itself committed.
 
 
1560
    # TODO: Run hooks on tree to-be-committed, and after commit.
 
 
1562
    # TODO: Strict commit that fails if there are deleted files.
 
 
1563
    #       (what does "deleted files" mean ??)
 
 
1565
    # TODO: Give better message for -s, --summary, used by tla people
 
 
1567
    # XXX: verbose currently does nothing
 
 
1569
    takes_args = ['selected*']
 
 
1570
    takes_options = ['message', 'verbose', 
 
 
1572
                            help='commit even if nothing has changed'),
 
 
1573
                     Option('file', type=str, 
 
 
1575
                            help='file containing commit message'),
 
 
1577
                            help="refuse to commit if there are unknown "
 
 
1578
                            "files in the working tree."),
 
 
1580
                            help="perform a local only commit in a bound "
 
 
1581
                                 "branch. Such commits are not pushed to "
 
 
1582
                                 "the master branch until a normal commit "
 
 
1586
    aliases = ['ci', 'checkin']
 
 
1588
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
 
1589
            unchanged=False, strict=False, local=False):
 
 
1590
        from bzrlib.commit import (NullCommitReporter, ReportCommitToLog)
 
 
1591
        from bzrlib.errors import (PointlessCommit, ConflictsInTree,
 
 
1593
        from bzrlib.msgeditor import edit_commit_message, \
 
 
1594
                make_commit_message_template
 
 
1595
        from tempfile import TemporaryFile
 
 
1598
        # TODO: Need a blackbox test for invoking the external editor; may be
 
 
1599
        # slightly problematic to run this cross-platform.
 
 
1601
        # TODO: do more checks that the commit will succeed before 
 
 
1602
        # spending the user's valuable time typing a commit message.
 
 
1604
        # TODO: if the commit *does* happen to fail, then save the commit 
 
 
1605
        # message to a temporary file where it can be recovered
 
 
1606
        tree, selected_list = tree_files(selected_list)
 
 
1607
        if selected_list == ['']:
 
 
1608
            # workaround - commit of root of tree should be exactly the same
 
 
1609
            # as just default commit in that tree, and succeed even though
 
 
1610
            # selected-file merge commit is not done yet
 
 
1613
        if local and not tree.branch.get_bound_location():
 
 
1614
            raise errors.LocalRequiresBoundBranch()
 
 
1615
        if message is None and not file:
 
 
1616
            template = make_commit_message_template(tree, selected_list)
 
 
1617
            message = edit_commit_message(template)
 
 
1619
                raise BzrCommandError("please specify a commit message"
 
 
1620
                                      " with either --message or --file")
 
 
1621
        elif message and file:
 
 
1622
            raise BzrCommandError("please specify either --message or --file")
 
 
1626
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
1629
                raise BzrCommandError("empty commit message specified")
 
 
1632
            reporter = ReportCommitToLog()
 
 
1634
            reporter = NullCommitReporter()
 
 
1637
            tree.commit(message, specific_files=selected_list,
 
 
1638
                        allow_pointless=unchanged, strict=strict, local=local,
 
 
1640
        except PointlessCommit:
 
 
1641
            # FIXME: This should really happen before the file is read in;
 
 
1642
            # perhaps prepare the commit; get the message; then actually commit
 
 
1643
            raise BzrCommandError("no changes to commit",
 
 
1644
                                  ["use --unchanged to commit anyhow"])
 
 
1645
        except ConflictsInTree:
 
 
1646
            raise BzrCommandError("Conflicts detected in working tree.  "
 
 
1647
                'Use "bzr conflicts" to list, "bzr resolve FILE" to resolve.')
 
 
1648
        except StrictCommitFailed:
 
 
1649
            raise BzrCommandError("Commit refused because there are unknown "
 
 
1650
                                  "files in the working tree.")
 
 
1651
        except errors.BoundBranchOutOfDate, e:
 
 
1652
            raise BzrCommandError(str(e)
 
 
1653
                                  + ' Either unbind, update, or'
 
 
1654
                                    ' pass --local to commit.')
 
 
1657
class cmd_check(Command):
 
 
1658
    """Validate consistency of branch history.
 
 
1660
    This command checks various invariants about the branch storage to
 
 
1661
    detect data corruption or bzr bugs.
 
 
1663
    takes_args = ['branch?']
 
 
1664
    takes_options = ['verbose']
 
 
1666
    def run(self, branch=None, verbose=False):
 
 
1667
        from bzrlib.check import check
 
 
1669
            tree = WorkingTree.open_containing()[0]
 
 
1670
            branch = tree.branch
 
 
1672
            branch = Branch.open(branch)
 
 
1673
        check(branch, verbose)
 
 
1676
class cmd_scan_cache(Command):
 
 
1679
        from bzrlib.hashcache import HashCache
 
 
1685
        print '%6d stats' % c.stat_count
 
 
1686
        print '%6d in hashcache' % len(c._cache)
 
 
1687
        print '%6d files removed from cache' % c.removed_count
 
 
1688
        print '%6d hashes updated' % c.update_count
 
 
1689
        print '%6d files changed too recently to cache' % c.danger_count
 
 
1695
class cmd_upgrade(Command):
 
 
1696
    """Upgrade branch storage to current format.
 
 
1698
    The check command or bzr developers may sometimes advise you to run
 
 
1699
    this command. When the default format has changed you may also be warned
 
 
1700
    during other operations to upgrade.
 
 
1702
    takes_args = ['url?']
 
 
1705
                            help='Upgrade to a specific format. Current formats'
 
 
1706
                                 ' are: default, knit, metaweave and weave.'
 
 
1707
                                 ' Default is knit; metaweave and weave are'
 
 
1709
                            type=get_format_type),
 
 
1713
    def run(self, url='.', format=None):
 
 
1714
        from bzrlib.upgrade import upgrade
 
 
1716
            format = get_format_type('default')
 
 
1717
        upgrade(url, format)
 
 
1720
class cmd_whoami(Command):
 
 
1721
    """Show bzr user id."""
 
 
1722
    takes_options = ['email']
 
 
1725
    def run(self, email=False):
 
 
1727
            b = WorkingTree.open_containing(u'.')[0].branch
 
 
1728
            config = bzrlib.config.BranchConfig(b)
 
 
1729
        except NotBranchError:
 
 
1730
            config = bzrlib.config.GlobalConfig()
 
 
1733
            print config.user_email()
 
 
1735
            print config.username()
 
 
1738
class cmd_nick(Command):
 
 
1739
    """Print or set the branch nickname.  
 
 
1741
    If unset, the tree root directory name is used as the nickname
 
 
1742
    To print the current nickname, execute with no argument.  
 
 
1744
    takes_args = ['nickname?']
 
 
1745
    def run(self, nickname=None):
 
 
1746
        branch = Branch.open_containing(u'.')[0]
 
 
1747
        if nickname is None:
 
 
1748
            self.printme(branch)
 
 
1750
            branch.nick = nickname
 
 
1753
    def printme(self, branch):
 
 
1757
class cmd_selftest(Command):
 
 
1758
    """Run internal test suite.
 
 
1760
    This creates temporary test directories in the working directory,
 
 
1761
    but not existing data is affected.  These directories are deleted
 
 
1762
    if the tests pass, or left behind to help in debugging if they
 
 
1763
    fail and --keep-output is specified.
 
 
1765
    If arguments are given, they are regular expressions that say
 
 
1766
    which tests should run.
 
 
1768
    If the global option '--no-plugins' is given, plugins are not loaded
 
 
1769
    before running the selftests.  This has two effects: features provided or
 
 
1770
    modified by plugins will not be tested, and tests provided by plugins will
 
 
1775
        bzr --no-plugins selftest -v
 
 
1777
    # TODO: --list should give a list of all available tests
 
 
1779
    # NB: this is used from the class without creating an instance, which is
 
 
1780
    # why it does not have a self parameter.
 
 
1781
    def get_transport_type(typestring):
 
 
1782
        """Parse and return a transport specifier."""
 
 
1783
        if typestring == "sftp":
 
 
1784
            from bzrlib.transport.sftp import SFTPAbsoluteServer
 
 
1785
            return SFTPAbsoluteServer
 
 
1786
        if typestring == "memory":
 
 
1787
            from bzrlib.transport.memory import MemoryServer
 
 
1789
        if typestring == "fakenfs":
 
 
1790
            from bzrlib.transport.fakenfs import FakeNFSServer
 
 
1791
            return FakeNFSServer
 
 
1792
        msg = "No known transport type %s. Supported types are: sftp\n" %\
 
 
1794
        raise BzrCommandError(msg)
 
 
1797
    takes_args = ['testspecs*']
 
 
1798
    takes_options = ['verbose',
 
 
1799
                     Option('one', help='stop when one test fails'),
 
 
1800
                     Option('keep-output', 
 
 
1801
                            help='keep output directories when tests fail'),
 
 
1803
                            help='Use a different transport by default '
 
 
1804
                                 'throughout the test suite.',
 
 
1805
                            type=get_transport_type),
 
 
1806
                     Option('benchmark', help='run the bzr bencharks.'),
 
 
1807
                     Option('lsprof-timed',
 
 
1808
                            help='generate lsprof output for benchmarked'
 
 
1809
                                 ' sections of code.'),
 
 
1812
    def run(self, testspecs_list=None, verbose=None, one=False,
 
 
1813
            keep_output=False, transport=None, benchmark=None,
 
 
1816
        from bzrlib.tests import selftest
 
 
1817
        import bzrlib.benchmarks as benchmarks
 
 
1818
        # we don't want progress meters from the tests to go to the
 
 
1819
        # real output; and we don't want log messages cluttering up
 
 
1821
        save_ui = bzrlib.ui.ui_factory
 
 
1822
        print '%10s: %s' % ('bzr', bzrlib.osutils.realpath(sys.argv[0]))
 
 
1823
        print '%10s: %s' % ('bzrlib', bzrlib.__path__[0])
 
 
1825
        bzrlib.trace.info('running tests...')
 
 
1827
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
 
1828
            if testspecs_list is not None:
 
 
1829
                pattern = '|'.join(testspecs_list)
 
 
1833
                test_suite_factory = benchmarks.test_suite
 
 
1837
                test_suite_factory = None
 
 
1840
            result = selftest(verbose=verbose, 
 
 
1842
                              stop_on_failure=one, 
 
 
1843
                              keep_output=keep_output,
 
 
1844
                              transport=transport,
 
 
1845
                              test_suite_factory=test_suite_factory,
 
 
1846
                              lsprof_timed=lsprof_timed)
 
 
1848
                bzrlib.trace.info('tests passed')
 
 
1850
                bzrlib.trace.info('tests failed')
 
 
1851
            return int(not result)
 
 
1853
            bzrlib.ui.ui_factory = save_ui
 
 
1856
def _get_bzr_branch():
 
 
1857
    """If bzr is run from a branch, return Branch or None"""
 
 
1858
    import bzrlib.errors
 
 
1859
    from bzrlib.branch import Branch
 
 
1860
    from bzrlib.osutils import abspath
 
 
1861
    from os.path import dirname
 
 
1864
        branch = Branch.open(dirname(abspath(dirname(__file__))))
 
 
1866
    except bzrlib.errors.BzrError:
 
 
1871
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1872
    # is bzrlib itself in a branch?
 
 
1873
    branch = _get_bzr_branch()
 
 
1875
        rh = branch.revision_history()
 
 
1877
        print "  bzr checkout, revision %d" % (revno,)
 
 
1878
        print "  nick: %s" % (branch.nick,)
 
 
1880
            print "  revid: %s" % (rh[-1],)
 
 
1881
    print "Using python interpreter:", sys.executable
 
 
1883
    print "Using python standard library:", os.path.dirname(site.__file__)
 
 
1884
    print "Using bzrlib:",
 
 
1885
    if len(bzrlib.__path__) > 1:
 
 
1886
        # print repr, which is a good enough way of making it clear it's
 
 
1887
        # more than one element (eg ['/foo/bar', '/foo/bzr'])
 
 
1888
        print repr(bzrlib.__path__)
 
 
1890
        print bzrlib.__path__[0]
 
 
1893
    print bzrlib.__copyright__
 
 
1894
    print "http://bazaar-vcs.org/"
 
 
1896
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1897
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1898
    print "General Public License version 2 or later."
 
 
1901
class cmd_version(Command):
 
 
1902
    """Show version of bzr."""
 
 
1907
class cmd_rocks(Command):
 
 
1908
    """Statement of optimism."""
 
 
1912
        print "it sure does!"
 
 
1915
class cmd_find_merge_base(Command):
 
 
1916
    """Find and print a base revision for merging two branches.
 
 
1918
    # TODO: Options to specify revisions on either side, as if
 
 
1919
    #       merging only part of the history.
 
 
1920
    takes_args = ['branch', 'other']
 
 
1924
    def run(self, branch, other):
 
 
1925
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
 
1927
        branch1 = Branch.open_containing(branch)[0]
 
 
1928
        branch2 = Branch.open_containing(other)[0]
 
 
1930
        history_1 = branch1.revision_history()
 
 
1931
        history_2 = branch2.revision_history()
 
 
1933
        last1 = branch1.last_revision()
 
 
1934
        last2 = branch2.last_revision()
 
 
1936
        source = MultipleRevisionSources(branch1.repository, 
 
 
1939
        base_rev_id = common_ancestor(last1, last2, source)
 
 
1941
        print 'merge base is revision %s' % base_rev_id
 
 
1945
        if base_revno is None:
 
 
1946
            raise bzrlib.errors.UnrelatedBranches()
 
 
1948
        print ' r%-6d in %s' % (base_revno, branch)
 
 
1950
        other_revno = branch2.revision_id_to_revno(base_revid)
 
 
1952
        print ' r%-6d in %s' % (other_revno, other)
 
 
1956
class cmd_merge(Command):
 
 
1957
    """Perform a three-way merge.
 
 
1959
    The branch is the branch you will merge from.  By default, it will
 
 
1960
    merge the latest revision.  If you specify a revision, that
 
 
1961
    revision will be merged.  If you specify two revisions, the first
 
 
1962
    will be used as a BASE, and the second one as OTHER.  Revision
 
 
1963
    numbers are always relative to the specified branch.
 
 
1965
    By default, bzr will try to merge in all new work from the other
 
 
1966
    branch, automatically determining an appropriate base.  If this
 
 
1967
    fails, you may need to give an explicit base.
 
 
1969
    Merge will do its best to combine the changes in two branches, but there
 
 
1970
    are some kinds of problems only a human can fix.  When it encounters those,
 
 
1971
    it will mark a conflict.  A conflict means that you need to fix something,
 
 
1972
    before you should commit.
 
 
1974
    Use bzr resolve when you have fixed a problem.  See also bzr conflicts.
 
 
1976
    If there is no default branch set, the first merge will set it. After
 
 
1977
    that, you can omit the branch to use the default.  To change the
 
 
1978
    default, use --remember.
 
 
1982
    To merge the latest revision from bzr.dev
 
 
1983
    bzr merge ../bzr.dev
 
 
1985
    To merge changes up to and including revision 82 from bzr.dev
 
 
1986
    bzr merge -r 82 ../bzr.dev
 
 
1988
    To merge the changes introduced by 82, without previous changes:
 
 
1989
    bzr merge -r 81..82 ../bzr.dev
 
 
1991
    merge refuses to run if there are any uncommitted changes, unless
 
 
1994
    The following merge types are available:
 
 
1996
    takes_args = ['branch?']
 
 
1997
    takes_options = ['revision', 'force', 'merge-type', 'reprocess', 'remember',
 
 
1998
                     Option('show-base', help="Show base revision text in "
 
 
2002
        from merge import merge_type_help
 
 
2003
        from inspect import getdoc
 
 
2004
        return getdoc(self) + '\n' + merge_type_help() 
 
 
2006
    def run(self, branch=None, revision=None, force=False, merge_type=None,
 
 
2007
            show_base=False, reprocess=False, remember=False):
 
 
2008
        if merge_type is None:
 
 
2009
            merge_type = Merge3Merger
 
 
2012
        tree = WorkingTree.open_containing(u'.')[0]
 
 
2014
            if branch is not None:
 
 
2015
                reader = BundleReader(file(branch, 'rb'))
 
 
2019
            if e.errno not in (errno.ENOENT, errno.EISDIR):
 
 
2024
        if reader is not None:
 
 
2025
            conflicts = merge_bundle(reader, tree, not force, merge_type,
 
 
2026
                                        reprocess, show_base)
 
 
2032
        stored_loc = tree.branch.get_parent()
 
 
2034
            if stored_loc is None:
 
 
2035
                raise BzrCommandError("No merge branch known or specified.")
 
 
2037
                print "Using saved branch: %s" % stored_loc
 
 
2040
        if tree.branch.get_parent() is None or remember:
 
 
2041
            tree.branch.set_parent(branch)
 
 
2043
        if revision is None or len(revision) < 1:
 
 
2045
            other = [branch, -1]
 
 
2046
            other_branch, path = Branch.open_containing(branch)
 
 
2048
            if len(revision) == 1:
 
 
2050
                other_branch, path = Branch.open_containing(branch)
 
 
2051
                revno = revision[0].in_history(other_branch).revno
 
 
2052
                other = [branch, revno]
 
 
2054
                assert len(revision) == 2
 
 
2055
                if None in revision:
 
 
2056
                    raise BzrCommandError(
 
 
2057
                        "Merge doesn't permit that revision specifier.")
 
 
2058
                b, path = Branch.open_containing(branch)
 
 
2060
                base = [branch, revision[0].in_history(b).revno]
 
 
2061
                other = [branch, revision[1].in_history(b).revno]
 
 
2063
            interesting_files = [path]
 
 
2065
            interesting_files = None
 
 
2066
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
2069
                conflict_count = merge(other, base, check_clean=(not force),
 
 
2070
                                       merge_type=merge_type, 
 
 
2071
                                       reprocess=reprocess,
 
 
2072
                                       show_base=show_base, 
 
 
2073
                                       pb=pb, file_list=interesting_files)
 
 
2076
            if conflict_count != 0:
 
 
2080
        except bzrlib.errors.AmbiguousBase, e:
 
 
2081
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
 
2082
                 "candidates are:\n  "
 
 
2083
                 + "\n  ".join(e.bases)
 
 
2085
                 "please specify an explicit base with -r,\n"
 
 
2086
                 "and (if you want) report this to the bzr developers\n")
 
 
2090
class cmd_remerge(Command):
 
 
2093
    Use this if you want to try a different merge technique while resolving
 
 
2094
    conflicts.  Some merge techniques are better than others, and remerge 
 
 
2095
    lets you try different ones on different files.
 
 
2097
    The options for remerge have the same meaning and defaults as the ones for
 
 
2098
    merge.  The difference is that remerge can (only) be run when there is a
 
 
2099
    pending merge, and it lets you specify particular files.
 
 
2102
    $ bzr remerge --show-base
 
 
2103
        Re-do the merge of all conflicted files, and show the base text in
 
 
2104
        conflict regions, in addition to the usual THIS and OTHER texts.
 
 
2106
    $ bzr remerge --merge-type weave --reprocess foobar
 
 
2107
        Re-do the merge of "foobar", using the weave merge algorithm, with
 
 
2108
        additional processing to reduce the size of conflict regions.
 
 
2110
    The following merge types are available:"""
 
 
2111
    takes_args = ['file*']
 
 
2112
    takes_options = ['merge-type', 'reprocess',
 
 
2113
                     Option('show-base', help="Show base revision text in "
 
 
2117
        from merge import merge_type_help
 
 
2118
        from inspect import getdoc
 
 
2119
        return getdoc(self) + '\n' + merge_type_help() 
 
 
2121
    def run(self, file_list=None, merge_type=None, show_base=False,
 
 
2123
        from bzrlib.merge import merge_inner, transform_tree
 
 
2124
        if merge_type is None:
 
 
2125
            merge_type = Merge3Merger
 
 
2126
        tree, file_list = tree_files(file_list)
 
 
2129
            pending_merges = tree.pending_merges() 
 
 
2130
            if len(pending_merges) != 1:
 
 
2131
                raise BzrCommandError("Sorry, remerge only works after normal"
 
 
2132
                                      + " merges.  Not cherrypicking or"
 
 
2134
            repository = tree.branch.repository
 
 
2135
            base_revision = common_ancestor(tree.branch.last_revision(), 
 
 
2136
                                            pending_merges[0], repository)
 
 
2137
            base_tree = repository.revision_tree(base_revision)
 
 
2138
            other_tree = repository.revision_tree(pending_merges[0])
 
 
2139
            interesting_ids = None
 
 
2140
            if file_list is not None:
 
 
2141
                interesting_ids = set()
 
 
2142
                for filename in file_list:
 
 
2143
                    file_id = tree.path2id(filename)
 
 
2145
                        raise NotVersionedError(filename)
 
 
2146
                    interesting_ids.add(file_id)
 
 
2147
                    if tree.kind(file_id) != "directory":
 
 
2150
                    for name, ie in tree.inventory.iter_entries(file_id):
 
 
2151
                        interesting_ids.add(ie.file_id)
 
 
2152
            transform_tree(tree, tree.basis_tree(), interesting_ids)
 
 
2153
            if file_list is None:
 
 
2154
                restore_files = list(tree.iter_conflicts())
 
 
2156
                restore_files = file_list
 
 
2157
            for filename in restore_files:
 
 
2159
                    restore(tree.abspath(filename))
 
 
2160
                except NotConflicted:
 
 
2162
            conflicts =  merge_inner(tree.branch, other_tree, base_tree,
 
 
2164
                                     interesting_ids = interesting_ids, 
 
 
2165
                                     other_rev_id=pending_merges[0], 
 
 
2166
                                     merge_type=merge_type, 
 
 
2167
                                     show_base=show_base,
 
 
2168
                                     reprocess=reprocess)
 
 
2176
class cmd_revert(Command):
 
 
2177
    """Reverse all changes since the last commit.
 
 
2179
    Only versioned files are affected.  Specify filenames to revert only 
 
 
2180
    those files.  By default, any files that are changed will be backed up
 
 
2181
    first.  Backup files have a '~' appended to their name.
 
 
2183
    takes_options = ['revision', 'no-backup']
 
 
2184
    takes_args = ['file*']
 
 
2185
    aliases = ['merge-revert']
 
 
2187
    def run(self, revision=None, no_backup=False, file_list=None):
 
 
2188
        from bzrlib.commands import parse_spec
 
 
2189
        if file_list is not None:
 
 
2190
            if len(file_list) == 0:
 
 
2191
                raise BzrCommandError("No files specified")
 
 
2195
        tree, file_list = tree_files(file_list)
 
 
2196
        if revision is None:
 
 
2197
            # FIXME should be tree.last_revision
 
 
2198
            rev_id = tree.last_revision()
 
 
2199
        elif len(revision) != 1:
 
 
2200
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
2202
            rev_id = revision[0].in_history(tree.branch).rev_id
 
 
2203
        pb = bzrlib.ui.ui_factory.nested_progress_bar()
 
 
2205
            tree.revert(file_list, 
 
 
2206
                        tree.branch.repository.revision_tree(rev_id),
 
 
2212
class cmd_assert_fail(Command):
 
 
2213
    """Test reporting of assertion failures"""
 
 
2216
        assert False, "always fails"
 
 
2219
class cmd_help(Command):
 
 
2220
    """Show help on a command or other topic.
 
 
2222
    For a list of all available commands, say 'bzr help commands'."""
 
 
2223
    takes_options = [Option('long', 'show help on all commands')]
 
 
2224
    takes_args = ['topic?']
 
 
2225
    aliases = ['?', '--help', '-?', '-h']
 
 
2228
    def run(self, topic=None, long=False):
 
 
2230
        if topic is None and long:
 
 
2235
class cmd_shell_complete(Command):
 
 
2236
    """Show appropriate completions for context.
 
 
2238
    For a list of all available commands, say 'bzr shell-complete'."""
 
 
2239
    takes_args = ['context?']
 
 
2244
    def run(self, context=None):
 
 
2245
        import shellcomplete
 
 
2246
        shellcomplete.shellcomplete(context)
 
 
2249
class cmd_fetch(Command):
 
 
2250
    """Copy in history from another branch but don't merge it.
 
 
2252
    This is an internal method used for pull and merge."""
 
 
2254
    takes_args = ['from_branch', 'to_branch']
 
 
2255
    def run(self, from_branch, to_branch):
 
 
2256
        from bzrlib.fetch import Fetcher
 
 
2257
        from bzrlib.branch import Branch
 
 
2258
        from_b = Branch.open(from_branch)
 
 
2259
        to_b = Branch.open(to_branch)
 
 
2260
        Fetcher(to_b, from_b)
 
 
2263
class cmd_missing(Command):
 
 
2264
    """Show unmerged/unpulled revisions between two branches.
 
 
2266
    OTHER_BRANCH may be local or remote."""
 
 
2267
    takes_args = ['other_branch?']
 
 
2268
    takes_options = [Option('reverse', 'Reverse the order of revisions'),
 
 
2270
                            'Display changes in the local branch only'),
 
 
2271
                     Option('theirs-only', 
 
 
2272
                            'Display changes in the remote branch only'), 
 
 
2281
    def run(self, other_branch=None, reverse=False, mine_only=False,
 
 
2282
            theirs_only=False, log_format=None, long=False, short=False, line=False, 
 
 
2283
            show_ids=False, verbose=False):
 
 
2284
        from bzrlib.missing import find_unmerged, iter_log_data
 
 
2285
        from bzrlib.log import log_formatter
 
 
2286
        local_branch = bzrlib.branch.Branch.open_containing(u".")[0]
 
 
2287
        parent = local_branch.get_parent()
 
 
2288
        if other_branch is None:
 
 
2289
            other_branch = parent
 
 
2290
            if other_branch is None:
 
 
2291
                raise BzrCommandError("No missing location known or specified.")
 
 
2292
            print "Using last location: " + local_branch.get_parent()
 
 
2293
        remote_branch = bzrlib.branch.Branch.open(other_branch)
 
 
2294
        if remote_branch.base == local_branch.base:
 
 
2295
            remote_branch = local_branch
 
 
2296
        local_branch.lock_read()
 
 
2298
            remote_branch.lock_read()
 
 
2300
                local_extra, remote_extra = find_unmerged(local_branch, remote_branch)
 
 
2301
                if (log_format == None):
 
 
2302
                    default = bzrlib.config.BranchConfig(local_branch).log_format()
 
 
2303
                    log_format = get_log_format(long=long, short=short, line=line, default=default)
 
 
2304
                lf = log_formatter(log_format, sys.stdout,
 
 
2306
                                   show_timezone='original')
 
 
2307
                if reverse is False:
 
 
2308
                    local_extra.reverse()
 
 
2309
                    remote_extra.reverse()
 
 
2310
                if local_extra and not theirs_only:
 
 
2311
                    print "You have %d extra revision(s):" % len(local_extra)
 
 
2312
                    for data in iter_log_data(local_extra, local_branch.repository,
 
 
2315
                    printed_local = True
 
 
2317
                    printed_local = False
 
 
2318
                if remote_extra and not mine_only:
 
 
2319
                    if printed_local is True:
 
 
2321
                    print "You are missing %d revision(s):" % len(remote_extra)
 
 
2322
                    for data in iter_log_data(remote_extra, remote_branch.repository, 
 
 
2325
                if not remote_extra and not local_extra:
 
 
2327
                    print "Branches are up to date."
 
 
2331
                remote_branch.unlock()
 
 
2333
            local_branch.unlock()
 
 
2334
        if not status_code and parent is None and other_branch is not None:
 
 
2335
            local_branch.lock_write()
 
 
2337
                # handle race conditions - a parent might be set while we run.
 
 
2338
                if local_branch.get_parent() is None:
 
 
2339
                    local_branch.set_parent(other_branch)
 
 
2341
                local_branch.unlock()
 
 
2345
class cmd_plugins(Command):
 
 
2350
        import bzrlib.plugin
 
 
2351
        from inspect import getdoc
 
 
2352
        for name, plugin in bzrlib.plugin.all_plugins().items():
 
 
2353
            if hasattr(plugin, '__path__'):
 
 
2354
                print plugin.__path__[0]
 
 
2355
            elif hasattr(plugin, '__file__'):
 
 
2356
                print plugin.__file__
 
 
2362
                print '\t', d.split('\n')[0]
 
 
2365
class cmd_testament(Command):
 
 
2366
    """Show testament (signing-form) of a revision."""
 
 
2367
    takes_options = ['revision', 'long']
 
 
2368
    takes_args = ['branch?']
 
 
2370
    def run(self, branch=u'.', revision=None, long=False):
 
 
2371
        from bzrlib.testament import Testament
 
 
2372
        b = WorkingTree.open_containing(branch)[0].branch
 
 
2375
            if revision is None:
 
 
2376
                rev_id = b.last_revision()
 
 
2378
                rev_id = revision[0].in_history(b).rev_id
 
 
2379
            t = Testament.from_revision(b.repository, rev_id)
 
 
2381
                sys.stdout.writelines(t.as_text_lines())
 
 
2383
                sys.stdout.write(t.as_short_text())
 
 
2388
class cmd_annotate(Command):
 
 
2389
    """Show the origin of each line in a file.
 
 
2391
    This prints out the given file with an annotation on the left side
 
 
2392
    indicating which revision, author and date introduced the change.
 
 
2394
    If the origin is the same for a run of consecutive lines, it is 
 
 
2395
    shown only at the top, unless the --all option is given.
 
 
2397
    # TODO: annotate directories; showing when each file was last changed
 
 
2398
    # TODO: if the working copy is modified, show annotations on that 
 
 
2399
    #       with new uncommitted lines marked
 
 
2400
    aliases = ['blame', 'praise']
 
 
2401
    takes_args = ['filename']
 
 
2402
    takes_options = [Option('all', help='show annotations on all lines'),
 
 
2403
                     Option('long', help='show date in annotations'),
 
 
2408
    def run(self, filename, all=False, long=False, revision=None):
 
 
2409
        from bzrlib.annotate import annotate_file
 
 
2410
        tree, relpath = WorkingTree.open_containing(filename)
 
 
2411
        branch = tree.branch
 
 
2414
            if revision is None:
 
 
2415
                revision_id = branch.last_revision()
 
 
2416
            elif len(revision) != 1:
 
 
2417
                raise BzrCommandError('bzr annotate --revision takes exactly 1 argument')
 
 
2419
                revision_id = revision[0].in_history(branch).rev_id
 
 
2420
            file_id = tree.inventory.path2id(relpath)
 
 
2421
            tree = branch.repository.revision_tree(revision_id)
 
 
2422
            file_version = tree.inventory[file_id].revision
 
 
2423
            annotate_file(branch, file_version, file_id, long, all, sys.stdout)
 
 
2428
class cmd_re_sign(Command):
 
 
2429
    """Create a digital signature for an existing revision."""
 
 
2430
    # TODO be able to replace existing ones.
 
 
2432
    hidden = True # is this right ?
 
 
2433
    takes_args = ['revision_id*']
 
 
2434
    takes_options = ['revision']
 
 
2436
    def run(self, revision_id_list=None, revision=None):
 
 
2437
        import bzrlib.config as config
 
 
2438
        import bzrlib.gpg as gpg
 
 
2439
        if revision_id_list is not None and revision is not None:
 
 
2440
            raise BzrCommandError('You can only supply one of revision_id or --revision')
 
 
2441
        if revision_id_list is None and revision is None:
 
 
2442
            raise BzrCommandError('You must supply either --revision or a revision_id')
 
 
2443
        b = WorkingTree.open_containing(u'.')[0].branch
 
 
2444
        gpg_strategy = gpg.GPGStrategy(config.BranchConfig(b))
 
 
2445
        if revision_id_list is not None:
 
 
2446
            for revision_id in revision_id_list:
 
 
2447
                b.repository.sign_revision(revision_id, gpg_strategy)
 
 
2448
        elif revision is not None:
 
 
2449
            if len(revision) == 1:
 
 
2450
                revno, rev_id = revision[0].in_history(b)
 
 
2451
                b.repository.sign_revision(rev_id, gpg_strategy)
 
 
2452
            elif len(revision) == 2:
 
 
2453
                # are they both on rh- if so we can walk between them
 
 
2454
                # might be nice to have a range helper for arbitrary
 
 
2455
                # revision paths. hmm.
 
 
2456
                from_revno, from_revid = revision[0].in_history(b)
 
 
2457
                to_revno, to_revid = revision[1].in_history(b)
 
 
2458
                if to_revid is None:
 
 
2459
                    to_revno = b.revno()
 
 
2460
                if from_revno is None or to_revno is None:
 
 
2461
                    raise BzrCommandError('Cannot sign a range of non-revision-history revisions')
 
 
2462
                for revno in range(from_revno, to_revno + 1):
 
 
2463
                    b.repository.sign_revision(b.get_rev_id(revno), 
 
 
2466
                raise BzrCommandError('Please supply either one revision, or a range.')
 
 
2469
class cmd_bind(Command):
 
 
2470
    """Bind the current branch to a master branch.
 
 
2472
    After binding, commits must succeed on the master branch
 
 
2473
    before they are executed on the local one.
 
 
2476
    takes_args = ['location']
 
 
2479
    def run(self, location=None):
 
 
2480
        b, relpath = Branch.open_containing(u'.')
 
 
2481
        b_other = Branch.open(location)
 
 
2484
        except DivergedBranches:
 
 
2485
            raise BzrCommandError('These branches have diverged.'
 
 
2486
                                  ' Try merging, and then bind again.')
 
 
2489
class cmd_unbind(Command):
 
 
2490
    """Unbind the current branch from its master branch.
 
 
2492
    After unbinding, the local branch is considered independent.
 
 
2493
    All subsequent commits will be local.
 
 
2500
        b, relpath = Branch.open_containing(u'.')
 
 
2502
            raise BzrCommandError('Local branch is not bound')
 
 
2505
class cmd_uncommit(bzrlib.commands.Command):
 
 
2506
    """Remove the last committed revision.
 
 
2508
    --verbose will print out what is being removed.
 
 
2509
    --dry-run will go through all the motions, but not actually
 
 
2512
    In the future, uncommit will create a revision bundle, which can then
 
 
2516
    # TODO: jam 20060108 Add an option to allow uncommit to remove
 
 
2517
    # unreferenced information in 'branch-as-repostory' branches.
 
 
2518
    # TODO: jam 20060108 Add the ability for uncommit to remove unreferenced
 
 
2519
    # information in shared branches as well.
 
 
2520
    takes_options = ['verbose', 'revision',
 
 
2521
                    Option('dry-run', help='Don\'t actually make changes'),
 
 
2522
                    Option('force', help='Say yes to all questions.')]
 
 
2523
    takes_args = ['location?']
 
 
2526
    def run(self, location=None, 
 
 
2527
            dry_run=False, verbose=False,
 
 
2528
            revision=None, force=False):
 
 
2529
        from bzrlib.branch import Branch
 
 
2530
        from bzrlib.log import log_formatter
 
 
2532
        from bzrlib.uncommit import uncommit
 
 
2534
        if location is None:
 
 
2536
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
 
2538
            tree = control.open_workingtree()
 
 
2540
        except (errors.NoWorkingTree, errors.NotLocalUrl):
 
 
2542
            b = control.open_branch()
 
 
2544
        if revision is None:
 
 
2546
            rev_id = b.last_revision()
 
 
2548
            revno, rev_id = revision[0].in_history(b)
 
 
2550
            print 'No revisions to uncommit.'
 
 
2552
        for r in range(revno, b.revno()+1):
 
 
2553
            rev_id = b.get_rev_id(r)
 
 
2554
            lf = log_formatter('short', to_file=sys.stdout,show_timezone='original')
 
 
2555
            lf.show(r, b.repository.get_revision(rev_id), None)
 
 
2558
            print 'Dry-run, pretending to remove the above revisions.'
 
 
2560
                val = raw_input('Press <enter> to continue')
 
 
2562
            print 'The above revision(s) will be removed.'
 
 
2564
                val = raw_input('Are you sure [y/N]? ')
 
 
2565
                if val.lower() not in ('y', 'yes'):
 
 
2569
        uncommit(b, tree=tree, dry_run=dry_run, verbose=verbose,
 
 
2573
class cmd_break_lock(Command):
 
 
2574
    """Break a dead lock on a repository, branch or working directory.
 
 
2576
    CAUTION: Locks should only be broken when you are sure that the process
 
 
2577
    holding the lock has been stopped.
 
 
2579
    You can get information on what locks are open via the 'bzr info' command.
 
 
2584
    takes_args = ['location?']
 
 
2586
    def run(self, location=None, show=False):
 
 
2587
        if location is None:
 
 
2589
        control, relpath = bzrdir.BzrDir.open_containing(location)
 
 
2591
            control.break_lock()
 
 
2592
        except NotImplementedError:
 
 
2597
# command-line interpretation helper for merge-related commands
 
 
2598
def merge(other_revision, base_revision,
 
 
2599
          check_clean=True, ignore_zero=False,
 
 
2600
          this_dir=None, backup_files=False, merge_type=Merge3Merger,
 
 
2601
          file_list=None, show_base=False, reprocess=False,
 
 
2602
          pb=DummyProgress()):
 
 
2603
    """Merge changes into a tree.
 
 
2606
        list(path, revno) Base for three-way merge.  
 
 
2607
        If [None, None] then a base will be automatically determined.
 
 
2609
        list(path, revno) Other revision for three-way merge.
 
 
2611
        Directory to merge changes into; '.' by default.
 
 
2613
        If true, this_dir must have no uncommitted changes before the
 
 
2615
    ignore_zero - If true, suppress the "zero conflicts" message when 
 
 
2616
        there are no conflicts; should be set when doing something we expect
 
 
2617
        to complete perfectly.
 
 
2618
    file_list - If supplied, merge only changes to selected files.
 
 
2620
    All available ancestors of other_revision and base_revision are
 
 
2621
    automatically pulled into the branch.
 
 
2623
    The revno may be -1 to indicate the last revision on the branch, which is
 
 
2626
    This function is intended for use from the command line; programmatic
 
 
2627
    clients might prefer to call merge.merge_inner(), which has less magic 
 
 
2630
    from bzrlib.merge import Merger
 
 
2631
    if this_dir is None:
 
 
2633
    this_tree = WorkingTree.open_containing(this_dir)[0]
 
 
2634
    if show_base and not merge_type is Merge3Merger:
 
 
2635
        raise BzrCommandError("Show-base is not supported for this merge"
 
 
2636
                              " type. %s" % merge_type)
 
 
2637
    if reprocess and not merge_type.supports_reprocess:
 
 
2638
        raise BzrCommandError("Conflict reduction is not supported for merge"
 
 
2639
                              " type %s." % merge_type)
 
 
2640
    if reprocess and show_base:
 
 
2641
        raise BzrCommandError("Cannot do conflict reduction and show base.")
 
 
2643
        merger = Merger(this_tree.branch, this_tree=this_tree, pb=pb)
 
 
2644
        merger.pp = ProgressPhase("Merge phase", 5, pb)
 
 
2645
        merger.pp.next_phase()
 
 
2646
        merger.check_basis(check_clean)
 
 
2647
        merger.set_other(other_revision)
 
 
2648
        merger.pp.next_phase()
 
 
2649
        merger.set_base(base_revision)
 
 
2650
        if merger.base_rev_id == merger.other_rev_id:
 
 
2651
            note('Nothing to do.')
 
 
2653
        merger.backup_files = backup_files
 
 
2654
        merger.merge_type = merge_type 
 
 
2655
        merger.set_interesting_files(file_list)
 
 
2656
        merger.show_base = show_base 
 
 
2657
        merger.reprocess = reprocess
 
 
2658
        conflicts = merger.do_merge()
 
 
2659
        if file_list is None:
 
 
2660
            merger.set_pending()
 
 
2666
# these get imported and then picked up by the scan for cmd_*
 
 
2667
# TODO: Some more consistent way to split command definitions across files;
 
 
2668
# we do need to load at least some information about them to know of 
 
 
2669
# aliases.  ideally we would avoid loading the implementation until the
 
 
2670
# details were needed.
 
 
2671
from bzrlib.conflicts import cmd_resolve, cmd_conflicts, restore
 
 
2672
from bzrlib.bundle.commands import cmd_bundle_revisions
 
 
2673
from bzrlib.sign_my_commits import cmd_sign_my_commits
 
 
2674
from bzrlib.weave_commands import cmd_weave_list, cmd_weave_join, \
 
 
2675
        cmd_weave_plan_merge, cmd_weave_merge_text