Add python docs package update script #314

2026-07-09T09:58:56-05:00

davidhorstmann-arm commented

2026-07-09 09:58:56 -05:00

(Migrated from github.com)

Add a small script to update the Python packages used to generate the docs in Mbed TLS.

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.

TF-PSA-Crypto development PR not required because: New script only
TF-PSA-Crypto 1.1 PR not required because: New script only
mbedtls development PR not required because: New script only
mbedtls 4.1 PR not required because: New script only
mbedtls 3.6 PR not required because: New script only

Add a small script to update the Python packages used to generate the docs in Mbed TLS. ## 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. - [x] **TF-PSA-Crypto development PR** not required because: New script only - [x] **TF-PSA-Crypto 1.1 PR** not required because: New script only - [x] **mbedtls development PR** not required because: New script only - [x] **mbedtls 4.1 PR** not required because: New script only - [x] **mbedtls 3.6 PR** not required because: New script only

yiwu0b11 (Migrated from github.com) approved these changes

2026-07-10 02:38:24 -05:00

yiwu0b11 (Migrated from github.com) left a comment

LGTM, i'm not sure why is the CI failing, seems unrelated.

Info: Test case was ignored: test_suite_config.crypto_combinations;Config: entropy: NV seed only
--
  |   |   | Error: Test case not executed: test_suite_psa_crypto;PSA generate key custom: RSA, e=3 with driver and no fallback (not yet supported)
  |   |   | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA decrypt transparent driver: fallback not available RSA OAEP-SHA-256
  |   |   | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA decrypt transparent driver: fallback not available RSA PKCS#1 v1.5
  |   |   | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt transparent driver: fallback not available RSA OAEP-SHA-256
  |   |   | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt transparent driver: fallback not available RSA PKCS#1 v1.5
  |   |   | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt-decrypt transparent driver: fallback not available RSA OAEP-SHA-256
  |   |   | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt-decrypt transparent driver: fallback not available RSA PKCS#1 v1.5
  |   |   | Info: Overall results: 0 warnings and 7 errors

LGTM, i'm not sure why is the CI failing, seems unrelated. ``` Info: Test case was ignored: test_suite_config.crypto_combinations;Config: entropy: NV seed only -- | | | Error: Test case not executed: test_suite_psa_crypto;PSA generate key custom: RSA, e=3 with driver and no fallback (not yet supported) | | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA decrypt transparent driver: fallback not available RSA OAEP-SHA-256 | | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA decrypt transparent driver: fallback not available RSA PKCS#1 v1.5 | | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt transparent driver: fallback not available RSA OAEP-SHA-256 | | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt transparent driver: fallback not available RSA PKCS#1 v1.5 | | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt-decrypt transparent driver: fallback not available RSA OAEP-SHA-256 | | | Error: Test case not executed: test_suite_psa_crypto_driver_wrappers;PSA encrypt-decrypt transparent driver: fallback not available RSA PKCS#1 v1.5 | | | Info: Overall results: 0 warnings and 7 errors ```

davidhorstmann-arm commented

2026-07-13 06:11:35 -05:00

(Migrated from github.com)

It looks like there were a couple of infrastructure issues. One of them hit the component that tests RSA acceleration and the result analysis detected it as a test case not executed. I'm going to give it a poke and see if that works.

gilles-peskine-arm (Migrated from github.com) approved these changes

2026-07-20 10:18:41 -05:00

gilles-peskine-arm (Migrated from github.com) left a comment

LGTM although I don't understand the exclusion of TF-PSA-Crypto

scripts/update_docs_python_packages.sh

					
				@ -0,0 +9,4 @@

				if is_tf_psa_crypto_root $PWD; then

				    echo "Error: This script is only for Mbed TLS"

				    exit 1

				fi

Why shouldn't this script run in TF-PSA-Crypto?

gilles-peskine-arm commented

2026-07-20 10:19:36 -05:00

(Migrated from github.com)

The CI failed for another intermittent reason. I'm leaving up to you to either rerun the CI and merge, or update to remove the repository restriction.

gilles-peskine-arm (Migrated from github.com) requested changes

2026-09-04 10:30:31 -05:00

gilles-peskine-arm (Migrated from github.com) left a comment

LGTM except the repository restriction

scripts/update_docs_python_packages.sh

					
				@ -0,0 +9,4 @@

				if is_tf_psa_crypto_root $PWD; then

				    echo "Error: This script is only for Mbed TLS"

				    exit 1

				fi

Revisiting: we're trying to make the projects more independent, so please remove the repository restriction. We don't yet have the necessary files in TF-PSA-Crypto, but we want to add them.

This pull request is broken due to missing fork information.

View command line instructions

Checkout

From your project repository, check out a new branch and test the changes.

git fetch -u origin 'davidhorstmann-arm/add-python-package-update-script:davidhorstmann-arm/add-python-package-update-script'

git switch 'davidhorstmann-arm/add-python-package-update-script'

Merge

Merge the changes and update on Forgejo.

Warning: The "Autodetect manual merge" setting is not enabled for this repository, you will have to mark this pull request as manually merged afterwards.

git switch 'main'

git merge --no-ff 'davidhorstmann-arm/add-python-package-update-script'

git switch 'davidhorstmann-arm/add-python-package-update-script'

git rebase 'main'

git switch 'main'

git merge --ff-only 'davidhorstmann-arm/add-python-package-update-script'

git switch 'davidhorstmann-arm/add-python-package-update-script'

git rebase 'main'

git switch 'main'

git merge --no-ff 'davidhorstmann-arm/add-python-package-update-script'

git switch 'main'

git merge --squash 'davidhorstmann-arm/add-python-package-update-script'

git switch 'main'

git merge --ff-only 'davidhorstmann-arm/add-python-package-update-script'

git switch 'main'

git merge 'davidhorstmann-arm/add-python-package-update-script'

git push origin 'main'

Sign in to join this conversation.

No reviewers

yiwu0b11

gilles-peskine-arm

No milestone

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

gh-Mbed-TLS/mbedtls-framework!314

Rows
Columns