Skip to content

Conversation

@mawiesne
Copy link
Contributor

Thank you for contributing to Apache OpenNLP.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically main)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder?
  • Have you written or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check GitHub Actions for build issues and submit an update to your PR as soon as possible.

@mawiesne mawiesne self-assigned this Dec 26, 2025
@mawiesne mawiesne added the documentation Pull requests that update documentation label Dec 26, 2025
@rzo1
Copy link
Contributor

rzo1 commented Dec 26, 2025

Should we mention adding
--add-opens java.base/jdk.internal.loader=ALL-UNNAMED
as a JVM argument here? Otherwise, it may not be clear to users that OpenNLP will fall back to the bootstrap class path for model lookup instead of using the UCP class loader

Maybe something like:

Note: When running on Java 17+, the JVM argument
--add-opens java.base/jdk.internal.loader=ALL-UNNAMED
may be required. Without this option, OpenNLP uses the JVM bootstrap class path to locate models rather than the UCP class loader. 

For more advanced or non-standard class loading scenarios, using ClassGraph and implementing a custom provider may cover additional cases beyond the default UCP class loader or JVM bootstrap class path behavior.

- adds note on JVM argument since J17 and beyond
- improves formatting of all "Note:" text fragments to better highlight helpful context to the reader
@mawiesne
Copy link
Contributor Author

@rzo1: Most recent commit:

  • adds note on JVM argument since J17 and beyond
  • improves formatting of all "Note:" text fragments to better highlight helpful context to the reader

@mawiesne mawiesne merged commit 7b362c8 into main Dec 29, 2025
12 of 21 checks passed
@mawiesne mawiesne deleted the OPENNLP-1791-Document-the-use-of-ClassPathModelProvider-in-dev-manual branch December 29, 2025 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Pull requests that update documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants