docs: Fix up test documentation

Observed issue
==============

Principally `LTTNG_TEST_GDBSERVER_SESSIOND` was listed twice in the
table, and `LTTNG_TEST_GDBSERVER_SESSIOND_WAIT` was no listed.

Solution
========

The duplicate `LTTNG_TEST_GDBSERVER_SESSIOND` has been removed and
`LTTNG_TEST_GDBSERVER_SESSIOND_WAIT` added.

The wording on the `*_GDBSERVER_WAIT` variables has been clarified.

The ordering of the new entries was modified to preserve alphabetical ordering.

Known drawbacks
===============

None.

Change-Id: I932a892a6aa78f37bb9a3a1c5ddaf8fadb552f56
Signed-off-by: Kienan Stewart <kstewart@efficios.com>
Signed-off-by: Jérémie Galarneau <jeremie.galarneau@efficios.com>

diff --git a/tests/README.adoc b/tests/README.adoc
index 13f53faace0bf92b7c215f6ac5c85c5d9647f5ee..10adcb75e0abbd85fbac3432d674185755b772b0 100644 (file)
--- a/tests/README.adoc
+++ b/tests/README.adoc
@@ -84,7 +84,7 @@ Some invocations of programs during the test may override this value to perform
 | {check} | {check} | {ex}
 
 | `LTTNG_TEST_GDBSERVER_RELAYD_WAIT`
-| When not empty, the test script will wait for user input before continuing.
+| When not empty, the test script will wait for user input after starting lttng-relayd before continuing.
 Useful to connect and insert breakpoints before other commands are run.
 | {check} | {check} | {ex}
 
@@ -92,8 +92,13 @@ Useful to connect and insert breakpoints before other commands are run.
 | Launch `gdbserver` and attach to newly spawned `lttng-sessiond` processes
 | {check} | {check} | {ex}
 
-| `LTTNG_TEST_GDBSERVER_SESSIOND`
-| Launch `gdbserver` and attach to newly spawned `lttng-sessiond` processes
+| `LTTNG_TEST_GDBSERVER_SESSIOND_PORT`
+| The TCP port for the gdbserver instance. Default:{nbsp}`1024`
+| {check} | {check} | {ex}
+
+| `LTTNG_TEST_GDBSERVER_SESSIOND_WAIT`
+| When not empty, the test script will wait for user input after starting lttng-sessiond before continuing.
+Useful to connect and insert breakpoints before other commands are run.
 | {check} | {check} | {ex}
 
 | `LTTNG_TEST_NO_RELAYD`
@@ -101,10 +106,6 @@ Useful to connect and insert breakpoints before other commands are run.
 Used to manually launch one during test troubleshooting
 | {check} | {ex} | {ex}
 
-| `LTTNG_TEST_GDBSERVER_SESSIOND_PORT`
-| The TCP port for the gdbserver instance. Default:{nbsp}`1024`
-| {check} | {check} | {ex}
-
 | `LTTNG_TEST_PRESERVE_TEST_ENV`
 | Do not delete test environment folders on tear-down
 | {check} | {ex} | {ex}