util/find-doc-nits: more precise option and function name checker
authorRichard Levitte <levitte@openssl.org>
Wed, 2 Oct 2019 11:16:48 +0000 (13:16 +0200)
committerRichard Levitte <levitte@openssl.org>
Wed, 2 Oct 2019 17:26:24 +0000 (19:26 +0200)
commit705128b0f0dbc82db9e7b90aa4103eab9a5ce10e
tree06879b05c7f2f1369a48f1fd19166a800b7a94a4
parent2342f68f56351601bdb277fbf1e844202d56aee9
util/find-doc-nits: more precise option and function name checker

The checks for our uses of 'B<' and 'I<' for options, and possibly
function names, was over-reaching quite a bit.

So we fine-tune it a bit:

- by only checking for options in man1 pages, and only in SYNOPSIS
  and *OPTIONS sections.
- by only checking for function names in man3 pages.

The man1 option checker has the additional check that options found in
*OPTIONS are also found in SYNOPSIS andd vice versa.

In all cases, this also handles options and function names with
additional markup, such as 'B<-I<cipher>>' and 'B<sk_I<TYPE>_push>'.

Reviewed-by: Matt Caswell <matt@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/10073)
util/find-doc-nits