diff options
| author | Nicklas Ansman Giertz <nicklas@ansman.se> | 2020-10-07 12:15:18 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-10-07 19:15:18 +0300 |
| commit | 3cb61fc44bec51f85abde11f83bc5f556e5e313a (patch) | |
| tree | 8b116cdaaa8342823bc9d40707c7cd9ecb0ae937 /CONTRIBUTING.md | |
| parent | 4c28f94ab69627303715d78bfb395c44603eeefd (diff) | |
| download | kotlinx.coroutines-3cb61fc44bec51f85abde11f83bc5f556e5e313a.tar.gz | |
Clarify the env requirements in CONTRIBUTING.md (#2281)
The wording is a bit confusing and does not clearly indicate that you can set `JDK_XX` to whatever JDK version you want.
Also add a shell snippet
Co-authored-by: Roman Elizarov <elizarov@gmail.com>
Co-authored-by: EdwarDDay <4127904+EdwarDDay@users.noreply.github.com>
Diffstat (limited to 'CONTRIBUTING.md')
| -rw-r--r-- | CONTRIBUTING.md | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index abd458e6..29187c83 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -79,9 +79,16 @@ to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Grad * JDK >= 11 referred to by the `JAVA_HOME` environment variable. * JDK 1.6 referred to by the `JDK_16` environment variable. - It is OK to have `JDK_16` pointing to `JAVA_HOME` for external contributions. + It is OK to have `JDK_16` pointing to a non 1.6 JDK (e.g. `JAVA_HOME`) for external contributions. * JDK 1.8 referred to by the `JDK_18` environment variable. Only used by nightly stress-tests. - It is OK to have `JDK_18` pointing to `JAVA_HOME` for external contributions. + It is OK to have `JDK_18` to a non 8 JDK (e.g. `JAVA_HOME`) for external contributions. + +For external contributions you can for example add this to your shell startup scripts (e.g. `~/.zshrc`): +```shell +# This assumes JAVA_HOME is set already to a JDK >= 11 version +export JDK_16="$JAVA_HOME" +export JDK_18="$JAVA_HOME" +``` ### Running the Knit tool |