From 159255ab7bacc519b4364b8ff9f23ed0d9e88744 Mon Sep 17 00:00:00 2001 From: Yuto Takano Date: Fri, 6 Aug 2021 17:00:28 +0100 Subject: [PATCH] Document dependency on nm Signed-off-by: Yuto Takano --- tests/scripts/check-names.py | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/tests/scripts/check-names.py b/tests/scripts/check-names.py index 100001beeb..659eda9039 100755 --- a/tests/scripts/check-names.py +++ b/tests/scripts/check-names.py @@ -17,11 +17,13 @@ """ This script confirms that the naming of all symbols and identifiers in Mbed TLS -are consistent with the house style and are also self-consistent. It performs -the following checks: +are consistent with the house style and are also self-consistent. It only runs +on Linux and macOS since it depends on nm. + +The script performs the following checks: - All exported and available symbols in the library object files, are explicitly - declared in the header files. + declared in the header files. This uses the nm command. - All macros, constants, and identifiers (function names, struct names, etc) follow the required pattern. - Typo checking: All words that begin with MBED exist as macros or constants.