The documentation of the -machine memory-backend has some minor
formatting errors:
* Misindentation of the initial line meant that the whole option
section is incorrectly indented in the HTML output compared to
the other -machine options
* The examples weren't indented, which meant that they were formatted
as plain run-on text including outputting the "::" as text.
* The a) b) list has no rst-format markup so it is rendered as
a single run-on paragraph
Fix the formatting.
Signed-off-by: Peter Maydell <peter.maydell@linaro.org>
---
qemu-options.hx | 30 +++++++++++++++++-------------
1 file changed, 17 insertions(+), 13 deletions(-)
diff --git a/qemu-options.hx b/qemu-options.hx
index 0c9ddc02746..d783626d5b6 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -98,28 +98,32 @@ SRST
Enables or disables ACPI Heterogeneous Memory Attribute Table
(HMAT) support. The default is off.
- ``memory-backend='id'``
+ ``memory-backend='id'``
An alternative to legacy ``-mem-path`` and ``mem-prealloc`` options.
Allows to use a memory backend as main RAM.
For example:
::
- -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on
- -machine memory-backend=pc.ram
- -m 512M
+
+ -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on
+ -machine memory-backend=pc.ram
+ -m 512M
Migration compatibility note:
- a) as backend id one shall use value of 'default-ram-id', advertised by
- machine type (available via ``query-machines`` QMP command), if migration
- to/from old QEMU (<5.0) is expected.
- b) for machine types 4.0 and older, user shall
- use ``x-use-canonical-path-for-ramblock-id=off`` backend option
- if migration to/from old QEMU (<5.0) is expected.
+
+ * as backend id one shall use value of 'default-ram-id', advertised by
+ machine type (available via ``query-machines`` QMP command), if migration
+ to/from old QEMU (<5.0) is expected.
+ * for machine types 4.0 and older, user shall
+ use ``x-use-canonical-path-for-ramblock-id=off`` backend option
+ if migration to/from old QEMU (<5.0) is expected.
+
For example:
::
- -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off
- -machine memory-backend=pc.ram
- -m 512M
+
+ -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off
+ -machine memory-backend=pc.ram
+ -m 512M
ERST
HXCOMM Deprecated by -machine
--
2.20.1
On Mon, 19 Jul 2021 11:52:57 +0100 Peter Maydell <peter.maydell@linaro.org> wrote: > The documentation of the -machine memory-backend has some minor > formatting errors: > * Misindentation of the initial line meant that the whole option > section is incorrectly indented in the HTML output compared to > the other -machine options > * The examples weren't indented, which meant that they were formatted > as plain run-on text including outputting the "::" as text. > * The a) b) list has no rst-format markup so it is rendered as > a single run-on paragraph > > Fix the formatting. > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> Reviewed-by: Igor Mammedov <imammedo@redhat.com> > --- > qemu-options.hx | 30 +++++++++++++++++------------- > 1 file changed, 17 insertions(+), 13 deletions(-) > > diff --git a/qemu-options.hx b/qemu-options.hx > index 0c9ddc02746..d783626d5b6 100644 > --- a/qemu-options.hx > +++ b/qemu-options.hx > @@ -98,28 +98,32 @@ SRST > Enables or disables ACPI Heterogeneous Memory Attribute Table > (HMAT) support. The default is off. > > - ``memory-backend='id'`` > + ``memory-backend='id'`` > An alternative to legacy ``-mem-path`` and ``mem-prealloc`` options. > Allows to use a memory backend as main RAM. > > For example: > :: > - -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on > - -machine memory-backend=pc.ram > - -m 512M > + > + -object memory-backend-file,id=pc.ram,size=512M,mem-path=/hugetlbfs,prealloc=on,share=on > + -machine memory-backend=pc.ram > + -m 512M > > Migration compatibility note: > - a) as backend id one shall use value of 'default-ram-id', advertised by > - machine type (available via ``query-machines`` QMP command), if migration > - to/from old QEMU (<5.0) is expected. > - b) for machine types 4.0 and older, user shall > - use ``x-use-canonical-path-for-ramblock-id=off`` backend option > - if migration to/from old QEMU (<5.0) is expected. > + > + * as backend id one shall use value of 'default-ram-id', advertised by > + machine type (available via ``query-machines`` QMP command), if migration > + to/from old QEMU (<5.0) is expected. > + * for machine types 4.0 and older, user shall > + use ``x-use-canonical-path-for-ramblock-id=off`` backend option > + if migration to/from old QEMU (<5.0) is expected. > + > For example: > :: > - -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off > - -machine memory-backend=pc.ram > - -m 512M > + > + -object memory-backend-ram,id=pc.ram,size=512M,x-use-canonical-path-for-ramblock-id=off > + -machine memory-backend=pc.ram > + -m 512M > ERST > > HXCOMM Deprecated by -machine
On Mon, 19 Jul 2021 at 14:07, Igor Mammedov <imammedo@redhat.com> wrote: > > On Mon, 19 Jul 2021 11:52:57 +0100 > Peter Maydell <peter.maydell@linaro.org> wrote: > > > The documentation of the -machine memory-backend has some minor > > formatting errors: > > * Misindentation of the initial line meant that the whole option > > section is incorrectly indented in the HTML output compared to > > the other -machine options > > * The examples weren't indented, which meant that they were formatted > > as plain run-on text including outputting the "::" as text. > > * The a) b) list has no rst-format markup so it is rendered as > > a single run-on paragraph > > > > Fix the formatting. > > > > Signed-off-by: Peter Maydell <peter.maydell@linaro.org> > > Reviewed-by: Igor Mammedov <imammedo@redhat.com> > Thanks for the review; I'll take this via target-arm.next since I'm doing a pullreq for the next rc anyway, unless anybody would prefer otherwise. -- PMM
© 2016 - 2024 Red Hat, Inc.