TF-PSA-Crypto Doxygen Adaptations #115

Harry-Ramsey · 2025-01-08T15:47:54Z

Description

Adapt doxygen scripts to work for TF-PSA-Crypto.

PR checklist

Please add the numbers (or links) of the associated pull requests for consuming branches. You can omit branches where this pull request is not needed.

crypto PR Mbed-TLS/TF-PSA-Crypto: #142
development PR Mbed-TLS/mbedtls: not required.
3.6 PR Mbed-TLS/mbedtls: not required.

Notes for the submitter

Please refer to the contributing guidelines, especially the
checklist for PR contributors.

Help make review efficient:

Multiple simple commits
- please structure your PR into a series of small commits, each of which does one thing
Avoid force-push
- please do not force-push to update your PR - just add new commit(s)
See our Guidelines for Contributors for more details about the review process.

scripts/apidoc_full.sh

scripts/doxygen.sh

scripts/all-core.sh

scripts/apidoc_full.sh

scripts/check-doxy-blocks.pl

scripts/apidoc_full.sh

ronald-cron-arm · 2025-02-10T08:33:28Z

scripts/apidoc_full.sh

+    mv $CONFIG_BAK $CONFIG_H
+elif in_tf_psa_crypto_repo; then
+    scripts/config.py realfull
+    cmake -DCMAKE_BUILD_TYPE:String=Check -DGEN_FILES=ON .


Having played with it, it would be better to build out of tree in a temporary directory. Otherwise when we run doxygen.sh locally the source tree ends up with all the CMake artefacts. mktemp is it seems the way to create a temporary directory in bash.

tmp=$(mktemp -d) creates a temporary directory in a user-configurable location (defaulting to /tmp) and stores the location in $tmp. tmp=$(TMPDIR=/path/to/parent mktemp -d) creates a temporary directory under /path/to/parent. Avoid other options to mktemp for portability to older Linux and *BSD.

But do we really need a temporary directory name? We want to keep the Doxygen build products around, so why not use a fixed directory name like doxygen/build-apidoc-full?

The documentation is currently generated at the root of the source tree in the apidoc directory thus we do not need to keep the build tree. A fixed build directory in the source tree would not really improve things regarding not modifying the build tree thus not sure it would be an improvement.

A fixed build directory is slightly easier to program, and is easier to inspect and clean if an error occurs.

okay the main thing I wanted to avoid here was to build in the source tree. I am fine with a build directory doxygen/build-apidoc-full.

ronald-cron-arm

To fix the CI test_full_cmake_clang and test_psa_compliance jobs you need to rebase on top of main.

ronald-cron-arm · 2025-02-10T13:19:43Z

scripts/apidoc_full.sh

+CRYPTO_CONFIG_H='include/psa/crypto_config.h'
+if in_mbedtls_repo; then
+    CONFIG_H='include/mbedtls/mbedtls_config.h'
+    CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h'


This does not work in 3.6 case.

ronald-cron-arm

A few things to fix, otherwise we do not plan to have mbedtls PRs for this thus we need a green CI and for that we need to rebase against latest main.

ronald-cron-arm · 2025-02-11T09:52:28Z

scripts/apidoc_full.sh


-scripts/config.py realfull
-make apidoc
+if in_tf_psa_crypto_repo || (in_mbedtls_repo && !in_3_6_branch); then


Suggested change

if in_tf_psa_crypto_repo || (in_mbedtls_repo && !in_3_6_branch); then

if in_tf_psa_crypto_repo || (in_mbedtls_repo && ! in_3_6_branch); then

without a space between the exclamation mark and "in_3_6_branch" it does not work.

ronald-cron-arm · 2025-02-11T09:54:03Z

scripts/apidoc_full.sh

+if in_mbedtls_repo; then
+    CONFIG_H='include/mbedtls/mbedtls_config.h'
+    if [ -r $CONFIG_H ]; then :; else
+        echo "$CONFIG_H not found" >&2
+    fi
 fi

-CONFIG_BAK=${CONFIG_H}.bak
-cp -p $CONFIG_H $CONFIG_BAK
+if in_mbedtls_repo; then
+    CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h'
+    if [ -r $CRYPTO_CONFIG_H ]; then :; else
+        echo "$CRYPTO_CONFIG_H not found" >&2
+        exit 1
+    fi
+fi


