Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TF-PSA-Crypto Doxygen Adaptations #115

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Harry-Ramsey
Copy link
Contributor

@Harry-Ramsey Harry-Ramsey commented Jan 8, 2025

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.

@Harry-Ramsey Harry-Ramsey self-assigned this Jan 8, 2025
@Harry-Ramsey 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 Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch 2 times, most recently from fe80451 to 41789ad Compare January 10, 2025 12:56
make apidoc
mv $CONFIG_BAK $CONFIG_H
elif in_tf_psa_crypto_repo; then
cd $OUT_OF_SOURCE_DIR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
cd $OUT_OF_SOURCE_DIR
cd $OUT_OF_SOURCE_DIR

This is specific to all.sh and we want this script to work on its own. Here you can just build in tree:
cmake -DCMAKE_BUILD_TYPE:String=Check ..

Comment on lines +36 to +37
cd $TF_PSA_CRYPTO_ROOT_DIR
rm -rf $OUT_OF_SOURCE_DIR
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ditto

This commit adapts check-doxy-blocks to run for TF-PSA-Crypto.

Signed-off-by: Harry Ramsey <[email protected]>
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]>
@Harry-Ramsey Harry-Ramsey force-pushed the tf-psa-crypto-doxygen branch from 41789ad to a86eefa Compare January 23, 2025 16:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants