Re: [PATCH 5/7] docs: add a codebase section

[Alex Bennée]

Peter Maydell <peter.maydell@linaro.org> writes:

> On Mon, 18 Nov 2024 at 17:24, Pierrick Bouvier
> <pierrick.bouvier@linaro.org> wrote:
>>
>> Present the various parts of QEMU and organization of codebase.
>>
>> Signed-off-by: Pierrick Bouvier <pierrick.bouvier@linaro.org>
>
> I like this; it's something I've thought for a while would
> be good to have, but which I never got round to trying to
> put together. Thanks for doing this!
>
> Mostly my comments below are spelling/typo nits and
> other minor stuff.
>
>> ---
>>  docs/about/emulation.rst               |   2 +
>>  docs/codebase/index.rst                | 211 +++++++++++++++++++++++++
>>  docs/devel/decodetree.rst              |   2 +
>>  docs/devel/ebpf_rss.rst                |   2 +
>>  docs/devel/index-internals.rst         |   2 +
>>  docs/devel/migration/main.rst          |   2 +
>>  docs/devel/qapi-code-gen.rst           |   1 +
>>  docs/devel/testing/main.rst            |   9 +-
>>  docs/devel/testing/qtest.rst           |   2 +
>>  docs/index.rst                         |   3 +
>>  docs/interop/qemu-ga.rst               |   2 +
>>  docs/system/qemu-block-drivers.rst.inc |   2 +
>>  docs/tools/qemu-storage-daemon.rst     |   2 +
>>  docs/user/main.rst                     |   6 +
>>  14 files changed, 247 insertions(+), 1 deletion(-)
>>  create mode 100644 docs/codebase/index.rst
>>
<snip>
>> +  Block devices and `image formats<disk images>` implementation.
>> +* `bsd-user <https://gitlab.com/qemu-project/qemu/-/tree/master/bsd-user>`_:
>> +  `BSD User mode<bsd-user-mode>`.
>> +* build: Where the code built goes!
>
> The built code doesn't have to be in 'build'. We could say:
>
>  * build: You can tell the QEMU build system to put the built code
>    anywhere you like. By default it will go into a directory named
>    ``build``. Sometimes documentation will assume this default
>    for convenience when describing command lines; you can always
>    replace it with the path to your build tree.
>
> ?

I always recommend creating a builds directory and having multiple build
trees under it:

  🕙17:22:02 alex@draig:qemu.git  on  testing/next [$!?] 
  ➜  tree -L 1 builds
  builds
  ├── all
  ├── all.clang
  ├── all.disabled
  ├── arm64-system.crossbuild
  ├── arm.afl
  ├── arm.all
  ├── arm.debug
  ├── arm.gcovr
  ├── arm.user.32bit
  ├── bisect
  ├── debug
  ├── debug.clang
  ├── deprecated
  ├── disable-misc
  ├── disable.plugins
  ├── disable-tcg
  ├── disable-user
  ├── extra.libs
  ├── gcov
  ├── gcov2
  ├── lto
  ├── profiling
  ├── qemu-system-arm
  ├── rust
  ├── sanitisers
  ├── sanitizer.clang
  ├── system
  ├── system.i386
  ├── system.nodefaults
  ├── system.threadsan
  ├── tcg
  ├── tci
  ├── tools-and-docs
  ├── trs.debug
  ├── tsan
  ├── user
  ├── user.static
  ├── virtio-gpu
  └── xen


-- 
Alex Bennée
Virtualisation Tech Lead @ Linaro