From e1de66147f026987801d25ba3934e2ad2cdfdc12 Mon Sep 17 00:00:00 2001 From: Petr Vesely Date: Fri, 23 Jun 2023 11:12:56 +0100 Subject: [PATCH] [UR] Add exp-feat docs to rst template --- scripts/templates/exp_feat.rst.mako | 10 ++++++++++ scripts/templates/exp_feat.yml.mako | 7 +++++++ 2 files changed, 17 insertions(+) diff --git a/scripts/templates/exp_feat.rst.mako b/scripts/templates/exp_feat.rst.mako index cfa124fd1b..628e9f8c50 100644 --- 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 index c23eab3f2b..84819697ed 100644 --- 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("-"))}\""