scripts/checkpatch: Check for patches adding #defines for libc APIs #60487
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
zephyrbot
requested review from
carlescufi,
jfischer-no,
keith-zephyr and
nashif
60 tasks
scripts/checkpatch.pl
Outdated
Comment on lines
596
to
598
| _POSIX_SOURCE| | ||
| _POSIX_C_SOURCE| | ||
| _XOPEN_SOURCE| | ||
| _XOPEN_SOURCE_EXTENDED| | ||
| _ISOC99_SOURCE| | ||
| _ISOC11_SOURCE| | ||
| _ATFILE_SOURCE| | ||
| _GNU_SOURCE| | ||
| _BSD_SOURCE| | ||
| _SVID_SOURCE| | ||
| _DEFAULT_SOURCE |
There was a problem hiding this comment.
Non-blocking - prefer you alphabetize these.
There was a problem hiding this comment.
Good call. done.
scripts/checkpatch.pl
Outdated
| @@ -6527,6 +6541,13 @@ sub process { | |||
| } | |||
| } | |||
|
|
|||
| # check for #defines of various API specifying things like _POSIX_C_SOURCE | |||
There was a problem hiding this comment.
Suggested change
| # check for #defines of various API specifying things like _POSIX_C_SOURCE | |
| # check for feature test macros that request C library API extensions, violating rules A.4 and A.5 |
There was a problem hiding this comment.
always best to say 'why' and not 'what' in your commit messages. thanks for the fix.
keith-packard
force-pushed
the
api-define-check-patch
branch
from
e596e94
to
b459761
Compare
All code in the Zephyr core must use only the Zephyr C library API according to rules A.4 and A.5. Such code is not permitted to request API extensions from the C library via any of the API request mechanisms. This addition to checkpatch.pl verifies that patches don't #define any of these: __STRICT_ANSI__ _POSIX_SOURCE _POSIX_C_SOURCE _XOPEN_SOURCE _ISOC99_SOURCE _ISOC11_SOURCE _ATFILE_SOURCE _GNU_SOURCE _BSD_SOURCE _SVID_SOURCE _DEFAULT_SOURCE Reference: zephyrproject-rtos#49922 Signed-off-by: Keith Packard <keithp@keithp.com>
keith-packard
force-pushed
the
api-define-check-patch
branch
from
b459761
to
56593bc
Compare
keith-zephyr
approved these changes
Jul 18, 2023
jfischer-no
approved these changes
Jul 18, 2023
kartben
reviewed
Jul 19, 2023
| our $api_defines = qr{(?x: | ||
| _ATFILE_SOURCE| | ||
| _BSD_SOURCE| | ||
| _DEFAULT_SOURCE |
There was a problem hiding this comment.
@keith-packard missing pipe might be the culprit?
There was a problem hiding this comment.
It actually got moved to the end of the pattern when I sorted the symbols upon request from a reviewer... Checkout #60551 for the fix.
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.
All code in the Zephyr core must use only the Zephyr C library API according to rules A.4 and A.5. Such code is not permitted to request API extensions from the C library via any of the API request mechanisms.
This addition to checkpatch.pl verifies that patches don't #define any of these:
Reference: #49922