API specifications at version 1.0 beta1 #38
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Documentation generated from the PSA Crypto API documentation private repository at tag "psa-crypto-api-1.0-beta1". This uses some of the files include/psa/crypto*.h from the mbed-crypto repository at tag "psa-api-1.0-beta".
gilles-peskine-arm
added
enhancement
Patater
approved these changes
Jan 31, 2019
There was a problem hiding this comment.
- Pre-existing issue observation:
psa_generate_key_extra_rsastill shows up as a "Class", and it's the only "Class". Any idea why or how to fix this? - Mild protest: Is this meant to be generated from the headers we shipped in the 1.0b1 or the currently checked in version? I think I'd prefer the docs to match the implementation at all times, but we need a web presence with the spec ASAP, so this'll do.
- Pre-existing issue observation: some of the group__crypto__types.html don't have Doxygen documentation.
|
Regarding the Doxygen issues: this will be fixed in the spec after migrating to the new format. For the implementation, I don't know how to fix it. The text says that it's linking to the specification. That's why it's pointing to a different branch. Later we'll make a process to have the library documentation on tls.mbed.org or crypto.mbed.org or whatever. |
dgreen-arm
approved these changes
Feb 1, 2019
Patater
added
the
needs: work
|
This is not quite passing CI... there are some failures in all.sh |
Patater
added
needs: ci
|
Failures are expected since the code hasn't caught up with the specification. That's why this is for the |
|
OK, didn't catch that this was for non-development branch. Mergin'. |
Patater
removed
needs: ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Upload the generated PDF and HTML for the PSA Crypto API 1.0 beta1.