Skip to content

Commit

Permalink
Actualize building instructions (#2639)
Browse files Browse the repository at this point in the history
There's no `native.deploy` flag anymore.
  • Loading branch information
sandwwraith authored Apr 24, 2024
1 parent d0ae697 commit e6fb440
Showing 1 changed file with 7 additions and 10 deletions.
17 changes: 7 additions & 10 deletions docs/building.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
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
In case you are determined to use a different JDK version or experience problems with JPMS, you can turn off compilation of module-info files
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`, `nativeTest` and so on are also available.
To build the library from the source and run all tests, use `./gradlew build`. Corresponding platform tasks like `jvmTest,` `jsTest,` `macosArm64Test`, and so on are also available.

Project can be opened in in Intellij IDEA without additional prerequisites.
The project can be opened in IntelliJ IDEA without additional prerequisites.
In case you want to work with Protobuf tests, you may need to run `./gradlew generateTestProto` beforehand.


Expand All @@ -30,19 +30,16 @@ dependencies {
}
```

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 and install it from sources), use flag `-Pbootstrap`.
To use snapshot version of compiler (if you have built and installed 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` 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,
The `master` and `dev` branches of the library should be binary compatible with the 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.
Compiler plugins 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/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.
In short, you'll just need to run `./gradlew dist install` to get `2.x.255-SNAPSHOT` versions of Kotlin compiler, stdlib, and serialization plugins in the Maven local repository.

0 comments on commit e6fb440

Please sign in to comment.