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.

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

Param type documentation consistency updates. #9891

Closed
wants to merge 3 commits into from

Conversation

@paulidale
Copy link
Contributor

paulidale commented Sep 13, 2019

Use the parameter types when describing generic params.

  • documentation is added or updated
  • tests are added or updated
doc/man3/EVP_DigestInit.pod Outdated Show resolved Hide resolved
doc/man3/EVP_KDF.pod Outdated Show resolved Hide resolved
doc/man3/EVP_KDF.pod Outdated Show resolved Hide resolved
doc/man3/EVP_MAC.pod Outdated Show resolved Hide resolved
@paulidale paulidale force-pushed the paulidale:mac-size-fix branch from b889348 to 479d8bd Sep 13, 2019
@levitte

This comment has been minimized.

Copy link
Member

levitte commented Sep 13, 2019

Okay, I wasn't sure what the guideline was.

Depending on where you read, that are incredibly vague, and often expressed in terms of "for types, use this mdoc macro" or something like that, and you have to figure out from the *roff language what it does... I've found that man-pages(7) and perlpodstyle are the clearest docs on the matter, so I often turn to them.

(I sometimes look at my old copy of "UNIX Programmer's Manual Volume 1" from 1982, but not too deeply, as it seems the conventions have changed since then)

@@ -208,6 +209,7 @@ If this memory usage limit is exceeded because the load factors are chosen
too high, the key derivation will fail.

The default value is implementation dependent.
The memory size must never exceed what can be given with a B<size_t>.

This comment has been minimized.

Copy link
@richsalz

richsalz Sep 13, 2019

Contributor

Is this enforced by the code?

This comment has been minimized.

Copy link
@levitte

levitte Sep 13, 2019

Member

It's enforced enough by the way it's used

levitte pushed a commit that referenced this pull request Sep 14, 2019
…ified using a size_t variable

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9891)
levitte pushed a commit that referenced this pull request Sep 14, 2019
… those where it makes sense.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9891)
levitte pushed a commit that referenced this pull request Sep 14, 2019
Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from #9891)
@paulidale

This comment has been minimized.

Copy link
Contributor Author

paulidale commented Sep 14, 2019

Merged, thanks.

@paulidale paulidale closed this Sep 14, 2019
@paulidale paulidale deleted the paulidale:mac-size-fix branch Sep 14, 2019
@levitte levitte mentioned this pull request Sep 23, 2019
1 of 2 tasks complete
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.