Skip to content

doc: fixes typo in disk_access.h #100304

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.

Sign up for GitHub

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
nashif merged 1 commit into from
Dec 3, 2025
Merged

doc: fixes typo in disk_access.h #100304

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions include/zephyr/storage/disk_access.h
View file
Open in desktop
Copy link
Contributor

@jfischer-no jfischer-no Dec 1, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit message, "This commit fixes two typos in the /zephyr/include/zephyr/storage/disk_access.h header file." is too long. There is no reason to mention /zephyr/include/zephyr/storage/disk_access in the commit message at all.

The commit title and message should be

include: storage: fixes typo in disk_access.h

Fix two typos in the disk access header file.

Signed-off-by: Aaron Delago <aarondelago@gmail.com>

Please fix commit message and title.

Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ int disk_access_status(const char *pdrv);
*
* Function to read data from disk to a memory buffer.
*
* Note: if he disk is of NVMe type, user will need to ensure data_buf
* Note: if the disk is of NVMe type, user will need to ensure data_buf
* pointer is 4-bytes aligned.
*
* @param[in] pdrv Disk name
Expand All @@ -87,7 +87,7 @@ int disk_access_read(const char *pdrv, uint8_t *data_buf,
*
* Function write data from memory buffer to disk.
*
* Note: if he disk is of NVMe type, user will need to ensure data_buf
* Note: if the disk is of NVMe type, user will need to ensure data_buf
* pointer is 4-bytes aligned.
*
* @param[in] pdrv Disk name
Expand Down