Skip to content

Commit

Permalink
Clarify specifying a version for the kotlin-dsl plugin in the doc
Browse files Browse the repository at this point in the history
Signed-off-by: Paul Merlin <paul@gradle.com>
  • Loading branch information
eskatos committed Apr 25, 2019
1 parent 2d7185e commit 23c76de
Showing 1 changed file with 6 additions and 0 deletions.
6 changes: 6 additions & 0 deletions subprojects/docs/src/docs/userguide/kotlin_dsl.adoc
Expand Up @@ -716,6 +716,12 @@ All three libraries and their dependencies are bundled with Gradle, so these dep
* Configures the Kotlin compiler with the same settings that are used for Kotlin DSL scripts, ensuring consistency between your build logic and those scripts.
* Enables support for <<kotdsl:precompiled_plugins,precompiled script plugins>>.

[CAUTION]
.Avoid specifying a version for the `kotlin-dsl` plugin
====
Each Gradle release is meant to be used with a specific version of the `kotlin-dsl` plugin and compatibility between arbitrary Gradle releases and `kotlin-dsl` plugin versions is not guaranteed. Using an unexpected version of the `kotlin-dsl` plugin in a build will emit a warning and can cause hard to diagnose problems.
====

This is the basic configuration you need to use the plugin:

.Applying the Kotlin DSL Plugin to a `buildSrc` project
Expand Down

0 comments on commit 23c76de

Please sign in to comment.