docs: cross-platform compatibility updates #2331
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
maxandersen
requested changes
Nov 22, 2025
|
|
||
| === Runtime Options (Cross-Platform Compatibility) | ||
|
|
||
| Most standard Java VM (JVM) options are generic and can be used on all Java versions and on all OS platforms, but some JVM options are platform-specific. If a OS specific option is used on a OS platform that do not support the specific option, JBang will fail to start and an error message will be displayed by the JVM. To prevent this from happening, also add JVM option |
Collaborator
There was a problem hiding this comment.
It's not really jbang failing but the java.
Collaborator
|
Besides the jbang vs Java fail looks good. Btw is this also relevant for compile options ? |
Contributor
Author
Thanks.
No. It is JVM specific. One could pass the option form javac to the JVM running javac
but I don't think that is what you have in mind. |
maxandersen
approved these changes
Nov 22, 2025
Collaborator
|
@all-contributors add @wfouche for docs |
Contributor
|
@wfouche already contributed before to doc |
Collaborator
|
I've updated to use the IgnoreUnrecognizedVMOptions flag so it should work on more platforms now. @wfouche @quintesse can you verify on other platforms than mac? |
Contributor
Author
|
PR jbangdev/jbang-examples#15 works without issues on Windows 11 and Linux (Debian 13, AMD64). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Document the use of JVM runtime option -XX:+IgnoreUnrecognizedVMOptions to allow platform specific options to be used generically across platforms.