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-652] - Dependencies on the patch-module path #139

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

philsmart
Copy link

Add parameter to turn off support for the module path even if supported by the environment.

To bypass module-path and patch-module-path arguments from being created for Javadoc even if using Java 9 and your project declares support for modules e.g. includes an automatic module name.

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

  • https://issues.apache.org/jira/browse/MJAVADOC-652
  • 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.

Add parameter to turn off support for the module path even if supported by the environment
@slawekjaranowski
Copy link
Member

Please add example project to IT test with twice executions - one without and one with new parameter.
you can prepare invoker.properties

invoker.goals.1 = ...
invoker.buildResult.1 = failure

invoker.goals.2 = ... -DdisableModulePath=true
invoker.buildResult.2 = success

@philsmart
Copy link
Author

I added the test project. However, both testing conditions will return success. The build is not actually failing (in the test project); you need to inspect the Javadoc @options file to see the patch-module discrepancy (which is causing a problem in a much larger project I work on).

@slawekjaranowski
Copy link
Member

It is not good that we can't reproduce problem in test project ...
We must find a way to reproduce, in other case that is a probability that problem is somewhere else.

@philsmart
Copy link
Author

philsmart commented May 13, 2022

The issue of it using the patch-module path is reproducible in the test project. But I will see if I can get it to fail during the Javadoc construction

Copy link
Contributor

@rfscholte rfscholte left a comment

Choose a reason for hiding this comment

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

there should be no need for this extra parameter

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants