qemu-devel.nongnu.org archive mirror
 help / color / mirror / Atom feed
From: "Philippe Mathieu-Daudé" <philmd@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Paolo Bonzini" <pbonzini@redhat.com>,
	"Peter Maydell" <peter.maydell@linaro.org>,
	"Alex Bennée" <alex.bennee@linaro.org>,
	"Marc-André Lureau" <marcandre.lureau@redhat.com>,
	"Philippe Mathieu-Daudé" <philmd@linaro.org>
Subject: [PATCH v3 02/10] chardev/char-io: Add @docstrings for io_channel_send[_full]()
Date: Wed, 12 Nov 2025 14:41:35 +0100	[thread overview]
Message-ID: <20251112134143.27194-3-philmd@linaro.org> (raw)
In-Reply-To: <20251112134143.27194-1-philmd@linaro.org>

Signed-off-by: Philippe Mathieu-Daudé <philmd@linaro.org>
---
 include/chardev/char-io.h | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/include/chardev/char-io.h b/include/chardev/char-io.h
index ac379ea70e3..5b181be6a0b 100644
--- a/include/chardev/char-io.h
+++ b/include/chardev/char-io.h
@@ -38,8 +38,28 @@ GSource *io_add_watch_poll(Chardev *chr,
 
 void remove_fd_in_watch(Chardev *chr);
 
+/**
+ * io_channel_send:
+ * @ioc: the IO channel object
+ * @buf: the data
+ * @len: the number of bytes to send
+ *
+ * Returns: the number of bytes consumed or -1 on error.
+ * On error, %errno is also set as appropriate.
+ */
 int io_channel_send(QIOChannel *ioc, const void *buf, size_t len);
 
+/**
+ * io_channel_send_full:
+ * @ioc: the IO channel object
+ * @buf: the data
+ * @len: the number of bytes to send
+ * @fds: an array of file handles to send
+ * @nfds: number of file handles in @fds
+ *
+ * Returns: the number of bytes consumed or -1 on error.
+ * On error, %errno is also set as appropriate.
+ */
 int io_channel_send_full(QIOChannel *ioc, const void *buf, size_t len,
                          int *fds, size_t nfds);
 
-- 
2.51.0



  parent reply	other threads:[~2025-11-12 13:49 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-11-12 13:41 [PATCH v3 00/10] chardev: Improve @docstring and clarify qemu_chr_write() uses Philippe Mathieu-Daudé
2025-11-12 13:41 ` [PATCH v3 01/10] chardev/char-fe: Improve @docstrings Philippe Mathieu-Daudé
2025-11-12 13:58   ` Daniel P. Berrangé
2025-11-13 11:31   ` Marc-André Lureau
2025-11-12 13:41 ` Philippe Mathieu-Daudé [this message]
2025-11-13 11:32   ` [PATCH v3 02/10] chardev/char-io: Add @docstrings for io_channel_send[_full]() Marc-André Lureau
2025-11-12 13:41 ` [PATCH v3 03/10] chardev/char: Improve ChardevClass::chr_write() docstring Philippe Mathieu-Daudé
2025-11-12 13:41 ` [PATCH v3 04/10] chardev/char: Document qemu_chr_write[_all]() Philippe Mathieu-Daudé
2025-11-12 13:41 ` [PATCH v3 05/10] chardev/char-pty: Do not ignore chr_write() failures Philippe Mathieu-Daudé
2025-11-12 13:41 ` [PATCH v3 06/10] chardev/char: Allow partial writes in qemu_chr_write() Philippe Mathieu-Daudé
2025-11-13 11:30   ` Marc-André Lureau
2025-11-12 13:41 ` [PATCH v3 07/10] chardev/char: Preserve %errno " Philippe Mathieu-Daudé
2025-11-12 13:41 ` [PATCH v3 08/10] chardev/char: Document qemu_chr_fe_write()'s return value Philippe Mathieu-Daudé
2025-11-13 11:32   ` Marc-André Lureau
2025-11-12 13:41 ` [PATCH v3 09/10] hw/char: Simplify when qemu_chr_fe_write() could not write Philippe Mathieu-Daudé
2025-11-12 13:41 ` [PATCH v3 10/10] system/replay: Rename some method parameters Philippe Mathieu-Daudé
2025-11-12 13:44 ` [PATCH v3 00/10] chardev: Improve @docstring and clarify qemu_chr_write() uses Philippe Mathieu-Daudé

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20251112134143.27194-3-philmd@linaro.org \
    --to=philmd@linaro.org \
    --cc=alex.bennee@linaro.org \
    --cc=marcandre.lureau@redhat.com \
    --cc=pbonzini@redhat.com \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-devel@nongnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).