if in_mbedtls_repo; then CONFIG_H='include/mbedtls/mbedtls_config.h' if [ -r $CONFIG_H ]; then :; else echo "$CONFIG_H not found" >&2 fi if ! in_3_6_branch; then CRYPTO_CONFIG_H='tf-psa-crypto/include/psa/crypto_config.h' fi fi

ronald-cron-arm · 2025-02-11T09:54:46Z

scripts/apidoc_full.sh

+if in_tf_psa_crypto_repo; then
+    CRYPTO_CONFIG_H='include/psa/crypto_config.h'
+    if [ -r $CRYPTO_CONFIG_H ]; then :; else
+        echo "$CRYPTO_CONFIG_H not found" >&2
+        exit 1
+    fi
+fi


Suggested change

if in_tf_psa_crypto_repo; then

CRYPTO_CONFIG_H='include/psa/crypto_config.h'

if [ -r $CRYPTO_CONFIG_H ]; then :; else

echo "$CRYPTO_CONFIG_H not found" >&2

exit 1

fi

fi

if in_tf_psa_crypto_repo; then

CRYPTO_CONFIG_H='include/psa/crypto_config.h'

fi

ronald-cron-arm · 2025-02-11T09:55:33Z

scripts/apidoc_full.sh

+if in_tf_psa_crypto_repo || (in_mbedtls_repo && !in_3_6_branch); then
+    CRYPTO_CONFIG_BAK=${CRYPTO_CONFIG_H}.bak
+    cp -p $CRYPTO_CONFIG_H $CRYPTO_CONFIG_BAK
+fi


Suggested change

if in_tf_psa_crypto_repo || (in_mbedtls_repo && !in_3_6_branch); then

CRYPTO_CONFIG_BAK=${CRYPTO_CONFIG_H}.bak

cp -p $CRYPTO_CONFIG_H $CRYPTO_CONFIG_BAK

fi

if in_tf_psa_crypto_repo || (in_mbedtls_repo && ! in_3_6_branch); then

if [ -r $CRYPTO_CONFIG_H ]; then :; else

echo "$CRYPTO_CONFIG_H not found" >&2

exit 1

fi

CRYPTO_CONFIG_BAK=${CRYPTO_CONFIG_H}.bak

cp -p $CRYPTO_CONFIG_H $CRYPTO_CONFIG_BAK

fi

ronald-cron-arm · 2025-02-11T09:56:08Z

scripts/apidoc_full.sh

+    cd $TF_PSA_CRYPTO_ROOT_DIR
+fi
+
+if in_tf_psa_crypto_repo || (in_mbedtls_repo && !in_3_6_branch); then


Suggested change

if in_tf_psa_crypto_repo || (in_mbedtls_repo && !in_3_6_branch); then

if in_tf_psa_crypto_repo || (in_mbedtls_repo && ! in_3_6_branch); then

This commit adapts check-doxy-blocks to run for TF-PSA-Crypto. Signed-off-by: Harry Ramsey <[email protected]>

This commit adapts the scripts apidoc_full.sh and doxygen.sh to run for TF-PSA-Crypto out of source builds. Signed-off-by: Harry Ramsey <[email protected]>

ronald-cron-arm

LGTM, thanks.

Harry-Ramsey self-assigned this Jan 8, 2025

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 2 times, most recently from 3a2fde9 to b22c1b6 Compare January 10, 2025 10:29

Harry-Ramsey mentioned this pull request Jan 10, 2025

Add doxygen components Mbed-TLS/TF-PSA-Crypto#142

Merged

3 tasks

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 2 times, most recently from fe80451 to 41789ad Compare January 10, 2025 12:56

ronald-cron-arm requested changes Jan 17, 2025

View reviewed changes

scripts/apidoc_full.sh Outdated Show resolved Hide resolved

scripts/doxygen.sh Outdated Show resolved Hide resolved

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 41789ad to a86eefa Compare January 23, 2025 16:49

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 59e9177 to f16b29c Compare January 30, 2025 16:53

ronald-cron-arm self-requested a review February 3, 2025 10:58

ronald-cron-arm requested changes Feb 4, 2025

View reviewed changes

scripts/all-core.sh Outdated Show resolved Hide resolved

