From e6633d3d9214402fcf3585ae8c24213a4761cc8b Mon Sep 17 00:00:00 2001
From: Abduqodiri Qurbonzoda <abduqodiri.qurbonzoda@jetbrains.com>
Date: Sat, 17 Jun 2023 20:15:55 +0000
Subject: [PATCH] [K/N] Document that Throwable.stackTraceToString format is
 unstable

As a part of efforts to stabilize Native stdlib.

Merge-request: KT-MR-10637
Merged-by: Abduqodiri Qurbonzoda <abduqodiri.qurbonzoda@jetbrains.com>
---
 kotlin-native/runtime/src/main/kotlin/kotlin/Throwable.kt | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/kotlin-native/runtime/src/main/kotlin/kotlin/Throwable.kt b/kotlin-native/runtime/src/main/kotlin/kotlin/Throwable.kt
index 53636335463..c6a6791c326 100644
--- a/kotlin-native/runtime/src/main/kotlin/kotlin/Throwable.kt
+++ b/kotlin-native/runtime/src/main/kotlin/kotlin/Throwable.kt
@@ -51,6 +51,8 @@ public open class Throwable(open val message: String?, open val cause: Throwable
 
     /**
      * Prints the [detailed description][Throwable.stackTraceToString] of this throwable to the standard output.
+     *
+     * Note that the format of the output is not stable and may change in the future.
      */
     public fun printStackTrace(): Unit = ExceptionTraceBuilder(this).print()
 
@@ -160,12 +162,16 @@ private external fun getStackTraceStrings(stackTrace: NativePtrArray): Array<Str
  * - the complete stack trace;
  * - detailed descriptions of the exceptions that were [suppressed][suppressedExceptions] in order to deliver this exception;
  * - the detailed description of each throwable in the [Throwable.cause] chain.
+ *
+ * Note that the description format is not stable and may change in the future.
  */
 @SinceKotlin("1.4")
 public actual fun Throwable.stackTraceToString(): String = dumpStackTrace()
 
 /**
  * Prints the [detailed description][Throwable.stackTraceToString] of this throwable to the standard output.
+ *
+ * Note that the format of the output is not stable and may change in the future.
  */
 @SinceKotlin("1.4")
 @Suppress("EXTENSION_SHADOWED_BY_MEMBER")