aboutsummaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorPau Espin Pedrol <pespin@sysmocom.de>2020-05-07 18:15:53 +0200
committerPau Espin Pedrol <pespin@sysmocom.de>2020-05-07 19:09:23 +0200
commit06c82aee5ce007a2c5ba12cd59d3db158c593ee8 (patch)
treee447d6660ac65864f4792a559956641e32f5f03e /doc
parent18ff1e6e25ed3d1cbb60474149daa9848027f0d4 (diff)
Deprecate envvar OSMO_GSM_TESTER_CONF and remove other ones
Environment variable OSMO_GSM_TESTER_CONF is marked as deprecated and an error is logged each time it's used. Same feature is available through "-c" command line parameters, so having the envvar only makes things more complex for no good reason. It cannot yet be completely dropped since some environemnt still make use of it. Give some time to users to adapt their setups. Other environment variables setting some config apths can be dropped since they are not being really used in any setup. Change-Id: I7eb69f870d0dcb5906d45ae067d6bed1aabf5862
Diffstat (limited to 'doc')
-rw-r--r--doc/examples/2g_osmocom/README.md22
-rw-r--r--doc/examples/2g_osmocom/README.txt30
-rw-r--r--doc/examples/4g_srsLTE/README.md22
-rw-r--r--doc/examples/4g_srsLTE/README.txt30
-rw-r--r--doc/manuals/chapters/config.adoc5
5 files changed, 47 insertions, 62 deletions
diff --git a/doc/examples/2g_osmocom/README.md b/doc/examples/2g_osmocom/README.md
new file mode 100644
index 0000000..47b0737
--- /dev/null
+++ b/doc/examples/2g_osmocom/README.md
@@ -0,0 +1,22 @@
+This a sample 2G test suite configured and ready to use.
+The only thing missing is a trial dir containing binaries.
+
+You can point osmo-gsm-tester.py at this config using the '-c $DIR' command line
+argument, where DIR is the directory path where this README file resides.
+
+If you have your trial with binary tar archives in ~/my_trial
+you can run the suite for example like this:
+```
+osmo-gsm-tester.py -c $DIR ~/my_trial
+```
+
+Alternatively you can setup this example as default config for your user by
+doing something like:
+```
+mkdir -p ~/.config
+ln -s "$DIR" ~/.config/osmo-gsm-tester
+```
+
+A ./state dir will be created to store the current osmo-gsm-tester state. If
+you prefer not to write to $DIR, set up an own configuration pointing at a
+different path (see paths.conf: 'state_dir').
diff --git a/doc/examples/2g_osmocom/README.txt b/doc/examples/2g_osmocom/README.txt
deleted file mode 100644
index 4c869ca..0000000
--- a/doc/examples/2g_osmocom/README.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-This a sample gsm test suite configured and ready to use.
-The only thing missing is a trial dir containing binaries.
-
-You can point osmo-gsm-tester.py at this config using the OSMO_GSM_TESTER_CONF
-environment variable:
-
- export OSMO_GSM_TESTER_CONF="$PWD"
-
-When there is no OSMO_GSM_TESTER_CONF set, osmo-gsm-tester will instead look
-for conf files in several locations like ~/.config/osmo-gsm-tester,
-/usr/local/etc/osmo-gsm-tester, /etc/osmo-gsm-tester.
-
-If you have your trial with binary tar archives in ~/my_trial
-you can run the suite for example like this:
-
- osmo-gsm-tester.py ~/my_trial
-
-Specifically, from this dir:
-
- OSMO_GSM_TESTER_CONF="$PWD" ../src/osmo-gsm-tester.py ~/my_trial
-
-Alternatively you can setup this example as permanent config using something
-like:
-
- mkdir -p ~/.config
- ln -s "$PWD" ~/.config/osmo-gsm-tester
-
-A ./state dir will be created to store the current osmo-gsm-tester state. If
-you prefer not to write to $PWD, set up an own configuration pointing at a
-different path (see paths.conf: 'state_dir').
diff --git a/doc/examples/4g_srsLTE/README.md b/doc/examples/4g_srsLTE/README.md
new file mode 100644
index 0000000..b577035
--- /dev/null
+++ b/doc/examples/4g_srsLTE/README.md
@@ -0,0 +1,22 @@
+This a sample 4G test suite configured and ready to use srsLTE stack.
+The only thing missing is a trial dir containing binaries.
+
+You can point osmo-gsm-tester.py at this config using the '-c $DIR' command line
+argument, where DIR is the directory path where this README file resides.
+
+If you have your trial with binary tar archives in ~/my_trial
+you can run the suite for example like this:
+```
+osmo-gsm-tester.py -c $DIR ~/my_trial
+```
+
+Alternatively you can setup this example as default config for your user by
+doing something like:
+```
+mkdir -p ~/.config
+ln -s "$DIR" ~/.config/osmo-gsm-tester
+```
+
+A ./state dir will be created to store the current osmo-gsm-tester state. If
+you prefer not to write to $DIR, set up an own configuration pointing at a
+different path (see paths.conf: 'state_dir').
diff --git a/doc/examples/4g_srsLTE/README.txt b/doc/examples/4g_srsLTE/README.txt
deleted file mode 100644
index 6840801..0000000
--- a/doc/examples/4g_srsLTE/README.txt
+++ /dev/null
@@ -1,30 +0,0 @@
-This a sample 4G test suite configured and ready to use srsLTE stack.
-The only thing missing is a trial dir containing binaries.
-
-You can point osmo-gsm-tester.py at this config using the OSMO_GSM_TESTER_CONF
-environment variable:
-
- export OSMO_GSM_TESTER_CONF="$PWD"
-
-When there is no OSMO_GSM_TESTER_CONF set, osmo-gsm-tester will instead look
-for conf files in several locations like ~/.config/osmo-gsm-tester,
-/usr/local/etc/osmo-gsm-tester, /etc/osmo-gsm-tester.
-
-If you have your trial with binary tar archives in ~/my_trial
-you can run the suite for example like this:
-
- osmo-gsm-tester.py ~/my_trial
-
-Specifically, from this dir:
-
- OSMO_GSM_TESTER_CONF="$PWD" ../../src/osmo-gsm-tester.py ~/my_trial
-
-Alternatively you can setup this example as permanent config using something
-like:
-
- mkdir -p ~/.config
- ln -s "$PWD" ~/.config/osmo-gsm-tester
-
-A ./state dir will be created to store the current osmo-gsm-tester state. If
-you prefer not to write to $PWD, set up an own configuration pointing at a
-different path (see paths.conf: 'state_dir').
diff --git a/doc/manuals/chapters/config.adoc b/doc/manuals/chapters/config.adoc
index 483fd8c..3f4bde1 100644
--- a/doc/manuals/chapters/config.adoc
+++ b/doc/manuals/chapters/config.adoc
@@ -185,12 +185,13 @@ This schema is used by <<suite_conf,suite.conf>> and <<scenario_conf,scenario.co
The osmo-gsm-tester looks for configuration files in various standard
directories in this order:
+- '.' (Current Working Directory)
- '$HOME/.config/osmo-gsm-tester/'
- '/usr/local/etc/osmo-gsm-tester/'
- '/etc/osmo-gsm-tester/'
-The config location can also be set by an environment variable
-'$OSMO_GSM_TESTER_CONF', which then overrides the above locations.
+The config location can also be set through '-c' command line argument, which
+then overrides the above locations.
The osmo-gsm-tester expects to find the following configuration files in a
configuration directory: