Allow for higher granularity of entropy estimates by using 'double'

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

diff --git a/doc/crypto/RAND_add.pod b/doc/crypto/RAND_add.pod
index 10be71a8948a064c17c894e58b355a976ea9da86..927c59d4c3a582b8af08068f8b11da06169b1763 100644 (file)
--- a/doc/crypto/RAND_add.pod
+++ b/doc/crypto/RAND_add.pod
@@ -10,7 +10,7 @@ RAND_add, RAND_seed, RAND_screen - Add entropy to the PRNG
 
  void RAND_seed(const void *buf, int num);
 
- void RAND_add(const void *buf, int num, int entropy);
+ void RAND_add(const void *buf, int num, double entropy);
 
  void RAND_screen(void);
 
@@ -22,9 +22,9 @@ increases the uncertainty about the state and makes the PRNG output
 less predictable. Suitable input comes from user interaction (random
 key presses, mouse movements) and certain hardware events. The
 B<entropy> argument is (the lower bound of) an estimate of how much
-randomness is contained in B<buf>. Details about sources of randomness
-and how to estimate their entropy can be found in the literature,
-e.g. RFC 1750.
+randomness is contained in B<buf>, measured in bytes. Details about
+sources of randomness and how to estimate their entropy can be found
+in the literature, e.g. RFC 1750.
 
 RAND_add() may be called with sensitive data such as user entered
 passwords. The seed values cannot be recovered from the PRNG output.