From: Peter Maydell <peter.maydell@linaro.org>
To: "Philippe Mathieu-Daudé" <philmd@redhat.com>
Cc: qemu-arm <qemu-arm@nongnu.org>,
QEMU Developers <qemu-devel@nongnu.org>,
Markus Armbruster <armbru@redhat.com>
Subject: Re: [PATCH 0/5] docs/system: Document some arm board models
Date: Fri, 15 May 2020 09:51:45 +0100 [thread overview]
Message-ID: <CAFEAcA-67uGcwSu7mJ+w26xYqpTm4C0t3Yrr8gWCsA1VtHeaLg@mail.gmail.com> (raw)
In-Reply-To: <567755c6-3bb1-b16e-af26-431dec4616ba@redhat.com>
On Fri, 15 May 2020 at 09:03, Philippe Mathieu-Daudé <philmd@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
next prev parent reply other threads:[~2020-05-15 8:53 UTC|newest]
Thread overview: 24+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-05-07 15:18 [PATCH 0/5] docs/system: Document some arm board models Peter Maydell
2020-05-07 15:18 ` [PATCH 1/5] docs/system: Add 'Arm' to the Integrator/CP document title Peter Maydell
2020-05-14 13:54 ` Edgar E. Iglesias
2020-05-15 9:00 ` Alex Bennée
2020-05-07 15:18 ` [PATCH 2/5] docs/system: Sort Arm board index into alphabetical order Peter Maydell
2020-05-14 13:54 ` Edgar E. Iglesias
2020-05-15 9:41 ` Alex Bennée
2020-05-07 15:18 ` [PATCH 3/5] docs/system: Document Arm Versatile Express boards Peter Maydell
2020-05-14 13:55 ` Edgar E. Iglesias
2020-05-15 9:54 ` Alex Bennée
2020-05-07 15:18 ` [PATCH 4/5] docs/system: Document the various MPS2 models Peter Maydell
2020-05-14 13:56 ` Edgar E. Iglesias
2020-05-15 9:55 ` Alex Bennée
2020-05-07 15:18 ` [PATCH 5/5] docs/system: Document Musca boards Peter Maydell
2020-05-14 13:56 ` Edgar E. Iglesias
2020-05-15 7:56 ` Philippe Mathieu-Daudé
2020-05-15 8:48 ` Peter Maydell
2020-05-15 9:06 ` Philippe Mathieu-Daudé
2020-05-15 9:56 ` Alex Bennée
2020-05-14 13:28 ` [PATCH 0/5] docs/system: Document some arm board models Peter Maydell
2020-05-15 8:03 ` Philippe Mathieu-Daudé
2020-05-15 8:51 ` Peter Maydell [this message]
2020-05-15 9:05 ` Philippe Mathieu-Daudé
2020-05-15 10:23 ` Peter Maydell
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=CAFEAcA-67uGcwSu7mJ+w26xYqpTm4C0t3Yrr8gWCsA1VtHeaLg@mail.gmail.com \
--to=peter.maydell@linaro.org \
--cc=armbru@redhat.com \
--cc=philmd@redhat.com \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).