Backwards-compatibility subject to OPENSSL_API_COMPAT

[openssl.git] / doc / crypto / BN_zero.pod

diff --git a/doc/crypto/BN_zero.pod b/doc/crypto/BN_zero.pod
index e0f653f81e324110139523996e0dba22cea28e67..5334aaa41a002b0f62499650dac80faf4f8d58fe 100644 (file)
--- a/doc/crypto/BN_zero.pod
+++ b/doc/crypto/BN_zero.pod
@@ -9,7 +9,7 @@ operations
 
  #include <openssl/bn.h>
 
- int BN_zero(BIGNUM *a);
+ void BN_zero(BIGNUM *a);
  int BN_one(BIGNUM *a);
 
  const BIGNUM *BN_value_one(void);
@@ -17,6 +17,12 @@ operations
  int BN_set_word(BIGNUM *a, unsigned long w);
  unsigned long BN_get_word(BIGNUM *a);
 
+Deprecated:
+
+ #if OPENSSL_API_COMPAT < 0x00908000L
+ int BN_zero(BIGNUM *a);
+ #endif
+
 =head1 DESCRIPTION
 
 BN_zero(), BN_one() and BN_set_word() set B<a> to the values 0, 1 and
@@ -33,8 +39,10 @@ long.
 BN_get_word() returns the value B<a>, and 0xffffffffL if B<a> cannot
 be represented as an unsigned long.
 
-BN_zero(), BN_one() and BN_set_word() return 1 on success, 0 otherwise.
+BN_one(), BN_set_word() and the deprecated version of BN_zero()
+return 1 on success, 0 otherwise.
 BN_value_one() returns the constant.
+The preferred version of BN_zer() never fails and returns no value.
 
 =head1 BUGS