aboutsummaryrefslogtreecommitdiff
path: root/libs
diff options
context:
space:
mode:
authormanuel <manuel.bott@eps.ch>2026-10-31 09:54:17 +0000
committermanuel <manuel.bott@eps.ch>2026-10-31 09:55:53 +0000
commit5361b78771fb6605b5df78aa2dbff560cb1ce44e (patch)
tree4befb75c000a0b703828c257e28784827f4816b9 /libs
parent3f2146d368f012a6f1aa87c706a857f5f782cfce (diff)
downloadkernel-feature/catch2-string-makers.tar.xz
kernel-feature/catch2-string-makers.zip
doc: require StringMaker instead of formatter for test printingfeature/catch2-string-makers
Diffstat (limited to 'libs')
-rw-r--r--libs/kstd/kstd/test_support/string_makers.hpp6
1 files changed, 3 insertions, 3 deletions
diff --git a/libs/kstd/kstd/test_support/string_makers.hpp b/libs/kstd/kstd/test_support/string_makers.hpp
index c2c6a38a..46d270f9 100644
--- a/libs/kstd/kstd/test_support/string_makers.hpp
+++ b/libs/kstd/kstd/test_support/string_makers.hpp
@@ -7,9 +7,9 @@
//! so that failed assertions show the actual values. It is force-included into every test translation unit by the
//! build system and must therefore never be included by kernel code.
//!
-//! Any type with a kstd::formatter specialization is printed via kstd::format, so the easiest way to make a type
-//! printable in tests is to give it a formatter. Types without a formatter can get a Catch::StringMaker specialization
-//! here, or in the test support header of the library they belong to.
+//! Types that already have a kstd::formatter specialization are printed via kstd::format. All other types get a
+//! Catch::StringMaker specialization here, or in the test support header of the library they belong to. Kernel code
+//! must never be changed just to make a type printable in tests.
#include <kstd/format.hpp>
#include <kstd/memory.hpp>