[v1] docs: rstfy some s390 docs

[PATCH RFC 0/2] docs: rstfy some s390 docs

Cornelia Huck posted 2 patches 4 years, 3 months ago

Diff against v2
Download series mbox

Test FreeBSD passed

Test docker-mingw@fedora passed

Test checkpatch passed

Test docker-quick@centos7 passed

Failed in applying to current master (apply log)

There is a newer version of this series

MAINTAINERS                                   |   4 +-
docs/devel/index.rst                          |   1 +
.../{s390-dasd-ipl.txt => s390-dasd-ipl.rst}  |  65 +-
docs/system/index.rst                         |   1 +
docs/{vfio-ap.txt => system/vfio-ap.rst}      | 755 +++++++++---------
5 files changed, 424 insertions(+), 402 deletions(-)
rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (77%)
rename docs/{vfio-ap.txt => system/vfio-ap.rst} (56%)

Expand all Fold all

[PATCH RFC 0/2] docs: rstfy some s390 docs

Posted by Cornelia Huck 4 years, 3 months ago

https://qemu.readthedocs.io/en/latest/index.html collects various
documents from the QEMU docs/ subdirectory; however, none of the
s390 files are currently included. Therefore, I set out to convert
the existing files to rst and hook them up.

s390-dasd-ipl was straightforward enough; I also found a numbering
issue.

vfio-ap was quite a bit more involved, but I hope I have produced
something readable (would benefit from some more review). I also
moved this into the system/ subdirectory; not sure if that is the
best resting place, but it seemed to be the most reasonable one.

Tested via running 'make html' and inspecting the output.

Branch: https://github.com/cohuck/qemu rstfy-s390

Cornelia Huck (2):
  docs: rstfy s390 dasd ipl documentation
  docs: rstfy vfio-ap documentation

 MAINTAINERS                                   |   4 +-
 docs/devel/index.rst                          |   1 +
 .../{s390-dasd-ipl.txt => s390-dasd-ipl.rst}  |  65 +-
 docs/system/index.rst                         |   1 +
 docs/{vfio-ap.txt => system/vfio-ap.rst}      | 755 +++++++++---------
 5 files changed, 424 insertions(+), 402 deletions(-)
 rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (77%)
 rename docs/{vfio-ap.txt => system/vfio-ap.rst} (56%)

-- 
2.21.1

Re: [PATCH RFC 0/2] docs: rstfy some s390 docs

Posted by Cornelia Huck 4 years, 3 months ago

On Tue, 28 Jan 2020 19:01:40 +0100
Cornelia Huck <cohuck@redhat.com> wrote:

> https://qemu.readthedocs.io/en/latest/index.html collects various
> documents from the QEMU docs/ subdirectory; however, none of the
> s390 files are currently included. Therefore, I set out to convert
> the existing files to rst and hook them up.
> 
> s390-dasd-ipl was straightforward enough; I also found a numbering
> issue.
> 
> vfio-ap was quite a bit more involved, but I hope I have produced
> something readable (would benefit from some more review). I also
> moved this into the system/ subdirectory; not sure if that is the
> best resting place, but it seemed to be the most reasonable one.
> 
> Tested via running 'make html' and inspecting the output.
> 
> Branch: https://github.com/cohuck/qemu rstfy-s390
> 
> Cornelia Huck (2):
>   docs: rstfy s390 dasd ipl documentation
>   docs: rstfy vfio-ap documentation
> 
>  MAINTAINERS                                   |   4 +-
>  docs/devel/index.rst                          |   1 +
>  .../{s390-dasd-ipl.txt => s390-dasd-ipl.rst}  |  65 +-
>  docs/system/index.rst                         |   1 +
>  docs/{vfio-ap.txt => system/vfio-ap.rst}      | 755 +++++++++---------
>  5 files changed, 424 insertions(+), 402 deletions(-)
>  rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (77%)
>  rename docs/{vfio-ap.txt => system/vfio-ap.rst} (56%)
> 

Friendly ping. Anybody got some spare cycles to look at this?