From 7bab9a13893c127510ac304c2ae9453de80e7058 Mon Sep 17 00:00:00 2001 From: Mads Ager Date: Mon, 9 May 2022 15:12:26 +0200 Subject: [PATCH] Minor tweaks to `HACKING.md`. --- kotlin-native/HACKING.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/kotlin-native/HACKING.md b/kotlin-native/HACKING.md index 3991a91b6a8..8eba6292ad8 100644 --- a/kotlin-native/HACKING.md +++ b/kotlin-native/HACKING.md @@ -91,7 +91,7 @@ To run blackbox compiler tests use: | `compileOnly ` | If `true` then tests are fully compiled to the executable binary, but not executed afterwards. The default is `false`. | | `optimizationMode` | Compiler optimization mode: `DEBUG` (default), `OPT`, `NO` | | `memoryModel` | The memory model: `DEFAULT` (default) or `EXPERIMENTAL` | -| `useThreadStateChecker` | Is thread state checker `DISABLED` (default) or `ENABLED`?

Note: Thread state checker can be enabled only in combination with `optimizationMode=DEBUG` and `memoryModel=EXPERIMENTAL`. | +| `useThreadStateChecker` | If `true` the thread state checker is enabled. The default is `false`.

Note: Thread state checker can be enabled only in combination with `optimizationMode=DEBUG`, `memoryModel=EXPERIMENTAL` and `cacheMode=NO`. | | `gcType` | The type of GC: `UNSPECIFIED` (default), `NOOP`, `STMS`, `CMS`

Note: The GC type can be specified only in combination with `memoryModel=EXPERIMENTAL`. | | `gcScheduler` | The type of GC scheduler: `UNSPECIFIED` (default), `DISABLED`, `WITH_TIMER`, `ON_SAFE_POINTS`, `AGGRESSIVE`

Note: The GC scheduler type can be specified only in combination with `memoryModel=EXPERIMENTAL`. | | `cacheMode` | * `NO`: no caches
* `STATIC_ONLY_DIST` (default): use only caches for libs from the distribution
* `STATIC_EVERYWHERE`: use caches for libs from the distribution and generate caches for all produced KLIBs

Note: Any cache mode that permits using caches can be enabled only when thread state checker is disabled. | @@ -341,7 +341,7 @@ is debuggable in CLion, with Attach to process tool. For a quick check use: ``` -$ ./gradlew :kotlin-native:sanity 2>&1 | tee log +$ ./gradlew :kotlin-native:backend.native:tests:sanity 2>&1 | tee log ``` For a longer, more thorough testing build the complete build. Make sure you are running it on a macOS.