[0/3] s390x: improve documentation

Message

Cornelia Huck May 5, 2020, 1:50 p.m. UTC

The documentation for the s390x system emulation target still has quite
a bit of room for improvement, so I started adding some device documentation.

I'm not quite happy with the long command/output lines in the 3270 and
vfio-ccw sections, but don't know how to make that more readable. Suggestions
welcome.

Cornelia Huck (3):
  docs/s390x: document the virtual css
  docs/s390x: document 3270
  docs/s390x: document vfio-ccw

 docs/system/s390x/3270.rst     | 32 +++++++++++++++++
 docs/system/s390x/css.rst      | 64 ++++++++++++++++++++++++++++++++++
 docs/system/s390x/vfio-ccw.rst | 58 ++++++++++++++++++++++++++++++
 docs/system/target-s390x.rst   |  3 ++
 4 files changed, 157 insertions(+)
 create mode 100644 docs/system/s390x/3270.rst
 create mode 100644 docs/system/s390x/css.rst
 create mode 100644 docs/system/s390x/vfio-ccw.rst

Comments

Cornelia Huck May 14, 2020, 6:13 a.m. UTC | #1

On Tue,  5 May 2020 15:50:22 +0200
Cornelia Huck <[e-mail]> wrote:

> The documentation for the s390x system emulation target still has quite
> a bit of room for improvement, so I started adding some device documentation.
> 
> I'm not quite happy with the long command/output lines in the 3270 and
> vfio-ccw sections, but don't know how to make that more readable. Suggestions
> welcome.
> 
> Cornelia Huck (3):
>   docs/s390x: document the virtual css
>   docs/s390x: document 3270
>   docs/s390x: document vfio-ccw
> 
>  docs/system/s390x/3270.rst     | 32 +++++++++++++++++
>  docs/system/s390x/css.rst      | 64 ++++++++++++++++++++++++++++++++++
>  docs/system/s390x/vfio-ccw.rst | 58 ++++++++++++++++++++++++++++++
>  docs/system/target-s390x.rst   |  3 ++
>  4 files changed, 157 insertions(+)
>  create mode 100644 docs/system/s390x/3270.rst
>  create mode 100644 docs/system/s390x/css.rst
>  create mode 100644 docs/system/s390x/vfio-ccw.rst
> 

Anybody feel like taking a look?