From cb00b8022b5041b93a4b066e4b27c2a0368a377c Mon Sep 17 00:00:00 2001
From: Feoramund <161657516+Feoramund@users.noreply.github.com>
Date: Sat, 1 Jun 2024 07:56:28 -0400
Subject: [PATCH] Add note about `SIGSEGV` edge case on UNIX-likes

---
 core/testing/runner.odin | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/core/testing/runner.odin b/core/testing/runner.odin
index 8b156eb22..24b902005 100644
--- a/core/testing/runner.odin
+++ b/core/testing/runner.odin
@@ -659,6 +659,13 @@ runner :: proc(internal_tests: []Internal_Test) -> bool {
 
 	// -- All tests are complete, or the runner has been interrupted.
 
+	// NOTE(Feoramund): If you've arrived here after receiving signal 11 or
+	// SIGSEGV on the main runner thread, while using a UNIX-like platform,
+	// there is the possibility that you may have encountered a rare edge case
+	// involving the joining of threads.
+	//
+	// At the time of writing, the thread library is undergoing a rewrite that
+	// should solve this problem; it is not an issue with the test runner itself.
 	thread.pool_join(&pool)
 
 	finished_in := time.since(start_time)