From f16b29c5578b71ef9571aafe8be2afb3cf2089a3 Mon Sep 17 00:00:00 2001 From: Harry Ramsey Date: Wed, 8 Jan 2025 15:43:13 +0000 Subject: [PATCH] Adapt doxygen scripts to run for TF-PSA-Crypto This commit adapts the script all-core.sh, apidoc_full.sh and doxygen.sh to run for TF-PSA-Crypto out of source builds. Signed-off-by: Harry Ramsey --- scripts/all-core.sh | 1 + scripts/apidoc_full.sh | 21 ++++++++++++++++----- scripts/doxygen.sh | 11 ++++++++--- 3 files changed, 25 insertions(+), 8 deletions(-) diff --git a/scripts/all-core.sh b/scripts/all-core.sh index 1882c1c4ef..0cf737a754 100644 --- a/scripts/all-core.sh +++ b/scripts/all-core.sh @@ -228,6 +228,7 @@ pre_initialize_variables () { : ${CLANG_EARLIEST:="clang-earliest"} : ${GCC_LATEST:="gcc-latest"} : ${GCC_EARLIEST:="gcc-earliest"} + # if MAKEFLAGS is not set add the -j option to speed up invocations of make if [ -z "${MAKEFLAGS+set}" ]; then export MAKEFLAGS="-j$(all_sh_nproc)" diff --git a/scripts/apidoc_full.sh b/scripts/apidoc_full.sh index 34daf37b59..9d553641e4 100755 --- a/scripts/apidoc_full.sh +++ b/scripts/apidoc_full.sh @@ -12,7 +12,13 @@ set -eu -CONFIG_H='include/mbedtls/mbedtls_config.h' +. $(dirname "$0")/project_detection.sh + +if in_mbedtls_repo; then + CONFIG_H='include/mbedtls/mbedtls_config.h' +elif in_tf_psa_crypto_repo; then + CONFIG_H='include/psa/crypto_config.h' +fi if [ -r $CONFIG_H ]; then :; else echo "$CONFIG_H not found" >&2 @@ -22,7 +28,12 @@ fi CONFIG_BAK=${CONFIG_H}.bak cp -p $CONFIG_H $CONFIG_BAK -scripts/config.py realfull -make apidoc - -mv $CONFIG_BAK $CONFIG_H +if in_mbedtls_repo; then + scripts/config.py realfull + make apidoc + mv $CONFIG_BAK $CONFIG_H +elif in_tf_psa_crypto_repo; then + cmake -DCMAKE_BUILD_TYPE:String=Check -DGEN_FILES=ON . + make tfpsacrypto-apidoc + mv $CONFIG_BAK $CONFIG_H +fi diff --git a/scripts/doxygen.sh b/scripts/doxygen.sh index 8c37b20dee..7d051ed1eb 100755 --- a/scripts/doxygen.sh +++ b/scripts/doxygen.sh @@ -8,8 +8,10 @@ # Abort on errors (and uninitialised variables) set -eu -if [ -d library -a -d include -a -d tests ]; then :; else - echo "Must be run from Mbed TLS root" >&2 +. $(dirname "$0")/project_detection.sh + +if in_mbedtls_repo || in_tf_psa_crypto_repo; then :; else + echo "Must be run from Mbed TLS root or TF-PSA-Crypto root" >&2 exit 1 fi @@ -28,5 +30,8 @@ if grep -E "(warning|error):" doc.filtered; then exit 1; fi -make apidoc_clean +if in_mbedtls_repo; then + make apidoc_clean +fi + rm -f doc.out doc.err doc.filtered