Use local includes for Cascade files #47
Closed
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
Following the standard practices we've applied to Derecho, #includes for headers within the Cascade library should use quotes rather than angle brackets and appear in a separate group before all non-Cascade includes. The Derecho includes should also be grouped before the standard library includes, since Derecho is more like a related sub-component of Cascade than a third-party library (they share a namespace). This is a manual cherry-pick of commit 5758256 from the cascade_chain branch, where I already made this change a while ago.
|
As we discovered while working on Derecho PR #276, using quotes instead of angle brackets actually should not have any effect on the include search path in most of these cases, so these changes are counterproductive. |
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.
This is another minor build-system improvement I made in my cascade_chain branch and wanted to port to the main branch. When writing a C++ library, the #include directives for the same library's files should use quotes rather than angle brackets, and they should appear in a separate group at the top of the include list. This helps the compiler find the "local" version of the files within the workspace instead of the "installed" version of the files (in a system include path) when you need to rebuild the library after already having installed it. Some Cascade files were already following this standard, but some weren't.