1
# Copyright (C) 2004, 2005 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
 
 
23
from bzrlib.trace import mutter, note, log_error, warning
 
 
24
from bzrlib.errors import BzrError, BzrCheckError, BzrCommandError
 
 
25
from bzrlib.branch import find_branch
 
 
26
from bzrlib import BZRDIR
 
 
27
from bzrlib.commands import Command
 
 
30
class cmd_status(Command):
 
 
31
    """Display status summary.
 
 
33
    This reports on versioned and unknown files, reporting them
 
 
34
    grouped by state.  Possible states are:
 
 
37
        Versioned in the working copy but not in the previous revision.
 
 
40
        Versioned in the previous revision but removed or deleted
 
 
44
        Path of this file changed from the previous revision;
 
 
45
        the text may also have changed.  This includes files whose
 
 
46
        parent directory was renamed.
 
 
49
        Text has changed since the previous revision.
 
 
52
        Nothing about this file has changed since the previous revision.
 
 
53
        Only shown with --all.
 
 
56
        Not versioned and not matching an ignore pattern.
 
 
58
    To see ignored files use 'bzr ignored'.  For details in the
 
 
59
    changes to file texts, use 'bzr diff'.
 
 
61
    If no arguments are specified, the status of the entire working
 
 
62
    directory is shown.  Otherwise, only the status of the specified
 
 
63
    files or directories is reported.  If a directory is given, status
 
 
64
    is reported for everything inside that directory.
 
 
66
    takes_args = ['file*']
 
 
67
    takes_options = ['all', 'show-ids']
 
 
68
    aliases = ['st', 'stat']
 
 
70
    def run(self, all=False, show_ids=False, file_list=None):
 
 
72
            b = find_branch(file_list[0])
 
 
73
            file_list = [b.relpath(x) for x in file_list]
 
 
74
            # special case: only one path was given and it's the root
 
 
81
        from bzrlib.status import show_status
 
 
82
        show_status(b, show_unchanged=all, show_ids=show_ids,
 
 
83
                    specific_files=file_list)
 
 
86
class cmd_cat_revision(Command):
 
 
87
    """Write out metadata for a revision."""
 
 
90
    takes_args = ['revision_id']
 
 
92
    def run(self, revision_id):
 
 
94
        sys.stdout.write(b.get_revision_xml_file(revision_id).read())
 
 
97
class cmd_revno(Command):
 
 
98
    """Show current revision number.
 
 
100
    This is equal to the number of revisions on this branch."""
 
 
102
        print find_branch('.').revno()
 
 
105
class cmd_revision_info(Command):
 
 
106
    """Show revision number and revision id for a given revision identifier.
 
 
109
    takes_args = ['revision_info*']
 
 
110
    takes_options = ['revision']
 
 
111
    def run(self, revision=None, revision_info_list=None):
 
 
112
        from bzrlib.branch import find_branch
 
 
115
        if revision is not None:
 
 
116
            revs.extend(revision)
 
 
117
        if revision_info_list is not None:
 
 
118
            revs.extend(revision_info_list)
 
 
120
            raise BzrCommandError('You must supply a revision identifier')
 
 
125
            print '%4d %s' % b.get_revision_info(rev)
 
 
128
class cmd_add(Command):
 
 
129
    """Add specified files or directories.
 
 
131
    In non-recursive mode, all the named items are added, regardless
 
 
132
    of whether they were previously ignored.  A warning is given if
 
 
133
    any of the named files are already versioned.
 
 
135
    In recursive mode (the default), files are treated the same way
 
 
136
    but the behaviour for directories is different.  Directories that
 
 
137
    are already versioned do not give a warning.  All directories,
 
 
138
    whether already versioned or not, are searched for files or
 
 
139
    subdirectories that are neither versioned or ignored, and these
 
 
140
    are added.  This search proceeds recursively into versioned
 
 
141
    directories.  If no names are given '.' is assumed.
 
 
143
    Therefore simply saying 'bzr add' will version all files that
 
 
144
    are currently unknown.
 
 
146
    TODO: Perhaps adding a file whose directly is not versioned should
 
 
147
    recursively add that parent, rather than giving an error?
 
 
149
    takes_args = ['file*']
 
 
150
    takes_options = ['verbose', 'no-recurse']
 
 
152
    def run(self, file_list, verbose=False, no_recurse=False):
 
 
153
        # verbose currently has no effect
 
 
154
        from bzrlib.add import smart_add, add_reporter_print
 
 
155
        smart_add(file_list, not no_recurse, add_reporter_print)
 
 
159
class cmd_mkdir(Command):
 
 
160
    """Create a new versioned directory.
 
 
162
    This is equivalent to creating the directory and then adding it.
 
 
164
    takes_args = ['dir+']
 
 
166
    def run(self, dir_list):
 
 
177
class cmd_relpath(Command):
 
 
178
    """Show path of a file relative to root"""
 
 
179
    takes_args = ['filename']
 
 
