From: Cornelia Huck <cohuck@redhat.com>
To: Peter Maydell <peter.maydell@linaro.org>
Cc: Tony Krowiak <akrowiak@linux.ibm.com>,
"Jason J . Herne" <jjherne@linux.ibm.com>,
Thomas Huth <thuth@redhat.com>,
Pierre Morel <pmorel@linux.ibm.com>,
QEMU Developers <qemu-devel@nongnu.org>,
Halil Pasic <pasic@linux.ibm.com>,
Christian Borntraeger <borntraeger@de.ibm.com>,
qemu-s390x <qemu-s390x@nongnu.org>
Subject: Re: [PATCH RFC 1/2] docs: rstfy s390 dasd ipl documentation
Date: Fri, 7 Feb 2020 16:22:21 +0100 [thread overview]
Message-ID: <20200207162221.371dfd05.cohuck@redhat.com> (raw)
In-Reply-To: <CAFEAcA9kkxNZg7ij5vXQU-pA+sxed13L0GB6RfiWsvyT2rPPYg@mail.gmail.com>
On Fri, 7 Feb 2020 12:05:09 +0000
Peter Maydell <peter.maydell@linaro.org> wrote:
> On Tue, 28 Jan 2020 at 19:36, Cornelia Huck <cohuck@redhat.com> wrote:
> >
> > While at it, also fix the numbering in 'What QEMU does'.
> >
> > Signed-off-by: Cornelia Huck <cohuck@redhat.com>
> > ---
>
> > diff --git a/docs/devel/s390-dasd-ipl.txt b/docs/devel/s390-dasd-ipl.rst
> > similarity index 77%
> > rename from docs/devel/s390-dasd-ipl.txt
> > rename to docs/devel/s390-dasd-ipl.rst
> > index 9107e048e4e6..1f6a7ea01ce6 100644
> > --- a/docs/devel/s390-dasd-ipl.txt
> > +++ b/docs/devel/s390-dasd-ipl.rst
> > @@ -1,25 +1,28 @@
> > -*****************************
> > -***** s390 hardware IPL *****
> > -*****************************
> > +Booting from real channel-attached devices on s390x
> > +===================================================
> > +
> > +s390 hardware IPL
> > +-----------------
> >
> > The s390 hardware IPL process consists of the following steps.
> >
> > -1. A READ IPL ccw is constructed in memory location 0x0.
> > +1. A READ IPL ccw is constructed in memory location ``0x0``.
> > This ccw, by definition, reads the IPL1 record which is located on the disk
> > at cylinder 0 track 0 record 1. Note that the chain flag is on in this ccw
> > so when it is complete another ccw will be fetched and executed from memory
> > - location 0x08.
> > + location ``0x08``.
>
> I think the indentation here is off -- rST likes to see every line
> in a multiline bullet point start in the same column, like this:
>
> 1. A READ IPL ccw is constructed in memory location ``0x0``.
> This ccw, by ...
> at cylinder...
>
> Otherwise I think you end up with a blockquote by accident.
Hm, the resulting html looked sane to me... but making this consistent
is a good idea anyway.
>
> Formatting-wise the rest looks OK to me (and the other enumerated
> lists in this document don't have this odd indentation, just this
> first set of 1..4).
Thanks for looking!
>
> thanks
> -- PMM
>
next prev parent reply other threads:[~2020-02-07 15:23 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-01-28 18:01 [PATCH RFC 0/2] docs: rstfy some s390 docs Cornelia Huck
2020-01-28 18:01 ` [PATCH RFC 1/2] docs: rstfy s390 dasd ipl documentation Cornelia Huck
2020-02-05 11:02 ` Thomas Huth
2020-02-07 12:05 ` Peter Maydell
2020-02-07 15:22 ` Cornelia Huck [this message]
2020-01-28 18:01 ` [PATCH RFC 2/2] docs: rstfy vfio-ap documentation Cornelia Huck
2020-02-05 11:05 ` Thomas Huth
2020-02-07 12:43 ` Peter Maydell
2020-02-07 15:32 ` Cornelia Huck
2020-02-12 14:57 ` Cornelia Huck
2020-02-12 15:41 ` Cornelia Huck
2020-02-05 10:51 ` [PATCH RFC 0/2] docs: rstfy some s390 docs 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=20200207162221.371dfd05.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.