All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Alex Bennée" <alex.bennee@linaro.org>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: qemu-arm@nongnu.org, qemu-devel@nongnu.org,
	"Cédric Le Goater" <clg@kaod.org>,
	"Jean-Christophe Dubois" <jcd@tribudubois.net>,
	"Igor Mitsyanko" <i.mitsyanko@gmail.com>,
	"Andrey Smirnov" <andrew.smirnov@gmail.com>,
	"Alexandre Iooss" <erdnaxe@crans.org>,
	"Alistair Francis" <alistair@alistair23.me>,
	"Edgar E. Iglesias" <edgar.iglesias@gmail.com>
Subject: Re: [PATCH 0/7] docs/system/arm: Provide at least skeleton docs for all boards
Date: Sun, 20 Oct 2024 21:34:26 +0100	[thread overview]
Message-ID: <87bjzev7hp.fsf@draig.linaro.org> (raw)
In-Reply-To: <20241018141332.942844-1-peter.maydell@linaro.org> (Peter Maydell's message of "Fri, 18 Oct 2024 15:13:25 +0100")

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>

-- 
Alex Bennée
Virtualisation Tech Lead @ Linaro

      parent reply	other threads:[~2024-10-20 20:34 UTC|newest]

Thread overview: 17+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-18 14:13 [PATCH 0/7] docs/system/arm: Provide at least skeleton docs for all boards Peter Maydell
2024-10-18 14:13 ` [PATCH 1/7] docs/system/arm/stm32: List olimex-stm32-h405 in document title Peter Maydell
2024-10-21  5:46   ` Cédric Le Goater
2024-10-18 14:13 ` [PATCH 2/7] docs/system/arm: Don't use wildcard '*-bmc' in doc titles Peter Maydell
2024-10-21  5:56   ` Cédric Le Goater
2024-10-18 14:13 ` [PATCH 3/7] docs/system/arm: Split fby35 out from aspeed.rst Peter Maydell
2024-10-21  5:49   ` Cédric Le Goater
2024-10-18 14:13 ` [PATCH 4/7] docs/system/arm: Add placeholder doc for exynos4 boards Peter Maydell
2024-10-21  5:57   ` Cédric Le Goater
2024-10-18 14:13 ` [PATCH 5/7] docs/system/arm: Add placeholder doc for xlnx-zcu102 board Peter Maydell
2024-10-21  0:24   ` Alistair Francis
2024-10-18 14:13 ` [PATCH 6/7] docs/system/arm: Add placeholder docs for mcimx6ul-evk and mcimx7d-sabre Peter Maydell
2024-10-21  5:57   ` Cédric Le Goater
2024-10-18 14:13 ` [PATCH 7/7] docs/system/target-arm.rst: Remove "many boards are undocumented" note Peter Maydell
2024-10-21  0:25   ` Alistair Francis
2024-10-21  5:56   ` Cédric Le Goater
2024-10-20 20:34 ` Alex Bennée [this message]

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=87bjzev7hp.fsf@draig.linaro.org \
    --to=alex.bennee@linaro.org \
    --cc=alistair@alistair23.me \
    --cc=andrew.smirnov@gmail.com \
    --cc=clg@kaod.org \
    --cc=edgar.iglesias@gmail.com \
    --cc=erdnaxe@crans.org \
    --cc=i.mitsyanko@gmail.com \
    --cc=jcd@tribudubois.net \
    --cc=peter.maydell@linaro.org \
    --cc=qemu-arm@nongnu.org \
    --cc=qemu-devel@nongnu.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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.