Rs-incform: clarify what a relative path is and offer implementation suggestion #2272
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
…suggestion - Add and example clarifying that #include "utilities.hpp" or #include "../module1/utilities.hpp" can resolve to same file and are both relative. - With this clarification, enforcement becomes very easy because compilers can report the absolute path of the file being reference.
jwakely
reviewed
Apr 18, 2025
jwakely
reviewed
Apr 18, 2025
CppCoreGuidelines.md
Outdated
| @@ -19629,9 +19629,18 @@ Failing to follow this results in difficult to diagnose errors due to picking up | |||
|
|
|||
| Library creators should put their headers in a folder and have clients include those files using the relative path `#include <some_library/common.h>` | |||
|
|
|||
| ##### Project Example | |||
|
|
|||
| Consider a project with modules where src/module2/foo.cpp is using src/module1/utilities.hpp: | |||
There was a problem hiding this comment.
I don't think you're referring to the C++ language feature 'modules', so this is a poor choice of wording.
There was a problem hiding this comment.
Correct. I updated it to use the more generic term component (a modular, self-contained unit of software that encapsulates specific functionality). Components may be built into .so/.dll's and linked or loaded by the main executable. Alternatively, all sources of multiple components can be compiled into one executable. Should I a definition of component to be super clear, or is the term component enough?
…e before enforcement tip
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.
The Prefer the quoted form of
#includefor files relative to the including file and the angle bracket form everywhere else is nice. This pull request is to clarify what relative path is, which then makes it very easy to enforce:Add and example clarifying that #include "utilities.hpp" or #include "../module1/utilities.hpp" can resolve to same file and are both relative.
With this clarification, enforcement becomes very easy because compilers can report the absolute path of the file being reference.