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

Cornelia Huck posted 2 patches 32 weeks ago
Test docker-quick@centos7 passed
Test FreeBSD passed
Test docker-mingw@fedora passed
Test checkpatch passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/qemu tags/patchew/20200213162942.14177-1-cohuck@redhat.com
Maintainers: Cornelia Huck <cohuck@redhat.com>
MAINTAINERS                                   |   4 +-
docs/devel/index.rst                          |   1 +
.../{s390-dasd-ipl.txt => s390-dasd-ipl.rst}  | 119 +--
docs/system/index.rst                         |   1 +
docs/{vfio-ap.txt => system/vfio-ap.rst}      | 796 +++++++++---------
5 files changed, 484 insertions(+), 437 deletions(-)
rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (51%)
rename docs/{vfio-ap.txt => system/vfio-ap.rst} (55%)

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

Posted by Cornelia Huck 32 weeks 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 (more review can never hurt...) 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-v2

Changes v1->v2 (mostly addressing feedback from Peter; thanks!):
- dasd ipl: fix some indentation
- vfio-ap: autogenerate contents table
- vfio-ap: use more literals
- vfio-ap: convert some examples to tables
- vfio-ap: various other formatting cleanups 

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}  | 119 +--
 docs/system/index.rst                         |   1 +
 docs/{vfio-ap.txt => system/vfio-ap.rst}      | 796 +++++++++---------
 5 files changed, 484 insertions(+), 437 deletions(-)
 rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (51%)
 rename docs/{vfio-ap.txt => system/vfio-ap.rst} (55%)


base-commit: 81f49abaaac2b88062bd1b07f451d9527ed1c9ce
-- 
2.21.1


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

Posted by Cornelia Huck 31 weeks ago
On Thu, 13 Feb 2020 17:29: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 (more review can never hurt...) 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-v2
> 
> Changes v1->v2 (mostly addressing feedback from Peter; thanks!):
> - dasd ipl: fix some indentation
> - vfio-ap: autogenerate contents table
> - vfio-ap: use more literals
> - vfio-ap: convert some examples to tables
> - vfio-ap: various other formatting cleanups 
> 
> 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}  | 119 +--
>  docs/system/index.rst                         |   1 +
>  docs/{vfio-ap.txt => system/vfio-ap.rst}      | 796 +++++++++---------
>  5 files changed, 484 insertions(+), 437 deletions(-)
>  rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (51%)
>  rename docs/{vfio-ap.txt => system/vfio-ap.rst} (55%)
> 
> 
> base-commit: 81f49abaaac2b88062bd1b07f451d9527ed1c9ce

Queued to s390-next.


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

Posted by Cornelia Huck 31 weeks ago
On Thu, 13 Feb 2020 17:29: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 (more review can never hurt...) 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-v2
> 
> Changes v1->v2 (mostly addressing feedback from Peter; thanks!):
> - dasd ipl: fix some indentation
> - vfio-ap: autogenerate contents table
> - vfio-ap: use more literals
> - vfio-ap: convert some examples to tables
> - vfio-ap: various other formatting cleanups 
> 
> 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}  | 119 +--
>  docs/system/index.rst                         |   1 +
>  docs/{vfio-ap.txt => system/vfio-ap.rst}      | 796 +++++++++---------
>  5 files changed, 484 insertions(+), 437 deletions(-)
>  rename docs/devel/{s390-dasd-ipl.txt => s390-dasd-ipl.rst} (51%)
>  rename docs/{vfio-ap.txt => system/vfio-ap.rst} (55%)
> 
> 
> base-commit: 81f49abaaac2b88062bd1b07f451d9527ed1c9ce

Any further feedback? I plan to queue this on my s390-next branch.