[UR] Add exp-feat docs to rst template

oneapi-src · Jun 23, 2023 · e1de661 · e1de661
1 parent 6a8acc4
commit e1de661
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 0 deletions.
diff --git a/scripts/templates/exp_feat.rst.mako b/scripts/templates/exp_feat.rst.mako
@@ -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:

diff --git a/scripts/templates/exp_feat.yml.mako b/scripts/templates/exp_feat.yml.mako
@@ -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("-"))}\""