[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build
From: |
Peter Maydell |
Subject: |
Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build |
Date: |
Tue, 29 Oct 2019 18:21:55 +0000 |
On Tue, 29 Oct 2019 at 16:22, Paolo Bonzini <address@hidden> wrote:
>
> Hello,
>
> this is an attempt at including kernel-doc, with small tweaks (see patch
> 2) to support QEMU's doc comment format, in the Sphinx documentation pipeline.
>
> The ugly part is patch 3, which disables Sphinx's "nitpicking" (warn on
> invalid cross-reference) mode. It would probably be possible to use
> the nitpick_ignore configuration entry instead.
>
> Paolo
>
> Paolo Bonzini (6):
> docs: import Linux kernel-doc script and extension
> docs: tweak kernel-doc for QEMU coding standards
> docs: disable sphinx warning about missing cross references
> memory: adjust API documentation to (modified) kerneldoc format
> docs: add memory API reference
> memory: include MemoryListener documentation and some missing function
> parameters
Could you briefly describe the differences between this patchset
and the RFC I sent a while back:
https://patchew.org/QEMU/address@hidden/
please?
thanks
-- PMM
- [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, Paolo Bonzini, 2019/10/29
- [PATCH 2/6] docs: tweak kernel-doc for QEMU coding standards, Paolo Bonzini, 2019/10/29
- [PATCH 5/6] docs: add memory API reference, Paolo Bonzini, 2019/10/29
- [PATCH 4/6] memory: adjust API documentation to (modified) kerneldoc format, Paolo Bonzini, 2019/10/29
- [PATCH 3/6] docs: disable sphinx warning about missing cross references, Paolo Bonzini, 2019/10/29
- [PATCH 6/6] memory: include MemoryListener documentation and some missing function parameters, Paolo Bonzini, 2019/10/29
- [PATCH 1/6] docs: import Linux kernel-doc script and extension, Paolo Bonzini, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build, no-reply, 2019/10/29
- Re: [RFC PATCH 0/6] docs: integrate doc comments with Sphinx build,
Peter Maydell <=