All of lore.kernel.org
 help / color / mirror / Atom feed
From: Cornelia Huck <cohuck@redhat.com>
To: Tony Krowiak <akrowiak@linux.ibm.com>,
	"Jason J . Herne" <jjherne@linux.ibm.com>
Cc: Peter Maydell <peter.maydell@linaro.org>,
	Thomas Huth <thuth@redhat.com>,
	Pierre Morel <pmorel@linux.ibm.com>,
	Cornelia Huck <cohuck@redhat.com>,
	qemu-devel@nongnu.org, Halil Pasic <pasic@linux.ibm.com>,
	Christian Borntraeger <borntraeger@de.ibm.com>,
	qemu-s390x@nongnu.org
Subject: [PATCH v2 0/2] docs: rstfy some s390 docs
Date: Thu, 13 Feb 2020 17:29:40 +0100	[thread overview]
Message-ID: <20200213162942.14177-1-cohuck@redhat.com> (raw)

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



             reply	other threads:[~2020-02-13 16:31 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-02-13 16:29 Cornelia Huck [this message]
2020-02-13 16:29 ` [PATCH v2 1/2] docs: rstfy s390 dasd ipl documentation Cornelia Huck
2020-02-13 16:29 ` [PATCH v2 2/2] docs: rstfy vfio-ap documentation Cornelia Huck
2020-02-13 18:38   ` Pierre Morel
2020-02-13 18:54     ` Peter Maydell
2020-02-18 12:44       ` Cornelia Huck
2020-02-18 13:57         ` Pierre Morel
2020-02-18 13:05 ` [PATCH v2 0/2] docs: rstfy some s390 docs Cornelia Huck
2020-02-21  8:24 ` Cornelia Huck

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=20200213162942.14177-1-cohuck@redhat.com \
    --to=cohuck@redhat.com \
    --cc=akrowiak@linux.ibm.com \
    --cc=borntraeger@de.ibm.com \
    --cc=jjherne@linux.ibm.com \
    --cc=pasic@linux.ibm.com \
    --cc=peter.maydell@linaro.org \
    --cc=pmorel@linux.ibm.com \
    --cc=qemu-devel@nongnu.org \
    --cc=qemu-s390x@nongnu.org \
    --cc=thuth@redhat.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.