Better and more consistent hyphenation#225
Merged
Merged
Conversation
athoelke
added
Crypto API
gilles-peskine-arm
approved these changes
Nov 4, 2024
Contributor
gilles-peskine-arm
left a comment
gilles-peskine-arm
left a comment
There was a problem hiding this comment.
Looks broadly ok to me. There are still a few inaccuracies but it's cosmetic.
| * `psa_key_derivation_output_key()` and `psa_key_derivation_output_key_custom()` create a key from data generated by a pseudorandom derivation process. See :secref:`kdf`. | ||
| * `psa_key_agreement()` creates a key from the shared secret result of a key agreement process. See :secref:`key-agreement`. | ||
| * `psa_key_agreement()` creates a key from the shared secret result of a key-agreement process. See :secref:`key-agreement`. | ||
| * `psa_pake_get_shared_key()` creates a key from the shared secret result of a password-authenticated key exchange. See :secref:`pake`. |
Contributor
There was a problem hiding this comment.
git grep -Eon 'key (agreement|derivation|generation) \w+' doc reports one “key derivation interface”.
| :numref:`fig-spake2p-reg` illustrates some example SPAKE2+ key derivation flows. | ||
| :numref:`fig-spake2p-reg` illustrates some example SPAKE2+ key-derivation flows. | ||
|
|
||
| The resulting SPAKE2+ key-pair must be protected at least as well as the password. |
Contributor
There was a problem hiding this comment.
Conversely this should be “key pair”. From git grep -Eon 'key-\w+ \w+' doc (I haven't combed the “key-foo and/or/with”).
We also seem to be inconsistent about keystore vs key-store.
Contributor
Author
There was a problem hiding this comment.
I will review key-pair/key pair, public-key/public key and key-store/keystore. For the latter I am inclined to go with "keystore".
athoelke
force-pushed
the
crypto-grammar
branch
from
e140b5d to
33ffcf8
Compare
Contributor
Author
|
Rebased to catch up with other merges. Tackled a few other noun expressions:
|
athoelke
force-pushed
the
crypto-grammar
branch
from
33ffcf8 to
2a9a566
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Some grammar fixes for hyphenation inconsistencies.