From ab26e26c89d474ddcb8682ee615a185d3d778240 Mon Sep 17 00:00:00 2001 From: Pavel Punegov Date: Wed, 30 Jan 2019 17:32:46 +0300 Subject: [PATCH] Update .md documentation --- FAQ.md | 17 +++++++++++------ HACKING.md | 2 -- LIBRARIES.md | 2 +- PLATFORM_LIBS.md | 2 +- 4 files changed, 13 insertions(+), 10 deletions(-) diff --git a/FAQ.md b/FAQ.md index 735e77b6806..da59f521f57 100644 --- a/FAQ.md +++ b/FAQ.md @@ -69,17 +69,22 @@ targets { ### Q: How do I enable bitcode for my Kotlin framework? -A: Use either `-Xembed-bitcode` or `-Xembed-bitcode-marker` compiler option -or matching Gradle DSL statement, i.e. +A: By default gradle plugin adds it on iOS target. + * For debug build it embeds placeholder LLVM IR data as a marker. + * For release build it embeds bitcode as data. +Or commandline arguments: `-Xembed-bitcode` (for release) and `-Xembed-bitcode-marker` (debug) + +Setting this in a Gradle DSL:
```groovy targets { fromPreset(presets.iosArm64, 'myapp') { - compilations.main.outputKinds 'FRAMEWORK' - compilations.main.extraOpts '-Xembed-bitcode' // for release binaries - // or '-Xembed-bitcode-marker' for debug binaries + compilations.main.outputKinds 'FRAMEWORK' + compilations.main.embedBitcode BitcodeEmbeddingMode.BITCODE // for release binaries + // or BitcodeEmbeddingMode.MARKER for debug binaries + } } ``` @@ -104,7 +109,7 @@ used to store different pointers to frozen objects in a frozen object and automa ### Q: How can I compile my project against the Kotlin/Native master? -A: We release dev builds frequently, usually at least once a week. You can check the [list of available versions](https://bintray.com/jetbrains/kotlin-native-dependencies/kotlin-native-gradle-plugin). But if we recently fixed an issue and you want to check it before a release is done, you can do: +A: One of the following should be done:
diff --git a/HACKING.md b/HACKING.md index 53eb74f151a..4e23c54a8c6 100644 --- a/HACKING.md +++ b/HACKING.md @@ -70,8 +70,6 @@ To update the blackbox compiler tests set TeamCity build number in `gradle.prope testKotlinVersion= -and run `./gradlew update_external_tests` - * **-Pfilter** allows one to choose test files to run. ./gradlew -Pfilter=overflowLong.kt run_external diff --git a/LIBRARIES.md b/LIBRARIES.md index 408880d0194..52801062f8e 100644 --- a/LIBRARIES.md +++ b/LIBRARIES.md @@ -36,7 +36,7 @@ For example, using the simple `libgit2.def` native library definition file provi
```bash -$ cinterop -def samples/gitchurn/src/main/c_interop/libgit2.def -compilerOpts -I/usr/local/include -o libgit2 +$ cinterop -def samples/gitchurn/src/nativeInterop/cinterop/libgit2.def -compilerOpts -I/usr/local/include -o libgit2 ```
diff --git a/PLATFORM_LIBS.md b/PLATFORM_LIBS.md index c31f140796a..bc948298cac 100644 --- a/PLATFORM_LIBS.md +++ b/PLATFORM_LIBS.md @@ -33,7 +33,7 @@ are a little different. There are many more platform libraries available for host and cross-compilation targets. `Kotlin/Native` distribution provides access to -`OpenGL`, `SDL`, `zlib` and other popular native libraries on +`OpenGL`, `zlib` and other popular native libraries on applicable platforms. On Apple platforms `objc` library is provided for interoperability with [Objective-C](https://en.wikipedia.org/wiki/Objective-C).