Ping for review on these docs conversions, please?
thanks
-- PMM
On Fri, 16 Aug 2024 at 14:22, Peter Maydell <peter.mayd...@linaro.org> wrote:
>
> This patchset converts a collection of the remaining txt files in
> docs/devel to rST format. At this point in the release cycle
> I'm targeting 9.2 for these.
>
> Patches 1-5 are simple conversions. In patch 6 I move the
> QemuLockCnt APIs to their own header file; this is so that we can
> include the kernel-doc generated APIs in lockcnt.rst (since
> kernel-doc works on a per-file basis).
>
> Paolo: can you confirm that you mean GPLv2-or-later for the lockcnt
> code? There's no explicit license comment in either util/lockcnt.c
> or include/qemu/thread.h.
>
> (There's one .txt file left in docs/devel after this, but I don't
> think it's very useful so I propose to delete it and will send a
> separate patch for that.)
>
> thanks
> -- PMM
>
> Peter Maydell (7):
> docs/devel/blkdebug: Convert to rST format
> docs/devel/blkverify: Convert to rST format
> docs/devel/lockcnt: Convert to rST format
> docs/devel/multiple-iothreads: Convert to rST format
> docs/devel/rcu: Convert to rST format
> include: Move QemuLockCnt APIs to their own header
> docs/devel/lockcnt: Include kernel-doc API documentation
>
> MAINTAINERS | 8 +-
> docs/devel/blkdebug.rst | 177 ++++++++++++++++++++
> docs/devel/blkdebug.txt | 162 ------------------
> docs/devel/{blkverify.txt => blkverify.rst} | 30 ++--
> docs/devel/index-api.rst | 1 +
> docs/devel/index-build.rst | 2 +
> docs/devel/index-internals.rst | 2 +
> docs/devel/{lockcnt.txt => lockcnt.rst} | 89 +++++-----
> docs/devel/multiple-iothreads.rst | 139 +++++++++++++++
> docs/devel/multiple-iothreads.txt | 130 --------------
> docs/devel/{rcu.txt => rcu.rst} | 172 +++++++++----------
> include/block/aio.h | 1 +
> include/hw/core/cpu.h | 1 +
> include/qemu/lockcnt.h | 130 ++++++++++++++
> include/qemu/thread.h | 111 ------------
> accel/accel-blocker.c | 1 +
> hw/core/cpu-common.c | 1 +
> util/aio-posix.c | 1 +
> util/aio-win32.c | 1 +
> util/async.c | 1 +
> util/fdmon-epoll.c | 1 +
> util/lockcnt.c | 1 +
> 22 files changed, 608 insertions(+), 554 deletions(-)
> create mode 100644 docs/devel/blkdebug.rst
> delete mode 100644 docs/devel/blkdebug.txt
> rename docs/devel/{blkverify.txt => blkverify.rst} (77%)
> rename docs/devel/{lockcnt.txt => lockcnt.rst} (75%)
> create mode 100644 docs/devel/multiple-iothreads.rst
> delete mode 100644 docs/devel/multiple-iothreads.txt
> rename docs/devel/{rcu.txt => rcu.rst} (73%)
> create mode 100644 include/qemu/lockcnt.h
>
> --
> 2.34.1
