diff options
Diffstat (limited to 'docs/building.md')
| -rw-r--r-- | docs/building.md | 29 |
1 files changed, 19 insertions, 10 deletions
diff --git a/docs/building.md b/docs/building.md index 533cdcc8..e9d00a07 100644 --- a/docs/building.md +++ b/docs/building.md @@ -2,15 +2,22 @@ ## JDK version -To build Kotlin Serialization JDK version 9 or higher is required. +To build Kotlin Serialization JDK version 11 or higher is required. Make sure this is your default JDK (`JAVA_HOME` is set accordingly). This is needed to compile the `module-info` file included for JPMS support. +In case you are determined to use different JDK version, or experience problems with JPMS you can turn off compilation of modules +completely with `disableJPMS` property: add `disableJPMS=true` to gradle.properties or `-PdisableJPMS` to Gradle CLI invocation. + ## Runtime library Kotlin Serialization runtime library itself is a [multiplatform](http://kotlinlang.org/docs/reference/multiplatform.html) project. -To build library from the source and run all tests, use `./gradlew build`. Corresponding platform tasks like `jvmTest`, `jsTest` and so on are also available. +To build library from the source and run all tests, use `./gradlew build`. Corresponding platform tasks like `jvmTest`, `jsTest`, `nativeTest` and so on are also available. + +Project can be opened in in Intellij IDEA without additional prerequisites. +In case you want to work with Protobuf tests, you may need to run `./gradlew generateTestProto` beforehand. + -To install it into the local Maven repository, run `./gradlew publishToMavenLocal`. +To install runtime library into the local Maven repository, run `./gradlew publishToMavenLocal`. After that, you can include this library in arbitrary projects like usual gradle dependency: ```gradle @@ -23,17 +30,19 @@ dependencies { } ``` -To open project in Intellij IDEA, first run `./gradlew generateTestProto` from console. -Make sure you've set an option 'Use Gradle wrapper' on import to use a correct version of Gradle. -You may also need to mark `runtime/build/generated/source/proto/test/java` as 'Generated source root' to build project/run tests in IDE without delegating a build to Gradle. -This requires Kotlin 1.3.11 and higher. +Note that by default, only one Native target is built (the one that is the current host, e.g. `macosX64` on Intel Mac machines, `linuxX64` on linux machines, etc). +To compile and publish all Native artifacts, not only the host one, use Gradle property `native.deploy=true`. -To use snapshot version of compiler (if you have built it from sources), use flag `-Pbootstrap`. To compile and publish all Native artifacts, not only the host one, use `-Pnative.deploy=true`. +To use snapshot version of compiler (if you have built and install it from sources), use flag `-Pbootstrap`. +If you have built both Kotlin and Kotlin/Native compilers, set `KONAN_LOCAL_DIST` environment property to the path with Kotlin/Native distribution +(usually `kotlin-native/dist` folder inside Kotlin project). -`master` branch of library should be binary compatible with latest released compiler plugin. In case you want to test some new features from other branches, which are still in development and may not be compatible in terms of bytecode produced by plugin, you'll need to build the plugin by yourself. +`master` and `dev` branches of library should be binary compatible with latest released compiler plugin. In case you want to test some new features from other branches, +which are still in development and may not be compatible in terms of bytecode produced by plugin, you'll need to build the plugin by yourself. ## Compiler plugin Compiler plugin for Gradle/Maven and IntelliJ plugin, starting from Kotlin 1.3, are embedded into the Kotlin compiler. -Sources and steps to build it are located [here](https://github.com/JetBrains/kotlin/blob/master/plugins/kotlin-serialization/kotlin-serialization-compiler/). In general, you'll just need to run `./gradlew dist install` to get `1.x.255` versions of Kotlin compiler, stdlib and serialization plugins in the Maven local repository. +Sources and steps to build it are located [here](https://github.com/JetBrains/kotlin/tree/master/plugins/kotlinx-serialization). +In short, you'll just need to run `./gradlew dist install` to get `1.x.255-SNAPSHOT` versions of Kotlin compiler, stdlib and serialization plugins in the Maven local repository. |