[incubator-nuttx] branch master updated: Update the file_write description in fs.h

[xi...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

xiaoxiang pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-nuttx.git


The following commit(s) were added to refs/heads/master by this push:
     new 3abdc35  Update the file_write description in fs.h
3abdc35 is described below

commit 3abdc352a8eeb178f565fcd57a51f39f039d7d2e
Author: junmin-kim <ju...@samsung.com>
AuthorDate: Wed Jan 8 14:20:29 2020 +0900

    Update the file_write description in fs.h
    
    Replace with the description taken from fs_write.c
    
    Signed-off-by: junmin-kim <ju...@samsung.com>
---
 include/nuttx/fs/fs.h | 20 ++++++++++++++++++--
 1 file changed, 18 insertions(+), 2 deletions(-)

diff --git a/include/nuttx/fs/fs.h b/include/nuttx/fs/fs.h
index e90f3e2..641a3ce 100644
--- a/include/nuttx/fs/fs.h
+++ b/include/nuttx/fs/fs.h
@@ -1073,8 +1073,24 @@ ssize_t nx_read(int fd, FAR void *buf, size_t nbytes);
  *
  * Description:
  *   Equivalent to the standard write() function except that is accepts a
- *   struct file instance instead of a file descriptor.  Currently used
- *   only by aio_write();
+ *   struct file instance instead of a file descriptor.  It is functionally
+ *   equivalent to write() except that in addition to the differences in
+ *   input paramters:
+ *
+ *  - It does not modify the errno variable,
+ *  - It is not a cancellation point, and
+ *  - It does not handle socket descriptors.
+ *
+ * Input Parameters:
+ *   filep  - Instance of struct file to use with the write
+ *   buf    - Data to write
+ *   nbytes - Length of data to write
+ *
+ * Returned Value:
+ *  On success, the number of bytes written are returned (zero indicates
+ *  nothing was written).  On any failure, a negated errno value is returned
+ *  (see comments withwrite() for a description of the appropriate errno
+ *  values).
  *
  ****************************************************************************/