summaryrefslogtreecommitdiffstats
path: root/doc/man7/bio.pod (follow)
Commit message (Collapse)AuthorAgeFilesLines
* POD: stop abusing commentRichard Levitte2019-10-111-1/+1
| | | | | | | | | | | | | | | | | | | OpenSSL uses some POD directives masquerading as 'comment' ('=for comment' etc). This is abusive and confusing. Instead, we use our own keyword. =for openssl whatever =begin openssl whatever =end openssl (we have never used the multiline form, but might start one day) Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> (Merged from https://github.com/openssl/openssl/pull/10048)
* Consistent formatting of flags with argsRich Salz2019-10-011-2/+2
| | | | | | | | | | | For documentation of all commands with "-flag arg" format them consistently: "B<-flag> I<arg>", except when arg is literal (for example "B<-inform> B<PEM>|B<DER>") Update find-doc-nits to complain if badly formatted strings are found. Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org> Reviewed-by: Richard Levitte <levitte@openssl.org> (Merged from https://github.com/openssl/openssl/pull/10022)
* Funtion name with variable part in doc/man7/ and doc/internal/man3/Richard Levitte2019-09-281-2/+2
| | | | | | | | | | | | | | | | | | | | We have a few pages where part of function names can be considered variable. There are no normative guidelines for such a case, but if we draw from the formatting convention of variable and argument names, we can draw the conclusion that this variable part should be italized, within already given conventions. In other words, we need to help the POD processor along in cases like these: SPARSE_ARRAY_OF(TYPE) ossl_sa_TYPE_num() These need explicit formatting: B<SPARSE_ARRAY_OF>(I<TYPE>) B<ossl_sa_I<TYPE>_num>() Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/10034)
* Make doc/man7/ and doc/internal/man3/ conform with man-pages(7)Richard Levitte2019-09-281-1/+1
| | | | | | | | | | | | | | | | | | | | It's all in the details, from man-pages(7): Formatting conventions for manual pages describing functions ... Variable names should, like argument names, be specified in italics. ... Formatting conventions (general) ... Special macros, which are usually in uppercase, are in bold. Exception: don't boldface NULL. ... Reviewed-by: Paul Dale <paul.dale@oracle.com> (Merged from https://github.com/openssl/openssl/pull/10034)
* Use EXAMPLES not EXAMPLE for section titleRich Salz2019-08-191-1/+1
| | | | | | | | And update find-doc-nits to complain if "=head1 EXAMPLE" is found. Reviewed-by: Richard Levitte <levitte@openssl.org> Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com> (Merged from https://github.com/openssl/openssl/pull/9602)
* Following the license change, modify the boilerplates in doc/man7/Richard Levitte2018-12-061-1/+1
| | | | | | | [skip ci] Reviewed-by: Matt Caswell <matt@openssl.org> (Merged from https://github.com/openssl/openssl/pull/7831)
* Fix minor typo in bio.podDaniel Bevenius2017-12-121-2/+2
| | | | | | Reviewed-by: Ben Kaduk <kaduk@mit.edu> Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/4917)
* Remove duplicate see also reference to BIO_s_mem.Pauli2017-06-221-2/+1
| | | | | Reviewed-by: Tim Hudson <tjh@openssl.org> (Merged from https://github.com/openssl/openssl/pull/3731)
* Fix referenses in section 7 manualsRichard Levitte2016-11-111-2/+2
| | | | Reviewed-by: Rich Salz <rsalz@openssl.org> (Merged from https://github.com/openssl/openssl/pull/1900)
* Document the new BIO functions introduced as part of the size_t workMatt Caswell2016-10-281-1/+1
| | | | Reviewed-by: Richard Levitte <levitte@openssl.org>
* Move manpages to man[1357] structure.Rich Salz2016-10-261-0/+88
Move manpages to manX directories Add Windows/VMS install fix from Richard Levitte Update README Fix typo's Remove some duplicates Reviewed-by: Richard Levitte <levitte@openssl.org>