Skip to content

Commit 35dea80

Browse files
author
Petr Vesely
committed
[UR] Documents generator and conformance tests
1 parent 47854d4 commit 35dea80

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

scripts/core/CONTRIB.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,13 @@ following command (or suitable build system equivalent):
6060
.. _YAML syntax:
6161
https://github.com/oneapi-src/unified-runtime/blob/main/scripts/YaML.md
6262

63+
.. note::
64+
65+
The generated source and header files are placed into ``/source`` and
66+
``/include`` directories respectively. You *should* make no attempt to
67+
modify them directly. When the generator is run all your changes will be
68+
overwritten.
69+
6370
Writing YAML
6471
============
6572

@@ -170,6 +177,15 @@ Conformance tests *must* not make assumptions about the adapter under test.
170177
Tests fixtures or cases *must* query for support of optional features and skip
171178
testing if unsupported by the adapter.
172179

180+
All tests in the Unified Runtime project are configured to use CTest to run.
181+
All conformance tests have the ``conformance`` label attached to them which
182+
allows them to be run independently. To run all the conformance tests, execute
183+
the following command from the build directory.
184+
185+
.. code-block:: console
186+
187+
ctest -L "conformance"
188+
173189
Experimental Features
174190
=====================
175191

0 commit comments

Comments
 (0)