typo in SSL_get_peer_cert_chain docs

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

diff --git a/doc/crypto/BN_zero.pod b/doc/crypto/BN_zero.pod
index 7061fccd8345d1262e2bdc4f092e7e158a219180..b555ec39885999ba61f36e0853d984a89beaa09d 100644 (file)
--- a/doc/crypto/BN_zero.pod
+++ b/doc/crypto/BN_zero.pod
@@ -2,7 +2,8 @@
 
 =head1 NAME
 
-BN_zero, BN_one, BN_set_word, BN_get_word - BIGNUM assignment operations
+BN_zero, BN_one, BN_value_one, BN_set_word, BN_get_word - BIGNUM assignment
+operations
 
 =head1 SYNOPSIS
 
@@ -11,7 +12,7 @@ BN_zero, BN_one, BN_set_word, BN_get_word - BIGNUM assignment operations
  int BN_zero(BIGNUM *a);
  int BN_one(BIGNUM *a);
 
- BIGNUM *BN_value_one(void);
+ const BIGNUM *BN_value_one(void);
 
  int BN_set_word(BIGNUM *a, unsigned long w);
  unsigned long BN_get_word(BIGNUM *a);
@@ -39,9 +40,12 @@ BN_value_one() returns the constant.
 
 Someone might change the constant.
 
+If a B<BIGNUM> is equal to 0xffffffffL it can be represented as an
+unsigned long but this value is also returned on error.
+
 =head1 SEE ALSO
 
-bn(3), BN_bn2bin(3)
+L<bn(3)|bn(3)>, L<BN_bn2bin(3)|BN_bn2bin(3)>
 
 =head1 HISTORY
 
@@ -49,4 +53,7 @@ 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.
 
+BN_value_one() was changed to return a true const BIGNUM * in OpenSSL
+0.9.7.
+
 =cut