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-751] No warnings for localized output #206

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

sitepark-schaeper
Copy link

This PR offers a solution for ticket MJAVADOC-751.
When parsing the output of the javadoc executable the english locale is expected (see containsWarnings and isInformationalOutput). In order for these checks to work the locale should be forced to english.

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.

Copy link
Contributor

@elharo elharo left a comment

Choose a reason for hiding this comment

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

This needs a test.

This might be a temporary workaround, but longer term I wonder if there's a non-command line way to invoke Javadoc these days.

@sitepark-schaeper
Copy link
Author

sitepark-schaeper commented Jul 4, 2023

This needs a test.

How would one go about testing this? Do we execute a test that executes the javadoc executable and check wether the output is english? There would also have to be a german/japanese/chinese environment to execute this test in as doing so in only english environments seems redundant.

This might be a temporary workaround, but longer term I wonder if there's a non-command line way to invoke Javadoc these days.

In Java 8 it should be as easy as:

javax.tools.ToolProvider.getSystemDocumentationTool().run(in, out, err, args)

And in Java 9+:

java.util.spi.ToolProvider.getSystemDocumentationTool().run(in, out, err, args);

But if we do that than we cannot influence the output locale anymore as it will always use Locale.default() (see here) and therefore cannot parse it reliably.

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