[ci][c++] fixed build/header_guard errors from cpplint
#7055
Conversation
StrikerRUS
requested review from
borchero,
guolinke,
jameslamb,
jmoralez and
shiyu1994
as code owners
src/network/linkers.h
Outdated
| #ifndef SRC_NETWORK_LINKERS_H_ | ||
| #define SRC_NETWORK_LINKERS_H_ |
There was a problem hiding this comment.
In line with the INCLUDE_ definitions, shouldn't this be
| #ifndef SRC_NETWORK_LINKERS_H_ | |
| #define SRC_NETWORK_LINKERS_H_ | |
| #ifndef SRC_LIGHTGBM_NETWORK_LINKERS_H_ | |
| #define SRC_LIGHTGBM_NETWORK_LINKERS_H_ |
There was a problem hiding this comment.
cpplint expects exactly these variables...
E.g.
...
src/treelearner/gpu_tree_learner.h:5: #ifndef header guard has wrong style, please use: SRC_TREELEARNER_GPU_TREE_LEARNER_H_ [build/header_guard] [5]
src/treelearner/gpu_tree_learner.h:287: #endif line should be "#endif // SRC_TREELEARNER_GPU_TREE_LEARNER_H_" [build/header_guard] [5]
...
include/LightGBM/utils/random.h:5: #ifndef header guard has wrong style, please use: INCLUDE_LIGHTGBM_UTILS_RANDOM_H_ [build/header_guard] [5]
include/LightGBM/utils/random.h:117: #endif line should be "#endif // INCLUDE_LIGHTGBM_UTILS_RANDOM_H_" [build/header_guard] [5]
There was a problem hiding this comment.
I see, thanks for the explanation!
There was a problem hiding this comment.
To clarify this... cpplint is just translating the directory structure into these identifiers. This file is at src/network/, not src/LightGBM/network/.
There was a problem hiding this comment.
Wait actually, before we merge... I thought about this more and realized that not having LIGHTGBM_ or similar in the name increases the risk of conflicts with definitions from other projects.
@StrikerRUS could you try the suggestion from cpplint/cpplint#44 (comment), to see if it'd result in cpplint being OK with everything prefixed with LIGHTGBM_?
There was a problem hiding this comment.
Thanks a lot for this nice workaround! Applied it in recent commits, please re-review when have time.
There was a problem hiding this comment.
Looks excellent, thank you!
Im glad we have a static analysis tool enforcing the presence of these guards and their exact spelling.
jameslamb
left a comment
jameslamb
left a comment
There was a problem hiding this comment.
Fine with me! I just recently spent time typing out a review comment on a PR about this (#7039 (comment)), I'm happy to have a linter catch it automatically instead.
jameslamb
left a comment
jameslamb
left a comment
There was a problem hiding this comment.
Sorry, just thought about this and I'm worried that generic names like SRC_APPLICATION_PREDICTOR_HPP_ could risk conflicting with other projects.
jameslamb
left a comment
jameslamb
left a comment
There was a problem hiding this comment.
Very happy to see this one go in, and in general to see all the recent activity here around making conventions easier to enforce and CI easier to maintain 😁
Refer to #7002.
I believe this linting rule is quite important because it helps to catch things like