aboutsummaryrefslogtreecommitdiff
path: root/CONTRIBUTING.rst
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 /CONTRIBUTING.rst
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 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst7
1 files changed, 3 insertions, 4 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 1ea69ee6..dabc2552 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -59,10 +59,9 @@ Printing Values in Test Failures
Catch2 prints values it cannot convert as ``{?}``.
To avoid that, every test translation unit force-includes ``kstd/test_support/string_makers.hpp`` (kstd tests) or ``kernel/test_support/string_makers.hpp`` (kernel tests), which teach Catch2 how to print our types without touching kernel code.
-To make a new type printable in tests, either:
-
-* give it a ``kstd::formatter`` specialization, which is picked up automatically, or
-* add a ``Catch::StringMaker`` specialization to the ``string_makers.hpp`` of the library the type belongs to.
+To make a new type printable in tests, add a ``Catch::StringMaker`` specialization to the ``string_makers.hpp`` of the library the type belongs to.
+Do not add or change anything in kernel code (e.g. a ``kstd::formatter``) just to make a type printable in tests.
+Types that already have a ``kstd::formatter`` are printed through it automatically.
Bootable Kernel Targets
~~~~~~~~~~~~~~~~~~~~~~~