From: Viktor Szakats <commit@vsz.me>
Date: Tue, 1 Apr 2025 09:42:25 +0000 (+0200)
Subject: tests/README: document test bundles
X-Git-Tag: curl-8_13_0~9
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fddc7a67eaf2ade627fef78e8fde2d590b9021cf;p=thirdparty%2Fcurl.git

tests/README: document test bundles

Closes #16902
---

diff --git a/.github/scripts/spellcheck.words b/.github/scripts/spellcheck.words
index deb68d6cff..80f323ba80 100644
--- a/.github/scripts/spellcheck.words
+++ b/.github/scripts/spellcheck.words
@@ -447,6 +447,8 @@ librtmp
 libs
 libssh
 libssh2
+libtest
+libtests
 Libtool
 libtool
 libuv
diff --git a/tests/README.md b/tests/README.md
index 54fb6b3e93..b2c4261abc 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -267,3 +267,15 @@ SPDX-License-Identifier: curl
   writing tests that verify behaviors of specific individual functions.
 
   The unit tests depend on curl being built with debug enabled.
+
+### test bundles
+
+  The `--enable-test-bundles` (autotools) and `-DCURL_TEST_BUNDLES=ON` (cmake)
+  build options allow to build tests bundled into single executables, one for
+  libtests, one for unit tests and one for servers.
+  The executables' first argument is the name of libtest, unit test or server
+  respectively.
+  In these executables, the build process automatically renames the entry point
+  to a unique symbol. `test` becomes `test_<tool>`, e.g. `test_lib1598` or
+  `test_unit1305`. For servers `main` becomes `main_sws` for the `sws` server,
+  and so on. Other common symbols may also be suffixed the same way.