[SPEC] Clarify the BinaryType output of urProgramCreateWithBinary (on…

…eapi-src#991)
aarongreig · Jan 8, 2024 · 0616963 · 0616963
1 parent 57d2daf
commit 0616963
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 0 deletions.
diff --git a/include/ur_api.h b/include/ur_api.h
@@ -4037,6 +4037,9 @@ urProgramCreateWithIL(
 ///
 /// @details
 /// - The application may call this function from simultaneous threads.
+/// - Following a successful call to this entry point, `phProgram` will
+/// contain a binary of type ::UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT or
+/// ::UR_PROGRAM_BINARY_TYPE_LIBRARY for `hDevice`.
 ///
 /// @remarks
 /// _Analogues_

diff --git a/scripts/core/program.yml b/scripts/core/program.yml
@@ -127,6 +127,7 @@ analogue:
  - "**clCreateProgramWithBinary**"
 details:
  - "The application may call this function from simultaneous threads."
+ - "Following a successful call to this entry point, `phProgram` will contain a binary of type $X_PROGRAM_BINARY_TYPE_COMPILED_OBJECT or $X_PROGRAM_BINARY_TYPE_LIBRARY for `hDevice`."
 params:
  - type: $x_context_handle_t
  name: hContext

diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp
@@ -2885,6 +2885,9 @@ ur_result_t UR_APICALL urProgramCreateWithIL(
 ///
 /// @details
 /// - The application may call this function from simultaneous threads.
+/// - Following a successful call to this entry point, `phProgram` will
+/// contain a binary of type ::UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT or
+/// ::UR_PROGRAM_BINARY_TYPE_LIBRARY for `hDevice`.
 ///
 /// @remarks
 /// _Analogues_

diff --git a/source/ur_api.cpp b/source/ur_api.cpp
@@ -2450,6 +2450,9 @@ ur_result_t UR_APICALL urProgramCreateWithIL(
 ///
 /// @details
 /// - The application may call this function from simultaneous threads.
+/// - Following a successful call to this entry point, `phProgram` will
+/// contain a binary of type ::UR_PROGRAM_BINARY_TYPE_COMPILED_OBJECT or
+/// ::UR_PROGRAM_BINARY_TYPE_LIBRARY for `hDevice`.
 ///
 /// @remarks
 /// _Analogues_