diff options
| author | Rich Salz <rsalz@openssl.org> | 2017-09-02 09:35:50 -0400 |
|---|---|---|
| committer | Rich Salz <rsalz@openssl.org> | 2017-09-02 09:35:50 -0400 |
| commit | b3696a55a5ed80717723a589020af30adb5db606 (patch) | |
| tree | 524f6b5dcd67242dedcf321dfcf55d9cd6dc39f6 /doc/man3/SSL_COMP_add_compression_method.pod | |
| parent | 607f4d564f9540cda6cf5b127f2414625a11741a (diff) | |
| download | openssl-b3696a55a5ed80717723a589020af30adb5db606.zip openssl-b3696a55a5ed80717723a589020af30adb5db606.tar.gz openssl-b3696a55a5ed80717723a589020af30adb5db606.tar.bz2 | |
Less documentation for deprecated API
Deprecated functions are still documented.
Put HISTORY after SEE ALSO; add HISTORY to BN_zero
Reviewed-by: Paul Dale <paul.dale@oracle.com>
(Merged from https://github.com/openssl/openssl/pull/3746)
Diffstat (limited to 'doc/man3/SSL_COMP_add_compression_method.pod')
| -rw-r--r-- | doc/man3/SSL_COMP_add_compression_method.pod | 17 |
1 files changed, 4 insertions, 13 deletions
diff --git a/doc/man3/SSL_COMP_add_compression_method.pod b/doc/man3/SSL_COMP_add_compression_method.pod index c3d402b..1dc8eb1 100644 --- a/doc/man3/SSL_COMP_add_compression_method.pod +++ b/doc/man3/SSL_COMP_add_compression_method.pod @@ -35,12 +35,8 @@ SSL_COMP_get0_name() returns the name of the compression method B<comp>. SSL_COMP_get_id() returns the id of the compression method B<comp>. -In versions of OpenSSL prior to 1.1.0 SSL_COMP_free_compression_methods() freed -the internal table of compression methods that were built internally, and -possibly augmented by adding SSL_COMP_add_compression_method(). However this is -now unnecessary from version 1.1.0. No explicit initialisation or -de-initialisation is necessary. See L<OPENSSL_init_crypto(3)> and -L<OPENSSL_init_ssl(3)>. From OpenSSL 1.1.0 calling this function does nothing. +SSL_COMP_free_compression_methods() releases any resources acquired to +maintain the internal table of compression methods. =head1 NOTES @@ -66,12 +62,6 @@ of compression methods supported on a per connection basis. If enabled during compilation, the OpenSSL library will have the COMP_zlib() compression method available. -=head1 WARNINGS - -Once the identities of the compression methods for the TLS protocol have -been standardized, the compression API will most likely be changed. Using -it in the current state is not recommended. - =head1 RETURN VALUES SSL_COMP_add_compression_method() may return the following values: @@ -101,7 +91,8 @@ L<ssl(7)> =head1 HISTORY -SSL_COMP_free_compression_methods() was deprecated in OpenSSL 1.1.0. +SSL_COMP_free_compression_methods() was deprecated in OpenSSL 1.1.0; +do not use it. SSL_COMP_get0_name() and SSL_comp_get_id() were added in OpenSSL 1.1.0d. =head1 COPYRIGHT |