mirror of
https://github.com/yuzu-emu/mbedtls.git
synced 2025-01-11 06:55:40 +00:00
Improve documentation
This commit is contained in:
parent
c5132ffc41
commit
4cde8a0513
|
@ -10,7 +10,7 @@ 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 either formatted as HTML and stored at
|
The results of the comparison are either formatted as HTML and stored at
|
||||||
a configurable location, or a brief list of problems found is output.
|
a configurable location, or are given as a brief list of problems.
|
||||||
Returns 0 on success, 1 on ABI/API non-compliance, and 2 if there is an error
|
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: must be run from Mbed TLS root.
|
||||||
"""
|
"""
|
||||||
|
@ -357,10 +357,10 @@ def run_main():
|
||||||
to compare the ABI and API of the library files from two
|
to compare the ABI and API of the library files from two
|
||||||
different Git revisions within an Mbed TLS repository.
|
different Git revisions within an Mbed TLS repository.
|
||||||
The results of the comparison are either formatted as HTML and
|
The results of the comparison are either formatted as HTML and
|
||||||
stored at a configurable location, or a brief list of problems
|
stored at a configurable location, or are given as a brief list
|
||||||
found is output. Returns 0 on success, 1 on ABI/API
|
of problems. Returns 0 on success, 1 on ABI/API non-compliance,
|
||||||
non-compliance, and 2 if there is an error while running the
|
and 2 if there is an error while running the script.
|
||||||
script. Note: must be run from Mbed TLS root."""
|
Note: must be run from Mbed TLS root."""
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
parser.add_argument(
|
parser.add_argument(
|
||||||
|
|
Loading…
Reference in a new issue