Documentation improvements

Signed-off-by: Gilles Peskine <Gilles.Peskine@arm.com>
This commit is contained in:
Gilles Peskine 2022-12-23 18:15:19 +01:00
parent 59803dba2b
commit 9d34cf3f0b

View File

@ -159,18 +159,20 @@ def main() -> int:
""" """
uncrustify_version = get_uncrustify_version().strip() uncrustify_version = get_uncrustify_version().strip()
if UNCRUSTIFY_SUPPORTED_VERSION not in uncrustify_version: if UNCRUSTIFY_SUPPORTED_VERSION not in uncrustify_version:
print("Warning: Using unsupported Uncrustify version '" \ print("Warning: Using unsupported Uncrustify version '" +
+ uncrustify_version + "' (Note: The only supported version" \ uncrustify_version + "'", file=STDOUT_UTF8)
"is " + UNCRUSTIFY_SUPPORTED_VERSION + ")", file=STDOUT_UTF8) print("Note: The only supported version is " +
UNCRUSTIFY_SUPPORTED_VERSION, file=STDOUT_UTF8)
parser = argparse.ArgumentParser() parser = argparse.ArgumentParser()
parser.add_argument('-f', '--fix', action='store_true', parser.add_argument('-f', '--fix', action='store_true',
help='modify source files to fix the code style') help=('modify source files to fix the code style '
'(default: print diff, do not modify files)'))
# --files is almost useless: it only matters if there are no files # --files is almost useless: it only matters if there are no files
# ('code_style.py' without arguments checks all files known to Git, # ('code_style.py' without arguments checks all files known to Git,
# 'code_style.py --files' does nothing). 'code_style.py --files ...' is # 'code_style.py --files' does nothing). In particular,
# intended as a stable ("porcelain") way to restyle a possibly empty # 'code_style.py --files ...' is intended as a stable ("porcelain") way
# set of files. # to restyle a possibly empty set of files.
parser.add_argument('--files', action='store_true', parser.add_argument('--files', action='store_true',
help='only check the specified files (default with non-option arguments)') help='only check the specified files (default with non-option arguments)')
parser.add_argument('operands', nargs='*', metavar='FILE', parser.add_argument('operands', nargs='*', metavar='FILE',