Point to psa-crypto-api branch for the PSA Crypto API specification #39
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
gilles-peskine-arm
added
bug
Patater
suggested changes
Jan 31, 2019
README.md
Outdated
|
|
||
| The PSA cryptography API specification consists of the following documents: | ||
|
|
||
| * The [PSA Cryptography API overview](https://github.com/gilles-peskine-arm/mbed-crypto/blob/psa-crypto-api-1.0-beta-docs/docs/PSA_Cryptography_API_Specification.pdf). |
There was a problem hiding this comment.
Recommend not pointing to your fork
There was a problem hiding this comment.
Thanks for catching this. I amended the commit.
Link to rendered copies of the specification on a separate branch, since the implementation is not always up-to-date with the specification. Fix the broken link to the HTML to something that works on the web. Add instructions to generate the library documentation in HTML locally.
gilles-peskine-arm
force-pushed
the
psa-api-1.0-beta-docs
branch
from
76825e1 to
7b39508
Compare
Patater
approved these changes
Jan 31, 2019
dgreen-arm
approved these changes
Feb 1, 2019
Patater
removed
needs: preceding PR
|
CI failure is FreeBSD timing test, a known issue. |
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.
Remove the PDF copies of the API specification. They aren't even generated from the header files in this branch now. Link to the branch https://github.com/ARMmbed/mbed-crypto/tree/psa-crypto-api instead.
Replace the broken link to HTML (which only ever worked if you generated the documentation locally, and even then had the wrong path) with a working link.
I created a label complianceDiscrepancy between the library and the PSA Crypto API specification
to track places where the implementation deviates from the specification (+
enhancementif it's incomplete, +bugif it's incompatible).The links to rendered documentation will not work until #38 is merged.
Fix #33