[PATCH 0/2] docs: domain: Fixes
Peter Krempa (2): docs: domain: Fix broken rST clauses docs: domain: Fix iothread to virtqueue mapping example docs/formatdomain.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) -- 2.43.0
Fix few malformed rST clauses breaking the 'Since' label and one internal link. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/formatdomain.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index 0a4f9d9000..ceb590f2b1 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -3368,7 +3368,7 @@ paravirtualized driver is specified via the ``disk`` element. - The optional ``queues`` attribute specifies the number of virt queues for virtio-blk ( :since:`Since 3.9.0` ) or vhost-user-blk - ( :since `Since 7.1.0` ) + ( :since:`Since 7.1.0` ) - The optional ``queue_size`` attribute specifies the size of each virt queue for virtio-blk or vhost-user-blk. ( :since:`Since 7.8.0` ) - For virtio disks, `Virtio-related options`_ can also @@ -4559,7 +4559,7 @@ or: found is "problematic" in some way, the generic vfio-pci driver similarly be forced. - (Note: :since:`Since 1.0.5, the ``name`` attribute has been + (Note: :since:`Since 1.0.5,` the ``name`` attribute has been described to be used to select the type of PCI device assignment ("vfio", "kvm", or "xen"), but those values have been mostly useless, since the type of device assignment is actually determined @@ -6347,7 +6347,7 @@ interaction with the admin. <audio id='1'> </graphics> - Where ``1`` is an id of the audio device (See`Audio backends`_). If no + Where ``1`` is an id of the audio device (See `Audio backends`_). If no ID is specified, then the default audio backend will be used. :since:`Since 7.2.0, qemu`. -- 2.43.0
Each queue can be referenced only once and queues are numbered starting from 0. Modify the example to show a valid configuration of one iothread servicing more queues. Signed-off-by: Peter Krempa <pkrempa@redhat.com> --- docs/formatdomain.rst | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst index ceb590f2b1..3e7dfb7f26 100644 --- a/docs/formatdomain.rst +++ b/docs/formatdomain.rst @@ -3352,15 +3352,13 @@ paravirtualized driver is specified via the ``disk`` element. handle given queues. :since:`Since 10.0.0 (QEMU 9.0, virtio disks only)`. Example:: - <driver name='qemu' queues='2'> + <driver name='qemu' queues='3'> <iothreads> - <iothread id='1'> - <queue id='1'/> - </iothread> <iothread id='2'> <queue id='1'/> </iothread> <iothread id='3'> + <queue id='0'/> <queue id='2'/> </iothread> </iothreads> -- 2.43.0
On a Friday in 2024, Peter Krempa wrote:
Peter Krempa (2): docs: domain: Fix broken rST clauses docs: domain: Fix iothread to virtqueue mapping example
docs/formatdomain.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
Reviewed-by: Ján Tomko <jtomko@redhat.com> Jano
On Fri, Feb 16, 2024 at 12:09:29PM +0100, Peter Krempa wrote:
Peter Krempa (2): docs: domain: Fix broken rST clauses docs: domain: Fix iothread to virtqueue mapping example
docs/formatdomain.rst | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-)
Reviewed-by: Andrea Bolognani <abologna@redhat.com> -- Andrea Bolognani / Red Hat / Virtualization
participants (3)
-
Andrea Bolognani -
Ján Tomko -
Peter Krempa