Make find-doc-nits check for newly added undocumented symbols
authorMatt Caswell <matt@openssl.org>
Thu, 6 Jun 2019 11:12:49 +0000 (12:12 +0100)
committerMatt Caswell <matt@openssl.org>
Wed, 12 Jun 2019 09:12:14 +0000 (10:12 +0100)
commitb5283535d52002f892ef17c890a3e1840640a60b
tree9980c32d1efb9bb99b25a36d8482b2f9da6c0740
parent51583cb8f464b49d2ea33b2be027274ac0d4b1a0
Make find-doc-nits check for newly added undocumented symbols

We create lists of undocumented functions and macros as they are now so
that find-doc-nits can check for newly introduced functions/macros that
are undocumented.

This works in a similar way to the -u and -d options to find-doc-nits.
These count undocumented symbols and print a detailed list of undocumented
symbols repsectively. This commit adds the -v and -e options to restrict
the count/detailed list to newly added undocumented symbols only.

There is also a new -s option that does the same as -e except that it
produces no output if there are no newly undocumented symbols.

We also amend "make doc-nits" to add the -s option which should cause
travis to fail if a PR adds undocumented symbols.

Reviewed-by: Richard Levitte <levitte@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/9094)
Configurations/unix-Makefile.tmpl
util/find-doc-nits
util/missingcrypto.txt [new file with mode: 0644]
util/missingmacro.txt [new file with mode: 0644]
util/missingssl.txt [new file with mode: 0644]