| Message ID | 20241018141332.942844-1-peter.maydell@linaro.org |
|---|---|
| Headers | show |
| Series | docs/system/arm: Provide at least skeleton docs for all boards | expand |
Peter Maydell <peter.maydell@linaro.org> writes: > In target-arm.rst there is an apologetic note: > > Unfortunately many of the Arm boards QEMU supports are currently > undocumented; you can get a complete list by running > ``qemu-system-aarch64 --machine help``. > > However, the situation isn't actually as bleak as this suggests: > over the years we have generally insisted on documentation for > new machine types and have filled in some of the gaps where > there was no documentation for older machine types. Plus we just > deleted a lot of older undocumented or underdocumented boards. > > I did a check of all the board types listed in --help and we > really don't have very many left that weren't listed in the > documentation. This series does some cleanup of existing > docs to ensure that every board covered by a .rst file has > a line in the right place in the list that lists the board > name explicitly. It then adds placeholder docs for the remaining > undocumented boards: > * nuri, smdkc210 (Exynos4 boards) > * xlnx-zcu102 > * mcimx6ul-evk > * mcimx7d-sabre > > and removes the apologetic note about the list being incomplete. > > The placeholder docs are obviously not very useful, but they > mean we at least have an entry in the list for the board > that gives the manufacturer's name for the board, and we > have a place to put expanded information in future if anybody > wants to write it. > > Anybody who has more information on the above boards is of > course welcome to expand on the minimal files here :-) For the series: Reviewed-by: Alex Bennée <alex.bennee@linaro.org>
In target-arm.rst there is an apologetic note: Unfortunately many of the Arm boards QEMU supports are currently undocumented; you can get a complete list by running ``qemu-system-aarch64 --machine help``. However, the situation isn't actually as bleak as this suggests: over the years we have generally insisted on documentation for new machine types and have filled in some of the gaps where there was no documentation for older machine types. Plus we just deleted a lot of older undocumented or underdocumented boards. I did a check of all the board types listed in --help and we really don't have very many left that weren't listed in the documentation. This series does some cleanup of existing docs to ensure that every board covered by a .rst file has a line in the right place in the list that lists the board name explicitly. It then adds placeholder docs for the remaining undocumented boards: * nuri, smdkc210 (Exynos4 boards) * xlnx-zcu102 * mcimx6ul-evk * mcimx7d-sabre and removes the apologetic note about the list being incomplete. The placeholder docs are obviously not very useful, but they mean we at least have an entry in the list for the board that gives the manufacturer's name for the board, and we have a place to put expanded information in future if anybody wants to write it. Anybody who has more information on the above boards is of course welcome to expand on the minimal files here :-) thanks -- PMM Peter Maydell (7): docs/system/arm/stm32: List olimex-stm32-h405 in document title docs/system/arm: Don't use wildcard '*-bmc' in doc titles docs/system/arm: Split fby35 out from aspeed.rst docs/system/arm: Add placeholder doc for exynos4 boards docs/system/arm: Add placeholder doc for xlnx-zcu102 board docs/system/arm: Add placeholder docs for mcimx6ul-evk and mcimx7d-sabre docs/system/target-arm.rst: Remove "many boards are undocumented" note MAINTAINERS | 5 +++ docs/system/arm/aspeed.rst | 52 ++----------------------------- docs/system/arm/exynos.rst | 9 ++++++ docs/system/arm/fby35.rst | 47 ++++++++++++++++++++++++++++ docs/system/arm/mcimx6ul-evk.rst | 5 +++ docs/system/arm/mcimx7d-sabre.rst | 5 +++ docs/system/arm/nuvoton.rst | 4 +-- docs/system/arm/stm32.rst | 4 +-- docs/system/arm/xlnx-zcu102.rst | 19 +++++++++++ docs/system/target-arm.rst | 9 +++--- 10 files changed, 101 insertions(+), 58 deletions(-) create mode 100644 docs/system/arm/exynos.rst create mode 100644 docs/system/arm/fby35.rst create mode 100644 docs/system/arm/mcimx6ul-evk.rst create mode 100644 docs/system/arm/mcimx7d-sabre.rst create mode 100644 docs/system/arm/xlnx-zcu102.rst