minor comments to update_versions.py

This commit is contained in:
Brian Carrier 2013-08-14 13:33:37 -04:00
parent 68c642cf1b
commit 1a6c40d97d

View File

@ -825,18 +825,16 @@ def usage():
return \ return \
""" """
USAGE: USAGE:
Run this script to generate a jdiff XML summary for every module Compares the API of the current Autopsy source code with a previous
in the current Autopsy source and in a previous source specified tagged version. By default, it will detect the previous tag from
by the given tag. Then, compare the XML files to see which modules the NEWS file and will not update the versions in the source code.
need updated version numbers. If the dry run tag is not given, the
module numbers will be automatically updated.
OPTIONAL FLAGS: OPTIONAL FLAGS:
-t --tag The tag name in git. Otherwise the NEWS file in source -t --tag Specify a previous tag to compare to.
will be used to determine the previous tag. Otherwise the NEWS file will be used.
-d --dir The output directory for the jdiff JavaDocs. If no -d --dir The output directory for the jdiff JavaDocs. If no
directory is given, the default is /javadocs/{module}. directory is given, the default is jdiff-javadocs/{module}.
-s --source The directory containing Autopsy's source code. -s --source The directory containing Autopsy's source code.
@ -909,6 +907,7 @@ def main():
printt("Comparing jdiff outputs...") printt("Comparing jdiff outputs...")
for module in similar_modules: for module in similar_modules:
module.set_ret(compare_xml(module, apiname_tag, apiname_cur)) module.set_ret(compare_xml(module, apiname_tag, apiname_cur))
print("Refer to the jdiff-javadocs folder for more details")
# ------------------------------------------------------------ # ------------------------------------------------------------
# 1) Do versioning # 1) Do versioning