Skip to content

Conversation

phepworth
Copy link

fs_open and fs_opendir rely on the structures in the first param being intialized. (The init functions are documented with the type declarations.) This simple documentation change mentions this need to initialize (and emphasizes it). (Users of similar APIs such as POSIX open and opendir do not expect this initialization need.)

Fixes #97205

Copy link

github-actions bot commented Oct 9, 2025

Hello @phepworth, and thank you very much for your first pull request to the Zephyr project!
Our Continuous Integration pipeline will execute a series of checks on your Pull Request commit messages and code, and you are expected to address any failures by updating the PR. Please take a look at our commit message guidelines to find out how to format your commit messages, and at our contribution workflow to understand how to update your Pull Request. If you haven't already, please make sure to review the project's Contributor Expectations and update (by amending and force-pushing the commits) your pull request if necessary.
If you are stuck or need help please join us on Discord and ask your question there. Additionally, you can escalate the review when applicable. 😊

@de-nordic
Copy link
Contributor

@kartben Are you ok with the formatting?

de-nordic
de-nordic previously approved these changes Oct 9, 2025
@de-nordic de-nordic added this to the v4.3.0 milestone Oct 9, 2025
@kartben
Copy link
Contributor

kartben commented Oct 9, 2025

@kartben Are you ok with the formatting?

It's a bit extreme to do both bold and emphasis IMO, so simply bold should be plenty fine :)

@phepworth
Copy link
Author

@kartben Are you ok with the formatting?

It's a bit extreme to do both bold and emphasis IMO, so simply bold should be plenty fine :)

I've found that a lot of fonts render bold with little extra weight making it not really very emphasized, so I went with bold-ital (equivalent, using the semantic tags). But I'm okay going with just bold. So I'll commit the suggested changes.

fs_open and fs_opendir rely on the structures in the first param
being intialized. (The init functions are documented with the type
declarations.) This simple documentation change mentions this need
to initialize (and emphasizes it). (Users of similar APIs such as
POSIX open and opendir do not expect this initialization need.)

Fixes zephyrproject-rtos#97205
Signed-off-by: Paul Hepworth <[email protected]>
Copy link

sonarqubecloud bot commented Oct 9, 2025

@kartben
Copy link
Contributor

kartben commented Oct 10, 2025

@kartben Are you ok with the formatting?

It's a bit extreme to do both bold and emphasis IMO, so simply bold should be plenty fine :)

I've found that a lot of fonts render bold with little extra weight making it not really very emphasized, so I went with bold-ital (equivalent, using the semantic tags). But I'm okay going with just bold. So I'll commit the suggested changes.

I think it's ok, right? https://builds.zephyrproject.io/zephyr/pr/97291/docs/doxygen/html/group__file__system__api.html#ga00c042be81b3785d868c0c7a680a2fcd

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Documentation Defect/Usability: fs_open() and fs_opendir() do not document important precondition: requirement to call _init() on context structs
4 participants