[API-NEXT,1/4] api: random: document usage of use_entropy parameter

Message ID 1477399744-16516-1-git-send-email-bill.fischofer@linaro.org
State New
Headers show

Commit Message

Bill Fischofer Oct. 25, 2016, 12:49 p.m.
Address bug https://bugs.linaro.org/show_bug.cgi?id=2557 by adding
documentation regarding handling of the use_entropy parameter of
odp_random_data()

Signed-off-by: Bill Fischofer <bill.fischofer@linaro.org>

---
 include/odp/api/spec/random.h | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

-- 
2.7.4

Patch

diff --git a/include/odp/api/spec/random.h b/include/odp/api/spec/random.h
index 00fa15b..8b9d449 100644
--- a/include/odp/api/spec/random.h
+++ b/include/odp/api/spec/random.h
@@ -28,9 +28,10 @@  extern "C" {
  *
  * @param[out]    buf   Output buffer
  * @param         size  Size of output buffer
- * @param use_entropy   Use entropy
- *
- * @todo Define the implication of the use_entropy parameter
+ * @param use_entropy   Use entropy. When true indicates that true random
+ *                      data is requested. Otherwise this routine returns
+ *                      pseudo-random data. Request is expected to fail if
+ *                      true random data is requested but cannot be supplied.
  *
  * @return Number of bytes written
  * @retval <0 on failure