diff options
author | Richard Levitte <levitte@openssl.org> | 2020-07-15 08:33:08 +0200 |
---|---|---|
committer | Richard Levitte <levitte@openssl.org> | 2020-07-19 18:45:30 +0200 |
commit | d3cb5904f3ca62f23c95248f951477d322159bbb (patch) | |
tree | 7ce57fe9b75a44a439179c9022d1baef5353ffc0 /doc/man3/SRP_create_verifier.pod | |
parent | Fix typo for SSL_get_peer_certificate() (diff) | |
download | openssl-d3cb5904f3ca62f23c95248f951477d322159bbb.tar.xz openssl-d3cb5904f3ca62f23c95248f951477d322159bbb.zip |
util/find-doc-nits: read full declarations as one line in name_synopsis()
name_synopsis was reading physical SYNOPSIS lines. This changes it to
consider a declaration at a time, so we treat a C declaration that's
been broken up in several lines as one.
This makes it mandatory to end all C declarations in the SYNOPSIS with
a semicolon. Those can be detected in two ways:
1. Parsing an individual .pod file outputs this error:
doc/man3/SOMETHING.pod:1: Can't parse rest of synopsis:
int SOMETHING_status(SOMETHING *s)
int SOMETHING_start(SOMETHING *s)
(declarations not ending with a semicolon (;)?)
2. Errors like this:
doc/man3/SOMETHING.pod:1: SOMETHING_status missing from SYNOPSIS
doc/man3/SOMETHING.pod:1: SOMETHING_start missing from SYNOPSIS
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
Reviewed-by: Shane Lontis <shane.lontis@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/12452)
Diffstat (limited to 'doc/man3/SRP_create_verifier.pod')
0 files changed, 0 insertions, 0 deletions