From 35dea80e15eafada24db6201303f122531afe4db Mon Sep 17 00:00:00 2001 From: Petr Vesely Date: Tue, 6 Jun 2023 15:10:18 +0100 Subject: [PATCH] [UR] Documents generator and conformance tests --- scripts/core/CONTRIB.rst | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/scripts/core/CONTRIB.rst b/scripts/core/CONTRIB.rst index aa19dc16e3..2ae8266094 100644 --- a/scripts/core/CONTRIB.rst +++ b/scripts/core/CONTRIB.rst @@ -60,6 +60,13 @@ following command (or suitable build system equivalent): .. _YAML syntax: https://github.com/oneapi-src/unified-runtime/blob/main/scripts/YaML.md +.. note:: + + The generated source and header files are placed into ``/source`` and + ``/include`` directories respectively. You *should* make no attempt to + modify them directly. When the generator is run all your changes will be + overwritten. + Writing YAML ============ @@ -170,6 +177,15 @@ Conformance tests *must* not make assumptions about the adapter under test. Tests fixtures or cases *must* query for support of optional features and skip testing if unsupported by the adapter. +All tests in the Unified Runtime project are configured to use CTest to run. +All conformance tests have the ``conformance`` label attached to them which +allows them to be run independently. To run all the conformance tests, execute +the following command from the build directory. + +.. code-block:: console + + ctest -L "conformance" + Experimental Features =====================