yuzu/mbedtls
1
0
Fork 0
mirror of https://github.com/yuzu-emu/mbedtls.git synced 2024-12-24 17:55:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Updated abi_check.py docstrings

Browse source
This commit is contained in:
Darryl Green 2018-04-06 11:23:22 +01:00
parent c47ac2651a
commit 4cd7a9b8ed
1 changed files with 17 additions and 16 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

33
scripts/abi_check.py
View file

@ -1,18 +1,19 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
# """
# This file is part of Mbed TLS (https://tls.mbed.org) This file is part of Mbed TLS (https://tls.mbed.org)
#
# Copyright (c) 2018, Arm Limited, All Rights Reserved Copyright (c) 2018, Arm Limited, All Rights Reserved
#
# Purpose Purpose
#
# This script is a small wrapper around the abi-compliance-checker and This script is a small wrapper around the abi-compliance-checker and
# abi-dumper tools, applying them to compare the ABI and API of the library abi-dumper tools, applying them to compare the ABI and API of the library
# files from two different Git revisions within an Mbed TLS repository. files from two different Git revisions within an Mbed TLS repository.
# The results of the comparison are formatted as HTML and stored at The results of the comparison are formatted as HTML and stored at
# a configurable location. Returns 0 on success, 1 on ABI/API non-compliance, a configurable location. Returns 0 on success, 1 on ABI/API non-compliance,
# and 2 if there is an error while running the script. and 2 if there is an error while running the script.
# Note: must be run from Mbed TLS root. Note: requires Python 3, must be run from Mbed TLS root.
"""
import os import os
import sys import sys
@ -205,8 +206,8 @@ def run_main():
" The results of the comparison are formatted as HTML and" " The results of the comparison are formatted as HTML and"
" stored at a configurable location. Returns 0 on success, " " stored at a configurable location. Returns 0 on success, "
"1 on ABI/API non-compliance, and 2 if there is an error " "1 on ABI/API non-compliance, and 2 if there is an error "
"while running the script. # Note: must be run from " "while running the script. Note: requires Python 3, "
"Mbed TLS root." "must be run from Mbed TLS root."
) )
) )
parser.add_argument( parser.add_argument(