Skip to content

Commit 7003e9a

Browse files
ansmanelizarovEdwarDDay
authored andcommitted
Clarify the env requirements in CONTRIBUTING.md (Kotlin#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 <[email protected]> Co-authored-by: EdwarDDay <[email protected]>
1 parent c6f3197 commit 7003e9a

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

CONTRIBUTING.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,16 @@ to Gradle (in Preferences -> Build, Execution, Deployment -> Build Tools -> Grad
7979

8080
* JDK >= 11 referred to by the `JAVA_HOME` environment variable.
8181
* JDK 1.6 referred to by the `JDK_16` environment variable.
82-
It is OK to have `JDK_16` pointing to `JAVA_HOME` for external contributions.
82+
It is OK to have `JDK_16` pointing to a non 1.6 JDK (e.g. `JAVA_HOME`) for external contributions.
8383
* JDK 1.8 referred to by the `JDK_18` environment variable. Only used by nightly stress-tests.
84-
It is OK to have `JDK_18` pointing to `JAVA_HOME` for external contributions.
84+
It is OK to have `JDK_18` to a non 8 JDK (e.g. `JAVA_HOME`) for external contributions.
85+
86+
For external contributions you can for example add this to your shell startup scripts (e.g. `~/.zshrc`):
87+
```shell
88+
# This assumes JAVA_HOME is set already to a JDK >= 11 version
89+
export JDK_16="$JAVA_HOME"
90+
export JDK_18="$JAVA_HOME"
91+
```
8592

8693
### Running the Knit tool
8794

0 commit comments

Comments
 (0)