Add note to docs

urCommandBufferFinalizeExp will return UR_RESULT_ERROR_INVALID_OPERATION if the command buffer has already been finalized.
oneapi-src · Nov 14, 2024 · 0a75eef · 0a75eef
1 parent 09b3a7c
commit 0a75eef
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 1 deletion.
diff --git a/include/ur_api.h b/include/ur_api.h
@@ -8484,6 +8484,7 @@ urCommandBufferReleaseExp(
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE
 ///         + `NULL == hCommandBuffer`
 ///     - ::UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
+///     - ::UR_RESULT_ERROR_INVALID_OPERATION - "If `hCommandBuffer` has already been finalized"
 ///     - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
 ///     - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
 UR_APIEXPORT ur_result_t UR_APICALL

diff --git a/scripts/core/exp-command-buffer.yml b/scripts/core/exp-command-buffer.yml
@@ -330,6 +330,8 @@ params:
       desc: "[in] Handle of the command-buffer object."
 returns:
     - $X_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
+    - $X_RESULT_ERROR_INVALID_OPERATION
+        - "If `hCommandBuffer` has already been finalized"
     - $X_RESULT_ERROR_OUT_OF_HOST_MEMORY
     - $X_RESULT_ERROR_OUT_OF_RESOURCES
 --- #--------------------------------------------------------------------------

diff --git a/source/loader/ur_libapi.cpp b/source/loader/ur_libapi.cpp
@@ -7542,6 +7542,7 @@ ur_result_t UR_APICALL urCommandBufferReleaseExp(
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE
 ///         + `NULL == hCommandBuffer`
 ///     - ::UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
+///     - ::UR_RESULT_ERROR_INVALID_OPERATION - "If `hCommandBuffer` has already been finalized"
 ///     - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
 ///     - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
 ur_result_t UR_APICALL urCommandBufferFinalizeExp(

diff --git a/source/ur_api.cpp b/source/ur_api.cpp
@@ -6405,6 +6405,7 @@ ur_result_t UR_APICALL urCommandBufferReleaseExp(
 ///     - ::UR_RESULT_ERROR_INVALID_NULL_HANDLE
 ///         + `NULL == hCommandBuffer`
 ///     - ::UR_RESULT_ERROR_INVALID_COMMAND_BUFFER_EXP
+///     - ::UR_RESULT_ERROR_INVALID_OPERATION - "If `hCommandBuffer` has already been finalized"
 ///     - ::UR_RESULT_ERROR_OUT_OF_HOST_MEMORY
 ///     - ::UR_RESULT_ERROR_OUT_OF_RESOURCES
 ur_result_t UR_APICALL urCommandBufferFinalizeExp(

diff --git a/test/conformance/exp_command_buffer/commands.cpp b/test/conformance/exp_command_buffer/commands.cpp
@@ -214,5 +214,4 @@ TEST_P(urCommandBufferAppendKernelLaunchExpTest, FinalizeTwice) {
     ASSERT_SUCCESS(urCommandBufferFinalizeExp(cmd_buf_handle));
     EXPECT_EQ_RESULT(urCommandBufferFinalizeExp(cmd_buf_handle),
                      UR_RESULT_ERROR_INVALID_OPERATION);
-
 }