osmith has uploaded this change for review.

View Change

testenv/README: automatic backtraces for coredumps

Add documentation for this feature.

Change-Id: I9b65bfb14853edb03ddb571867bb795bde9d495c
---
M _testenv/README.md
1 file changed, 13 insertions(+), 0 deletions(-)

git pull ssh://gerrit.osmocom.org:29418/osmo-ttcn3-hacks refs/changes/20/43420/1

diff --git a/_testenv/README.md b/_testenv/README.md
index 710c021..3496785 100644
--- a/_testenv/README.md
+++ b/_testenv/README.md
@@ -309,6 +309,19 @@
 Switching between the versions is done either by setting a `titan_min` version
 in `testsrcdir.cfg`, or by using `-T` / `--titan-version`.
 
+## Automatic backtraces for coredumps
+
+When your SUT crashes with a coredump, testenv automatically runs `gdb` to get
+a backtrace, displays it in the output and writes it along with the other logs
+into a `.backtrace` file.
+
+For this to work, you either need to have `systemd-coredump` set up, or
+alternatively have a core pattern in `/proc/sys/kernel/core_pattern` starting
+with `core`.
+
+Executables that do not start with a relevant prefix (`osmo-` or `open5gs-`)
+get ignored, see `testenv.coredump.executable_is_relevant()`.
+
 ## Troubleshooting
 
 ### Timeout waiting for RESET-ACK after sending RESET

To view, visit change 43420. To unsubscribe, or for help writing mail filters, visit settings.