182
    def run(self, filename):
 
 
183
        print find_branch(filename).relpath(filename)
 
 
187
class cmd_inventory(Command):
 
 
188
    """Show inventory of the current working copy or a revision."""
 
 
189
    takes_options = ['revision', 'show-ids']
 
 
191
    def run(self, revision=None, show_ids=False):
 
 
194
            inv = b.read_working_inventory()
 
 
196
            if len(revision) > 1:
 
 
197
                raise BzrCommandError('bzr inventory --revision takes'
 
 
198
                    ' exactly one revision identifier')
 
 
199
            inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
 
 
201
        for path, entry in inv.entries():
 
 
203
                print '%-50s %s' % (path, entry.file_id)
 
 
208
class cmd_move(Command):
 
 
209
    """Move files to a different directory.
 
 
214
    The destination must be a versioned directory in the same branch.
 
 
216
    takes_args = ['source$', 'dest']
 
 
217
    def run(self, source_list, dest):
 
 
220
        # TODO: glob expansion on windows?
 
 
221
        b.move([b.relpath(s) for s in source_list], b.relpath(dest))
 
 
224
class cmd_rename(Command):
 
 
225
    """Change the name of an entry.
 
 
228
      bzr rename frob.c frobber.c
 
 
229
      bzr rename src/frob.c lib/frob.c
 
 
231
    It is an error if the destination name exists.
 
 
233
    See also the 'move' command, which moves files into a different
 
 
234
    directory without changing their name.
 
 
236
    TODO: Some way to rename multiple files without invoking bzr for each
 
 
238
    takes_args = ['from_name', 'to_name']
 
 
240
    def run(self, from_name, to_name):
 
 
242
        b.rename_one(b.relpath(from_name), b.relpath(to_name))
 
 
246
class cmd_mv(Command):
 
 
247
    """Move or rename a file.
 
 
250
        bzr mv OLDNAME NEWNAME
 
 
251
        bzr mv SOURCE... DESTINATION
 
 
253
    If the last argument is a versioned directory, all the other names
 
 
254
    are moved into it.  Otherwise, there must be exactly two arguments
 
 
255
    and the file is changed to a new name, which must not already exist.
 
 
257
    Files cannot be moved between branches.
 
 
259
    takes_args = ['names*']
 
 
260
    def run(self, names_list):
 
 
261
        if len(names_list) < 2:
 
 
262
            raise BzrCommandError("missing file argument")
 
 
263
        b = find_branch(names_list[0])
 
 
265
        rel_names = [b.relpath(x) for x in names_list]
 
 
267
        if os.path.isdir(names_list[-1]):
 
 
268
            # move into existing directory
 
 
269
            for pair in b.move(rel_names[:-1], rel_names[-1]):
 
 
270
                print "%s => %s" % pair
 
 
272
            if len(names_list) != 2:
 
 
273
                raise BzrCommandError('to mv multiple files the destination '
 
 
274
                                      'must be a versioned directory')
 
 
275
            for pair in b.move(rel_names[0], rel_names[1]):
 
 
276
                print "%s => %s" % pair
 
 
281
class cmd_pull(Command):
 
 
282
    """Pull any changes from another branch into the current one.
 
 
284
    If the location is omitted, the last-used location will be used.
 
 
285
    Both the revision history and the working directory will be
 
 
288
    This command only works on branches that have not diverged.  Branches are
 
 
289
    considered diverged if both branches have had commits without first
 
 
290
    pulling from the other.
 
 
292
    If branches have diverged, you can use 'bzr merge' to pull the text changes
 
 
293
    from one into the other.
 
 
295
    takes_args = ['location?']
 
 
297
    def run(self, location=None):
 
 
298
        from bzrlib.merge import merge
 
 
300
        from shutil import rmtree
 
 
303
        br_to = find_branch('.')
 
 
306
            stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
 
 
308
            if e.errno != errno.ENOENT:
 
 
311
            if stored_loc is None:
 
 
312
                raise BzrCommandError("No pull location known or specified.")
 
 
314
                print "Using last location: %s" % stored_loc
 
 
315
                location = stored_loc
 
 
316
        cache_root = tempfile.mkdtemp()
 
 
317
        from bzrlib.branch import DivergedBranches
 
 
318
        br_from = find_branch(location)
 
 
319
        location = br_from.base
 
 
320
        old_revno = br_to.revno()
 
 
322
            from branch import find_cached_branch, DivergedBranches
 
 
323
            br_from = find_cached_branch(location, cache_root)
 
 
324
            location = br_from.base
 
 
325
            old_revno = br_to.revno()
 
 
327
                br_to.update_revisions(br_from)
 
 
328
            except DivergedBranches:
 
 
