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

Tweak header guard names #45

Open
wermos opened this issue Sep 30, 2021 · 0 comments
Open

Tweak header guard names #45

wermos opened this issue Sep 30, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@wermos
Copy link
Collaborator

wermos commented Sep 30, 2021 •
edited
Loading

Any header guard of the form __ABCD_H__ is reserved in Linux.

If we change our header guard names from __ABCD_H__ to PHYSICC_ABCD_H (or PHYSICC_ABCD_HPP), then we completely eliminate the (somewhat minute) chances of a header guard name clash, and make it easier to determine what project the header guards belong to.

We can even name the Light header guards to LIGHT_ABCD_H to minimize the friction when we pull the Physicc code out of the Light repo and make it into its own submodule.

This kind of naming scheme is not new, and is in use in large projects like Eigen.
@wermos wermos added the enhancement New feature or request label Sep 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@wermos