upd: openssl to 1.1.0

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

diff --git a/lib/openssl/doc/crypto/BN_zero.pod b/lib/openssl/doc/crypto/BN_zero.pod
index b555ec39885999ba61f36e0853d984a89beaa09d..fadc21b7fde29f036975f47874669609b28eed15 100644 (file)
--- a/lib/openssl/doc/crypto/BN_zero.pod
+++ b/lib/openssl/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_zero() never fails and returns no value.
 
 =head1 BUGS
 
@@ -45,15 +53,15 @@ unsigned long but this value is also returned on error.
 
 =head1 SEE ALSO
 
-L<bn(3)|bn(3)>, L<BN_bn2bin(3)|BN_bn2bin(3)>
+L<bn(3)>, L<BN_bn2bin(3)>
 
-=head1 HISTORY
+=head1 COPYRIGHT
 
-BN_zero(), BN_one() and BN_set_word() are available in all versions of
-SSLeay and OpenSSL. BN_value_one() and BN_get_word() were added in
-SSLeay 0.8.
+Copyright 2000-2016 The OpenSSL Project Authors. All Rights Reserved.
 
-BN_value_one() was changed to return a true const BIGNUM * in OpenSSL
-0.9.7.
+Licensed under the OpenSSL license (the "License").  You may not use
+this file except in compliance with the License.  You can obtain a copy
+in the file LICENSE in the source distribution or at
+L<https://www.openssl.org/source/license.html>.
 
 =cut