Re: [PATCH] docs/system/s390x: Improve the 3270 documentation

[Peter Maydell]

On Fri, 10 Jul 2020 at 11:56, Cornelia Huck <cohuck@redhat.com> wrote:
>
> On Thu,  9 Jul 2020 18:04:39 +0200
> Thomas Huth <thuth@redhat.com> wrote:
>
> > There is some additional information about the 3270 support in our
> > Wiki at https://wiki.qemu.org/Features/3270 - so let's include this
> > information into the main documentation now to have one single
> > source of information (the Wiki page could later be removed).
>
> No objection; but what should our general policy with regard to wiki
> pages vs. documentation be? The 3270 support is pretty much static, but
> e.g. for vfio-ccw, we use the wiki page as a place where we track
> things that should be worked on etc.

I think that (apart from docs/devel) the ideal would be that a
user should be able to look at the documentation to find what
they need to know and not have to look in the wiki. So "feature X
is unsupported" is useful to have in the documentation; developer
TODO lists, design notes, suggestions for improvements, etc
would be better on the wiki.

> (Related: What is the scope of our QEMU documentation? Is a libvirt XML
> snippet on topic? Kernel configuration options (as in here)?)

If we don't think they're liable to become rapidly out of date,
I guess we might as well err on the side of providing information
that's helpful to users. (I think a full-on "here is a tutorial
and how-to guide on setting up guest OS Foo on this model"
would perhaps be a bit out of place, but there's lots of space
between here and there.)

thanks
-- PMM