From 582231c37d04c012ec9814727e712f6f4dd31246 Mon Sep 17 00:00:00 2001
From: Tom Henderson <tomh@tomh.org>
Date: Fri, 10 Jun 2016 14:50:07 -0700
Subject: [PATCH] core:  Improve RngSeed and RngRun documentation

---
 src/core/model/rng-seed-manager.cc | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/src/core/model/rng-seed-manager.cc b/src/core/model/rng-seed-manager.cc
index b35c20e37..49c06dfb0 100644
--- a/src/core/model/rng-seed-manager.cc
+++ b/src/core/model/rng-seed-manager.cc
@@ -42,7 +42,10 @@ NS_LOG_COMPONENT_DEFINE ("RngSeedManager");
 static uint64_t g_nextStreamIndex = 0;
 /**
  * \relates RngSeedManager
- * The random number generator seed number global value.
+ * The random number generator seed number global value.  This is used to
+ * generate an new master PRNG sequence.  It is typically not modified
+ * by user programs; the variable RngRun is preferred for independent
+ * replications.
  *
  * This is accessible as "--RngSeed" from CommandLine.
  */
@@ -52,12 +55,15 @@ static ns3::GlobalValue g_rngSeed ("RngSeed",
                                    ns3::MakeIntegerChecker<uint32_t> ());
 /**
  * \relates RngSeedManager
- * The random number generator run number global value.
+ * The random number generator substream index.  This is used to generate
+ * new PRNG sequences for all streams (random variables) in such a manner
+ * that the streams remain uncorrelated.  Incrementing this variable can
+ * be used for independent replications.
  *
  * This is accessible as "--RngRun" from CommandLine.
  */
 static ns3::GlobalValue g_rngRun ("RngRun", 
-                                  "The run number used to modify the global seed",
+                                  "The substream index used for all streams",
                                   ns3::IntegerValue (1),
                                   ns3::MakeIntegerChecker<int64_t> ());