solr icon indicating copy to clipboard operation
solr copied to clipboard

SOLR-17223 Remove hardcoded java version in renderJavadoc task

Open janhoy opened this issue 1 year ago • 6 comments

Oneliner :)

janhoy avatar Apr 03 '24 08:04 janhoy

The approach you used did not work in Lucene because inputs/outputs and "rootProject" was not known in the task instance. Here it is different, if it works, +1

uschindler avatar Apr 03 '24 08:04 uschindler

P.S.: I missed this in Lucene, there is also a reference to the JDK Javadocs and its package file above. We may also make this dynamic.

The package file needs to be placed in the gradle folder so the execution of Javadocs works without network connection. I will make a PR to Lucene about this.

uschindler avatar Apr 03 '24 08:04 uschindler

Will take another look at the javadoc links. What gradle command do I run to build javadocs that should have substituted local javadocs? Do I have to unzip some jdk javadoc file into my git checkout and then run gradlew javadocs?

janhoy avatar Apr 03 '24 11:04 janhoy

Will take another look at the javadoc links. What gradle command do I run to build javadocs that should have substituted local javadocs? Do I have to unzip some jdk javadoc file into my git checkout and then run gradlew javadocs?

See those commits: https://github.com/apache/lucene/commit/dfce6ee8d29da75b67fa0679e192c4defa9f9f78 and https://github.com/apache/lucene/commit/5aaaeaee391934363b207718c6eea7853db3ca81

The coresponding file can be found in the ZIP download of JDK (it may be named 'package-list' or 'element-list'. You can also get it from the official Javadocs page by appending that filename instaed of index.html. Maybe we should generate an automated task to regenerate it. The Java 21 one is here: https://docs.oracle.com/en/java/javase/21/docs/api/element-list

To generate the javadocs on Lucene, run gradlew documentation, this will build both local Javadocs as well as full site. If you want to quickly test a single project use: gradlew :solr:xyz:javadoc

uschindler avatar Apr 03 '24 15:04 uschindler

This PR had no visible activity in the past 60 days, labeling it as stale. Any new activity will remove the stale label. To attract more reviewers, please tag someone or notify the [email protected] mailing list. Thank you for your contribution!

github-actions[bot] avatar Jun 05 '24 00:06 github-actions[bot]

@janhoy is this ready for merging?

epugh avatar Jun 19 '24 17:06 epugh

This PR has had no activity for 60 days and is now labeled as stale. Any new activity or converting it to draft will remove the stale label. To attract more reviewers, please tag people who might be familiar with the code area and/or notify the [email protected] mailing list. Thank you for your contribution!

github-actions[bot] avatar Aug 20 '24 00:08 github-actions[bot]

I just merged this.

uschindler avatar Aug 20 '24 07:08 uschindler