Skip to content

Commit 355c4c3

Browse files
committed
Cosmetic tweaks to native enqueue spec
Pedantic things I noticed while reading spec.
1 parent 167ddf9 commit 355c4c3

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

scripts/core/EXP-NATIVE-ENQUEUE.rst

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ within the native API through the function passed to
3232
${x}EnqueueNativeCommandExp, the function argument must only use the native
3333
queue accessed through ${x}QueueGetNativeHandle. Use of a native queue that is
3434
not the native queue returned by ${x}QueueGetNativeHandle results in undefined
35-
behaviour.
35+
behavior.
3636

37-
Any args that are needed by the func must be passed through a void* and unpacked
38-
within the func. If ${x}_mem_handle_t arguments are to be used within
39-
pfnNativeEnqueue, they must be accessed using ${x}MemGetNativeHandle.
40-
${x}_mem_handle_t arguments must be packed in the void* argument that will be
41-
used in pfnNativeEnqueue, as well as ${x}EnqueueNativeCommandExp's phMemList
37+
Any args that are needed by the func must be passed through a ``void*`` and unpacked
38+
within the func. If ``${x}_mem_handle_t`` arguments are to be used within
39+
``pfnNativeEnqueue``, they must be accessed using ${x}MemGetNativeHandle.
40+
``${x}_mem_handle_t`` arguments must be packed in the void* argument that will be
41+
used in ``pfnNativeEnqueue``, as well as ${x}EnqueueNativeCommandExp's ``phMemList``
4242
argument.
4343

4444
API
@@ -65,24 +65,25 @@ Functions
6565
Changelog
6666
--------------------------------------------------------------------------------
6767

68-
+-----------+-------------------------+
69-
| Revision | Changes |
70-
+===========+=========================+
71-
| 1.0 | Initial Draft |
72-
+-----------+-------------------------+
73-
| 1.1 | Make `phEvent` optional |
74-
+-----------+-------------------------+
68+
+-----------+---------------------------+
69+
| Revision | Changes |
70+
+===========+===========================+
71+
| 1.0 | Initial Draft |
72+
+-----------+---------------------------+
73+
| 1.1 | Make ``phEvent`` optional |
74+
+-----------+---------------------------+
7575

7676

7777
Support
7878
--------------------------------------------------------------------------------
7979

8080
Adapters which support this experimental feature *must* return true for the new
81-
`${X}_DEVICE_INFO_ENQUEUE_NATIVE_COMMAND_SUPPORT_EXP` device info query.
81+
``${X}_DEVICE_INFO_ENQUEUE_NATIVE_COMMAND_SUPPORT_EXP`` device info query.
8282

8383

8484
Contributors
8585
--------------------------------------------------------------------------------
8686

8787
* Hugh Delaney `hugh.delaney@codeplay.com <hugh.delaney@codeplay.com>`_
8888
* Kenneth Benzie (Benie) `k.benzie@codeplay.com <k.benzie@codeplay.com>`_
89+
* Ewan Crawford `ewan@codeplay.com <ewan@codeplay.com>`_

0 commit comments

Comments
 (0)