Clean up some doc nits

[richsalz]

Mostly "No items in =over/=back list"

Didn't anyone notice this when they did "make doc-nits" ? :)

[mspncp]

Didn't anyone notice this when they did "make doc-nits" ? :)

Hmmm... 'make doc-nits' does not report anything to me on current master (e1c6f76)?

~/src/openssl$ git log --oneline -1 
e1c6f76281 (HEAD -> master, origin/master, origin/HEAD, github/master, github/gh-2067) There is no -signreq option in CA.pl

~/src/openssl$ make doc-nits
/usr/bin/perl ./util/find-doc-nits -n -l -e

[mspncp]

I like your topic branch name.

[richsalz]

Must have different versions of some perl utils. On my mac, I get:

MAC ~/git/openssl$ mk doc-nits
/usr/bin/perl ./util/find-doc-nits -n -l -e
*** WARNING: No items in =over (at line 22) / =back list at line 27 in file doc/man3/X509_get0_distinguishing_id.pod
*** WARNING: No items in =over (at line 12) / =back list at line 52 in file doc/man7/EVP_MD-common.pod
*** WARNING: No items in =over (at line 19) / =back list at line 25 in file doc/man7/OSSL_PROVIDER-FIPS.pod
*** WARNING: No items in =over (at line 18) / =back list at line 22 in file doc/man7/OSSL_PROVIDER-default.pod
*** WARNING: No items in =over (at line 21) / =back list at line 25 in file doc/man7/OSSL_PROVIDER-legacy.pod

MAC ~/git/openssl$ 

On linux I get:

; ./util/find-doc-nits -n -l -e
Trying to read doc/man3/ISSUER_SIGN_TOOL_new.pod: No such file or directory
        exit 2
; 

Not sure what's going on with the latter but the former is the subject of this PR.

[mspncp]

Regarding the latter: try to reconfigure and run doc-nits again. The file ISSUER_SIGN_TOOL_new.pod was removed in d9321c0.

[slontis]

I am seeing these also.. not sure why others are not.

[mattcaswell]

LGTM. Running doc-nits for me on the current master also shows no problems. Strange.

[levitte]

Some of this has a better clean-up in #11610...

[richsalz]

The error "no items in =over" comes from Pod::Checker.pm, which is 5.18 on my mac and does not show up in my Linux box which is 5.26

[levitte]

According to the current Pod::Checker documentation, there is now a empty =over/=back block... I suspect someone pointed out that =over/=back is useful for indented paragraphs in general, not just item lists.

[richsalz]

Perhaps it can be useful, but the examples in the source, so far, don't seem that. Using "code" formatting addresses most of them, and fixing the other item gets the last one. It's about catching the common (error) case.

But yes, this is a matter of opinion, and if the project things I'm wrong, close this.

[levitte]

But yes, this is a matter of opinion, and if the project things I'm wrong, close this.

Er, what I just said was related to the development of perl and its modules, not to OpenSSL

[richsalz]

Fixup commit pushed, and another commit to undo the man7 over/back nits.

[openssl-machine]

24 hours has passed since 'approval: done' was set, but as this PR has been updated in that time the label 'approval: ready to merge' is not being automatically set. Please review the updates and set the label manually.

[richsalz]

This can be merged now.

[mspncp]

Merged to master as e847085, thanks!