mirror of
https://github.com/yuzu-emu/mbedtls
synced 2024-11-24 13:38:24 +00:00
Updated abi_check.py docstrings
This commit is contained in:
parent
a6f430f577
commit
7869680e41
1 changed files with 17 additions and 16 deletions
|
@ -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(
|
||||||
|
|
Loading…
Reference in a new issue