Rs-incform: clarify what a relative path is and offer implementation suggestion #2272
Conversation
…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.
CppCoreGuidelines.md
Outdated
|
|
||
| ##### 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
|
Editors call: The Guidelines are focused on trying to encourage a set of best practices, and so can't bless all potentially reasonable practices. In this case, we don't want to encourage relative paths, especially with |
3 participants
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.