Skip to content

Commit 8767908

Browse files
author
Petr Vesely
committed
[UR] Refactor script and rst template
1 parent aae37fd commit 8767908

File tree

2 files changed

+61
-10
lines changed

2 files changed

+61
-10
lines changed

scripts/templates/exp_feat.rst.mako

Lines changed: 61 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
X=x.upper()
55
%>
66
</%text>
7-
.. _experimental-${name}
7+
.. _experimental-${name}:
88

99
================================================================================
1010
${" ".join(name.split("-")).title()}
1111
================================================================================
1212

13-
14-
.. warning:
13+
.. _warning:
1514

1615
Experimental features:
1716

@@ -21,8 +20,63 @@ ${" ".join(name.split("-")).title()}
2120
* Do not require conformance testing of their own additions.
2221

2322

24-
.. todo::
23+
--------------------------------------------------------------------------------
24+
Terminology
25+
--------------------------------------------------------------------------------
26+
If your experimental feature introduces a new concept or terminoloyg. Please
27+
provide a detailed explanation in this section. If this does not apply to your
28+
feature you may freely delete this section.
29+
30+
--------------------------------------------------------------------------------
31+
Motivation
32+
--------------------------------------------------------------------------------
33+
In this section you *must* justify your motivation for adding this experimental
34+
feature. You should also state at least one adapter upon which this feature can
35+
be supported.
36+
37+
--------------------------------------------------------------------------------
38+
API
39+
--------------------------------------------------------------------------------
40+
In this section you *must* list all additions your experimental feature will
41+
make to the Unified Runtime specification. If your experimental feature does not
42+
include additions from one or more of the sections listed below, you may freely
43+
remove them.
44+
45+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
46+
Macros
47+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
48+
* <%text>${x}</%text>_EXP_MACRO
49+
50+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
51+
Enums
52+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
53+
* <%text>${x}</%text>_exp_enum_t
54+
55+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
56+
Structs
57+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58+
* <%text>${x}</%text>_exp_struct_t
59+
60+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
61+
Functions
62+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
63+
* <%text>${x}</%text>FunctionExp
64+
65+
--------------------------------------------------------------------------------
66+
Changelog
67+
--------------------------------------------------------------------------------
68+
69+
+-----------+------------------------+
70+
| Revision | Changes |
71+
+===========+========================+
72+
| 1.0 | Intial Draft |
73+
+-----------+------------------------+
74+
75+
--------------------------------------------------------------------------------
76+
Contributors
77+
--------------------------------------------------------------------------------
78+
Please list all people who wish to be credited for contribution to this
79+
experimental feature.
2580

26-
In the following sections you should explain and document the motivation of
27-
the experimental feature, the additions made to the specification along with
28-
its valid usage.
81+
* Contributor One `contrib.one@email.com <contrib.one@email.com>`_
82+
* Contributor Two `contrib.two@email.com <contrib.one@email.com>`_

scripts/templates/exp_feat.yml.mako

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,3 @@ import datetime
1717
type: header
1818
desc: "Intel $OneApi Unified Runtime Experimental APIs for ${" ".join(name.split("-")).title()}"
1919
ordinal: "99"
20-
--- #--------------------------------------------------------------------------
21-
## TODO - Add you experimental feature additions here
22-
## - refer to YaML.md for the syntax defintion

0 commit comments

Comments
 (0)