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.

Sign up for GitHub

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

Jump to bottom

Make on TextLogLevel PascalCase (instead of SCREAMING CASE) to avoid clashes with preprocessor defines #4152

Merged
merged 6 commits into from Nov 6, 2023
Merged

Make on TextLogLevel PascalCase (instead of SCREAMING CASE) to avoid clashes with preprocessor defines #4152

merged 6 commits into from Nov 6, 2023

Conversation

Wumpf
Copy link
Member

@Wumpf Wumpf commented Nov 6, 2023 •
edited

What

Considered also just using lower case on these (nobody would do #define debug, ... RIGHT?). But they are enum - like constants so all-caps felt appropriate.

Checklist

  • I have read and agree to Contributor Guide and the Code of Conduct
  • I've included a screenshot or gif (if applicable)
  • I have tested demo.rerun.io (if applicable)
  • The PR title and labels are set such as to maximize their usefulness for the next release's CHANGELOG

@Wumpf Wumpf added 🪳 bug Something isn't working 🌊 C++ API C or C++ logging API labels Nov 6, 2023
abey79
abey79 approved these changes Nov 6, 2023
View reviewed changes
Copy link
Contributor

@abey79 abey79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was my preferred choice, so I'm gonna approve this ;)

@emilk
Copy link
Member

emilk commented Nov 6, 2023

Alternative: use PascalCase for constants in C++. See #4151 (comment)

@Wumpf
Copy link
Member Author

Wumpf commented Nov 6, 2023

Discussed this a bit more on internal Slack: there's some risk that Debug is a define as well, but we'll take that.
Our enums that are emitted for arrow union types already follow this convention so we can stick with that everywhere now

@Wumpf Wumpf changed the title Prefix constants on TextLogLevel with LEVEL_ to avoid clashes with preprocessor defines Make on TextLogLevel PascalCase (instead of SCREAMING CASE) to avoid clashes with preprocessor defines Nov 6, 2023
@Wumpf Wumpf requested a review from abey79 November 6, 2023 17:05
abey79
abey79 approved these changes Nov 6, 2023
View reviewed changes
Copy link
Contributor

@abey79 abey79 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@Wumpf Wumpf merged commit 8a97416 into main Nov 6, 2023
40 checks passed
@Wumpf Wumpf deleted the andreas/cpp/fix-potential-preprocessor-clash branch November 6, 2023 18:43
@Wumpf Wumpf mentioned this pull request Nov 6, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@abey79 abey79 abey79 approved these changes

Assignees
No one assigned
Labels
🪳 bug Something isn't working 🌊 C++ API C or C++ logging API include in changelog
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

C++ API, DEBUG symbol conflict
3 participants
@Wumpf @emilk @abey79