Document that multipart operation setup can return BAD_STATE #11
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
hash_setup and mac_setup used to be called hash_start and mac_start, but we've now converged on _setup as names. Finish making the terminology in the documentation consistent.
Future commits will implement this and add tests.
gilles-peskine-arm
added
enhancement
Patater
approved these changes
Jan 23, 2019
yanesca
approved these changes
Feb 19, 2019
Patater
removed
the
needs: review
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.
A setup function for a multipart operation should return
PSA_ERROR_BAD_STATEif the operation structure is already in use. Before #6 this was impossible because the operation structure was not initialized, but now this is possible and strongly desirable so mandate it.This PR only updates the implementation documentation, which currently also serves as a specification document. A future PR will need to implement the checks and add corresponding tests (tracked in #10).