random: doc: warn about global PRNG state

2017-03-07 12:15:11 +01:00 · 2017-03-07 12:15:11 +01:00 · 83a69c0cb2
commit 83a69c0cb2
parent 302d5d35e9
1 changed files with 4 additions and 0 deletions
--- a/sys/include/random.h
+++ b/sys/include/random.h
@ -39,6 +39,10 @@ extern "C" {
 /**
 * @brief initializes PRNG with a seed
 *
+ * @warning Currently, the random module uses a global state
+ * => multiple calls to @ref random_init will reset the existing
+ * state of the PRNG.
+ *
 * @param s seed for the PRNG
 */
 void random_init(uint32_t s);