On 12/9/24 10:30, Pierrick Bouvier wrote:
> This series extends our documentation with new pages to help developers
> onboarding on QEMU. It focuses on providing a big picture of QEMU (to a
> modest extend).
>
> As such, it was written to be simple, short, easy to understand, and pointing to
> more details. It provides another way to dive into details instead of simply
> hitting the "search" box.
>
> The first patches enhance the existing developer section. They provide
> information about b4 and git-publish, two important tools that I learnt from my
> coworkers, and were not presented anywhere, and were really missing IMHO.
>
> Then, we introduce a new Codebase page, presenting (succintly) the various parts
> of QEMU, and what every folder of the codebase contains.
> We then add a glossary with the most recurrent acronyms we hear in our daily
> conversations on the mailing list.
> Finally, we add an "How-to" page which present how to build and test qemu, and
> how to contribute a patch. It's definitely a repetition of existing information,
> but the goal was to have a self contained page with all the commands I run
> daily personally, and that someone would be interested to have.
>
> When reviewing, please keep in mind this is targeting someone who discovers
> QEMU, and not someone who contributed to the project for several years. What is
> obvious for you will not be obvious for a random young developer.
>
> That said, please free to point if something is "false", or "really incomplete".
> It can be hard to summarize in one or two sentences complex parts, but that's
> the intent here.
>
> Your feedback on content or organization is very welcome!
>
> Thanks,
> Pierrick
>
> v2:
> - removed how-to section
> - integrated all suggestions from Daniel and Peter (thanks for all your comments)
> - Note: build environment keeps mentioning windows-arm64 because we solved the
> issue with gcc_struct attribute. The related series will be merged before this
> documentation.
>
> v3:
> - added a comment about git-publish asked by Daniel.
>
> v4:
> - add suggestion from Thomas for codebase and message-id.
>
> Pierrick Bouvier (6):
> docs/devel: remove dead video link for sourcehut submit process
> docs/devel: add git-publish for patch submitting
> docs/devel: add b4 for patch retrieval
> docs/devel: add information on how to setup build environments
> docs: add a codebase section
> docs: add a glossary
>
> docs/about/build-platforms.rst | 4 +-
> docs/about/emulation.rst | 2 +
> docs/devel/build-environment.rst | 118 +++++++++++
> docs/devel/codebase.rst | 220 +++++++++++++++++++
> docs/devel/control-flow-integrity.rst | 2 +
> docs/devel/decodetree.rst | 2 +
> docs/devel/ebpf_rss.rst | 2 +
> docs/devel/index-build.rst | 1 +
> docs/devel/index-internals.rst | 2 +
> docs/devel/index.rst | 1 +
> docs/devel/migration/main.rst | 2 +
> docs/devel/multi-thread-tcg.rst | 2 +
> docs/devel/qapi-code-gen.rst | 1 +
> docs/devel/submitting-a-patch.rst | 44 +++-
> docs/devel/testing/main.rst | 9 +-
> docs/devel/testing/qtest.rst | 2 +
> docs/glossary.rst | 280 +++++++++++++++++++++++++
> docs/index.rst | 3 +
> docs/interop/qemu-ga.rst | 2 +
> docs/system/arm/virt.rst | 2 +
> docs/system/images.rst | 2 +
> docs/system/qemu-block-drivers.rst.inc | 2 +
> docs/tools/qemu-nbd.rst | 2 +
> docs/tools/qemu-storage-daemon.rst | 2 +
> docs/user/main.rst | 6 +
> 25 files changed, 709 insertions(+), 6 deletions(-)
> create mode 100644 docs/devel/build-environment.rst
> create mode 100644 docs/devel/codebase.rst
> create mode 100644 docs/glossary.rst
>
Gentle ping on this series.
It was reviewed and it's currently waiting to be pulled by a maintainer.
Regards,
Pierrick