[NUTCH-2969] Javadoc: Javascript search is not working when built on JDK 11

• Type: Bug
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 1.19
• Fix Version/s: 1.19
• Component/s: build, documentation
• Patch Info: Patch Available
• Assignee: Sebastian Nagel
• Reporter: Sebastian Nagel
• Created: 22/Aug/22 13:17
• Updated: 13/Mar/24 14:51
• Resolved: 22/Aug/22 13:40

Description

Newer Java versions create a nice Javascript-backed search box on the Javadocs. When built on JDK 11 clicking on search results leads to 404 results with a /undefined/ path element in the URL. This is caused by JDK-8215291 - Nutch does not use Java modules.

The issue can be solved by adding --no-module-directories as argument to the javadoc command. However, this only works for JDK 11 and will break the javadoc build for later JDK versions, see JDK-8215582.

See also

• https://stackoverflow.com/questions/52326318/maven-javadoc-search-redirects-to-undefined-url
• https://github.com/crawler-commons/crawler-commons/pull/380

Notes:

• seen while preparing a release candidate for 1.19 (will quickly commit the solution)
• adding --no-module-directories should be conditional for JDK 11 only
  • ant: see condition
  • gradle:

    if (JavaVersion.current().isJava11()) {
      options.addBooleanOption("-no-module-directories", true)
    }
    

Issue Links

• links to: GitHub Pull Request #749