Update developer_guide.md with new guidance on quoted internal includes
#15238
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
davidwendt
approved these changes
Mar 5, 2024
ttnghia
reviewed
Mar 6, 2024
| * We use clang-format for grouping and sorting headers automatically. See the | ||
| `cudf/cpp/.clang-format` file for specifics. | ||
| * Use `<>` for all includes except for internal headers that are not in the `include/cudf` | ||
| directory. In other words, if it is a cuDF internal header (e.g. in the `src` or `test` |
There was a problem hiding this comment.
Does this apply to cudf_test? That means we will need to change all test files to use #include "cudf_test/...".
There was a problem hiding this comment.
No, because cudf_test is a library with public headers in include/cudf_test. Therefore includes of its public headers should use <>. Moreover, there is a separate regex grouping for cudf_test in .clang-format.
There was a problem hiding this comment.
Added clarification of this (and nvtext) in the guide.
vuule
approved these changes
Mar 6, 2024
|
/merge |
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.
Description
Follow up to #15063 to add new guidance for quoting includes of internal headers from
srcpaths. Also covers clang-format include grouping.Also fixes a single include that was added with
<>recently that should be"". #15063 updated all includes to match the guidance in this PR (changing a lot of<>to""for includes fromsrc/....Checklist