scripts/apidoc_full.sh Show resolved Hide resolved

scripts/apidoc_full.sh Outdated Show resolved Hide resolved

scripts/check-doxy-blocks.pl Show resolved Hide resolved

scripts/check-doxy-blocks.pl Outdated Show resolved Hide resolved

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 3 times, most recently from a256c44 to fa1bc66 Compare February 5, 2025 15:50

ronald-cron-arm requested changes Feb 6, 2025

View reviewed changes

scripts/apidoc_full.sh Outdated Show resolved Hide resolved

scripts/apidoc_full.sh Outdated Show resolved Hide resolved

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 2 times, most recently from 7eea683 to 8660359 Compare February 6, 2025 13:32

ronald-cron-arm requested changes Feb 10, 2025

View reviewed changes

valeriosetti self-requested a review February 10, 2025 10:02

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 8660359 to d5d468d Compare February 10, 2025 11:07

valeriosetti previously approved these changes Feb 10, 2025

View reviewed changes

ronald-cron-arm requested changes Feb 10, 2025

View reviewed changes

Harry-Ramsey dismissed valeriosetti’s stale review via b8bf60e February 10, 2025 21:55

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from d5d468d to b8bf60e Compare February 10, 2025 21:55

ronald-cron-arm requested changes Feb 11, 2025

View reviewed changes

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from b8bf60e to 4fef8d8 Compare February 11, 2025 10:13

This was referenced Feb 11, 2025

[Backport 3.6] Update framework pointer Mbed-TLS/mbedtls#9961

Closed

TF-PSA-Crypto pointer doxygen update Mbed-TLS/mbedtls#9962

Closed

Harry-Ramsey added 2 commits February 11, 2025 13:53

Adapt check-doxy-blocks to run for TF-PSA-Crypto

2f62067

This commit adapts check-doxy-blocks to run for TF-PSA-Crypto. Signed-off-by: Harry Ramsey <[email protected]>

Adapt doxygen scripts to run for TF-PSA-Crypto

8172207

This commit adapts the scripts apidoc_full.sh and doxygen.sh to run for TF-PSA-Crypto out of source builds. Signed-off-by: Harry Ramsey <[email protected]>

Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 4fef8d8 to 8172207 Compare February 11, 2025 13:54

ronald-cron-arm approved these changes Feb 11, 2025

View reviewed changes

ronald-cron-arm requested a review from valeriosetti February 11, 2025 16:04

valeriosetti approved these changes Feb 11, 2025

View reviewed changes

ronald-cron-arm merged commit 655a117 into Mbed-TLS:main Feb 11, 2025
2 of 3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

TF-PSA-Crypto Doxygen Adaptations #115

TF-PSA-Crypto Doxygen Adaptations #115

Harry-Ramsey commented Jan 8, 2025 •

edited

Loading

ronald-cron-arm Feb 10, 2025

gilles-peskine-arm Feb 10, 2025

ronald-cron-arm Feb 10, 2025

gilles-peskine-arm Feb 10, 2025

ronald-cron-arm Feb 10, 2025 •

edited

Loading

ronald-cron-arm left a comment

ronald-cron-arm Feb 10, 2025

ronald-cron-arm left a comment

ronald-cron-arm Feb 11, 2025

ronald-cron-arm Feb 11, 2025

ronald-cron-arm Feb 11, 2025

ronald-cron-arm Feb 11, 2025

ronald-cron-arm Feb 11, 2025

ronald-cron-arm left a comment

	if in_tf_psa_crypto_repo \|\| (in_mbedtls_repo && !in_3_6_branch); then
	if in_tf_psa_crypto_repo \|\| (in_mbedtls_repo && ! in_3_6_branch); then

TF-PSA-Crypto Doxygen Adaptations #115

TF-PSA-Crypto Doxygen Adaptations #115

Conversation

Harry-Ramsey commented Jan 8, 2025 • edited Loading

Description

PR checklist

Notes for the submitter

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronald-cron-arm Feb 10, 2025 • edited Loading

Choose a reason for hiding this comment

ronald-cron-arm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronald-cron-arm left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ronald-cron-arm left a comment

Choose a reason for hiding this comment

Harry-Ramsey commented Jan 8, 2025 •

edited

Loading

ronald-cron-arm Feb 10, 2025 •

edited

Loading