From: "Alex Bennée" <alex.bennee@linaro.org>
To: qemu-devel@nongnu.org
Cc: "Eduardo Habkost" <eduardo@habkost.net>,
"Philippe Mathieu-Daudé" <philmd@linaro.org>,
"Daniel P. Berrangé" <berrange@redhat.com>,
"Paolo Bonzini" <pbonzini@redhat.com>,
"Markus Armbruster" <armbru@redhat.com>,
"Peter Xu" <peterx@redhat.com>,
"Mark Cave-Ayland" <mark.cave-ayland@ilande.co.uk>,
"Peter Maydell" <peter.maydell@linaro.org>,
"Juan Quintela" <quintela@redhat.com>,
"Richard Henderson" <richard.henderson@linaro.org>,
"Leonardo Bras" <leobras@redhat.com>,
"Alex Bennée" <alex.bennee@linaro.org>
Subject: [PATCH 0/5] docs/devel: improve API documentation for QOM
Date: Mon, 19 Jun 2023 18:14:32 +0100 [thread overview]
Message-ID: <20230619171437.357374-1-alex.bennee@linaro.org> (raw)
Hi,
At the recent QEMU maintainers summit we lamented the fact it was hard
to push forward with our modernising plans as legacy approaches still
get introduced into the code. A lot of knowledge about the "modern"
way of doing things is locked up in senior developers heads. Lets make
a push to improve the developer documentation and ensure best
practice is easy to find.
Some sort of parable about distribution of fishes and knowledge seems
appropriate here.
Alex Bennée (5):
docs/devel: add some front matter to the devel index
include/migration: mark vmstate_register() as a legacy function
include/hw/qdev-core: fixup kerneldoc annotations (!COMPLETE)
docs/devel: split qom-api reference into new file
docs/devel: introduce some key concepts for QOM development
docs/devel/index-api.rst | 2 +
docs/devel/index-process.rst | 2 +
docs/devel/index-tcg.rst | 2 +
docs/devel/index.rst | 24 ++++++-
docs/devel/qdev-api.rst | 12 ++++
docs/devel/qom-api.rst | 9 +++
docs/devel/qom.rst | 50 +++++++++++++-
docs/devel/tcg.rst | 2 +
include/hw/qdev-core.h | 123 +++++++++++++++++++++++++++++------
include/migration/vmstate.h | 9 ++-
10 files changed, 210 insertions(+), 25 deletions(-)
create mode 100644 docs/devel/qdev-api.rst
create mode 100644 docs/devel/qom-api.rst
--
2.39.2
next reply other threads:[~2023-06-19 17:15 UTC|newest]
Thread overview: 18+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-06-19 17:14 Alex Bennée [this message]
2023-06-19 17:14 ` [PATCH 1/5] docs/devel: add some front matter to the devel index Alex Bennée
2023-06-20 9:57 ` Richard Henderson
2023-06-20 15:37 ` Peter Maydell
2023-06-19 17:14 ` [PATCH 2/5] include/migration: mark vmstate_register() as a legacy function Alex Bennée
2023-06-20 4:36 ` Philippe Mathieu-Daudé
2023-06-20 9:58 ` Richard Henderson
2023-06-20 14:19 ` Peter Xu
2023-06-21 19:29 ` Juan Quintela
2023-06-19 17:14 ` [PATCH 3/5] include/hw/qdev-core: fixup kerneldoc annotations (!COMPLETE) Alex Bennée
2023-06-20 10:02 ` Richard Henderson
2023-06-19 17:14 ` [PATCH 4/5] docs/devel: split qom-api reference into new file Alex Bennée
2023-06-20 4:38 ` Philippe Mathieu-Daudé
2023-06-20 10:03 ` Richard Henderson
2023-06-20 10:22 ` Philippe Mathieu-Daudé
2023-06-19 17:14 ` [PATCH 5/5] docs/devel: introduce some key concepts for QOM development Alex Bennée
2023-06-20 10:10 ` Richard Henderson
2023-06-20 15:50 ` Paolo Bonzini
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230619171437.357374-1-alex.bennee@linaro.org \
--to=alex.bennee@linaro.org \
--cc=armbru@redhat.com \
--cc=berrange@redhat.com \
--cc=eduardo@habkost.net \
--cc=leobras@redhat.com \
--cc=mark.cave-ayland@ilande.co.uk \
--cc=pbonzini@redhat.com \
--cc=peter.maydell@linaro.org \
--cc=peterx@redhat.com \
--cc=philmd@linaro.org \
--cc=qemu-devel@nongnu.org \
--cc=quintela@redhat.com \
--cc=richard.henderson@linaro.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).