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.

Sign up for GitHub

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

Jump to bottom

Add migration guide and ChangeLog #214

Open
wants to merge 6 commits into
base: development
Choose a base branch
from
Open

Add migration guide and ChangeLog #214

wants to merge 6 commits into from
+251 −0

Conversation

bjwtaylor
Copy link

@bjwtaylor bjwtaylor commented Mar 19, 2025 •
edited
Loading

Description

Add a migration guide for the rng removal and a generic ChangeLog entry for the rng removal that points to it. resolves Mbed-TLS/mbedtls#10028

PR checklist

  • changelog provided
  • framework PR not required
  • mbedtls development PR provided Mbed-TLS/mbedtls#Add ChangeLog for rng mbedtls#10074
  • mbedtls 3.6 PR not required because: No backports
  • mbedtls 2.28 PR not required because: No backports
  • tests not required because: No changes

Sorry, something went wrong.

@bjwtaylor bjwtaylor marked this pull request as draft March 19, 2025 13:22
@bjwtaylor bjwtaylor mentioned this pull request Mar 19, 2025
Open
6 tasks
@bjwtaylor bjwtaylor added needs-review Every commit must be reviewed by at least two team members needs-reviewer This PR needs someone to pick it up for review labels Mar 21, 2025
@bjwtaylor bjwtaylor marked this pull request as ready for review March 21, 2025 07:40
minosgalanakis
minosgalanakis requested changes Mar 26, 2025
View reviewed changes
Copy link
Contributor

@minosgalanakis minosgalanakis left a comment

Choose a reason for hiding this comment

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

I am not certain relative referencing works for TF-PSA crypto docs. Could we use absolute links?

4.0 migration guide

minosgalanakis
minosgalanakis requested changes Mar 27, 2025
View reviewed changes
Copy link
Contributor

@minosgalanakis minosgalanakis left a comment

Choose a reason for hiding this comment

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

Since this is markdown we should go with:

[4.0-migration-guide.md](https://github.com/Mbed-TLS/TF-PSA-Crypto/blob/development/docs/tf-psa-crypto/docs/4.0-migration-guide.md)

minosgalanakis
minosgalanakis previously approved these changes Mar 27, 2025
View reviewed changes
Copy link
Contributor

@minosgalanakis minosgalanakis left a comment

Choose a reason for hiding this comment

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

Looks good, needs CI

@davidhorstmann-arm davidhorstmann-arm self-requested a review March 27, 2025 17:39
@mpg mpg removed the needs-reviewer This PR needs someone to pick it up for review label Mar 28, 2025
@minosgalanakis
Copy link
Contributor

As in the framework commit, I was wrong, we should not be using markdown links on the changelogs. Please just rebase removing the last commit.

minosgalanakis
minosgalanakis previously approved these changes Mar 28, 2025
View reviewed changes
Copy link
Contributor

@minosgalanakis minosgalanakis left a comment

Choose a reason for hiding this comment

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

Thanks for the quick rebase.

LGTM

davidhorstmann-arm
davidhorstmann-arm requested changes Mar 28, 2025
View reviewed changes
Copy link
Contributor

@davidhorstmann-arm davidhorstmann-arm left a comment

Choose a reason for hiding this comment

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

Some problems and nits but looks good otherwise.

davidhorstmann-arm
davidhorstmann-arm requested changes Mar 31, 2025
View reviewed changes
Copy link
Contributor

@davidhorstmann-arm davidhorstmann-arm left a comment

Choose a reason for hiding this comment

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

Some formatting issues but looks okay otherwise!

Ben Taylor added 3 commits April 2, 2025 08:33
Add migration guide and ChangeLog
70aefdf 
Signed-off-by: Ben Taylor <ben.taylor@linaro.org>
removed whitespace
74b1c93 
Signed-off-by: Ben Taylor <ben.taylor@linaro.org>
Add improvements and corrections to the migration guide
9971d31 
Signed-off-by: Ben Taylor <ben.taylor@linaro.org>
@bjwtaylor bjwtaylor force-pushed the rng-documentation branch from 89effc6 to 9971d31 Compare April 2, 2025 07:33
Ben Taylor added 3 commits April 3, 2025 10:22
remove stray ' from migration guide
470bf2f 
Signed-off-by: Ben Taylor <ben.taylor@linaro.org>
added missing close to rng-removal.md
f6931df 
Signed-off-by: Ben Taylor <ben.taylor@linaro.org>
corrected close of code block in rng-removal.md
57fc0f0 
Signed-off-by: Ben Taylor <ben.taylor@linaro.org>
davidhorstmann-arm
davidhorstmann-arm approved these changes Apr 3, 2025
View reviewed changes
Copy link
Contributor

@davidhorstmann-arm davidhorstmann-arm left a comment

Choose a reason for hiding this comment

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

LGTM, thanks!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@davidhorstmann-arm davidhorstmann-arm

@minosgalanakis minosgalanakis

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
needs-review Every commit must be reviewed by at least two team members
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Documentation for removing explicit RNG arguments
4 participants
@bjwtaylor @minosgalanakis @davidhorstmann-arm @mpg