Skip to content

Commit

Permalink
[UR] Add exp-feat docs to rst template
Browse files Browse the repository at this point in the history
  • Loading branch information
Petr Vesely committed Jun 23, 2023
1 parent 6a8acc4 commit e1de661
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 0 deletions.
10 changes: 10 additions & 0 deletions scripts/templates/exp_feat.rst.mako
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,16 @@ Changelog
| 1.0 | Initial Draft |
+-----------+------------------------+

Support
--------------------------------------------------------------------------------

Adapters which support this experimental feature *must* return the valid string
defined in ``${"${X}"}_${"_".join(name.split("-")).upper()}_EXTENSION_STRING_EXP``
as one of the options from ${"${x}"}DeviceGetInfo when querying for
${"${X}"}_DEVICE_INFO_EXTENSIONS. Conversly, before using any of the
functionality defined in this experimental feature the user *must* use the
device query to determine if the adapter supports this feature.

Contributors
--------------------------------------------------------------------------------
.. comment:
Expand Down
7 changes: 7 additions & 0 deletions scripts/templates/exp_feat.yml.mako
Original file line number Diff line number Diff line change
Expand Up @@ -17,3 +17,10 @@ import datetime
type: header
desc: "Intel $OneApi Unified Runtime Experimental APIs for ${" ".join(name.split("-")).title()}"
ordinal: "99"
--- #--------------------------------------------------------------------------
type: macro
desc: |
The extension string which defines support for ${name}
which is returned when querying device extensions.
name: $X_${"_".join(name.split("-")).upper()}_EXTENSION_STRING_EXP
value: "\"$x_exp_${"_".join(name.split("-"))}\""

0 comments on commit e1de661

Please sign in to comment.