Skip to content

Commit 39a29ea

Browse files
authored
Fix to documentation warnings (#405)
Signed-off-by: Neil R. Spruit <neil.r.spruit@intel.com>
1 parent ebe7537 commit 39a29ea

3 files changed

Lines changed: 18 additions & 10 deletions

File tree

scripts/core/EXT.rst

Lines changed: 12 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,10 @@ from templates import helper as th
77
X=x.upper()
88
s=tags['$s']
99
S=s.upper()
10+
t=tags['$t']
11+
T=t.upper()
12+
r=tags['$r']
13+
R=r.upper()
1014
%>
1115
============
1216
Extensions
@@ -166,43 +170,47 @@ Each extension must document which specific structures and functions can be exte
166170

167171
List of Standard Core Extensions
168172
================================
169-
173+
## --validate=off
170174
%for name in meta['macro']:
171175
%if name.endswith("EXT_NAME") and name.startswith('$X' + '_'):
172176
- :ref:`${th.subt(namespace, tags, meta['macro'][name]['values'][0])} <${th.subt(namespace, tags, meta['macro'][name]['values'][0]).replace('"', '')}>`\
173177

174178
%endif
175179
%endfor
180+
## --validate=on
176181

177182
List of Standard Tools Extensions
178183
=================================
179-
184+
## --validate=off
180185
%for name in meta['macro']:
181186
%if name.endswith("EXT_NAME") and name.startswith('$T' + '_'):
182187
- :ref:`${th.subt(namespace, tags, meta['macro'][name]['values'][0])} <${th.subt(namespace, tags, meta['macro'][name]['values'][0]).replace('"', '')}>`\
183188

184189
%endif
185190
%endfor
191+
## --validate=on
186192

187193
List of Standard Sysman Extensions
188194
==================================
189-
195+
## --validate=off
190196
%for name in meta['macro']:
191197
%if name.endswith("EXT_NAME") and name.startswith('$S' + '_'):
192198
- :ref:`${th.subt(namespace, tags, meta['macro'][name]['values'][0])} <${th.subt(namespace, tags, meta['macro'][name]['values'][0]).replace('"', '')}>`\
193199

194200
%endif
195201
%endfor
202+
## --validate=on
196203

197204
List of Standard Runtime Extensions
198205
===================================
199-
206+
## --validate=off
200207
%for name in meta['macro']:
201208
%if name.endswith("EXT_NAME") and name.startswith('$R' + '_'):
202209
- :ref:`${th.subt(namespace, tags, meta['macro'][name]['values'][0])} <${th.subt(namespace, tags, meta['macro'][name]['values'][0]).replace('"', '')}>`\
203210

204211
%endif
205212
%endfor
213+
## --validate=on
206214

207215
List of All Experimental Extensions
208216
===================================

scripts/core/EXT_Image_Format_Support.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ Example Usage
5454
-------------
5555

5656
Single Image Format Validation
57-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
57+
------------------------------
5858

5959
.. code-block:: cpp
6060
@@ -87,7 +87,7 @@ Single Image Format Validation
8787
}
8888
8989
Testing Multiple Image Formats on the Same Device
90-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
90+
-------------------------------------------------
9191

9292
.. code-block:: cpp
9393
@@ -135,7 +135,7 @@ Testing Multiple Image Formats on the Same Device
135135
}
136136
137137
Testing the Same Image Format Across Multiple Devices
138-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138+
-----------------------------------------------------
139139

140140
.. code-block:: cpp
141141

scripts/core/memory.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -450,7 +450,7 @@ members:
450450
details:
451451
- "1.0": "This structure may be passed to $xMemAllocDevice, via the `pNext` member of $x_device_mem_alloc_desc_t, to indicate an exportable memory allocation."
452452
"1.5": "This structure may be passed to $xMemAllocDevice and $xMemAllocHost, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, respectively, to indicate an exportable memory allocation."
453-
"1.15": "This structure may be passed to $xMemAllocDevice, $xMemAllocHost, or $xPhysicalMemCreate, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, or $x_physical_mem_alloc_desc_t, respectively, to indicate an exportable memory allocation."
453+
"1.15": "This structure may be passed to $xMemAllocDevice, $xMemAllocHost, or $xPhysicalMemCreate, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, or $x_physical_mem_desc_t, respectively, to indicate an exportable memory allocation."
454454
- "This structure may be passed to $xImageCreate, via the `pNext` member of $x_image_desc_t, to indicate an exportable image."
455455
--- #--------------------------------------------------------------------------
456456
type: struct
@@ -471,7 +471,7 @@ members:
471471
details:
472472
- "1.0": "This structure may be passed to $xMemAllocDevice, via the `pNext` member of $x_device_mem_alloc_desc_t, to import memory from a file descriptor."
473473
"1.5": "This structure may be passed to $xMemAllocDevice or $xMemAllocHost, via the `pNext` member of $x_device_mem_alloc_desc_t or of $x_host_mem_alloc_desc_t, respectively, to import memory from a file descriptor."
474-
"1.15": "This structure may be passed to $xMemAllocDevice, $xMemAllocHost, or $xPhysicalMemCreate, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, or $x_physical_mem_alloc_desc_t, respectively, to import memory from a file descriptor."
474+
"1.15": "This structure may be passed to $xMemAllocDevice, $xMemAllocHost, or $xPhysicalMemCreate, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, or $x_physical_mem_desc_t, respectively, to import memory from a file descriptor."
475475
- "This structure may be passed to $xImageCreate, via the `pNext` member of $x_image_desc_t, to import memory from a file descriptor."
476476
--- #--------------------------------------------------------------------------
477477
type: struct
@@ -520,7 +520,7 @@ details:
520520
- "When `flags` is $X_EXTERNAL_MEMORY_TYPE_FLAG_OPAQUE_WIN32_KMT, `name` must be `nullptr`."
521521
- "1.0": "This structure may be passed to $xMemAllocDevice, via the `pNext` member of $x_device_mem_alloc_desc_t, to import memory from a Win32 handle."
522522
"1.5": "This structure may be passed to $xMemAllocDevice or $xMemAllocHost, via the `pNext` member of $x_device_mem_alloc_desc_t or of $x_host_mem_alloc_desc_t, respectively, to import memory from a Win32 handle."
523-
"1.15": "This structure may be passed to $xMemAllocDevice, $xMemAllocHost, or $xPhysicalMemCreate, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, or $x_physical_mem_alloc_desc_t, respectively, to import memory from a Win32 handle."
523+
"1.15": "This structure may be passed to $xMemAllocDevice, $xMemAllocHost, or $xPhysicalMemCreate, via the `pNext` member of $x_device_mem_alloc_desc_t or $x_host_mem_alloc_desc_t, or $x_physical_mem_desc_t, respectively, to import memory from a Win32 handle."
524524
- "This structure may be passed to $xImageCreate, via the `pNext` member of $x_image_desc_t, to import memory from a Win32 handle."
525525
--- #--------------------------------------------------------------------------
526526
type: struct

0 commit comments

Comments
 (0)