Remove SSL_OP_TLS_BLOCK_PADDING_BUG
[openssl.git] / doc / crypto / BN_set_bit.pod
index bc581e701fb3da947fad6b19abf84e68dbc2d8a3..a32cca2cee6b111bc4dc89e4b64d5d2ef173d4c1 100644 (file)
@@ -3,7 +3,7 @@
 =head1 NAME
 
 BN_set_bit, BN_clear_bit, BN_is_bit_set, BN_mask_bits, BN_lshift,
-BN_lshift1, BN_rshift, BN_rshift1 - Bit operations on BIGNUMs
+BN_lshift1, BN_rshift, BN_rshift1 - bit operations on BIGNUMs
 
 =head1 SYNOPSIS
 
@@ -37,12 +37,14 @@ BN_mask_bits() truncates B<a> to an B<n> bit number
 shorter than B<n> bits.
 
 BN_lshift() shifts B<a> left by B<n> bits and places the result in
-B<r> (C<r=a*2^n>). BN_lshift1() shifts B<a> left by one and places
-the result in B<r> (C<r=2*a>).
+B<r> (C<r=a*2^n>). Note that B<n> must be non-negative. BN_lshift1() shifts
+B<a> left by one and places the result in B<r> (C<r=2*a>).
 
 BN_rshift() shifts B<a> right by B<n> bits and places the result in
-B<r> (C<r=a/2^n>). BN_rshift1() shifts B<a> right by one and places
-the result in B<r> (C<r=a/2>).
+B<r> (C<r=a/2^n>). Note that B<n> must be non-negative. BN_rshift1() shifts
+B<a> right by one and places the result in B<r> (C<r=a/2>).
+
+For the shift functions, B<r> and B<a> may be the same variable.
 
 =head1 RETURN VALUES