Don't refer to project headers in *.cpp files as system headers. #4005
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
Just textual update of includes in *.cpp files, no code changes. This implements style-guide rule https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes We do use angle bracktes for inlucdes within the headers that are also system-installed with angle brackets so that they can be used in such context. This is the reason why angle brackets made it into the project. However, within our own _implementation_ we should refer to the local project headers as such, with #include "quoted.h" instead of angled. Within each compilation unit, the corresponding declaration header should be the very first header (that way we can detect quickly if they are self-contained). Both of these issues are addressed here. The includes in _header_ files are not addressed at this point, they are still included as system headers to accomodate the original use-case of installing them system-wide.
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.
Just textual update of includes in *.cpp files, no code changes.
This implements style-guide rule
https://google.github.io/styleguide/cppguide.html#Names_and_Order_of_Includes
We do use angle bracktes for inlucdes within the headers that are also system-installed with angle brackets so that they can be used in such context. This is the reason why angle brackets made it into the project.
However, within our own implementation we should refer to the local project headers as such, with #include "quoted.h" instead of angled.
Within each compilation unit, the corresponding declaration header should be the very first header (that way we can detect quickly if they are self-contained).
Both of these issues are addressed here.
The includes in header files are not addressed at this point, they are still included as system headers to accomodate the original use-case of installing them system-wide.