Skip to content

Commit

Permalink
Update .md documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PavelPunegov committed Jan 30, 2019
1 parent 715e9af commit ab26e26
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 10 deletions.
17 changes: 11 additions & 6 deletions FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
<div class="sample" markdown="1" theme="idea" mode="groovy">

```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
}
}
```

Expand All @@ -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:

<details>

Expand Down
2 changes: 0 additions & 2 deletions HACKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ To update the blackbox compiler tests set TeamCity build number in `gradle.prope

testKotlinVersion=<build number>

and run `./gradlew update_external_tests`

* **-Pfilter** allows one to choose test files to run.

./gradlew -Pfilter=overflowLong.kt run_external
Expand Down
2 changes: 1 addition & 1 deletion LIBRARIES.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ For example, using the simple `libgit2.def` native library definition file provi
<div class="sample" markdown="1" theme="idea" mode="shell">

```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
```

</div>
Expand Down
2 changes: 1 addition & 1 deletion PLATFORM_LIBS.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit ab26e26

Please sign in to comment.