mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2024-11-29 18:24:16 +01:00
Updated abi_check.py docstrings
This commit is contained in:
parent
a6f430f577
commit
7869680e41
@ -1,18 +1,19 @@
|
||||
#!/usr/bin/env python3
|
||||
#
|
||||
# This file is part of Mbed TLS (https://tls.mbed.org)
|
||||
#
|
||||
# Copyright (c) 2018, Arm Limited, All Rights Reserved
|
||||
#
|
||||
# Purpose
|
||||
#
|
||||
# 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
|
||||
# files from two different Git revisions within an Mbed TLS repository.
|
||||
# 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,
|
||||
# and 2 if there is an error while running the script.
|
||||
# Note: must be run from Mbed TLS root.
|
||||
"""
|
||||
This file is part of Mbed TLS (https://tls.mbed.org)
|
||||
|
||||
Copyright (c) 2018, Arm Limited, All Rights Reserved
|
||||
|
||||
Purpose
|
||||
|
||||
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
|
||||
files from two different Git revisions within an Mbed TLS repository.
|
||||
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,
|
||||
and 2 if there is an error while running the script.
|
||||
Note: requires Python 3, must be run from Mbed TLS root.
|
||||
"""
|
||||
|
||||
import os
|
||||
import sys
|
||||
@ -205,8 +206,8 @@ def run_main():
|
||||
" 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, and 2 if there is an error "
|
||||
"while running the script. # Note: must be run from "
|
||||
"Mbed TLS root."
|
||||
"while running the script. Note: requires Python 3, "
|
||||
"must be run from Mbed TLS root."
|
||||
)
|
||||
)
|
||||
parser.add_argument(
|
||||
|
Loading…
Reference in New Issue
Block a user