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

Document conditional directives in x/codegen/J9TreeEvaluator.cpp #20470

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

Conversation

dylanjtuttle
Copy link
Contributor

Add missing comments to #else and #endif directives in runtime/compiler/x/codegen/J9TreeEvaluator.cpp to document the conditions that they are closing, improving readability and aligning with the OMR C and C++ Coding Standards.

Add missing comments to #else and #endif directives to document
the conditions that they are closing, to improve readability

Signed-off-by: Dylan Tuttle <[email protected]>
@dylanjtuttle
Copy link
Contributor Author

@hzongaro Could I get a review on this if you get a chance? It's only documentation, so it hopefully shouldn't require any PR builds.

@hzongaro
Copy link
Member

hzongaro commented Nov 1, 2024

closing, improving readability and aligning with the OMR C and C++ Coding Standards.

Thanks, @dylanjtuttle! Although that coding standard document doesn't mention this, the compiler source code in OpenJ9 and OMR has always followed — though not especially rigidly — its own coding style.

Having said that, this particular change can certainly help with readability. @dsouzai, is this something that should be considered in the context of issue eclipse-omr/omr#7434? I'm assuming the final format selected for OMR's compiler code will eventually strongly influence formatting of compiler code in OpenJ9.

@dylanjtuttle, may I suggest you add a comment to the OMR issue?

@dsouzai
Copy link
Contributor

dsouzai commented Nov 1, 2024

@dsouzai, is this something that should be considered in the context of issue eclipse-omr/omr#7434? I'm assuming the final format selected for OMR's compiler code will eventually strongly influence formatting of compiler code in OpenJ9.

Yeah it's probably a good idea, especially since this exact thing was explicitly discussed in the original OMR architecture meeting that introduced the code formatting proposal.

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

Successfully merging this pull request may close these issues.

3 participants