Add wordlist from man7.org #10023
Add wordlist from man7.org #10023
Conversation
util/find-doc-nits
Outdated
There was a problem hiding this comment.
Hehehe, is this a US English vs The Queen's English thing?
There was a problem hiding this comment.
I know policy is UK English, so are there anything to fix in that list? man7.org says to use US English.
There was a problem hiding this comment.
I'm not about sure the zeroes to zeros change. The Oxford dictionary notes that zeros is plural and zeroes is a verb.
Make sure your function zeroes memory by filling it with zeros. 😁
There was a problem hiding this comment.
Ah, considering we might potentially use the word in both forms, this line should go.
There was a problem hiding this comment.
Given this:
; g grep -i zeroes
man1/openssl-ts.pod:seconds, that need to be included in the time field. The trailing zeroes
man3/BN_bn2bin.pod:B<to>. The result is padded with zeroes if necessary. If B<tolen> is less than
man3/EVP_PKEY_CTX_ctrl.pod:If B<OSSL_EXCHANGE_PARAM_PAD> is 1 then the shared secret is padded with zeroes
man3/EVP_PKEY_CTX_ctrl.pod:If B<pad> is 1 the shared secret is padded with zeroes up to the size of the DH
man3/HMAC.pod:HMAC_CTX_reset() zeroes an existing B<HMAC_CTX> and associated
man3/d2i_X509.pod:The encoded data is in binary form and may contain embedded zeroes.
And since we can replace the one correct instance with "fills the context with zeros" I'd like to leave it so we catch the five typo's.
There was a problem hiding this comment.
I'm ambivalent, frankly. Please do fix the errors, but consider giving a warning instead of an error on zeroes
There was a problem hiding this comment.
Another option is to use "zeroise" (sic) instead of "zeroes". But I'll fix the errors and mull it over a bit.
There was a problem hiding this comment.
I think that zeroise is evil.
There was a problem hiding this comment.
I used "clear" instead. The main point is that of six instances found, five were wrong. We want to optimize to catch the error.
levitte
left a comment
There was a problem hiding this comment.
\b matches \w\W and \W\w boundaries
|
I updated the commit to add @levitte's regexp fixes. I'll make the actual changes and take this out of WIP once I get feedback on the zeroe?s sub-thread above. |
|
Oh yeah: travis failures are expected until I make the doc fixes. Look at the travis build log if you want to see what it finds. |
|
Fixed all the errors found, taking this out of WIP. |
|
You missed one 😉 |
|
yeah it got overwritten by a rebase of your other man/*/internal fixes. :) |
|
rebased and pushed. doc-nits errors are from the TYPE stuff, which @levitte is going to fix. |
|
I'll have to rebase after the build-breaking PR goes in, so wait on this. |
Eh... isn't that already merged? 😉 |
|
Yes, I typed too soon. The point is once Travis doc-nits is fixed, I'll have to rebase this. Same for #10039. |
Also patch find-doc-nits to ignore a Microsoft trademark and not flag it as a spelling error.
|
Rebased and pushed. I don't know if this needs another review round or not. |
Not if it was a clean rebase |
|
There were merge issues in find-doc-nits, as to be expected. |
|
In that case, then yeah |
|
Thanks. Matt will be pleased because once this is merged I'll do his favourite UK spelling :) PR |
Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from #10023)
Also patch find-doc-nits to ignore a Microsoft trademark and not flag it as a spelling error. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from #10023)
|
Merged to master. Thanks @richsalz |
Following the style of man7.org, update find-doc-nits to find 'terms to avoid' and suggest their
official replacements.
Do we want to do this? There are about 70 errors found.