RT3462: Document actions when data==NULL

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

diff --git a/doc/crypto/BN_bn2bin.pod b/doc/crypto/BN_bn2bin.pod
index 5d26765dd96e43e7568514641f3a795bc83e0d13..a4b17ca60a891ec265a92ca6d7f0552521fe659b 100644 (file)
--- a/doc/crypto/BN_bn2bin.pod
+++ b/doc/crypto/BN_bn2bin.pod
@@ -3,7 +3,7 @@
 =head1 NAME
 
 BN_bn2bin, BN_bin2bn, BN_bn2hex, BN_bn2dec, BN_hex2bn, BN_dec2bn,
-BN_print_fp, BN_print, BN_bn2mpi, BN_mpi2bn - Format conversions
+BN_print, BN_print_fp, BN_bn2mpi, BN_mpi2bn - format conversions
 
 =head1 SYNOPSIS
 
@@ -17,8 +17,8 @@ BN_print_fp, BN_print, BN_bn2mpi, BN_mpi2bn - Format conversions
  int BN_hex2bn(BIGNUM **a, const char *str);
  int BN_dec2bn(BIGNUM **a, const char *str);
 
- int BN_print_fp(FILE *fp, BIGNUM *a);
  int BN_print(BIO *fp, const BIGNUM *a);
+ int BN_print_fp(FILE *fp, const BIGNUM *a);
 
  int BN_bn2mpi(const BIGNUM *a, unsigned char *to);
  BIGNUM *BN_mpi2bn(unsigned char *s, int len, BIGNUM *ret);
@@ -36,7 +36,7 @@ NULL, a new B<BIGNUM> is created.
 BN_bn2hex() and BN_bn2dec() return printable strings containing the
 hexadecimal and decimal encoding of B<a> respectively. For negative
 numbers, the string is prefaced with a leading '-'. The string must be
-Free()d later.
+freed later using OPENSSL_free().
 
 BN_hex2bn() converts the string B<str> containing a hexadecimal number
 to a B<BIGNUM> and stores it in **B<bn>. If *B<bn> is NULL, a new
@@ -44,12 +44,12 @@ B<BIGNUM> is created. If B<bn> is NULL, it only computes the number's
 length in hexadecimal digits. If the string starts with '-', the
 number is negative. BN_dec2bn() is the same using the decimal system.
 
-BN_print_fp() and BN_print() write the hexadecimal encoding of B<a>,
-with a leading '-' for negative numbers, to the B<FILE> or B<BIO>
+BN_print() and BN_print_fp() write the hexadecimal encoding of B<a>,
+with a leading '-' for negative numbers, to the B<BIO> or B<FILE>
 B<fp>.
 
 BN_bn2mpi() and BN_mpi2bn() convert B<BIGNUM>s from and to a format
-that consists of the number's length in bytes represented as a 3-byte
+that consists of the number's length in bytes represented as a 4-byte
 big-endian number, and the number itself in big-endian format, where
 the most significant bit signals a negative number (the representation
 of numbers with the MSB set is prefixed with null byte).
@@ -59,7 +59,7 @@ must be large enough to hold the result. The size can be determined by
 calling BN_bn2mpi(B<a>, NULL).
 
 BN_mpi2bn() converts the B<len> bytes long representation at B<s> to
-a B<BIGNUM> and stores it ar B<ret>, or in a newly allocated B<BIGNUM>
+a B<BIGNUM> and stores it at B<ret>, or in a newly allocated B<BIGNUM>
 if B<ret> is NULL.
 
 =head1 RETURN VALUES
@@ -76,11 +76,13 @@ BN_print_fp() and BN_print() return 1 on success, 0 on write errors.
 BN_bn2mpi() returns the length of the representation. BN_mpi2bn()
 returns the B<BIGNUM>, and NULL on error.
 
-The error codes can be obtained by ERR_get_error(3).
+The error codes can be obtained by L<ERR_get_error(3)|ERR_get_error(3)>.
 
 =head1 SEE ALSO
 
-bn(3), err(3), BN_zero(3), ASN1_INTEGER_to_BN(3), BN_num_bytes(3)
+L<bn(3)|bn(3)>, L<ERR_get_error(3)|ERR_get_error(3)>, L<BN_zero(3)|BN_zero(3)>,
+L<ASN1_INTEGER_to_BN(3)|ASN1_INTEGER_to_BN(3)>,
+L<BN_num_bytes(3)|BN_num_bytes(3)>
 
 =head1 HISTORY