From 0616963747f300987d38ae79a3094b044562c716 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A1bio?= <fabio.mestre@codeplay.com>
Date: Thu, 4 Jan 2024 14:40:00 +0000
Subject: [PATCH] [SPEC] Clarify the BinaryType output of
 urProgramCreateWithBinary (#991)

---
 include/ur_api.h            | 3 +++
 scripts/core/program.yml    | 1 +
 source/loader/ur_libapi.cpp | 3 +++
 source/ur_api.cpp           | 3 +++
 4 files changed, 10 insertions(+)

diff --git a/include/ur_api.h b/include/ur_api.h
index 0403e2b306..5c9c7af5da 100644
--- 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
index acab24c3bd..88b652210b 100644
--- 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
index 4b7525d92f..0a69fcd1e2 100644
--- 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
index eeca6c0c95..2bcc229f29 100644
--- 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_