fs: correct comments for fs_read() and write()
PATCH 1/1 fs: correct comments for fs_read() and write()
The existing comments where confusing read and write. The comment for fs_write() had:
"@addr: The address to read into"
So let's rework the comments and format them in Sphinx style.
Signed-off-by Heinrich Schuchardt <[email protected]>
---
I will take the patch via the EFI tree.
--- include/fs.h | 39 +++++++++++++++++++++------------------ 1 file changed, 21 insertions(+), 18 deletions(-)
include/fs.h +21 -18
@@ -71,30 +71,33 @@ int fs_exists(const char *filename);*/ int fs_size (const char *filename,loff_t *size); -/* -* fs_read - Read file from the partition previously set by fs_set_blk_dev() -* Note that not all filesystem types support either/both offset!=0 or len!=0. +/** +* fs_read() - read file from the partition previously set by fs_set_blk_dev() +* +* Note that not all filesystem drivers support either or both of offset != 0 +* and len != 0. * -* @filename: Name of file to read from -* @addr: The address to read into -* @offset: The offset in file to read from -* @len: The number of bytes to read. Maybe 0 to read entire file -* @actread: Returns the actual number of bytes read -* @return 0 if ok with valid *actread, -1 on error conditions +* @filename: full path of the file to read from +* @addr: address of the buffer to write to +* @offset: offset in the file from where to start reading +* @len: the number of bytes to read. Use 0 to read entire file. +* @actread: returns the actual number of bytes read +* Return: 0 if OK with valid *actread, -1 on error conditions */ int fs_read (const char *filename,ulong addr,loff_t offset,loff_t len,loff_t *actread); -/* -* fs_write - Write file to the partition previously set by fs_set_blk_dev() -* Note that not all filesystem types support offset!=0. +/** +* fs_write() - write file to the partition previously set by fs_set_blk_dev() +* +* Note that not all filesystem drivers support offset != 0. * -* @filename: Name of file to read from -* @addr: The address to read into -* @offset: The offset in file to read from. Maybe 0 to write to start of file -* @len: The number of bytes to write -* @actwrite: Returns the actual number of bytes written -* @return 0 if ok with valid *actwrite, -1 on error conditions +* @filename: full path of the file to write to +* @addr: address of the buffer to read from +* @offset: offset in the file from where to start writing +* @len: the number of bytes to write +* @actwrite: returns the actual number of bytes written +* Return: 0 if OK with valid *actwrite, -1 on error conditions */ int fs_write (const char *filename,ulong addr,loff_t offset,loff_t len,loff_t *actwrite);
--
2.20.1
PATCH 1/1 fs: correct comments for fs_read() and write()
Quoted 7 lines · Heinrich Schuchardt
The existing comments where confusing read and write. The comment for
fs_write()had:
"@addr: The address to read into"So let's rework the comments and format them in Sphinx style.
Signed-off-by Heinrich Schuchardt <[email protected]>
Applied to u-boot/master, thanks!
Signature · 8 lines
Tom -------------- next part -------------- A non-text attachment was scrubbed... Name: signature.asc Type: application/pgp-signature Size: 819 bytes Desc: not available URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190503/1c80b7cd/attachment.sig>