-
-
Notifications
You must be signed in to change notification settings - Fork 642
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Mention full JDK as a prerequisite #3340
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for finding this missing spot!
Make sure you have a complete JDK installation. Many Linux distributions | ||
provide only the runtime support by default. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Make sure you have a complete JDK installation. Many Linux distributions | |
provide only the runtime support by default. | |
On Linux you are also strongly advised to make sure that JDK sources and javadocs are installed. | |
You can find example commands in xref:troubleshooting.adoc#navigation-to-jdk-sources-doesnt-work[Troubleshooting]. |
I took that from https://docs.cider.mx/cider/about/compatibility.html#java . Probably it's a good idea so simply have the same paragraph/link twice.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally the full JDK is needed only if people are using cider-nrepl
, but I guess that's most of the users anyways.
So, what will we have here as the final wording? |
I'd prefer something that is clear to newcomers, who are the most in need of installation instructions. That's people who know very little about CIDER and probably even nREPL. When I read "strongly advised to make sure that JDK sources and javadocs are installed", I am left wondering why JDK sources and javadocs matter for CIDER, given that they are "strongly advised" but not required. If you want to send the message that experienced users should investigate this for themselves, then I'd write "Unless you know what you are doing, install a full JDK with sources and javadocs". |
Thanks for the input! I changed
I considered this one but it kind of invites adventurous devs to try random things? 😄 |
CIDER apparently needs a full JDK (see #3339), rather than just a Java runtime. This is not obvious, so it should be stated explicitly in the list of prerequisites.
Before submitting the PR make sure the following things have been done (and denote this
by checking the relevant checkboxes):
(the remaining items do not apply as only the documentation is modified).