From db56cec3ab61d2234691312d19e6038e5f814b83 Mon Sep 17 00:00:00 2001 From: Satyanvesh Dittakavi Date: Fri, 15 Nov 2024 18:07:59 +0000 Subject: [PATCH] SWDEV-488922 - Document the usage of DEBUG_HIP_7_PREVIEW hipGetLastError API's behavior matches with its corresponding CUDA API when this variable is set to 1 Change-Id: I661af7083e9c8dfc5e4f2003e39702ece4ccfa21 --- docs/how-to/debugging.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/docs/how-to/debugging.rst b/docs/how-to/debugging.rst index 4925e87b02..2f9e6ff307 100644 --- a/docs/how-to/debugging.rst +++ b/docs/how-to/debugging.rst @@ -369,6 +369,14 @@ Here are some of the more commonly used environment variables: number does not apply to hardware queues that are created for CU-masked HIP streams, or cooperative queues for HIP Cooperative Groups (single queue per device). + * - DEBUG_HIP_7_PREVIEW + |break| Enable preview of upcoming runtime changes that break backward compatibility. + These changes might require updating existing application code to support the new behavior. + The new behavior will become default in a future major release and this environment + variable will no longer be needed. + - 0 + - 0x1: Match the behavior of hipGetLastError with its corresponding CUDA API + General debugging tips ======================================================