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
Annotations to support config/counters documentation/validation #1593
Draft
nbradac
wants to merge
21
commits into
real-logic:master
Choose a base branch
from
nbradac:config_doc_gen
base: master
Could not load branches
Branch not found: {{ refName }}
Could not load tags
Nothing to show
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Conversation
This file contains 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
aeron-annotations/src/main/java/io/aeron/config/docgen/GenerateConfigDocTask.java
Fixed
Show fixed
Hide fixed
nbradac
changed the title
[Java] initial work
Annotations to support config/counters documentation/validation
Apr 30, 2024
aeron-annotations/src/main/java/io/aeron/config/docgen/GenerateConfigDocTask.java
Fixed
Show fixed
Hide fixed
aeron-annotations/src/main/java/io/aeron/config/docgen/ConfigDocGenerator.java
Fixed
Show fixed
Hide fixed
nbradac
commented
May 9, 2024
aeron-annotations/src/main/java/io/aeron/config/ConfigInfo.java
Outdated
Show resolved
Hide resolved
aeron-annotations/src/main/java/io/aeron/config/validation/Validator.java
Fixed
Show fixed
Hide fixed
aeron-annotations/src/main/java/io/aeron/config/validation/Validator.java
Fixed
Show fixed
Hide fixed
mikeb01
reviewed
May 20, 2024
} | ||
catch (final Exception e) | ||
{ | ||
e.printStackTrace(System.err); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we exit this method here? If we've run into a problem is valid to continue processing.
|
||
private String message; | ||
|
||
private ByteArrayOutputStream ba_out; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Variable naming convention, please use baOut
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Very much a work in progress. Much of this is still pretty rough. But I think the general approach is more or less validated (it works at least...). Biggest/current open questions (for me) are around the right way to get this integrated correctly into the build.
There's now a task that validates the aeron counters between java and C