[MERGED] osmo-gsm-manuals[master]: OsmoGSMTester: Installation: change some confusing terminology

This is merely a historical archive of years 2008-2021, before the migration to mailman3.

A maintained and still updated list archive can be found at https://lists.osmocom.org/hyperkitty/list/gerrit-log@lists.osmocom.org/.

Harald Welte gerrit-no-reply at lists.osmocom.org
Sun Nov 12 14:21:18 UTC 2017


Harald Welte has submitted this change and it was merged.

Change subject: OsmoGSMTester: Installation: change some confusing terminology
......................................................................


OsmoGSMTester: Installation: change some confusing terminology

It's difficult to understand when it referrs to jenkins job in general
and when it talks about specific jenkins jobs that builds binaries required for
osmo-gsm-tester and the ones which run osmo-gsm-tester.

As a result, it's difficult to understand which sections apply to each
host in case more than one host is used.

Change-Id: I5c882e77b469629028b8d773053783e18f3d1737
---
M OsmoGSMTester/chapters/install.adoc
M OsmoGSMTester/chapters/trial.adoc
2 files changed, 12 insertions(+), 13 deletions(-)

Approvals:
  Neels Hofmeyr: Looks good to me, approved
  Jenkins Builder: Verified



diff --git a/OsmoGSMTester/chapters/install.adoc b/OsmoGSMTester/chapters/install.adoc
index 112d4f9..5f6f1bc 100644
--- a/OsmoGSMTester/chapters/install.adoc
+++ b/OsmoGSMTester/chapters/install.adoc
@@ -9,7 +9,7 @@
 for manual test runs and/or a different user name is identical, simply replace
 the user name or group.
 
-=== Dependencies
+=== Osmo-gsm-tester Dependencies
 
 On a Debian/Ubuntu based system, these commands install the packages needed to
 run the osmo-gsm-tester.py code, i.e. install these on your main unit:
@@ -46,7 +46,7 @@
 ----
 
 [[jenkins_deps]]
-==== Jenkins Build Dependencies
+==== Osmocom Build Dependencies
 
 Each of the jenkins builds requires individual dependencies. This is generally
 the same as for building the software outside of osmo-gsm-tester and will not
@@ -57,8 +57,8 @@
 should match the installed sysmoBTS firmware.
 
 
-[[configure_build_slave]]
-=== Jenkins Build Slave
+[[configure_jenkins_slave]]
+=== Jenkins Build and Run Slave
 
 ==== Create 'jenkins' User on Main Unit
 
@@ -140,8 +140,8 @@
 exit
 ----
 
-[[install_add_build_slave]]
-==== Add Build Slave
+[[install_add_jenkins_slave]]
+==== Add Jenkins Slave
 
 In the jenkins web UI, add a new build slave for the osmo-gsm-tester:
 
@@ -253,10 +253,10 @@
 
 ==== Add Run Job
 
-This is the build job that actually runs the tests on the GSM hardware:
+This is the jenkins job that runs the tests on the GSM hardware:
 
-* It sources the artifacts from the build jobs.
-* It runs on the osmo-gsm-tester main unit's build slave.
+* It sources the artifacts from jenkins' build jobs.
+* It runs on the osmo-gsm-tester main unit.
 
 Here is the configuration for the run job:
 
@@ -265,7 +265,7 @@
   Configure this to taste, for example:
 ** 'Max # of build to keep': "20"
 * 'Restrict where this project can be run': "osmo-gsm-tester" +
-  (to match the 'Label' configured in <<install_add_build_slave>>).
+  (to match the 'Label' configured in <<install_add_jenkins_slave>>).
 * 'Source Code Management':
 ** 'Git'
 *** 'Repository URL': "git://git.osmocom.org/osmo-gsm-tester"
@@ -332,7 +332,7 @@
 
 === Install osmo-gsm-tester on Main Unit
 
-This assumes you have already created the jenkins user (see <<configure_build_slave>>).
+This assumes you have already created the jenkins user (see <<configure_jenkins_slave>>).
 
 ==== User Permissions
 
diff --git a/OsmoGSMTester/chapters/trial.adoc b/OsmoGSMTester/chapters/trial.adoc
index 928ee28..86bf12b 100644
--- a/OsmoGSMTester/chapters/trial.adoc
+++ b/OsmoGSMTester/chapters/trial.adoc
@@ -3,7 +3,7 @@
 
 A trial is a set of pre-built binaries to be tested. They are typically built
 by jenkins using the build scripts found in osmo-gsm-tester's source in the
-'contrib/' dir, see <<install_add_build_slave>>.
+'contrib/' dir, see <<install_add_jenkins_slave>>.
 
 A trial comes in the form of a directory containing a number of '*.tgz' tar
 archives as well as a 'checksums.md5' file to verify the tar archives'
@@ -20,4 +20,3 @@
 * stdout and stderr outputs of the binaries
 * a test log
 * *TODO*: jenkins parsable XML reports
-

-- 
To view, visit https://gerrit.osmocom.org/4660
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I5c882e77b469629028b8d773053783e18f3d1737
Gerrit-PatchSet: 2
Gerrit-Project: osmo-gsm-manuals
Gerrit-Branch: master
Gerrit-Owner: Pau Espin Pedrol <pespin at sysmocom.de>
Gerrit-Reviewer: Harald Welte <laforge at gnumonks.org>
Gerrit-Reviewer: Jenkins Builder
Gerrit-Reviewer: Neels Hofmeyr <nhofmeyr at sysmocom.de>



More information about the gerrit-log mailing list