Fix three pre-existing typos in the iothread poll sub-element
description:
- Remove spurious 'with' in 'poll with can be used to'
- Add missing closing ')' after the poll-grow/shrink '0' note
- Fix typo 'extensive' -> 'excessive'
Signed-off-by: Jaehoon Kim <jhkim@linux.ibm.com>
---
docs/formatdomain.rst | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst
index a861f9f177..3ba981422f 100644
--- a/docs/formatdomain.rst
+++ b/docs/formatdomain.rst
@@ -842,13 +842,13 @@ host/guest with many LUNs. :since:`Since 1.2.8 (QEMU only)`
``thread_pool_max`` which allow setting lower and upper boundary for number
of worker threads for given IOThread. While the former can be value of zero,
the latter can't. :since:`Since 8.5.0`
- :since:`Since 9.4.0` an optional sub-element ``poll`` with can be used to
+ :since:`Since 9.4.0` an optional sub-element ``poll`` can be used to
override the hypervisor-default interval of polling for the iothread before
it switches back to events. The optional attribute ``max`` sets the maximum
time polling should be used in nanoseconds. Setting ``max`` to ``0`` disables
polling. Attributes ``grow`` and ``shrink`` override (or disable when set to
- ``0`` the default steps for increasing/decreasing the polling interval if
- the set interval is deemed insufficient or extensive.
+ ``0``) the default steps for increasing/decreasing the polling interval if
+ the set interval is deemed insufficient or excessive.
``defaultiothread``
This element represents the default event loop within hypervisor, where I/O
requests from devices not assigned to a specific IOThread are processed.
--
2.54.0
On Wed, Jul 22, 2026 at 13:52:14 -0500, Jaehoon Kim wrote: > Fix three pre-existing typos in the iothread poll sub-element > description: > - Remove spurious 'with' in 'poll with can be used to' > - Add missing closing ')' after the poll-grow/shrink '0' note > - Fix typo 'extensive' -> 'excessive' > > Signed-off-by: Jaehoon Kim <jhkim@linux.ibm.com> > --- > docs/formatdomain.rst | 6 +++--- > 1 file changed, 3 insertions(+), 3 deletions(-) > > diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst > index a861f9f177..3ba981422f 100644 > --- a/docs/formatdomain.rst > +++ b/docs/formatdomain.rst > @@ -842,13 +842,13 @@ host/guest with many LUNs. :since:`Since 1.2.8 (QEMU only)` > ``thread_pool_max`` which allow setting lower and upper boundary for number > of worker threads for given IOThread. While the former can be value of zero, > the latter can't. :since:`Since 8.5.0` > - :since:`Since 9.4.0` an optional sub-element ``poll`` with can be used to > + :since:`Since 9.4.0` an optional sub-element ``poll`` can be used to > override the hypervisor-default interval of polling for the iothread before > it switches back to events. The optional attribute ``max`` sets the maximum > time polling should be used in nanoseconds. Setting ``max`` to ``0`` disables > polling. Attributes ``grow`` and ``shrink`` override (or disable when set to > - ``0`` the default steps for increasing/decreasing the polling interval if > - the set interval is deemed insufficient or extensive. > + ``0``) the default steps for increasing/decreasing the polling interval if > + the set interval is deemed insufficient or excessive. > ``defaultiothread`` > This element represents the default event loop within hypervisor, where I/O > requests from devices not assigned to a specific IOThread are processed. > -- > 2.54.0 > Reviewed-by: Peter Krempa <pkrempa@redhat.com> and I'll push this one right away.
On 7/29/2026 9:32 AM, Peter Krempa wrote: > On Wed, Jul 22, 2026 at 13:52:14 -0500, Jaehoon Kim wrote: >> Fix three pre-existing typos in the iothread poll sub-element >> description: >> - Remove spurious 'with' in 'poll with can be used to' >> - Add missing closing ')' after the poll-grow/shrink '0' note >> - Fix typo 'extensive' -> 'excessive' >> >> Signed-off-by: Jaehoon Kim <jhkim@linux.ibm.com> >> --- >> docs/formatdomain.rst | 6 +++--- >> 1 file changed, 3 insertions(+), 3 deletions(-) >> >> diff --git a/docs/formatdomain.rst b/docs/formatdomain.rst >> index a861f9f177..3ba981422f 100644 >> --- a/docs/formatdomain.rst >> +++ b/docs/formatdomain.rst >> @@ -842,13 +842,13 @@ host/guest with many LUNs. :since:`Since 1.2.8 (QEMU only)` >> ``thread_pool_max`` which allow setting lower and upper boundary for number >> of worker threads for given IOThread. While the former can be value of zero, >> the latter can't. :since:`Since 8.5.0` >> - :since:`Since 9.4.0` an optional sub-element ``poll`` with can be used to >> + :since:`Since 9.4.0` an optional sub-element ``poll`` can be used to >> override the hypervisor-default interval of polling for the iothread before >> it switches back to events. The optional attribute ``max`` sets the maximum >> time polling should be used in nanoseconds. Setting ``max`` to ``0`` disables >> polling. Attributes ``grow`` and ``shrink`` override (or disable when set to >> - ``0`` the default steps for increasing/decreasing the polling interval if >> - the set interval is deemed insufficient or extensive. >> + ``0``) the default steps for increasing/decreasing the polling interval if >> + the set interval is deemed insufficient or excessive. >> ``defaultiothread`` >> This element represents the default event loop within hypervisor, where I/O >> requests from devices not assigned to a specific IOThread are processed. >> -- >> 2.54.0 >> > Reviewed-by: Peter Krempa <pkrempa@redhat.com> > > and I'll push this one right away. Thanks for the review and for applying this. I'll drop this patch from the v2 series. Thanks, Jaehoon >
© 2016 - 2026 Red Hat, Inc.