I've investigated lacks of documentation in the current OpenSSL
snapshot.
Method of investigation is quite simple
1. Run util/extract-names.pl on the all pod files in the doc/crypto and
doc/ssl and produce sorted list of all function names referenced in the
NAME sections.
2. Take lists of exported symbols used in Windows DLL building
(utils/libeay.num and utils/ssl.num)
3. Use comm(1) to compare these lists
Results are quite discouraging.
library| exported | documened | other things documented |
| | | (macros, intro pages) |
-------+----------+-----------+-------------------------+
ssl | 258 | 159 | 52 |
crypto | 4012 | 683 | 159 |
-------+----------+-----------+-------------------------+
Of course, there are functions which are really documented, just non
mentioned in the NAME section of appropriate man page (which means
that symlink with such name is not installed, and user would be unable
to find documentation for this function)
There might be some semi-internal functions or exported variable, which
do not deserve its own manual pages.
But there are big omissions.
For example entire family of
X509_STORE functions, OCSP api, TS API are nont documetned.
I'm attaching here couple of POD files for EVP_PKEY_METHOD and
EVP_PKEY_ASN1_METHOD API, which we have written while developing ccgost
engine. Of course it would cover only 19 of more than 3 thousands undocumented
names, and not most widely used APIs.
We also have some documentation about X509_STORE and OCSP API,
published in the PDF format on
http://www.cryptocom.ru/OpenSource/OpenSSL_rus.html, but it
has to be translated from Russian and converted into POD format.
______________________________________________________________________
OpenSSL Project http://www.openssl.org
Development Mailing List [email protected]
Automated List Manager [email protected]
