v0.2.47..v0.2.48 changeset optimize network conf.asciidoc
Garret Voltz edited this page Sep 27, 2019
·
1 revision
diff --git a/docs/commands/optimize-network-conf.asciidoc b/docs/commands/optimize-network-conf.asciidoc
index c35d389..b3841d6 100644
--- a/docs/commands/optimize-network-conf.asciidoc
+++ b/docs/commands/optimize-network-conf.asciidoc
@@ -3,18 +3,18 @@
=== Description
-The +optimize-network-conf+ command runs a series of network road conflation tests to determine the best performing
+The +optimize-network-conf+ command runs a series of network road conflation tests to determine the best performing
values for a user specified group of configuration options.
-* +testsDir+ - the root directory containing the tests to run; the directory must contain Hootenanny conflate case tests,
+* +testsDir+ - the root directory containing the tests to run; the directory must contain Hootenanny conflate case tests,
release regression tests, or PERTY regression tests
* +testType+ - the type of test to run; valid values are 'case', 'release', or 'perty'
-* +testSettings+ - a JSON file containing configuration with min/max test values; see
+* +testSettings+ - a JSON file containing configuration with min/max test values; see
'test-files/cmd/slow/OptimizeConflateSettingsCmd/testSettings.json' for an example
* +numIterations+ - the number of test iterations to run
* +output+ - file location to write the text summary of the optimization to
* +verbose+ - if true; logs extra detail during the optimization run
-* +customConfig+ - file location of a custom Hootenanny configuration file containing static configuration options to apply
+* +customConfig+ - file location of a custom Hootenanny configuration file containing static configuration options to apply
to the tests (configuration values remain constant for the duration of the test run (optional)
=== Usage