[libvirt] [PATCH] docs: Harmonize backend names for QEMU and LXC

Michael Weiser posted 1 patch 4 years, 3 months ago
Test syntax-check failed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20200103140906.647649-1-michael.weiser@gmx.de
docs/manpages/virsh.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
[libvirt] [PATCH] docs: Harmonize backend names for QEMU and LXC
Posted by Michael Weiser 4 years, 3 months ago
Trivially replace usages of qemu and lxc in the virsh manpage with their
more heavily used and (according to Wikipedia) correct upper-case
spellings QEMU and LXC.

Signed-off-by: Michael Weiser <michael.weiser@gmx.de>
Suggested-by: Daniel Henrique Barboza <danielhb413@gmail.com>
---
 docs/manpages/virsh.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/manpages/virsh.rst b/docs/manpages/virsh.rst
index fea0527caf..7e26676570 100644
--- a/docs/manpages/virsh.rst
+++ b/docs/manpages/virsh.rst
@@ -577,7 +577,7 @@ from the domain's XML <os/> element and <type/> subelement or one from a
 list of machines from the ``virsh capabilities`` output for a specific
 architecture and domain type.
 
-For the qemu hypervisor, a *virttype* of either 'qemu' or 'kvm' must be
+For the QEMU hypervisor, a *virttype* of either 'qemu' or 'kvm' must be
 supplied along with either the *emulatorbin* or *arch* in order to
 generate output for the default *machine*.  Supplying a *machine*
 value will generate output for the specific machine.
@@ -1072,7 +1072,7 @@ read I/O operations limit.
 write I/O operations limit.
 *--size-iops-sec* specifies size I/O operations limit per second.
 *--group-name* specifies group name to share I/O quota between multiple drives.
-For a qemu domain, if no name is provided, then the default is to have a single
+For a QEMU domain, if no name is provided, then the default is to have a single
 group for each *device*.
 
 Older versions of virsh only accepted these options with underscore
@@ -1084,7 +1084,7 @@ An explicit 0 also clears any limit.  A non-zero value for a given total
 cannot be mixed with non-zero values for read or write.
 
 It is up to the hypervisor to determine how to handle the length values.
-For the qemu hypervisor, if an I/O limit value or maximum value is set,
+For the QEMU hypervisor, if an I/O limit value or maximum value is set,
 then the default value of 1 second will be displayed. Supplying a 0 will
 reset the value back to the default.
 
@@ -1642,7 +1642,7 @@ domblkstat
 Get device block stats for a running domain.  A *block-device* corresponds
 to a unique target name (<target dev='name'/>) or source file (<source
 file='name'/>) for one of the disk devices attached to *domain* (see
-also ``domblklist`` for listing these names). On a lxc or qemu domain,
+also ``domblklist`` for listing these names). On a LXC or QEMU domain,
 omitting the *block-device* yields device block stats summarily for the
 entire domain.
 
@@ -3247,7 +3247,7 @@ destination). Some hypervisors do not support this feature and will return an
 error if this parameter is used.
 
 Optional *disks-port* sets the port that hypervisor on destination side should
-bind to for incoming disks traffic. Currently it is supported only by qemu.
+bind to for incoming disks traffic. Currently it is supported only by QEMU.
 
 
 migrate-compcache
-- 
2.24.1


--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list

Re: [libvirt] [PATCH] docs: Harmonize backend names for QEMU and LXC
Posted by Daniel Henrique Barboza 4 years, 3 months ago

On 1/3/20 11:09 AM, Michael Weiser wrote:
> Trivially replace usages of qemu and lxc in the virsh manpage with their
> more heavily used and (according to Wikipedia) correct upper-case
> spellings QEMU and LXC.
> 
> Signed-off-by: Michael Weiser <michael.weiser@gmx.de>
> Suggested-by: Daniel Henrique Barboza <danielhb413@gmail.com>
> ---


Thanks for sending this. You missed a few instances of 'qemu' though:

1213 *bandwidth* specifies copying bandwidth limit in MiB/s, although for
1214 qemu, it may be non-zero only for an online domain. For further information


7440 Send an arbitrary monitor command *command* to domain *domain* through the
7441 qemu monitor.  The results of the command will be printed on stdout.  If


7459 Send an arbitrary guest agent command *command* to domain *domain* through
7460 qemu agent.


These 'qemu' instances in lines 1214, 7441 and 7460 should be upper-cased as well.
The remaining lower-case references are fine since they're referencing commands
or URIs.


LXC instances are good to go.


Thanks,


DHB

--
libvir-list mailing list
libvir-list@redhat.com
https://www.redhat.com/mailman/listinfo/libvir-list