Peter Maydell <peter.mayd...@linaro.org> writes:
> The virtio-pmem documentation has some minor style issues we hadn't > noticed since we weren't rendering it in our docs: > > * Sphinx doesn't complain about overlong title-underlining the > way it complains about too-short underlining, but it looks odd; > make the underlines of the top level title the right length > > * Indent of paragraphs makes them render as blockquotes; > remove the indent so they just render as normal text > > * Leading 'o' isn't rst markup, so it just renders as a literal > "o"; reformat as a subsection heading instead > > * "QEMU" in the document title and section headings are a bit > odd and unnecessary since this is the QEMU manual; delete > or rephrase them > > * There's no need to specify what QEMU version the device first > appeared in. > > Signed-off-by: Peter Maydell <peter.mayd...@linaro.org> > --- > docs/system/virtio-pmem.rst | 55 ++++++++++++++++++------------------- > 1 file changed, 27 insertions(+), 28 deletions(-) > > diff --git a/docs/system/virtio-pmem.rst b/docs/system/virtio-pmem.rst > index 4bf5d004432..e5f91eff1c2 100644 > --- a/docs/system/virtio-pmem.rst > +++ b/docs/system/virtio-pmem.rst > @@ -1,38 +1,37 @@ > > -======================== > -QEMU virtio pmem > -======================== > +=========== > +virtio pmem > +=========== > > - This document explains the setup and usage of the virtio pmem device > - which is available since QEMU v4.1.0. > - > - The virtio pmem device is a paravirtualized persistent memory device > - on regular (i.e non-NVDIMM) storage. > +This document explains the setup and usage of the virtio pmem device. > +The virtio pmem device is a paravirtualized persistent memory device > +on regular (i.e non-NVDIMM) storage. > > Usecase > -------- nit: but we didn't fix this while we were at it? Anyway: Reviewed-by: Alex Bennée <alex.ben...@linaro.org> -- Alex Bennée
