[libvirt] [PATCH] tools: Fix grammar

Andrea Bolognani posted 1 patch 9 weeks ago
Test syntax-check passed
Patches applied successfully (tree, apply log)
git fetch https://github.com/patchew-project/libvirt tags/patchew/20190415145401.16309-1-abologna@redhat.com
tools/virsh-domain.c |  3 ++-
tools/virsh.pod      | 20 ++++++++++----------
tools/virt-admin.pod |  4 ++--
3 files changed, 14 insertions(+), 13 deletions(-)

[libvirt] [PATCH] tools: Fix grammar

Posted by Andrea Bolognani 9 weeks ago
Apparently "allow(s) to frobnicate" is not correct English, and
either "allow(s) one to frobnicate" or "allow(s) frobnicating"
should be used instead.

Spotted by Lintian (spelling-error-in-{binary,manpage} tags).

Signed-off-by: Andrea Bolognani <abologna@redhat.com>
---
 tools/virsh-domain.c |  3 ++-
 tools/virsh.pod      | 20 ++++++++++----------
 tools/virt-admin.pod |  4 ++--
 3 files changed, 14 insertions(+), 13 deletions(-)

diff --git a/tools/virsh-domain.c b/tools/virsh-domain.c
index d99b9afda9..da57d96d1a 100644
--- a/tools/virsh-domain.c
+++ b/tools/virsh-domain.c
@@ -8313,7 +8313,8 @@ static const vshCmdInfo info_desc[] = {
      .data = N_("show or set domain's description or title")
     },
     {.name = "desc",
-     .data = N_("Allows to show or modify description or title of a domain.")
+     .data = N_("Allows setting or modifying the description or title of "
+                "a domain.")
     },
     {.name = NULL}
 };
diff --git a/tools/virsh.pod b/tools/virsh.pod
index 3196636825..afc1684db0 100644
--- a/tools/virsh.pod
+++ b/tools/virsh.pod
@@ -778,7 +778,7 @@ effect on the next boot.
               New description or title message]
 
 Show or modify description and title of a domain. These values are user
-fields that allow to store arbitrary textual data to allow easy
+fields that allow storing arbitrary textual data to allow easy
 identification of domains. Title should be short, although it's not enforced.
 (See also B<metadata> that works with XML based domain metadata.)
 
@@ -1303,7 +1303,7 @@ within a certain range. Specifying I<buf-size> will control how much data can
 be simultaneously in-flight during the copy; larger values use more memory but
 may allow faster completion (the default value is usually correct).
 
-I<--transient-job> allows to specify that the user does not require the job to
+I<--transient-job> allows specifying that the user does not require the job to
 be recovered if the VM crashes or is turned off before the job completes. This
 flag removes the restriction of copy jobs to transient domains if that
 restriction is applied by the hypervisor.
@@ -1450,9 +1450,9 @@ bytes/s. Specifying a negative value is interpreted as an unsigned long
 value or essentially unlimited. The hypervisor can choose whether to
 reject the value or convert it to the maximum value allowed. Optionally a
 scaled positive number may be used as bandwidth (see B<NOTES> above). Using
-I<--bytes> with a scaled value allows to use finer granularity. A scaled value
-used without I<--bytes> will be rounded down to MiB/s. Note that the
-I<--bytes> may be unsupported by the hypervisor.
+I<--bytes> with a scaled value permits a finer granularity to be selected.
+A scaled value used without I<--bytes> will be rounded down to MiB/s. Note
+that the I<--bytes> may be unsupported by the hypervisor.
 
 
 =item B<domblkthreshold> I<domain> I<dev> I<threshold>
@@ -1876,7 +1876,7 @@ stats.
 [I<--edit>] [I<uri>] [I<key>] [I<set>] [I<--remove>]
 
 Show or modify custom XML metadata of a domain. The metadata is a user
-defined XML that allows to store arbitrary XML data in the domain definition.
+defined XML that allows storing arbitrary XML data in the domain definition.
 Multiple separate custom metadata pieces can be stored in the domain XML.
 The pieces are identified by a private XML namespace provided via the
 I<uri> argument. (See also B<desc> that works with textual metadata of
@@ -2327,8 +2327,8 @@ either parameter is the same as not specifying that parameter.
 =item B<screenshot> I<domain> [I<imagefilepath>] [I<--screen> B<screenID>]
 
 Takes a screenshot of a current domain console and stores it into a file.
-Optionally, if hypervisor supports more displays for a domain, I<screenID>
-allows to specify which screen will be captured. It is the sequential number
+Optionally, if the hypervisor supports more displays for a domain, I<screenID>
+allows specifying which screen will be captured. It is the sequential number
 of screen. In case of multiple graphics cards, heads are enumerated before
 devices, e.g. having two graphics cards, both with four heads, screen ID 5
 addresses the second head on the second card.
@@ -3392,8 +3392,8 @@ expected.
 
 Change media of CDROM or floppy drive. I<path> can be the fully-qualified path
 or the unique target name (<target dev='hdc'>) of the disk device. I<source>
-specifies the path of the media to be inserted or updated. Flag I<--block>
-allows to set the backing type in case a block device is used as media for the
+specifies the path of the media to be inserted or updated. The I<--block> flag
+allows setting the backing type in case a block device is used as media for the
 CDROM or floppy drive instead of a file.
 
 I<--eject> indicates the media will be ejected.
diff --git a/tools/virt-admin.pod b/tools/virt-admin.pod
index f06ee9247a..1ea6defa0e 100644
--- a/tools/virt-admin.pod
+++ b/tools/virt-admin.pod
@@ -149,8 +149,8 @@ libvirtd:///system is used.
 
 =head1 DAEMON COMMANDS
 
-The following commands allow to monitor the daemon's state as well as directly
-change its internal configuration.
+The following commands allow one to monitor the daemon's state as well as
+directly change its internal configuration.
 
 =over 4
 
-- 
2.20.1

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

Re: [libvirt] [PATCH] tools: Fix grammar

Posted by Eric Blake 9 weeks ago
On 4/15/19 9:54 AM, Andrea Bolognani wrote:
> Apparently "allow(s) to frobnicate" is not correct English, and
> either "allow(s) one to frobnicate" or "allow(s) frobnicating"
> should be used instead.
> 
> Spotted by Lintian (spelling-error-in-{binary,manpage} tags).
> 
> Signed-off-by: Andrea Bolognani <abologna@redhat.com>
> ---
>  tools/virsh-domain.c |  3 ++-
>  tools/virsh.pod      | 20 ++++++++++----------
>  tools/virt-admin.pod |  4 ++--
>  3 files changed, 14 insertions(+), 13 deletions(-)

Reviewed-by: Eric Blake <eblake@redhat.com>

-- 
Eric Blake, Principal Software Engineer
Red Hat, Inc.           +1-919-301-3226
Virtualization:  qemu.org | libvirt.org

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