Don't ignore ASN1 when checking for undocumented symbols#10980
Don't ignore ASN1 when checking for undocumented symbols#10980mattcaswell wants to merge 2 commits intoopenssl:masterfrom
Conversation
When we run "make doc-nits" (which happens during travis runs) it will complain if we add any new symbols that aren't documented. However it was suppressing anything starting with ASN1. There's no reason why we should allow ASN1 symbols to go undocumented any more than any others. Therefore we remove that exception.
|
H'oh boy... Did you find a reasoning re skipping those functions in the commit log? |
Seems to have always been there. No specific reasoning mentioned in the logs that I could find. |
|
We never considered the ASN1 parsing to be really part of the public API. Nobody on the team was really thrillled with the way that stuff works, and there was also a bubbling undercurrent of replacing it. When developing find-doc-nits, I just codified that sentiment :) Perhaps a more tractable solution is to just ignore the common new/free/it names? And then trim down the missing list significantly. |
|
Ping? |
|
Knowing which of these isn't documented seems like a good idea. |
paulidale
added
the
approval: done
mattcaswell
added
approval: ready to merge
PR openssl#10942 introduced the new function ASN1_item_verify_ctx(), but did not document it with the promise that documentation would follow soon. We temporarily add this function to missingcrypto.txt until it has been done.
mattcaswell
added
approval: review pending
|
Darn. PR #10942 went in and added a new and undocumented ASN1 function with the promise from @levitte that he would add the docs real soon. Until that happens we need to add that function to missingcrypto.txt in this PR to avoid a "make doc-nits" failure. @paulidale (or anyone) please can you reconfirm? |
|
Travis red cross is not relevant. Ping? |
paulidale
left a comment
paulidale
left a comment
There was a problem hiding this comment.
Still good, missed the earlier reminder sorry.
paulidale
added
approval: done
iamamoose
added
approval: ready to merge
When we run "make doc-nits" (which happens during travis runs) it will complain if we add any new symbols that aren't documented. However it was suppressing anything starting with ASN1. There's no reason why we should allow ASN1 symbols to go undocumented any more than any others. Therefore we remove that exception. Reviewed-by: Paul Dale <[email protected]> (Merged from #10980)
PR #10942 introduced the new function ASN1_item_verify_ctx(), but did not document it with the promise that documentation would follow soon. We temporarily add this function to missingcrypto.txt until it has been done. Reviewed-by: Paul Dale <[email protected]> (Merged from #10980)
|
Pushed. Thanks. |
5 participants
When we run "make doc-nits" (which happens during travis runs) it will
complain if we add any new symbols that aren't documented. However it
was suppressing anything starting with ASN1. There's no reason why we
should allow ASN1 symbols to go undocumented any more than any others.
Therefore we remove that exception.
Checklist