SOLR-17697: visually flag required options#4433
Merged
epugh merged 3 commits intoMay 18, 2026
Merged
Conversation
github-actions
Bot
added
documentation
janhoy
approved these changes
May 16, 2026
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
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.
https://issues.apache.org/jira/browse/SOLR-17697
Description
Generated Options documentation doesn't reflect if they are required or not, which is a key thing users want to know!
Solution
Me and claude found out that there are some limitations in Picocli's Man Page Generator, and so we solved it with some more gradle code. I opened up remkop/picocli#2519 for a more permanent solution.
Here is a screenshot with current ref guide on left, and with this change, on the right:
Tests
manual