262
"""Construct an instance of this command."""
235
def __init__(self, options, arguments):
236
"""Construct and run the command.
238
Sets self.status to the return value of run()."""
239
assert isinstance(options, dict)
240
assert isinstance(arguments, dict)
241
cmdargs = options.copy()
242
cmdargs.update(arguments)
263
243
if self.__doc__ == Command.__doc__:
244
from warnings import warn
264
245
warn("No help message set for %r" % self)
267
def run_argv(self, argv):
268
"""Parse command line and run."""
269
args, opts = parse_args(argv)
271
if 'help' in opts: # e.g. bzr add --help
272
from bzrlib.help import help_on_command
273
help_on_command(self.name())
276
# check options are reasonable
277
allowed = self.takes_options
279
if oname not in allowed:
280
raise BzrCommandError("option '--%s' is not allowed for command %r"
281
% (oname, self.name()))
283
# mix arguments and options into one dictionary
284
cmdargs = _match_argform(self.name(), self.takes_args, args)
286
for k, v in opts.items():
287
cmdopts[k.replace('-', '_')] = v
289
all_cmd_args = cmdargs.copy()
290
all_cmd_args.update(cmdopts)
292
return self.run(**all_cmd_args)
246
self.status = self.run(**cmdargs)
247
if self.status is None:
296
"""Actually run the command.
252
"""Override this in sub-classes.
298
254
This is invoked with the options and arguments bound to
299
255
keyword parameters.
301
Return 0 or None if the command was successful, or a non-zero
302
shell error code if not. It's OK for this method to allow
303
an exception to raise up.
257
Return 0 or None if the command was successful, or a shell
305
raise NotImplementedError()
309
"""Return help message for this class."""
310
if self.__doc__ is Command.__doc__:
315
return _unsquish_command_name(self.__class__.__name__)
263
class ExternalCommand(Command):
264
"""Class to wrap external commands.
266
We cheat a little here, when get_cmd_class() calls us we actually
267
give it back an object we construct that has the appropriate path,
268
help, options etc for the specified command.
270
When run_bzr() tries to instantiate that 'class' it gets caught by
271
the __call__ method, which we override to call the Command.__init__
272
method. That then calls our run method which is pretty straight
275
The only wrinkle is that we have to map bzr's dictionary of options
276
and arguments back into command line options and arguments for the
280
def find_command(cls, cmd):
282
bzrpath = os.environ.get('BZRPATH', '')
284
for dir in bzrpath.split(os.pathsep):
285
path = os.path.join(dir, cmd)
286
if os.path.isfile(path):
287
return ExternalCommand(path)
291
find_command = classmethod(find_command)
293
def __init__(self, path):
296
pipe = os.popen('%s --bzr-usage' % path, 'r')
297
self.takes_options = pipe.readline().split()
299
for opt in self.takes_options:
300
if not opt in OPTIONS:
301
raise BzrError("Unknown option '%s' returned by external command %s"
304
# TODO: Is there any way to check takes_args is valid here?
305
self.takes_args = pipe.readline().split()
307
if pipe.close() is not None:
308
raise BzrError("Failed funning '%s --bzr-usage'" % path)
310
pipe = os.popen('%s --bzr-help' % path, 'r')
311
self.__doc__ = pipe.read()
312
if pipe.close() is not None:
313
raise BzrError("Failed funning '%s --bzr-help'" % path)
315
def __call__(self, options, arguments):
316
Command.__init__(self, options, arguments)
319
def run(self, **kargs):
326
optname = name.replace('_','-')
328
if OPTIONS.has_key(optname):
330
opts.append('--%s' % optname)
331
if value is not None and value is not True:
332
opts.append(str(value))
334
# it's an arg, or arg list
335
if type(value) is not list:
341
self.status = os.spawnv(os.P_WAIT, self.path, [self.path] + opts + args)
345
class cmd_status(Command):
346
"""Display status summary.
348
This reports on versioned and unknown files, reporting them
349
grouped by state. Possible states are:
352
Versioned in the working copy but not in the previous revision.
355
Versioned in the previous revision but removed or deleted
359
Path of this file changed from the previous revision;
360
the text may also have changed. This includes files whose
361
parent directory was renamed.
364
Text has changed since the previous revision.
367
Nothing about this file has changed since the previous revision.
368
Only shown with --all.
371
Not versioned and not matching an ignore pattern.
373
To see ignored files use 'bzr ignored'. For details in the
374
changes to file texts, use 'bzr diff'.
376
If no arguments are specified, the status of the entire working
377
directory is shown. Otherwise, only the status of the specified
378
files or directories is reported. If a directory is given, status
379
is reported for everything inside that directory.
381
If a revision is specified, the changes since that revision are shown.
383
takes_args = ['file*']
384
takes_options = ['all', 'show-ids', 'revision']
385
aliases = ['st', 'stat']
387
def run(self, all=False, show_ids=False, file_list=None):
389
b = find_branch(file_list[0])
390
file_list = [b.relpath(x) for x in file_list]
391
# special case: only one path was given and it's the root
393
if file_list == ['']:
398
from bzrlib.status import show_status
399
show_status(b, show_unchanged=all, show_ids=show_ids,
400
specific_files=file_list)
403
class cmd_cat_revision(Command):
404
"""Write out metadata for a revision."""
407
takes_args = ['revision_id']
409
def run(self, revision_id):
410
from bzrlib.xml import pack_xml
411
pack_xml(find_branch('.').get_revision(revision_id), sys.stdout)
414
class cmd_revno(Command):
415
"""Show current revision number.
417
This is equal to the number of revisions on this branch."""
419
print find_branch('.').revno()
421
class cmd_revision_info(Command):
422
"""Show revision number and revision id for a given revision identifier.
425
takes_args = ['revision_info*']
426
takes_options = ['revision']
427
def run(self, revision=None, revision_info_list=None):
428
from bzrlib.branch import find_branch
431
if revision is not None:
432
revs.extend(revision)
433
if revision_info_list is not None:
434
revs.extend(revision_info_list)
436
raise BzrCommandError('You must supply a revision identifier')
441
print '%4d %s' % b.get_revision_info(rev)
444
class cmd_add(Command):
445
"""Add specified files or directories.
447
In non-recursive mode, all the named items are added, regardless
448
of whether they were previously ignored. A warning is given if
449
any of the named files are already versioned.
451
In recursive mode (the default), files are treated the same way
452
but the behaviour for directories is different. Directories that
453
are already versioned do not give a warning. All directories,
454
whether already versioned or not, are searched for files or
455
subdirectories that are neither versioned or ignored, and these
456
are added. This search proceeds recursively into versioned
457
directories. If no names are given '.' is assumed.
459
Therefore simply saying 'bzr add' will version all files that
460
are currently unknown.
462
TODO: Perhaps adding a file whose directly is not versioned should
463
recursively add that parent, rather than giving an error?
465
takes_args = ['file*']
466
takes_options = ['verbose', 'no-recurse']
468
def run(self, file_list, verbose=False, no_recurse=False):
469
from bzrlib.add import smart_add, _PrintAddCallback
470
smart_add(file_list, verbose, not no_recurse,
471
callback=_PrintAddCallback)
475
class cmd_mkdir(Command):
476
"""Create a new versioned directory.
478
This is equivalent to creating the directory and then adding it.
480
takes_args = ['dir+']
482
def run(self, dir_list):
489
b.add([d], verbose=True)
492
class cmd_relpath(Command):
493
"""Show path of a file relative to root"""
494
takes_args = ['filename']
497
def run(self, filename):
498
print find_branch(filename).relpath(filename)
502
class cmd_inventory(Command):
503
"""Show inventory of the current working copy or a revision."""
504
takes_options = ['revision', 'show-ids']
506
def run(self, revision=None, show_ids=False):
509
inv = b.read_working_inventory()
511
if len(revision) > 1:
512
raise BzrCommandError('bzr inventory --revision takes'
513
' exactly one revision identifier')
514
inv = b.get_revision_inventory(b.lookup_revision(revision[0]))
516
for path, entry in inv.entries():
518
print '%-50s %s' % (path, entry.file_id)
523
class cmd_move(Command):
524
"""Move files to a different directory.
529
The destination must be a versioned directory in the same branch.
531
takes_args = ['source$', 'dest']
532
def run(self, source_list, dest):
535
# TODO: glob expansion on windows?
536
b.move([b.relpath(s) for s in source_list], b.relpath(dest))
539
class cmd_rename(Command):
540
"""Change the name of an entry.
543
bzr rename frob.c frobber.c
544
bzr rename src/frob.c lib/frob.c
546
It is an error if the destination name exists.
548
See also the 'move' command, which moves files into a different
549
directory without changing their name.
551
TODO: Some way to rename multiple files without invoking bzr for each
553
takes_args = ['from_name', 'to_name']
555
def run(self, from_name, to_name):
557
b.rename_one(b.relpath(from_name), b.relpath(to_name))
561
class cmd_mv(Command):
562
"""Move or rename a file.
565
bzr mv OLDNAME NEWNAME
566
bzr mv SOURCE... DESTINATION
568
If the last argument is a versioned directory, all the other names
569
are moved into it. Otherwise, there must be exactly two arguments
570
and the file is changed to a new name, which must not already exist.
572
Files cannot be moved between branches.
574
takes_args = ['names*']
575
def run(self, names_list):
576
if len(names_list) < 2:
577
raise BzrCommandError("missing file argument")
578
b = find_branch(names_list[0])
580
rel_names = [b.relpath(x) for x in names_list]
582
if os.path.isdir(names_list[-1]):
583
# move into existing directory
584
b.move(rel_names[:-1], rel_names[-1])
586
if len(names_list) != 2:
587
raise BzrCommandError('to mv multiple files the destination '
588
'must be a versioned directory')
589
b.move(rel_names[0], rel_names[1])
594
class cmd_pull(Command):
595
"""Pull any changes from another branch into the current one.
597
If the location is omitted, the last-used location will be used.
598
Both the revision history and the working directory will be
601
This command only works on branches that have not diverged. Branches are
602
considered diverged if both branches have had commits without first
603
pulling from the other.
605
If branches have diverged, you can use 'bzr merge' to pull the text changes
606
from one into the other.
608
takes_args = ['location?']
610
def run(self, location=None):
611
from bzrlib.merge import merge
613
from shutil import rmtree
615
from bzrlib.branch import pull_loc
617
br_to = find_branch('.')
620
stored_loc = br_to.controlfile("x-pull", "rb").read().rstrip('\n')
622
if e.errno != errno.ENOENT:
625
if stored_loc is None:
626
raise BzrCommandError("No pull location known or specified.")
628
print "Using last location: %s" % stored_loc
629
location = stored_loc
630
cache_root = tempfile.mkdtemp()
631
from bzrlib.branch import DivergedBranches
632
br_from = find_branch(location)
633
location = pull_loc(br_from)
634
old_revno = br_to.revno()
636
from branch import find_cached_branch, DivergedBranches
637
br_from = find_cached_branch(location, cache_root)
638
location = pull_loc(br_from)
639
old_revno = br_to.revno()
641
br_to.update_revisions(br_from)
642
except DivergedBranches:
643
raise BzrCommandError("These branches have diverged."
646
merge(('.', -1), ('.', old_revno), check_clean=False)
647
if location != stored_loc:
648
br_to.controlfile("x-pull", "wb").write(location + "\n")
654
class cmd_branch(Command):
655
"""Create a new copy of a branch.
657
If the TO_LOCATION is omitted, the last component of the FROM_LOCATION will
658
be used. In other words, "branch ../foo/bar" will attempt to create ./bar.
660
To retrieve the branch as of a particular revision, supply the --revision
661
parameter, as in "branch foo/bar -r 5".
663
takes_args = ['from_location', 'to_location?']
664
takes_options = ['revision']
665
aliases = ['get', 'clone']
667
def run(self, from_location, to_location=None, revision=None):
668
from bzrlib.branch import copy_branch, find_cached_branch
671
from shutil import rmtree
672
cache_root = tempfile.mkdtemp()
676
elif len(revision) > 1:
677
raise BzrCommandError(
678
'bzr branch --revision takes exactly 1 revision value')
680
br_from = find_cached_branch(from_location, cache_root)
682
if e.errno == errno.ENOENT:
683
raise BzrCommandError('Source location "%s" does not'
684
' exist.' % to_location)
687
if to_location is None:
688
to_location = os.path.basename(from_location.rstrip("/\\"))
690
os.mkdir(to_location)
692
if e.errno == errno.EEXIST:
693
raise BzrCommandError('Target directory "%s" already'
694
' exists.' % to_location)
695
if e.errno == errno.ENOENT:
696
raise BzrCommandError('Parent of "%s" does not exist.' %
701
copy_branch(br_from, to_location, revision[0])
702
except bzrlib.errors.NoSuchRevision:
704
msg = "The branch %s has no revision %d." % (from_location, revision[0])
705
raise BzrCommandError(msg)
710
class cmd_renames(Command):
711
"""Show list of renamed files.
713
TODO: Option to show renames between two historical versions.
715
TODO: Only show renames under dir, rather than in the whole branch.
717
takes_args = ['dir?']
719
def run(self, dir='.'):
721
old_inv = b.basis_tree().inventory
722
new_inv = b.read_working_inventory()
724
renames = list(bzrlib.tree.find_renames(old_inv, new_inv))
726
for old_name, new_name in renames:
727
print "%s => %s" % (old_name, new_name)
730
class cmd_info(Command):
731
"""Show statistical information about a branch."""
732
takes_args = ['branch?']
734
def run(self, branch=None):
737
b = find_branch(branch)
741
class cmd_remove(Command):
742
"""Make a file unversioned.
744
This makes bzr stop tracking changes to a versioned file. It does
745
not delete the working copy.
747
takes_args = ['file+']
748
takes_options = ['verbose']
750
def run(self, file_list, verbose=False):
751
b = find_branch(file_list[0])
752
b.remove([b.relpath(f) for f in file_list], verbose=verbose)
755
class cmd_file_id(Command):
756
"""Print file_id of a particular file or directory.
758
The file_id is assigned when the file is first added and remains the
759
same through all revisions where the file exists, even when it is
763
takes_args = ['filename']
764
def run(self, filename):
765
b = find_branch(filename)
766
i = b.inventory.path2id(b.relpath(filename))
768
raise BzrError("%r is not a versioned file" % filename)
773
class cmd_file_path(Command):
774
"""Print path of file_ids to a file or directory.
776
This prints one line for each directory down to the target,
777
starting at the branch root."""
779
takes_args = ['filename']
780
def run(self, filename):
781
b = find_branch(filename)
783
fid = inv.path2id(b.relpath(filename))
785
raise BzrError("%r is not a versioned file" % filename)
786
for fip in inv.get_idpath(fid):
790
class cmd_revision_history(Command):
791
"""Display list of revision ids on this branch."""
794
for patchid in find_branch('.').revision_history():
798
class cmd_directories(Command):
799
"""Display list of versioned directories in this branch."""
801
for name, ie in find_branch('.').read_working_inventory().directories():
808
class cmd_init(Command):
809
"""Make a directory into a versioned branch.
811
Use this to create an empty branch, or before importing an
814
Recipe for importing a tree of files:
819
bzr commit -m 'imported project'
822
from bzrlib.branch import Branch
823
Branch('.', init=True)
826
class cmd_diff(Command):
827
"""Show differences in working tree.
829
If files are listed, only the changes in those files are listed.
830
Otherwise, all changes for the tree are listed.
832
TODO: Allow diff across branches.
834
TODO: Option to use external diff command; could be GNU diff, wdiff,
837
TODO: Python difflib is not exactly the same as unidiff; should
838
either fix it up or prefer to use an external diff.
840
TODO: If a directory is given, diff everything under that.
842
TODO: Selected-file diff is inefficient and doesn't show you
845
TODO: This probably handles non-Unix newlines poorly.
853
takes_args = ['file*']
854
takes_options = ['revision', 'diff-options']
855
aliases = ['di', 'dif']
857
def run(self, revision=None, file_list=None, diff_options=None):
858
from bzrlib.diff import show_diff
861
b = find_branch(file_list[0])
862
file_list = [b.relpath(f) for f in file_list]
863
if file_list == ['']:
864
# just pointing to top-of-tree
869
if revision is not None:
870
if len(revision) == 1:
871
show_diff(b, revision[0], specific_files=file_list,
872
external_diff_options=diff_options)
873
elif len(revision) == 2:
874
show_diff(b, revision[0], specific_files=file_list,
875
external_diff_options=diff_options,
876
revision2=revision[1])
878
raise BzrCommandError('bzr diff --revision takes exactly one or two revision identifiers')
880
show_diff(b, None, specific_files=file_list,
881
external_diff_options=diff_options)
886
class cmd_deleted(Command):
887
"""List files deleted in the working tree.
889
TODO: Show files deleted since a previous revision, or between two revisions.
891
def run(self, show_ids=False):
894
new = b.working_tree()
896
## TODO: Much more efficient way to do this: read in new
897
## directories with readdir, rather than stating each one. Same
898
## level of effort but possibly much less IO. (Or possibly not,
899
## if the directories are very large...)
901
for path, ie in old.inventory.iter_entries():
902
if not new.has_id(ie.file_id):
904
print '%-50s %s' % (path, ie.file_id)
909
class cmd_modified(Command):
910
"""List files modified in working tree."""
913
from bzrlib.delta import compare_trees
916
td = compare_trees(b.basis_tree(), b.working_tree())
918
for path, id, kind in td.modified:
923
class cmd_added(Command):
924
"""List files added in working tree."""
928
wt = b.working_tree()
929
basis_inv = b.basis_tree().inventory
932
if file_id in basis_inv:
934
path = inv.id2path(file_id)
935
if not os.access(b.abspath(path), os.F_OK):
941
class cmd_root(Command):
942
"""Show the tree root directory.
944
The root is the nearest enclosing directory with a .bzr control
946
takes_args = ['filename?']
947
def run(self, filename=None):
948
"""Print the branch root."""
949
b = find_branch(filename)
950
print getattr(b, 'base', None) or getattr(b, 'baseurl')
953
class cmd_log(Command):
954
"""Show log of this branch.
956
To request a range of logs, you can use the command -r begin:end
957
-r revision requests a specific revision, -r :end or -r begin: are
960
--message allows you to give a regular expression, which will be evaluated
961
so that only matching entries will be displayed.
963
TODO: Make --revision support uuid: and hash: [future tag:] notation.
967
takes_args = ['filename?']
968
takes_options = ['forward', 'timezone', 'verbose', 'show-ids', 'revision',
969
'long', 'message', 'short',]
971
def run(self, filename=None, timezone='original',
979
from bzrlib.branch import find_branch
980
from bzrlib.log import log_formatter, show_log
983
direction = (forward and 'forward') or 'reverse'
986
b = find_branch(filename)
987
fp = b.relpath(filename)
989
file_id = b.read_working_inventory().path2id(fp)
991
file_id = None # points to branch root
999
elif len(revision) == 1:
1000
rev1 = rev2 = b.get_revision_info(revision[0])[0]
1001
elif len(revision) == 2:
1002
rev1 = b.get_revision_info(revision[0])[0]
1003
rev2 = b.get_revision_info(revision[1])[0]
1005
raise BzrCommandError('bzr log --revision takes one or two values.')
1012
mutter('encoding log as %r' % bzrlib.user_encoding)
1014
# use 'replace' so that we don't abort if trying to write out
1015
# in e.g. the default C locale.
1016
outf = codecs.getwriter(bzrlib.user_encoding)(sys.stdout, errors='replace')
1021
log_format = 'short'
1022
lf = log_formatter(log_format,
1025
show_timezone=timezone)
1031
direction=direction,
1032
start_revision=rev1,
1038
class cmd_touching_revisions(Command):
1039
"""Return revision-ids which affected a particular file.
1041
A more user-friendly interface is "bzr log FILE"."""
1043
takes_args = ["filename"]
1044
def run(self, filename):
1045
b = find_branch(filename)
1046
inv = b.read_working_inventory()
1047
file_id = inv.path2id(b.relpath(filename))
1048
for revno, revision_id, what in bzrlib.log.find_touching_revisions(b, file_id):
1049
print "%6d %s" % (revno, what)
1052
class cmd_ls(Command):
1053
"""List files in a tree.
1055
TODO: Take a revision or remote path and list that tree instead.
1058
def run(self, revision=None, verbose=False):
1059
b = find_branch('.')
1060
if revision == None:
1061
tree = b.working_tree()
1063
tree = b.revision_tree(b.lookup_revision(revision))
1065
for fp, fc, kind, fid in tree.list_files():
1067
if kind == 'directory':
1069
elif kind == 'file':
1074
print '%-8s %s%s' % (fc, fp, kindch)
1080
class cmd_unknowns(Command):
1081
"""List unknown files."""
1083
from bzrlib.osutils import quotefn
1084
for f in find_branch('.').unknowns():
1089
class cmd_ignore(Command):
1090
"""Ignore a command or pattern.
1092
To remove patterns from the ignore list, edit the .bzrignore file.
1094
If the pattern contains a slash, it is compared to the whole path
1095
from the branch root. Otherwise, it is comapred to only the last
1096
component of the path.
1098
Ignore patterns are case-insensitive on case-insensitive systems.
1100
Note: wildcards must be quoted from the shell on Unix.
1103
bzr ignore ./Makefile
1104
bzr ignore '*.class'
1106
takes_args = ['name_pattern']
1108
def run(self, name_pattern):
1109
from bzrlib.atomicfile import AtomicFile
1112
b = find_branch('.')
1113
ifn = b.abspath('.bzrignore')
1115
if os.path.exists(ifn):
1118
igns = f.read().decode('utf-8')
1124
# TODO: If the file already uses crlf-style termination, maybe
1125
# we should use that for the newly added lines?
1127
if igns and igns[-1] != '\n':
1129
igns += name_pattern + '\n'
1132
f = AtomicFile(ifn, 'wt')
1133
f.write(igns.encode('utf-8'))
1138
inv = b.working_tree().inventory
1139
if inv.path2id('.bzrignore'):
1140
mutter('.bzrignore is already versioned')
1142
mutter('need to make new .bzrignore file versioned')
1143
b.add(['.bzrignore'])
1147
class cmd_ignored(Command):
1148
"""List ignored files and the patterns that matched them.
1150
See also: bzr ignore"""
1152
tree = find_branch('.').working_tree()
1153
for path, file_class, kind, file_id in tree.list_files():
1154
if file_class != 'I':
1156
## XXX: Slightly inefficient since this was already calculated
1157
pat = tree.is_ignored(path)
1158
print '%-50s %s' % (path, pat)
1161
class cmd_lookup_revision(Command):
1162
"""Lookup the revision-id from a revision-number
1165
bzr lookup-revision 33
1168
takes_args = ['revno']
1170
def run(self, revno):
1174
raise BzrCommandError("not a valid revision-number: %r" % revno)
1176
print find_branch('.').lookup_revision(revno)
1179
class cmd_export(Command):
1180
"""Export past revision to destination directory.
1182
If no revision is specified this exports the last committed revision.
1184
Format may be an "exporter" name, such as tar, tgz, tbz2. If none is
1185
given, try to find the format with the extension. If no extension
1186
is found exports to a directory (equivalent to --format=dir).
1188
Root may be the top directory for tar, tgz and tbz2 formats. If none
1189
is given, the top directory will be the root name of the file."""
1190
# TODO: list known exporters
1191
takes_args = ['dest']
1192
takes_options = ['revision', 'format', 'root']
1193
def run(self, dest, revision=None, format=None, root=None):
1195
b = find_branch('.')
1196
if revision is None:
1197
rev_id = b.last_patch()
1199
if len(revision) != 1:
1200
raise BzrError('bzr export --revision takes exactly 1 argument')
1201
revno, rev_id = b.get_revision_info(revision[0])
1202
t = b.revision_tree(rev_id)
1203
root, ext = os.path.splitext(dest)
1205
if ext in (".tar",):
1207
elif ext in (".gz", ".tgz"):
1209
elif ext in (".bz2", ".tbz2"):
1213
t.export(dest, format, root)
1216
class cmd_cat(Command):
1217
"""Write a file's text from a previous revision."""
1219
takes_options = ['revision']
1220
takes_args = ['filename']
1222
def run(self, filename, revision=None):
1223
if revision == None:
1224
raise BzrCommandError("bzr cat requires a revision number")
1225
elif len(revision) != 1:
1226
raise BzrCommandError("bzr cat --revision takes exactly one number")
1227
b = find_branch('.')
1228
b.print_file(b.relpath(filename), revision[0])
1231
class cmd_local_time_offset(Command):
1232
"""Show the offset in seconds from GMT to local time."""
1235
print bzrlib.osutils.local_time_offset()
1239
class cmd_commit(Command):
1240
"""Commit changes into a new revision.
1242
If no arguments are given, the entire tree is committed.
1244
If selected files are specified, only changes to those files are
1245
committed. If a directory is specified then the directory and everything
1246
within it is committed.
1248
A selected-file commit may fail in some cases where the committed
1249
tree would be invalid, such as trying to commit a file in a
1250
newly-added directory that is not itself committed.
1252
TODO: Run hooks on tree to-be-committed, and after commit.
1254
TODO: Strict commit that fails if there are unknown or deleted files.
1256
takes_args = ['selected*']
1257
takes_options = ['message', 'file', 'verbose', 'unchanged']
1258
aliases = ['ci', 'checkin']
1260
# TODO: Give better message for -s, --summary, used by tla people
1262
def run(self, message=None, file=None, verbose=True, selected_list=None,
1264
from bzrlib.errors import PointlessCommit
1265
from bzrlib.osutils import get_text_message
1267
## Warning: shadows builtin file()
1268
if not message and not file:
1269
# FIXME: Ugly; change status code to send to a provided function?
1273
catcher = cStringIO.StringIO()
1274
sys.stdout = catcher
1275
cmd_status({"file_list":selected_list}, {})
1276
info = catcher.getvalue()
1278
message = get_text_message(info)
1281
raise BzrCommandError("please specify a commit message",
1282
["use either --message or --file"])
1283
elif message and file:
1284
raise BzrCommandError("please specify either --message or --file")
1288
message = codecs.open(file, 'rt', bzrlib.user_encoding).read()
1290
b = find_branch('.')
1292
selected_list = [b.relpath(s) for s in selected_list]
1295
b.commit(message, verbose=verbose,
1296
specific_files=selected_list,
1297
allow_pointless=unchanged)
1298
except PointlessCommit:
1299
# FIXME: This should really happen before the file is read in;
1300
# perhaps prepare the commit; get the message; then actually commit
1301
raise BzrCommandError("no changes to commit",
1302
["use --unchanged to commit anyhow"])
1305
class cmd_check(Command):
1306
"""Validate consistency of branch history.
1308
This command checks various invariants about the branch storage to
1309
detect data corruption or bzr bugs.
1311
If given the --update flag, it will update some optional fields
1312
to help ensure data consistency.
1314
takes_args = ['dir?']
1316
def run(self, dir='.'):
1317
from bzrlib.check import check
1319
check(find_branch(dir))
1322
class cmd_scan_cache(Command):
1325
from bzrlib.hashcache import HashCache
1332
print '%6d stats' % c.stat_count
1333
print '%6d in hashcache' % len(c._cache)
1334
print '%6d files removed from cache' % c.removed_count
1335
print '%6d hashes updated' % c.update_count
1336
print '%6d files changed too recently to cache' % c.danger_count
1343
class cmd_upgrade(Command):
1344
"""Upgrade branch storage to current format.
1346
This should normally be used only after the check command tells
1349
takes_args = ['dir?']
1351
def run(self, dir='.'):
1352
from bzrlib.upgrade import upgrade
1353
upgrade(find_branch(dir))
1357
class cmd_whoami(Command):
1358
"""Show bzr user id."""
1359
takes_options = ['email']
1361
def run(self, email=False):
1363
b = bzrlib.branch.find_branch('.')
1368
print bzrlib.osutils.user_email(b)
1370
print bzrlib.osutils.username(b)
1373
class cmd_selftest(Command):
1374
"""Run internal test suite"""
1376
takes_options = ['verbose', 'pattern']
1377
def run(self, verbose=False, pattern=".*"):
1379
from bzrlib.selftest import selftest
1380
# we don't want progress meters from the tests to go to the
1382
save_ui = bzrlib.ui.ui_factory
1384
bzrlib.ui.ui_factory = bzrlib.ui.SilentUIFactory()
1385
return int(not selftest(verbose=verbose, pattern=pattern))
1387
bzrlib.ui.ui_factory = save_ui
1390
class cmd_version(Command):
1391
"""Show version of bzr."""
1396
print "bzr (bazaar-ng) %s" % bzrlib.__version__
1397
# is bzrlib itself in a branch?
1398
bzrrev = bzrlib.get_bzr_revision()
1400
print " (bzr checkout, revision %d {%s})" % bzrrev
1401
print bzrlib.__copyright__
1402
print "http://bazaar-ng.org/"
1404
print "bzr comes with ABSOLUTELY NO WARRANTY. bzr is free software, and"
1405
print "you may use, modify and redistribute it under the terms of the GNU"
1406
print "General Public License version 2 or later."
1409
class cmd_rocks(Command):
1410
"""Statement of optimism."""
1413
print "it sure does!"
318
1415
def parse_spec(spec):