aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPau Espin Pedrol <pespin@sysmocom.de>2020-05-25 13:26:41 +0200
committerPau Espin Pedrol <pespin@sysmocom.de>2020-05-25 13:33:50 +0200
commit66ef9457cba0c2b311a7f57a5dc2a4b68a00e0cb (patch)
tree38fed3fce6fa20d2c79145138734a252d2983401 /doc
parent3a0dea682e73c605c2a4d45f0e7a8a39fba3bb6b (diff)
config: suites_dir and scenarios_dir are now a list of paths
This allows inheriting suites or scenarios from eg. sysmocom/ dir, while still allowing to apply new suites and scenarios on top. Change-Id: Icecdae32d400a6b6da2ebf167c1c795f7a74ae96
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/2g_osmocom/main.conf4
-rw-r--r--doc/examples/4g_srsLTE/main.conf4
-rw-r--r--doc/manuals/chapters/config.adoc14
3 files changed, 14 insertions, 8 deletions
diff --git a/doc/examples/2g_osmocom/main.conf b/doc/examples/2g_osmocom/main.conf
index b810519..699c518 100644
--- a/doc/examples/2g_osmocom/main.conf
+++ b/doc/examples/2g_osmocom/main.conf
@@ -1,6 +1,6 @@
state_dir: '/var/tmp/osmo-gsm-tester/state'
-suites_dir: './suites'
-scenarios_dir: './scenarios'
+suites_dir: ['./suites']
+scenarios_dir: ['./scenarios']
default_suites_conf_path: './default-suites.conf'
defaults_conf_path: './defaults.conf'
resource_conf_path: './resources.conf'
diff --git a/doc/examples/4g_srsLTE/main.conf b/doc/examples/4g_srsLTE/main.conf
index b810519..699c518 100644
--- a/doc/examples/4g_srsLTE/main.conf
+++ b/doc/examples/4g_srsLTE/main.conf
@@ -1,6 +1,6 @@
state_dir: '/var/tmp/osmo-gsm-tester/state'
-suites_dir: './suites'
-scenarios_dir: './scenarios'
+suites_dir: ['./suites']
+scenarios_dir: ['./scenarios']
default_suites_conf_path: './default-suites.conf'
defaults_conf_path: './defaults.conf'
resource_conf_path: './resources.conf'
diff --git a/doc/manuals/chapters/config.adoc b/doc/manuals/chapters/config.adoc
index 17cf825..18ff55d 100644
--- a/doc/manuals/chapters/config.adoc
+++ b/doc/manuals/chapters/config.adoc
@@ -26,13 +26,19 @@ then overrides the above locations.
{app-name} expects to find the following configuration settings in 'main.conf':
- 'state_dir': Path to <<state_dir,state_dir>> directory
-- 'suites_dir': Path to <<suites_dir,suites_dir>> directory
- 'trial_dir': Path to <<trials,trial>> directory to test against (overridden by cmdline argument)
-- 'scenarios_dir': Path to <<scenarios_dir,scenarios_dir>> directory (optional)
+- 'suites_dir': List of paths to <<suites_dir,suites_dir>> directories.
+- 'scenarios_dir': List of paths to <<scenarios_dir,scenarios_dir>> directories (optional)
- 'default_suites_conf_path': Path to <<default_suites_conf,default-suites.conf>> file (optional)
- 'defaults_conf_path': Path to <<defaults_conf,defaults.conf>> file (optional)
- 'resource_conf_path': Path to <<resource_conf,resources.conf>> file (optional)
+Configuration settings holding a list of paths, such as 'suites_dir' or
+'scenarios_dir', are used to look up for paths in regular list of order, meaning
+first paths in list take preference over last ones. As a result, if a suite
+named 'A' is found in several paths, the one on the first path in the list will
+be used.
+
These are described in detail in the following sections. If no value is provided
for a given setting, sane default paths are used: For 'state_dir',
'/var/tmp/osmo-gsm-tester/state/' is used. All other files and directories are
@@ -45,8 +51,8 @@ of the {app-name} process parsing it.
.Sample main.conf file:
----
state_dir: '/var/tmp/osmo-gsm-tester/state'
-suites_dir: '/usr/local/src/osmo-gsm-tester/suites'
-scenarios_dir: './scenarios'
+suites_dir: [ '/usr/local/src/osmo-gsm-tester/suites' ]
+scenarios_dir: [ './scenarios' ]
trial_dir: './trial'
default_suites_conf_path: './default-suites.conf'
defaults_conf_path: './defaults.conf'