Skip to content

Commit

Permalink
[doc] kvmfr/libvirt: change double quotes to single quotes
Browse files Browse the repository at this point in the history
virt-manager (or libvirt itself) tends to preserve outer quotation marks but explode inner double-quotes into '&quot' which is annoying.

this looks nicer when pasted into the XML editor and applied

Also used double-quotes for the QEMU <6.2 example for consistency

PS: added myself to AUTHORS since this is my first contribution
  • Loading branch information
majcosta authored and gnif committed Jun 2, 2024
1 parent 695cbc2 commit d21bdeb
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 9 deletions.
1 change: 1 addition & 0 deletions AUTHORS
Original file line number Diff line number Diff line change
Expand Up @@ -69,3 +69,4 @@ MakiseKurisu <[email protected]> (MakiseKurisu)
Zenithal <[email protected]> (ZenithalHourlyRate)
Kamplom <[email protected]> (kamplom)
Jacob McNamee <[email protected]> (jacobmcnamee)
Marco Antonio J. Costa <[email protected]> (majcosta)
18 changes: 9 additions & 9 deletions doc/ivshmem_kvmfr.rst
Original file line number Diff line number Diff line change
Expand Up @@ -157,15 +157,15 @@ should use this XML block to configure their VM for kvmfr:
.. code:: xml
<qemu:commandline>
<qemu:arg value='-device'/>
<qemu:arg value='{"driver":"ivshmem-plain","id":"shmem0","memdev":"looking-glass"}'/>
<qemu:arg value='-object'/>
<qemu:arg value='{"qom-type":"memory-backend-file","id":"looking-glass","mem-path":"/dev/kvmfr0","size":33554432,"share":true}'/>
<qemu:arg value="-device"/>
<qemu:arg value="{'driver':'ivshmem-plain','id':'shmem0','memdev':'looking-glass'}"/>
<qemu:arg value="-object"/>
<qemu:arg value="{'qom-type':'memory-backend-file','id':'looking-glass','mem-path':'/dev/kvmfr0','size':33554432,'share':true}"/>
</qemu:commandline>
.. note::

- The ``"size"`` tag represents the size of the shared memory device in
- The ``'size'`` tag represents the size of the shared memory device in
bytes. Once you determine the proper size of the device as per
:ref:`Determining Memory <libvirt_determining_memory>`, use the figure you
got to calculate the size in bytes:
Expand All @@ -178,10 +178,10 @@ legacy syntax for IVSHMEM setup:
.. code:: xml
<qemu:commandline>
<qemu:arg value='-device'/>
<qemu:arg value='ivshmem-plain,id=shmem0,memdev=looking-glass'/>
<qemu:arg value='-object'/>
<qemu:arg value='memory-backend-file,id=looking-glass,mem-path=/dev/kvmfr0,size=32M,share=yes'/>
<qemu:arg value="-device"/>
<qemu:arg value="ivshmem-plain,id=shmem0,memdev=looking-glass"/>
<qemu:arg value="-object"/>
<qemu:arg value="memory-backend-file,id=looking-glass,mem-path=/dev/kvmfr0,size=32M,share=yes"/>
</qemu:commandline>
.. note::
Expand Down

2 comments on commit d21bdeb

@dinkonin
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think this fixes the issue it just changes &quot to &apos for me see here:
image

@gnif
Copy link
Owner

@gnif gnif commented on d21bdeb Jun 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I dont think this fixes the issue it just changes &quot to &apos for me see here: image

There really is no issue here to fix in the first place, it's simply to make things a bit more readable if possible.

Please sign in to comment.