diff options
| author | Richard Levitte <levitte@openssl.org> | 2019-09-27 13:26:22 +0200 |
|---|---|---|
| committer | Richard Levitte <levitte@openssl.org> | 2019-09-28 06:33:16 +0200 |
| commit | dfabee82be84f8ac80eede5d552058fbcdf4928d (patch) | |
| tree | b4c59fbe849d95e57cad84078f88dc97ec6d549c /doc/man7/crypto.pod | |
| parent | a39bc4404baa4e065d01efe829a1f26eba737049 (diff) | |
Make doc/man7/ and doc/internal/man3/ conform with man-pages(7)
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)
Diffstat (limited to 'doc/man7/crypto.pod')
| -rw-r--r-- | doc/man7/crypto.pod | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/man7/crypto.pod b/doc/man7/crypto.pod index 0e8008b332..aa6b6405ba 100644 --- a/doc/man7/crypto.pod +++ b/doc/man7/crypto.pod @@ -10,13 +10,13 @@ See the individual manual pages for details. =head1 DESCRIPTION -The OpenSSL B<crypto> library implements a wide range of cryptographic -algorithms used in various Internet standards. The services provided -by this library are used by the OpenSSL implementations of SSL, TLS +The OpenSSL crypto library (C<libcrypto>) implements a wide range of +cryptographic algorithms used in various Internet standards. The services +provided by this library are used by the OpenSSL implementations of SSL, TLS and S/MIME, and they have also been used to implement SSH, OpenPGP, and other cryptographic standards. -B<libcrypto> consists of a number of sub-libraries that implement the +C<libcrypto> consists of a number of sub-libraries that implement the individual algorithms. The functionality includes symmetric encryption, public key @@ -34,11 +34,11 @@ B<0> and B<1>. For example the functions: The B<0> version uses the supplied structure pointer directly in the parent and it will be freed up when the parent is freed. -In the above example B<crl> would be freed but B<rev> would not. +In the above example I<crl> would be freed but I<rev> would not. The B<1> function uses a copy of the supplied structure pointer (or in some cases increases its link count) in the parent and -so both (B<x> and B<obj> above) should be freed up. +so both (I<x> and I<obj> above) should be freed up. =head1 RETURN VALUES |