[v3] chardev: Improve @docstring and clarify qemu_chr_write() uses

[PATCH v3 00/10] chardev: Improve @docstring and clarify qemu_chr_write() uses

Philippe Mathieu-Daudé posted 10 patches 2 days, 3 hours ago

Diff against v1 v2
Download series mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20251112134143.27194-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>, "Alex Bennée" <alex.bennee@linaro.org>

include/chardev/char-fe.h | 33 ++++++++++++++++++++++++++-----
include/chardev/char-io.h | 20 +++++++++++++++++++
include/chardev/char.h    | 41 ++++++++++++++++++++++++++++++++++++++-
include/system/replay.h   | 16 +++++++--------
chardev/char-pty.c        |  2 +-
chardev/char.c            | 11 +++++++++++
hw/char/cadence_uart.c    |  2 +-
hw/char/ibex_uart.c       |  2 +-
hw/char/sifive_uart.c     |  2 +-
replay/replay-char.c      | 14 ++++++-------
stubs/replay-tools.c      | 10 +++++-----
11 files changed, 123 insertions(+), 30 deletions(-)

Expand all Fold all

[PATCH v3 00/10] chardev: Improve @docstring and clarify qemu_chr_write() uses

Posted by Philippe Mathieu-Daudé 2 days, 3 hours ago

v3:
- Addressed Marc-André & Daniel comments
- Document qemu_chr_fe_write()
- Rename replay arguments

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é (10):
  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: Document qemu_chr_fe_write()'s return value
  hw/char: Simplify when qemu_chr_fe_write() could not write
  system/replay: Rename some method parameters

 include/chardev/char-fe.h | 33 ++++++++++++++++++++++++++-----
 include/chardev/char-io.h | 20 +++++++++++++++++++
 include/chardev/char.h    | 41 ++++++++++++++++++++++++++++++++++++++-
 include/system/replay.h   | 16 +++++++--------
 chardev/char-pty.c        |  2 +-
 chardev/char.c            | 11 +++++++++++
 hw/char/cadence_uart.c    |  2 +-
 hw/char/ibex_uart.c       |  2 +-
 hw/char/sifive_uart.c     |  2 +-
 replay/replay-char.c      | 14 ++++++-------
 stubs/replay-tools.c      | 10 +++++-----
 11 files changed, 123 insertions(+), 30 deletions(-)

-- 
2.51.0

Re: [PATCH v3 00/10] chardev: Improve @docstring and clarify qemu_chr_write() uses

Posted by Philippe Mathieu-Daudé 2 days, 3 hours ago

Missing review: 1, 2, 6, 8, 10

On 12/11/25 14:41, Philippe Mathieu-Daudé wrote:
> v3:
> - Addressed Marc-André & Daniel comments
> - Document qemu_chr_fe_write()
> - Rename replay arguments


> Philippe Mathieu-Daudé (10):
>    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: Document qemu_chr_fe_write()'s return value
>    hw/char: Simplify when qemu_chr_fe_write() could not write
>    system/replay: Rename some method parameters