329
                raise BzrCommandError("These branches have diverged."
 
 
332
            merge(('.', -1), ('.', old_revno), check_clean=False)
 
 
333
            if location != stored_loc:
 
 
334
                br_to.controlfile("x-pull", "wb").write(location + "\n")
 
 
340
class cmd_branch(Command):
 
 
341
    """Create a new copy of a branch.
 
 
343
    If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
 
 
344
    be used.  In other words, "branch ../foo/bar" will attempt to create ./bar.
 
 
346
    To retrieve the branch as of a particular revision, supply the --revision
 
 
347
    parameter, as in "branch foo/bar -r 5".
 
 
349
    takes_args = ['from_location', 'to_location?']
 
 
350
    takes_options = ['revision']
 
 
351
    aliases = ['get', 'clone']
 
 
353
    def run(self, from_location, to_location=None, revision=None):
 
 
354
        from bzrlib.branch import copy_branch, find_cached_branch
 
 
357
        from shutil import rmtree
 
 
358
        cache_root = tempfile.mkdtemp()
 
 
362
            elif len(revision) > 1:
 
 
363
                raise BzrCommandError(
 
 
364
                    'bzr branch --revision takes exactly 1 revision value')
 
 
366
                br_from = find_cached_branch(from_location, cache_root)
 
 
368
                if e.errno == errno.ENOENT:
 
 
369
                    raise BzrCommandError('Source location "%s" does not'
 
 
370
                                          ' exist.' % to_location)
 
 
373
            if to_location is None:
 
 
374
                to_location = os.path.basename(from_location.rstrip("/\\"))
 
 
376
                os.mkdir(to_location)
 
 
378
                if e.errno == errno.EEXIST:
 
 
379
                    raise BzrCommandError('Target directory "%s" already'
 
 
380
                                          ' exists.' % to_location)
 
 
381
                if e.errno == errno.ENOENT:
 
 
382
                    raise BzrCommandError('Parent of "%s" does not exist.' %
 
 
387
                copy_branch(br_from, to_location, revision[0])
 
 
388
            except bzrlib.errors.NoSuchRevision:
 
 
390
                msg = "The branch %s has no revision %d." % (from_location, revision[0])
 
 
391
                raise BzrCommandError(msg)
 
 
396
class cmd_renames(Command):
 
 
397
    """Show list of renamed files.
 
 
399
    TODO: Option to show renames between two historical versions.
 
 
401
    TODO: Only show renames under dir, rather than in the whole branch.
 
 
403
    takes_args = ['dir?']
 
 
405
    def run(self, dir='.'):
 
 
407
        old_inv = b.basis_tree().inventory
 
 
408
        new_inv = b.read_working_inventory()
 
 
410
        renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
 
 
412
        for old_name, new_name in renames:
 
 
413
            print "%s => %s" % (old_name, new_name)        
 
 
416
class cmd_info(Command):
 
 
417
    """Show statistical information about a branch."""
 
 
418
    takes_args = ['branch?']
 
 
420
    def run(self, branch=None):
 
 
423
        b = find_branch(branch)
 
 
427
class cmd_remove(Command):
 
 
428
    """Make a file unversioned.
 
 
430
    This makes bzr stop tracking changes to a versioned file.  It does
 
 
431
    not delete the working copy.
 
 
433
    takes_args = ['file+']
 
 
434
    takes_options = ['verbose']
 
 
436
    def run(self, file_list, verbose=False):
 
 
437
        b = find_branch(file_list[0])
 
 
438
        b.remove([b.relpath(f) for f in file_list], verbose=verbose)
 
 
441
class cmd_file_id(Command):
 
 
442
    """Print file_id of a particular file or directory.
 
 
444
    The file_id is assigned when the file is first added and remains the
 
 
445
    same through all revisions where the file exists, even when it is
 
 
449
    takes_args = ['filename']
 
 
450
    def run(self, filename):
 
 
451
        b = find_branch(filename)
 
 
452
        i = b.inventory.path2id(b.relpath(filename))
 
 
454
            raise BzrError("%r is not a versioned file" % filename)
 
 
459
class cmd_file_path(Command):
 
 
460
    """Print path of file_ids to a file or directory.
 
 
462
    This prints one line for each directory down to the target,
 
 
463
    starting at the branch root."""
 
 
465
    takes_args = ['filename']
 
 
466
    def run(self, filename):
 
 
467
        b = find_branch(filename)
 
 
469
        fid = inv.path2id(b.relpath(filename))
 
 
471
            raise BzrError("%r is not a versioned file" % filename)
 
 
472
        for fip in inv.get_idpath(fid):
 
 
476
class cmd_revision_history(Command):
 
 
477
    """Display list of revision ids on this branch."""
 
 
480
        for patchid in find_branch('.').revision_history():
 
 
484
class cmd_directories(Command):
 
 
485
    """Display list of versioned directories in this branch."""
 
 
487
        for name, ie in find_branch('.').read_working_inventory().directories():
 
 
494
class cmd_init(Command):
 
 
495
    """Make a directory into a versioned branch.
 
 
497
    Use this to create an empty branch, or before importing an
 
 
500
    Recipe for importing a tree of files:
 
 
505
        bzr commit -m 'imported project'
 
 
508
        from bzrlib.branch import Branch
 
 
509
        Branch('.', init=True)
 
 
512
class cmd_diff(Command):
 
 
513
    """Show differences in working tree.
 
 
515
    If files are listed, only the changes in those files are listed.
 
 
516
    Otherwise, all changes for the tree are listed.
 
 
518
    TODO: Allow diff across branches.
 
 
520
    TODO: Option to use external diff command; could be GNU diff, wdiff,
 
 
523
    TODO: Python difflib is not exactly the same as unidiff; should
 
 
524
          either fix it up or prefer to use an external diff.
 
 
526
    TODO: If a directory is given, diff everything under that.
 
 
528
    TODO: Selected-file diff is inefficient and doesn't show you
 
 
531
    TODO: This probably handles non-Unix newlines poorly.
 
 
539
    takes_args = ['file*']
 
 
540
    takes_options = ['revision', 'diff-options']
 
 
541
    aliases = ['di', 'dif']
 
 
543
    def run(self, revision=None, file_list=None, diff_options=None):
 
 
544
        from bzrlib.diff import show_diff
 
 
547
            b = find_branch(file_list[0])
 
 
548
            file_list = [b.relpath(f) for f in file_list]
 
 
549
            if file_list == ['']:
 
 
550
                # just pointing to top-of-tree
 
 
555
        if revision is not None:
 
 
556
            if len(revision) == 1:
 
 
557
                show_diff(b, revision[0], specific_files=file_list,
 
 
558
                          external_diff_options=diff_options)
 
 
559
            elif len(revision) == 2:
 
 
560
                show_diff(b, revision[0], specific_files=file_list,
 
 
561
                          external_diff_options=diff_options,
 
 
562
                          revision2=revision[1])
 
 
564
                raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
 
 
566
            show_diff(b, None, specific_files=file_list,
 
 
567
                      external_diff_options=diff_options)
 
 
572
class cmd_deleted(Command):
 
 
573
    """List files deleted in the working tree.
 
 
575
    TODO: Show files deleted since a previous revision, or between two revisions.
 
 
577
    def run(self, show_ids=False):
 
 
580
        new = b.working_tree()
 
 
582
        ## TODO: Much more efficient way to do this: read in new
 
 
583
        ## directories with readdir, rather than stating each one.  Same
 
 
584
        ## level of effort but possibly much less IO.  (Or possibly not,
 
 
585
        ## if the directories are very large...)
 
 
587
        for path, ie in old.inventory.iter_entries():
 
 
588
            if not new.has_id(ie.file_id):
 
 
590
                    print '%-50s %s' % (path, ie.file_id)
 
 
595
class cmd_modified(Command):
 
 
596
    """List files modified in working tree."""
 
 
599
        from bzrlib.delta import compare_trees
 
 
602
        td = compare_trees(b.basis_tree(), b.working_tree())
 
 
604
        for path, id, kind in td.modified:
 
 
609
class cmd_added(Command):
 
 
610
    """List files added in working tree."""
 
 
614
        wt = b.working_tree()
 
 
615
        basis_inv = b.basis_tree().inventory
 
 
618
            if file_id in basis_inv:
 
 
620
            path = inv.id2path(file_id)
 
 
621
            if not os.access(b.abspath(path), os.F_OK):
 
 
627
class cmd_root(Command):
 
 
628
    """Show the tree root directory.
 
 
630
    The root is the nearest enclosing directory with a .bzr control
 
 
632
    takes_args = ['filename?']
 
 
633
    def run(self, filename=None):
 
 
634
        """Print the branch root."""
 
 
635
        b = find_branch(filename)
 
 
639
class cmd_log(Command):
 
 
640
    """Show log of this branch.
 
 
642
    To request a range of logs, you can use the command -r begin:end
 
 
643
    -r revision requests a specific revision, -r :end or -r begin: are
 
 
646
    --message allows you to give a regular expression, which will be evaluated
 
 
647
    so that only matching entries will be displayed.
 
 
649
    TODO: Make --revision support uuid: and hash: [future tag:] notation.
 
 
653
    takes_args = ['filename?']
 
 
654
    takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
 
 
655
                     'long', 'message', 'short',]
 
 
657
    def run(self, filename=None, timezone='original',
 
 
665
        from bzrlib.log import log_formatter, show_log
 
 
668
        direction = (forward and 'forward') or 'reverse'
 
 
671
            b = find_branch(filename)
 
 
672
            fp = b.relpath(filename)
 
 
674
                file_id = b.read_working_inventory().path2id(fp)
 
 
676
                file_id = None  # points to branch root
 
 
684
        elif len(revision) == 1:
 
 
685
            rev1 = rev2 = b.get_revision_info(revision[0])[0]
 
 
686
        elif len(revision) == 2:
 
 
687
            rev1 = b.get_revision_info(revision[0])[0]
 
 
688
            rev2 = b.get_revision_info(revision[1])[0]
 
 
690
            raise BzrCommandError('bzr log --revision takes one or two values.')
 
 
697
        mutter('encoding log as %r' % bzrlib.user_encoding)
 
 
699
        # use 'replace' so that we don't abort if trying to write out
 
 
700
        # in e.g. the default C locale.
 
 
701
        outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
 
 
707
        lf = log_formatter(log_format,
 
 
710
                           show_timezone=timezone)
 
 
723
class cmd_touching_revisions(Command):
 
 
724
    """Return revision-ids which affected a particular file.
 
 
726
    A more user-friendly interface is "bzr log FILE"."""
 
 
728
    takes_args = ["filename"]
 
 
729
    def run(self, filename):
 
 
730
        b = find_branch(filename)
 
 
731
        inv = b.read_working_inventory()
 
 
732
        file_id = inv.path2id(b.relpath(filename))
 
 
733
        for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
 
 
734
            print "%6d %s" % (revno, what)
 
 
737
class cmd_ls(Command):
 
 
738
    """List files in a tree.
 
 
740
    TODO: Take a revision or remote path and list that tree instead.
 
 
743
    def run(self, revision=None, verbose=False):
 
 
746
            tree = b.working_tree()
 
 
748
            tree = b.revision_tree(b.lookup_revision(revision))
 
 
750
        for fp, fc, kind, fid in tree.list_files():
 
 
752
                if kind == 'directory':
 
 
759
                print '%-8s %s%s' % (fc, fp, kindch)
 
 
765
class cmd_unknowns(Command):
 
 
766
    """List unknown files."""
 
 
768
        from bzrlib.osutils import quotefn
 
 
769
        for f in find_branch('.').unknowns():
 
 
774
class cmd_ignore(Command):
 
 
775
    """Ignore a command or pattern.
 
 
777
    To remove patterns from the ignore list, edit the .bzrignore file.
 
 
779
    If the pattern contains a slash, it is compared to the whole path
 
 
780
    from the branch root.  Otherwise, it is comapred to only the last
 
 
781
    component of the path.
 
 
783
    Ignore patterns are case-insensitive on case-insensitive systems.
 
 
785
    Note: wildcards must be quoted from the shell on Unix.
 
 
788
        bzr ignore ./Makefile
 
 
791
    takes_args = ['name_pattern']
 
 
793
    def run(self, name_pattern):
 
 
794
        from bzrlib.atomicfile import AtomicFile
 
 
798
        ifn = b.abspath('.bzrignore')
 
 
800
        if os.path.exists(ifn):
 
 
803
                igns = f.read().decode('utf-8')
 
 
809
        # TODO: If the file already uses crlf-style termination, maybe
 
 
810
        # we should use that for the newly added lines?
 
 
812
        if igns and igns[-1] != '\n':
 
 
814
        igns += name_pattern + '\n'
 
 
817
            f = AtomicFile(ifn, 'wt')
 
 
818
            f.write(igns.encode('utf-8'))
 
 
823
        inv = b.working_tree().inventory
 
 
824
        if inv.path2id('.bzrignore'):
 
 
825
            mutter('.bzrignore is already versioned')
 
 
827
            mutter('need to make new .bzrignore file versioned')
 
 
828
            b.add(['.bzrignore'])
 
 
832
class cmd_ignored(Command):
 
 
833
    """List ignored files and the patterns that matched them.
 
 
835
    See also: bzr ignore"""
 
 
837
        tree = find_branch('.').working_tree()
 
 
838
        for path, file_class, kind, file_id in tree.list_files():
 
 
839
            if file_class != 'I':
 
 
841
            ## XXX: Slightly inefficient since this was already calculated
 
 
842
            pat = tree.is_ignored(path)
 
 
843
            print '%-50s %s' % (path, pat)
 
 
846
class cmd_lookup_revision(Command):
 
 
847
    """Lookup the revision-id from a revision-number
 
 
850
        bzr lookup-revision 33
 
 
853
    takes_args = ['revno']
 
 
855
    def run(self, revno):
 
 
859
            raise BzrCommandError("not a valid revision-number: %r" % revno)
 
 
861
        print find_branch('.').lookup_revision(revno)
 
 
864
class cmd_export(Command):
 
 
865
    """Export past revision to destination directory.
 
 
867
    If no revision is specified this exports the last committed revision.
 
 
869
    Format may be an "exporter" name, such as tar, tgz, tbz2.  If none is
 
 
870
    given, try to find the format with the extension. If no extension
 
 
871
    is found exports to a directory (equivalent to --format=dir).
 
 
873
    Root may be the top directory for tar, tgz and tbz2 formats. If none
 
 
874
    is given, the top directory will be the root name of the file."""
 
 
875
    # TODO: list known exporters
 
 
876
    takes_args = ['dest']
 
 
877
    takes_options = ['revision', 'format', 'root']
 
 
878
    def run(self, dest, revision=None, format=None, root=None):
 
 
882
            rev_id = b.last_patch()
 
 
884
            if len(revision) != 1:
 
 
885
                raise BzrError('bzr export --revision takes exactly 1 argument')
 
 
886
            revno, rev_id = b.get_revision_info(revision[0])
 
 
887
        t = b.revision_tree(rev_id)
 
 
888
        root, ext = os.path.splitext(dest)
 
 
892
            elif ext in (".gz", ".tgz"):
 
 
894
            elif ext in (".bz2", ".tbz2"):
 
 
898
        t.export(dest, format, root)
 
 
901
class cmd_cat(Command):
 
 
902
    """Write a file's text from a previous revision."""
 
 
904
    takes_options = ['revision']
 
 
905
    takes_args = ['filename']
 
 
907
    def run(self, filename, revision=None):
 
 
909
            raise BzrCommandError("bzr cat requires a revision number")
 
 
910
        elif len(revision) != 1:
 
 
911
            raise BzrCommandError("bzr cat --revision takes exactly one number")
 
 
913
        b.print_file(b.relpath(filename), revision[0])
 
 
916
class cmd_local_time_offset(Command):
 
 
917
    """Show the offset in seconds from GMT to local time."""
 
 
920
        print bzrlib.osutils.local_time_offset()
 
 
924
class cmd_commit(Command):
 
 
925
    """Commit changes into a new revision.
 
 
927
    If no arguments are given, the entire tree is committed.
 
 
929
    If selected files are specified, only changes to those files are
 
 
930
    committed.  If a directory is specified then the directory and everything 
 
 
931
    within it is committed.
 
 
933
    A selected-file commit may fail in some cases where the committed
 
 
934
    tree would be invalid, such as trying to commit a file in a
 
 
935
    newly-added directory that is not itself committed.
 
 
937
    TODO: Run hooks on tree to-be-committed, and after commit.
 
 
939
    TODO: Strict commit that fails if there are unknown or deleted files.
 
 
941
    takes_args = ['selected*']
 
 
942
    takes_options = ['message', 'file', 'verbose', 'unchanged']
 
 
943
    aliases = ['ci', 'checkin']
 
 
945
    # TODO: Give better message for -s, --summary, used by tla people
 
 
947
    def run(self, message=None, file=None, verbose=True, selected_list=None,
 
 
949
        from bzrlib.errors import PointlessCommit
 
 
950
        from bzrlib.msgeditor import edit_commit_message
 
 
951
        from bzrlib.status import show_status
 
 
952
        from cStringIO import StringIO
 
 
956
            selected_list = [b.relpath(s) for s in selected_list]
 
 
958
        if not message and not file:
 
 
960
            show_status(b, specific_files=selected_list,
 
 
962
            message = edit_commit_message(catcher.getvalue())
 
 
965
                raise BzrCommandError("please specify a commit message"
 
 
966
                                      " with either --message or --file")
 
 
967
        elif message and file:
 
 
968
            raise BzrCommandError("please specify either --message or --file")
 
 
972
            message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
 
 
975
            b.commit(message, verbose=verbose,
 
 
976
                     specific_files=selected_list,
 
 
977
                     allow_pointless=unchanged)
 
 
978
        except PointlessCommit:
 
 
979
            # FIXME: This should really happen before the file is read in;
 
 
980
            # perhaps prepare the commit; get the message; then actually commit
 
 
981
            raise BzrCommandError("no changes to commit",
 
 
982
                                  ["use --unchanged to commit anyhow"])
 
 
985
class cmd_check(Command):
 
 
986
    """Validate consistency of branch history.
 
 
988
    This command checks various invariants about the branch storage to
 
 
989
    detect data corruption or bzr bugs.
 
 
991
    If given the --update flag, it will update some optional fields
 
 
992
    to help ensure data consistency.
 
 
994
    takes_args = ['dir?']
 
 
996
    def run(self, dir='.'):
 
 
997
        from bzrlib.check import check
 
 
999
        check(find_branch(dir))
 
 
1002
class cmd_scan_cache(Command):
 
 
1005
        from bzrlib.hashcache import HashCache
 
 
1011
        print '%6d stats' % c.stat_count
 
 
1012
        print '%6d in hashcache' % len(c._cache)
 
 
1013
        print '%6d files removed from cache' % c.removed_count
 
 
1014
        print '%6d hashes updated' % c.update_count
 
 
1015
        print '%6d files changed too recently to cache' % c.danger_count
 
 
1022
class cmd_upgrade(Command):
 
 
1023
    """Upgrade branch storage to current format.
 
 
1025
    The check command or bzr developers may sometimes advise you to run
 
 
1028
    takes_args = ['dir?']
 
 
1030
    def run(self, dir='.'):
 
 
1031
        from bzrlib.upgrade import upgrade
 
 
1032
        upgrade(find_branch(dir))
 
 
1036
class cmd_whoami(Command):
 
 
1037
    """Show bzr user id."""
 
 
1038
    takes_options = ['email']
 
 
1040
    def run(self, email=False):
 
 
1042
            b = bzrlib.branch.find_branch('.')
 
 
1047
            print bzrlib.osutils.user_email(b)
 
 
1049
            print bzrlib.osutils.username(b)
 
 
1052
class cmd_selftest(Command):
 
 
1053
    """Run internal test suite"""
 
 
1055
    takes_options = ['verbose', 'pattern']
 
 
1056
    def run(self, verbose=False, pattern=".*"):
 
 
1058
        from bzrlib.selftest import selftest
 
 
1059
        # we don't want progress meters from the tests to go to the
 
 
1060
        # real output; and we don't want log messages cluttering up
 
 
1062
        save_ui = bzrlib.ui.ui_factory
 
 
1063
        bzrlib.trace.info('running tests...')
 
 
1065
            bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
 
 
1066
            result = selftest(verbose=verbose, pattern=pattern)
 
 
1068
                bzrlib.trace.info('tests passed')
 
 
1070
                bzrlib.trace.info('tests failed')
 
 
1071
            return int(not result)
 
 
1073
            bzrlib.ui.ui_factory = save_ui
 
 
1077
    print "bzr (bazaar-ng) %s" % bzrlib.__version__
 
 
1078
    # is bzrlib itself in a branch?
 
 
1079
    bzrrev = bzrlib.get_bzr_revision()
 
 
1081
        print "  (bzr checkout, revision %d {%s})" % bzrrev
 
 
1082
    print bzrlib.__copyright__
 
 
1083
    print "http://bazaar-ng.org/"
 
 
1085
    print "bzr comes with ABSOLUTELY NO WARRANTY.  bzr is free software, and"
 
 
1086
    print "you may use, modify and redistribute it under the terms of the GNU"
 
 
1087
    print "General Public License version 2 or later."
 
 
1090
class cmd_version(Command):
 
 
1091
    """Show version of bzr."""
 
 
1095
class cmd_rocks(Command):
 
 
1096
    """Statement of optimism."""
 
 
1099
        print "it sure does!"
 
 
1102
class cmd_find_merge_base(Command):
 
 
1103
    """Find and print a base revision for merging two branches.
 
 
1105
    TODO: Options to specify revisions on either side, as if
 
 
1106
          merging only part of the history.
 
 
1108
    takes_args = ['branch', 'other']
 
 
1111
    def run(self, branch, other):
 
 
1112
        from bzrlib.revision import common_ancestor, MultipleRevisionSources
 
 
1114
        branch1 = find_branch(branch)
 
 
1115
        branch2 = find_branch(other)
 
 
1117
        history_1 = branch1.revision_history()
 
 
1118
        history_2 = branch2.revision_history()
 
 
1120
        last1 = branch1.last_patch()
 
 
1121
        last2 = branch2.last_patch()
 
 
1123
        source = MultipleRevisionSources(branch1, branch2)
 
 
1125
        base_rev_id = common_ancestor(last1, last2, source)
 
 
1127
        print 'merge base is revision %s' % base_rev_id
 
 
1131
        if base_revno is None:
 
 
1132
            raise bzrlib.errors.UnrelatedBranches()
 
 
1134
        print ' r%-6d in %s' % (base_revno, branch)
 
 
1136
        other_revno = branch2.revision_id_to_revno(base_revid)
 
 
1138
        print ' r%-6d in %s' % (other_revno, other)
 
 
1142
class cmd_merge(Command):
 
 
1143
    """Perform a three-way merge.
 
 
1145
    The branch is the branch you will merge from.  By default, it will
 
 
1146
    merge the latest revision.  If you specify a revision, that
 
 
1147
    revision will be merged.  If you specify two revisions, the first
 
 
1148
    will be used as a BASE, and the second one as OTHER.  Revision
 
 
1149
    numbers are always relative to the specified branch.
 
 
1151
    By default bzr will try to merge in all new work from the other
 
 
1152
    branch, automatically determining an appropriate base.  If this
 
 
1153
    fails, you may need to give an explicit base.
 
 
1157
    To merge the latest revision from bzr.dev
 
 
1158
    bzr merge ../bzr.dev
 
 
1160
    To merge changes up to and including revision 82 from bzr.dev
 
 
1161
    bzr merge -r 82 ../bzr.dev
 
 
1163
    To merge the changes introduced by 82, without previous changes:
 
 
1164
    bzr merge -r 81..82 ../bzr.dev
 
 
1166
    merge refuses to run if there are any uncommitted changes, unless
 
 
1169
    takes_args = ['branch?']
 
 
1170
    takes_options = ['revision', 'force', 'merge-type']
 
 
1172
    def run(self, branch='.', revision=None, force=False, 
 
 
1174
        from bzrlib.merge import merge
 
 
1175
        from bzrlib.merge_core import ApplyMerge3
 
 
1176
        if merge_type is None:
 
 
1177
            merge_type = ApplyMerge3
 
 
1179
        if revision is None or len(revision) < 1:
 
 
1181
            other = [branch, -1]
 
 
1183
            if len(revision) == 1:
 
 
1184
                other = [branch, revision[0]]
 
 
1187
                assert len(revision) == 2
 
 
1188
                if None in revision:
 
 
1189
                    raise BzrCommandError(
 
 
1190
                        "Merge doesn't permit that revision specifier.")
 
 
1191
                base = [branch, revision[0]]
 
 
1192
                other = [branch, revision[1]]
 
 
1195
            merge(other, base, check_clean=(not force), merge_type=merge_type)
 
 
1196
        except bzrlib.errors.AmbiguousBase, e:
 
 
1197
            m = ("sorry, bzr can't determine the right merge base yet\n"
 
 
1198
                 "candidates are:\n  "
 
 
1199
                 + "\n  ".join(e.bases)
 
 
1201
                 "please specify an explicit base with -r,\n"
 
 
1202
                 "and (if you want) report this to the bzr developers\n")
 
 
1206
class cmd_revert(Command):
 
 
1207
    """Reverse all changes since the last commit.
 
 
1209
    Only versioned files are affected.  Specify filenames to revert only 
 
 
1210
    those files.  By default, any files that are changed will be backed up
 
 
1211
    first.  Backup files have a '~' appended to their name.
 
 
1213
    takes_options = ['revision', 'no-backup']
 
 
1214
    takes_args = ['file*']
 
 
1215
    aliases = ['merge-revert']
 
 
1217
    def run(self, revision=None, no_backup=False, file_list=None):
 
 
1218
        from bzrlib.merge import merge
 
 
1219
        from bzrlib.branch import Branch
 
 
1220
        from bzrlib.commands import parse_spec
 
 
1222
        if file_list is not None:
 
 
1223
            if len(file_list) == 0:
 
 
1224
                raise BzrCommandError("No files specified")
 
 
1225
        if revision is None:
 
 
1227
        elif len(revision) != 1:
 
 
1228
            raise BzrCommandError('bzr revert --revision takes exactly 1 argument')
 
 
1229
        merge(('.', revision[0]), parse_spec('.'),
 
 
1232
              backup_files=not no_backup,
 
 
1233
              file_list=file_list)
 
 
1235
            Branch('.').set_pending_merges([])
 
 
1238
class cmd_assert_fail(Command):
 
 
1239
    """Test reporting of assertion failures"""
 
 
1242
        assert False, "always fails"
 
 
1245
class cmd_help(Command):
 
 
1246
    """Show help on a command or other topic.
 
 
1248
    For a list of all available commands, say 'bzr help commands'."""
 
 
1249
    takes_options = ['long']
 
 
1250
    takes_args = ['topic?']
 
 
1253
    def run(self, topic=None, long=False):
 
 
1255
        if topic is None and long:
 
 
1260
class cmd_shell_complete(Command):
 
 
1261
    """Show appropriate completions for context.
 
 
1263
    For a list of all available commands, say 'bzr shell-complete'."""
 
 
1264
    takes_args = ['context?']
 
 
1268
    def run(self, context=None):
 
 
1269
        import shellcomplete
 
 
1270
        shellcomplete.shellcomplete(context)
 
 
1273
class cmd_missing(Command):
 
 
1274
    """What is missing in this branch relative to other branch.
 
 
1276
    takes_args = ['remote?']
 
 
1277
    aliases = ['mis', 'miss']
 
 
1278
    # We don't have to add quiet to the list, because 
 
 
1279
    # unknown options are parsed as booleans
 
 
1280
    takes_options = ['verbose', 'quiet']
 
 
1282
    def run(self, remote=None, verbose=False, quiet=False):
 
 
1283
        from bzrlib.errors import BzrCommandError
 
 
1284
        from bzrlib.missing import show_missing
 
 
1286
        if verbose and quiet:
 
 
1287
            raise BzrCommandError('Cannot pass both quiet and verbose')
 
 
1289
        b = find_branch('.')
 
 
1290
        parent = b.get_parent()
 
 
1293
                raise BzrCommandError("No missing location known or specified.")
 
 
1296
                    print "Using last location: %s" % parent
 
 
1298
        elif parent is None:
 
 
1299
            # We only update x-pull if it did not exist, missing should not change the parent
 
 
1300
            b.controlfile('x-pull', 'wb').write(remote + '\n')
 
 
1301
        br_remote = find_branch(remote)
 
 
1303
        return show_missing(b, br_remote, verbose=verbose, quiet=quiet)
 
 
1307
class cmd_plugins(Command):
 
 
1311
        import bzrlib.plugin
 
 
1312
        from inspect import getdoc
 
 
1313
        for plugin in bzrlib.plugin.all_plugins:
 
 
1314
            if hasattr(plugin, '__path__'):
 
 
1315
                print plugin.__path__[0]
 
 
1316
            elif hasattr(plugin, '__file__'):
 
 
1317
                print plugin.__file__
 
 
1323
                print '\t', d.split('\n')[0]