tests/README: document test bundles

Closes #16902

diff --git a/.github/scripts/spellcheck.words b/.github/scripts/spellcheck.words
index deb68d6cffed39aa6aefc023635f01e6891113ca..80f323ba80a0dbb57cf403252e5b456e046737a9 100644 (file)
--- 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 54fb6b3e938d5fc8596c25d5dbdcd79ca6e35ad2..b2c4261abca89852027171df7ab613498171a9ff 100644 (file)
--- 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.