diff mbox series

[v2,1/7] chardev/char-fe: Document returned value on error

Message ID 20240722160745.67904-2-philmd@linaro.org
State Superseded
Headers show
Series util/fifo8: Rework fifo8_pop_buf() | expand

Commit Message

Philippe Mathieu-Daudé July 22, 2024, 4:07 p.m. UTC 
qemu_chr_fe_add_watch() and qemu_chr_fe_write[_all]()
return -1 on error. Mention it in the documentation.

Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
Reviewed-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk>
---
 include/chardev/char-fe.h | 3 +++
 1 file changed, 3 insertions(+)

Comments

Pierrick Bouvier July 22, 2024, 9:06 p.m. UTC | #1 
On 7/22/24 09:07, Philippe Mathieu-Daudé wrote:
> qemu_chr_fe_add_watch() and qemu_chr_fe_write[_all]()
> return -1 on error. Mention it in the documentation.
> 
> Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
> Reviewed-by: Mark Cave-Ayland <mark.cave-ayland@ilande.co.uk>
> ---
>   include/chardev/char-fe.h | 3 +++
>   1 file changed, 3 insertions(+)
> 
> diff --git a/include/chardev/char-fe.h b/include/chardev/char-fe.h
> index ecef182835..3310449eaf 100644
> --- a/include/chardev/char-fe.h
> +++ b/include/chardev/char-fe.h
> @@ -228,6 +228,7 @@ guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
>    * is thread-safe.
>    *
>    * Returns: the number of bytes consumed (0 if no associated Chardev)
> + *          or -1 on error.
>    */
>   int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len);
>   
> @@ -242,6 +243,7 @@ int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len);
>    * attempted to be written.  This function is thread-safe.
>    *
>    * Returns: the number of bytes consumed (0 if no associated Chardev)
> + *          or -1 on error.
>    */
>   int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len);
>   
> @@ -253,6 +255,7 @@ int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len);
>    * Read data to a buffer from the back end.
>    *
>    * Returns: the number of bytes read (0 if no associated Chardev)
> + *          or -1 on error.
>    */
>   int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len);
>   

Reviewed-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
diff mbox series

Patch

diff --git a/include/chardev/char-fe.h b/include/chardev/char-fe.h
index ecef182835..3310449eaf 100644
--- a/include/chardev/char-fe.h
+++ b/include/chardev/char-fe.h
@@ -228,6 +228,7 @@  guint qemu_chr_fe_add_watch(CharBackend *be, GIOCondition cond,
  * is thread-safe.
  *
  * Returns: the number of bytes consumed (0 if no associated Chardev)
+ *          or -1 on error.
  */
 int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len);
 
@@ -242,6 +243,7 @@  int qemu_chr_fe_write(CharBackend *be, const uint8_t *buf, int len);
  * attempted to be written.  This function is thread-safe.
  *
  * Returns: the number of bytes consumed (0 if no associated Chardev)
+ *          or -1 on error.
  */
 int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len);
 
@@ -253,6 +255,7 @@  int qemu_chr_fe_write_all(CharBackend *be, const uint8_t *buf, int len);
  * Read data to a buffer from the back end.
  *
  * Returns: the number of bytes read (0 if no associated Chardev)
+ *          or -1 on error.
  */
 int qemu_chr_fe_read_all(CharBackend *be, uint8_t *buf, int len);