diff options
| author | Matt Caswell <matt@openssl.org> | 2019-06-06 13:12:49 +0200 |
|---|---|---|
| committer | Matt Caswell <matt@openssl.org> | 2019-06-12 11:12:14 +0200 |
| commit | b5283535d52002f892ef17c890a3e1840640a60b (patch) | |
| tree | 9980c32d1efb9bb99b25a36d8482b2f9da6c0740 /Configurations | |
| parent | Configure: count basenames for all library sources (diff) | |
| download | openssl-b5283535d52002f892ef17c890a3e1840640a60b.tar.xz openssl-b5283535d52002f892ef17c890a3e1840640a60b.zip | |
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)
Diffstat (limited to 'Configurations')
| -rw-r--r-- | Configurations/unix-Makefile.tmpl | 2 |
1 files changed, 1 insertions, 1 deletions
diff --git a/Configurations/unix-Makefile.tmpl b/Configurations/unix-Makefile.tmpl index 8a1ec4944f..ce93a4ed1c 100644 --- a/Configurations/unix-Makefile.tmpl +++ b/Configurations/unix-Makefile.tmpl @@ -728,7 +728,7 @@ generate: generate_apps generate_crypto_bn generate_crypto_objects \ .PHONY: doc-nits doc-nits: build_generated - (cd $(SRCDIR); $(PERL) util/find-doc-nits -n -p ) >doc-nits + (cd $(SRCDIR); $(PERL) util/find-doc-nits -n -p -s ) >doc-nits @if [ -s doc-nits ] ; then cat doc-nits ; exit 1; \ else echo 'doc-nits: no errors.'; rm doc-nits ; fi |