commit db53b83822759570069e7d2fde099df97bf383be
author Vladimir Sukharev <vladimir.sukharev@jetbrains.com> Tue Jan 24 10:34:09 2023 +0000
committer Space Team <noreply@jetbrains.team> Tue Jan 24 10:34:09 2023 +0000
tree d5abcf0992ba04f5035b422189ab6ab34d06e696
parent edbd05ba47fd875d9f61b8d762eab1ca5d14803d

[K/N] Improve native README for MacOS aarch64

Merge-request: KT-MR-8428
Merged-by: Vladimir Sukharev <Vladimir.Sukharev@jetbrains.com>

kotlin-native/HACKING.md

diff --git a/kotlin-native/HACKING.md b/kotlin-native/HACKING.md
index f281a23..b99a952 100644
--- a/kotlin-native/HACKING.md
+++ b/kotlin-native/HACKING.md
@@ -103,6 +103,8 @@
 There are also tests that are very Native-backend specific: tests for Kotlin/Native-specific function, C-interop tests, linkage tests, etc.
 In common, they are called "target-specific tests".
 
+Note: on MacOS aarch64, [JDK aarch64 is required](./README.md#building-from-source)
+
 To run Kotlin/Native target-specific tests use (takes time):
 
     ./gradlew :kotlin-native:backend.native:tests:sanity  2>&1 | tee log                             # quick one

kotlin-native/README.md

diff --git a/kotlin-native/README.md b/kotlin-native/README.md
index 087a73a..9e897e9 100644
--- a/kotlin-native/README.md
+++ b/kotlin-native/README.md
@@ -43,6 +43,11 @@
 *   at the root directory of the repository,
     create `local.properties` file with `kotlin.native.enabled=true` line
 *   macOS: Xcode 14.0 or newer
+    * on `MacOS aarch64`, CInterop functionality is available only using aarch64 JDK builds, e.g.
+[Eclipse Temurin 17.0.5](https://github.com/adoptium/temurin17-binaries/releases) or
+[Azul Zulu JDK8](https://www.azul.com/downloads/?version=java-8-lts&os=macos&architecture=arm-64-bit&package=jdk)
+
+      Note: using `JDK x86_64` on `MacOS aarch64` will cause `java.lang.UnsatisfiedLinkError` for `libclang.dylib`
 *   Linux: glibc 2.23 or newer
 *   Windows:
     * Microsoft C++ build tools for Visual Studio 2019 14.29 or newer
@@ -91,10 +96,15 @@
 To import a C or Objective-C library, use `./dist/bin/cinterop` tool.
 See the [documentation](https://kotlinlang.org/docs/native-c-interop.html) for more details.
 
+Note: on MacOS aarch64, [JDK aarch64 is required](./README.md#building-from-source)
+
+
 ### Running tests
 
 For tests, use `./gradlew :native:native.tests:codegenBoxTest` and `./gradlew :kotlin-native:backend.native:tests:run`.
 
+Note: on MacOS aarch64, for target-specific tests, [JDK aarch64 is required](./README.md#building-from-source)
+
 For more details see [Testing](HACKING.md#Testing).
 
 ## More tips and tricks