Skip to content

Commit c270247

Browse files
authored
[NFC][UR] Clarify the wording of urProgramLink[Exp] (#19237)
These functions allow the adapter to optionally provide an output program for the build log. The way this was worded in the spec is a bit unclear, so now it's been reworded. There should be no change in behaviour in regards to the original intent.
1 parent 100f89d commit c270247

File tree

5 files changed

+32
-32
lines changed

5 files changed

+32
-32
lines changed

unified-runtime/include/ur_api.h

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

unified-runtime/scripts/core/exp-multi-device-compile.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ analogue:
9595
details:
9696
- "The application may call this function from simultaneous threads."
9797
- "Following a successful call to this entry point the program returned in `phProgram` will contain a binary of the $X_PROGRAM_BINARY_TYPE_EXECUTABLE type for each device in `phDevices`."
98-
- "If a non-success code is returned and `phProgram` is not `nullptr`, it will contain an unspecified program or `nullptr`. Implementations may use the build log of this program (accessible via $xProgramGetBuildInfo) to provide an error log for the linking failure."
98+
- "If a non-success code is returned, adapters may store a program in `phProgram`. This program should only be used with `$xProgramGetBuildInfo` to get the build log for the failure. Adapters which do not do not support producing build logs must set this value to `nullptr`."
9999
params:
100100
- type: $x_context_handle_t
101101
name: hContext

unified-runtime/scripts/core/program.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -227,7 +227,7 @@ analogue:
227227
details:
228228
- "The application may call this function from simultaneous threads."
229229
- "Following a successful call to this entry point the program returned in `phProgram` will contain a binary of the $X_PROGRAM_BINARY_TYPE_EXECUTABLE type for each device in `hContext`."
230-
- "If a non-success code is returned and `phProgram` is not `nullptr`, it will contain an unspecified program or `nullptr`. Implementations may use the build log of this program (accessible via $xProgramGetBuildInfo) to provide an error log for the linking failure."
230+
- "If a non-success code is returned, adapters may store a program in `phProgram`. This program should only be used with `$xProgramGetBuildInfo` to get the build log for the failure. Adapters which do not do not support producing build logs must set this value to `nullptr`."
231231
params:
232232
- type: $x_context_handle_t
233233
name: hContext

unified-runtime/source/loader/ur_libapi.cpp

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

unified-runtime/source/ur_api.cpp

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)