Skip to content

Commit

Permalink
Adapt doxygen scripts to run for TF-PSA-Crypto
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
Harry-Ramsey committed Jan 30, 2025
1 parent 9bada6a commit f16b29c
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 8 deletions.
1 change: 1 addition & 0 deletions scripts/all-core.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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)"
Expand Down
21 changes: 16 additions & 5 deletions scripts/apidoc_full.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
11 changes: 8 additions & 3 deletions scripts/doxygen.sh
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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

0 comments on commit f16b29c

Please sign in to comment.