Updated abi_check.py docstrings
#!/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(
