aboutsummaryrefslogtreecommitdiff
path: root/tests/core/race/README.rst
diff options
context:
space:
mode:
Diffstat (limited to 'tests/core/race/README.rst')
-rw-r--r--tests/core/race/README.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/tests/core/race/README.rst b/tests/core/race/README.rst
new file mode 100644
index 00000000..a5152211
--- /dev/null
+++ b/tests/core/race/README.rst
@@ -0,0 +1,10 @@
+race instrumentation
+====================
+
+race_test
+---------
+
+Embeds a library that triggers a data race inside a binary and a test.
+Verifies that no race is reported by default and a race is reported when either
+target is build with the ``race = "on"`` attribute or the ``--features=race``
+flag.