From 5387ab9181e083bd6919d693b70ea7495c69620b Mon Sep 17 00:00:00 2001 From: "Jiang, Julia" Date: Wed, 9 Apr 2025 00:00:22 -0400 Subject: [PATCH] SWDEV-521768 - Update descriptions for HIP linker APIs (#23) [ROCm/hip commit: e451b5a4afd7d494796abc13339e967c72a65154] --- projects/hip/include/hip/hip_runtime_api.h | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/projects/hip/include/hip/hip_runtime_api.h b/projects/hip/include/hip/hip_runtime_api.h index 1eaff984ae..e61ff949b6 100644 --- a/projects/hip/include/hip/hip_runtime_api.h +++ b/projects/hip/include/hip/hip_runtime_api.h @@ -5939,7 +5939,7 @@ hipError_t hipModuleLoadData(hipModule_t* module, const void* image); hipError_t hipModuleLoadDataEx(hipModule_t* module, const void* image, unsigned int numOptions, hipJitOption* options, void** optionValues); /** - * @brief Completes the linking of the given program. + * @brief Adds bitcode data to be linked with options. * @param [in] state hip link state * @param [in] type Type of the input data or bitcode * @param [in] data Input data which is null terminated @@ -5961,7 +5961,7 @@ hipError_t hipLinkAddData(hipLinkState_t state, hipJitInputType type, void* data void** optionValues); /** - * @brief Adds a file with bit code to be linked with options + * @brief Adds a file with bitcode to be linked with options. * @param [in] state hip link state * @param [in] type Type of the input data or bitcode * @param [in] path Path to the input file where bitcode is present @@ -5996,7 +5996,7 @@ hipError_t hipLinkAddFile(hipLinkState_t state, hipJitInputType type, const char hipError_t hipLinkComplete(hipLinkState_t state, void** hipBinOut, size_t* sizeOut); /** - * @brief Creates the link instance via hip APIs. + * @brief Creates a linker instance with options. * @param [in] numOptions Number of options * @param [in] option Array of options * @param [in] optionValues Array of option values cast to void* @@ -6009,7 +6009,7 @@ hipError_t hipLinkComplete(hipLinkState_t state, void** hipBinOut, size_t* sizeO hipError_t hipLinkCreate(unsigned int numOptions, hipJitOption* options, void** optionValues, hipLinkState_t* stateOut); /** - * @brief Deletes the link instance via hip APIs. + * @brief Deletes the linker instance. * @param [in] state link state instance * * @returns #hipSuccess #hipErrorInvalidValue