PKCS5_PBKDF2_HMAC documentation submitted by Jeffrey Walton

[openssl.git] / doc / ssl / SSL_COMP_add_compression_method.pod

diff --git a/doc/ssl/SSL_COMP_add_compression_method.pod b/doc/ssl/SSL_COMP_add_compression_method.pod
index 9e970044a6b063017db83e150069dbc24879b1ba..f4d191c9b6bdc57c81de9388b8e8f831f760a725 100644 (file)
--- a/doc/ssl/SSL_COMP_add_compression_method.pod
+++ b/doc/ssl/SSL_COMP_add_compression_method.pod
@@ -41,17 +41,23 @@ of compression methods supported on a per connection basis.
 The OpenSSL library has the compression methods B<COMP_rle()> and (when
 especially enabled during compilation) B<COMP_zlib()> 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:
 
 =over 4
 
-=item 1
+=item Z<>0
 
 The operation succeeded.
 
-=item 0
+=item Z<>1
 
 The operation failed. Check the error queue to find out the reason.