[PATCH v2 0/9] chardev: Improve @docstring and clarify qemu_chr_write() uses

Philippe Mathieu-Daudé posted 9 patches 3 weeks, 2 days ago
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20251022150743.78183-1-philmd@linaro.org
Maintainers: "Marc-André Lureau" <marcandre.lureau@redhat.com>, Paolo Bonzini <pbonzini@redhat.com>, "Edgar E. Iglesias" <edgar.iglesias@gmail.com>, Alistair Francis <alistair@alistair23.me>, Peter Maydell <peter.maydell@linaro.org>, Palmer Dabbelt <palmer@dabbelt.com>
There is a newer version of this series
include/chardev/char-fe.h | 24 +++++++++++++++++++++++-
include/chardev/char-io.h | 18 ++++++++++++++++++
include/chardev/char.h    | 35 ++++++++++++++++++++++++++++++++++-
chardev/char-hub.c        |  2 +-
chardev/char-pty.c        |  2 +-
chardev/char.c            |  7 ++++++-
hw/char/cadence_uart.c    |  2 +-
hw/char/ibex_uart.c       |  2 +-
hw/char/sifive_uart.c     |  2 +-
9 files changed, 86 insertions(+), 8 deletions(-)
[PATCH v2 0/9] chardev: Improve @docstring and clarify qemu_chr_write() uses
Posted by Philippe Mathieu-Daudé 3 weeks, 2 days ago
v2:
- Document ChardevClass::chr_write() and qemu_chr_write[_all]()

Few chardev fixes:
- preserve %errno
- allow partial writes in qemu_chr_write()

Improve chardev methods documentation.

While @c for frontend and @s for backend is accepted, it
confuses me, so I prefer to document for my own mental health.

Based-on: <20251022074612.1258413-1-marcandre.lureau@redhat.com>

Philippe Mathieu-Daudé (9):
  chardev/char-fe: Improve @docstrings
  chardev/char-io: Add @docstrings for io_channel_send[_full]()
  chardev/char: Improve ChardevClass::chr_write() docstring
  chardev/char: Document qemu_chr_write[_all]()
  chardev/char-pty: Do not ignore chr_write() failures
  chardev/char: Allow partial writes in qemu_chr_write()
  chardev/char: Preserve %errno in qemu_chr_write()
  chardev/char-hub: Retry when qemu_chr_fe_write() can not write
  hw/char: Simplify when qemu_chr_fe_write() could not write

 include/chardev/char-fe.h | 24 +++++++++++++++++++++++-
 include/chardev/char-io.h | 18 ++++++++++++++++++
 include/chardev/char.h    | 35 ++++++++++++++++++++++++++++++++++-
 chardev/char-hub.c        |  2 +-
 chardev/char-pty.c        |  2 +-
 chardev/char.c            |  7 ++++++-
 hw/char/cadence_uart.c    |  2 +-
 hw/char/ibex_uart.c       |  2 +-
 hw/char/sifive_uart.c     |  2 +-
 9 files changed, 86 insertions(+), 8 deletions(-)

-- 
2.51.0


Re: [PATCH v2 0/9] chardev: Improve @docstring and clarify qemu_chr_write() uses
Posted by Philippe Mathieu-Daudé 3 weeks, 2 days ago
On 22/10/25 17:07, Philippe Mathieu-Daudé wrote:
> v2:
> - Document ChardevClass::chr_write() and qemu_chr_write[_all]()
> 
> Few chardev fixes:
> - preserve %errno
> - allow partial writes in qemu_chr_write()
> 
> Improve chardev methods documentation.

Sigh, this is still missing the qemu_chr_fe_write() @docstring
update requested by Peter:
https://lore.kernel.org/qemu-devel/CAFEAcA_kEndvNtw4EHySXWwQPoGs029yAzZGGBcV=zGHaj7KUQ@mail.gmail.com/