On Fri, 15 May 2020 at 09:03, Philippe Mathieu-Daudé <phi...@redhat.com> wrote: > However I'd rather see the board documentation in the source code, and > extract it when building. It'd be harder to miss updating the > documentation when modifying the code.
I definitely agree in principle; but for the moment at least we can have some documentation... > Another way (rather than using external program to extract from source > code) can be to add a method/field to MachineClass, and once a build is > finished, we could run 'qemu-system-arch -M gendoc' which go thru all > machines and display the documentation properly formatted. The documentation needs to include all machines, not just the ones that got compiled into a particular binary, so I'm not sure this will work. I also would prefer it if we avoided having the docs build depend on doing a full binary build -- places like readthedocs will just do a docs build by invoking Sphinx directly, and we'd like the machine docs to be visible there. thanks -- PMM