docs: improve the memory API documentation

[PATCH 0/5] docs: improve the memory API documentation

Alex Bennée posted 5 patches 1 month, 3 weeks ago

Download series mbox

Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20240307181105.4081793-1-alex.bennee@linaro.org

Maintainers: Paolo Bonzini <pbonzini@redhat.com>, Peter Xu <peterx@redhat.com>, David Hildenbrand <david@redhat.com>, "Philippe Mathieu-Daudé" <philmd@linaro.org>

docs/devel/memory.rst   | 49 +++++++++++++-------------
include/exec/memory.h   | 48 +++++++++++++++++++++++---
include/exec/ramblock.h | 76 +++++++++++++++++++++++++++--------------
scripts/kernel-doc      |  9 ++++-
4 files changed, 127 insertions(+), 55 deletions(-)

Expand all Fold all

[PATCH 0/5] docs: improve the memory API documentation

Posted by Alex Bennée 1 month, 3 weeks ago

As I've been looking through the Memory API for our Xen work I thought
I should take the time to clean it up. I needed to teach kdoc about
our QLIST_ macros and I found at least one unused field in the
structure.

Looking through the definitions I do wander if the meaning of
romd_mode and ram_device could be cleaned up to a single bool
(directly_mapped or use_ops?).

Anyway for now just cosmetic improvements to the docs as we are close
to softfreeze.

Alex.

Alex Bennée (5):
  scripts/kernel-doc: teach kdoc about QLIST_ macros
  docs: include ramblock.h in the memory API docs
  include/exec: remove warning_printed from MemoryRegion
  include/exec: annotate all the MemoryRegion fields
  docs/devel: mark out defined functions and structures

 docs/devel/memory.rst   | 49 +++++++++++++-------------
 include/exec/memory.h   | 48 +++++++++++++++++++++++---
 include/exec/ramblock.h | 76 +++++++++++++++++++++++++++--------------
 scripts/kernel-doc      |  9 ++++-
 4 files changed, 127 insertions(+), 55 deletions(-)

-- 
2.39.2