Skip to content
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

[MJAVADOC-770] Implement legacy mode for Java 9+ #228

Merged
merged 1 commit into from
Sep 6, 2023

Conversation

hgschmie
Copy link
Contributor

@hgschmie hgschmie commented Sep 1, 2023

A lot of existing projects that don't use module descriptors but only
automatic module naming have moved past Java 8. However, when trying
to build docs, the javadoc plugin assumes that the project is
modularized and starts using the module path which leads to problems
with documentation generation.

This change introduces a new configuration setting <legacyMode>
which is turned off by default. When turning on, the javadoc plugin
will continue to construct just a classpath (and not a module path)
for the javadoc tool, even if the jdk version is 9 or greater.

Includes integration test and documentation.

Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [MJAVADOC-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace MJAVADOC-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean verify -Prun-its to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

A lot of existing projects that don't use module descriptors but only
automatic module naming have moved past Java 8. However, when trying
to build docs, the javadoc plugin assumes that the project is
modularized and starts using the module path which leads to problems
with documentation generation.

This change introduces a new configuration setting `<legacyMode>`
which is turned off by default. When turning on, the javadoc plugin
will continue to construct just a classpath (and not a module path)
for the javadoc tool, even if the jdk version is 9 or greater.

Includes integration test and documentation.
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.build.targetJdk>9</project.build.targetJdk>
<maven.compiler.source>${project.build.targetJdk}</maven.compiler.source>
<maven.compiler.target>${project.build.targetJdk}</maven.compiler.target>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why not maven.compiler.release in javadoc configuration a release options is used.

@hgschmie hgschmie merged commit dd350ed into apache:master Sep 6, 2023
28 checks passed
@hgschmie hgschmie deleted the mjavadoc-770 branch September 6, 2023 20:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants