Skip to content

shell/saul: Rename internal functions #21416

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 16, 2025
Merged

Conversation

Teufelchen1
Copy link
Contributor

Contribution description

Hello 🐶,

this renames internal functions of the shell command module saul_reg.
As C does not have proper name spacing, reusing names is risky. Especially well known names such as read and write.
I am not sure how I triggered the issue for me, as the functions are static but well...

Testing procedure

If the CI doesn't find anything and we get a regression, then there is a coverage hole in our tests :>
Otherwise: build & flash the default example and use saul I guess.

Issues/PRs references

@github-actions github-actions bot added the Area: sys Area: System label Apr 16, 2025
@benpicco benpicco added Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR labels Apr 16, 2025
@riot-ci
Copy link

riot-ci commented Apr 16, 2025

Murdock results

✔️ PASSED

38b0287 shell/saul: Rename internal functions

Success Failures Total Runtime
10299 0 10299 11m:17s

Artifacts

@maribu maribu added this pull request to the merge queue Apr 16, 2025
@maribu
Copy link
Member

maribu commented Apr 16, 2025

I am not sure how I triggered the issue for me, as the functions are static but well...

Probably because somehow this got included: https://man7.org/linux/man-pages/man2/read.2.html

I think it is indeed good practice to not use standard POSIX function names in your C base.

Merged via the queue into RIOT-OS:master with commit 7ecf028 Apr 16, 2025
28 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area: sys Area: System CI: ready for build If set, CI server will compile all applications for all available boards for the labeled PR Impact: minor The PR is small in size and might only require a quick look of a knowledgeable reviewer
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants