Documentation | Draft: posix-users/input_and_output.rst: Update AIO Documentation (!26)

[Joel Sherrill (@joel)]

Merge request https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26 was reviewed by Joel Sherrill

--
  
Joel Sherrill started a new discussion on posix-users/input_and_output.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26#note_108482

 >  **STATUS CODES:**
 >  
 > +If the request is successfully enqueued, zero is returned.

Look at clock.rst to see how returning -1 and setting errno is done. I think the main thing you missed is the markup on errno itself.

`clock.rst:On error, this routine returns -1 and sets ``errno`` to one of the following:`

--
  
Joel Sherrill started a new discussion on posix-users/input_and_output.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26#note_108483

 > +This function returns immediately, and the read operation proceeds in
 > +the background.
 > +The parameters for the read are specified in the ``aiocbp`` structure.

Add a blank line above.

--
  
Joel Sherrill started a new discussion on posix-users/input_and_output.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26#note_108484

 >  **DESCRIPTION:**
 >  
 > +The ``aio_read()`` function is the asynchronous equivalent of ``read()``.

In the background hints at the thread(s) servicing requests. Are they mentioned anywhere?

--
  
Joel Sherrill started a new discussion on posix-users/input_and_output.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26#note_108485

 >  
 > +If the request is successfully enqueued, zero is returned.
 > +On error, -1 is returned, and errno is set appropriately.

Same errno comment.

--
  
Joel Sherrill started a new discussion on posix-users/input_and_output.rst: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26#note_108486

 >  **DESCRIPTION:**
 >  
 > +The ``aio_write()`` function is the asynchronous equivalent of ``write()``.

Same comments as above. A section on the configuration of the thread is needed. I don't remember what the user can specify.




-- 
View it on GitLab: https://gitlab.rtems.org/rtems/docs/rtems-docs/-/merge_requests/26
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20240628/4972984e/attachment-0001.htm>