Skip to content

[UR] Documents generator and conformance tests #574

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
veselypeta merged 1 commit into from
Jun 6, 2023
Merged

[UR] Documents generator and conformance tests #574

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions scripts/core/CONTRIB.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
============

Expand Down Expand Up @@ -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
=====================

Expand Down