Merge pull request #1513 from stevenengler/bootstrap_time_docs

stevenengler · web-flow · commit e60738d88860 · 2021-07-14T11:05:45.000-04:00
Added documentation for the 'bootstrap_end_time' option
diff --git a/docs/shadow_config_spec.md b/docs/shadow_config_spec.md
@@ -97,6 +97,14 @@ General experiment settings.
 Default: "0 sec"  
 Type: String OR Integer
 
+The simulated time that ends Shadow's high network bandwidth/reliability
+bootstrap period.
+
+If the bootstrap end time is greater than 0, Shadow uses a simulation
+bootstrapping period where hosts have unrestricted network bandwidth and no
+packet drop. This can help to bootstrap large networks quickly when the network
+hosts have low network bandwidth or low network reliability.
+
 #### `general.data_directory`
 
 Default: "shadow.data"  
diff --git a/src/main/core/support/configuration.rs b/src/main/core/support/configuration.rs
@@ -146,6 +146,7 @@ pub struct GeneralOptions {
     #[serde(default = "default_some_nz_1")]
     parallelism: Option<NonZeroU32>,
 
+    /// The simulated time that ends Shadow's high network bandwidth/reliability bootstrap period
     #[clap(long, value_name = "seconds")]
     #[clap(about = GENERAL_HELP.get("bootstrap_end_time").unwrap())]
     #[serde(default = "default_some_time_0")]
