diff mbox

docs: Fix typos found by codespell

Message ID 20161101171927.25684-1-sw@weilnetz.de
State Under Review
Headers show

Commit Message

Stefan Weil Nov. 1, 2016, 5:19 p.m. UTC
Fix also some indefinite articles.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
---

I still don't understand the comment in docs/colo-proxy.txt.

Stefan

 docs/COLO-FT.txt    | 2 +-
 docs/colo-proxy.txt | 2 +-
 qemu-doc.texi       | 2 +-
 qemu-options.hx     | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

Comments

Peter Maydell Nov. 1, 2016, 5:32 p.m. UTC | #1
On 1 November 2016 at 17:19, Stefan Weil <sw@weilnetz.de> wrote:
> Fix also some indefinite articles.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
>
> I still don't understand the comment in docs/colo-proxy.txt.

> diff --git a/docs/colo-proxy.txt b/docs/colo-proxy.txt
> index 76767cb..6c8cca5 100644
> --- a/docs/colo-proxy.txt
> +++ b/docs/colo-proxy.txt
> @@ -158,7 +158,7 @@ secondary.
>
>  == Usage ==
>
> -Here, we use demo ip and port discribe more clearly.
> +Here, we use demo ip and port describe more clearly.

The problem with this sentence (as you note) is not the spelling
but that it is not clear what it is trying to say and needs
rewriting.

>  Primary(ip:3.3.3.3):
>  -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
>  -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66

thanks
-- PMM
Eric Blake Nov. 1, 2016, 5:52 p.m. UTC | #2
On 11/01/2016 12:19 PM, Stefan Weil wrote:
> Fix also some indefinite articles.
> 
> Signed-off-by: Stefan Weil <sw@weilnetz.de>
> ---
> 
> I still don't understand the comment in docs/colo-proxy.txt.

Me neither.


> +++ b/docs/colo-proxy.txt
> @@ -158,7 +158,7 @@ secondary.
>  
>  == Usage ==
>  
> -Here, we use demo ip and port discribe more clearly.
> +Here, we use demo ip and port describe more clearly.
>  Primary(ip:3.3.3.3):
>  -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
>  -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66

Maybe:

Here is an example using demonstration IP and port addresses to more
clearly describe the usage.

The remaining hunks are clear improvements, so:
Reviewed-by: Eric Blake <eblake@redhat.com>
Zhang Chen Nov. 2, 2016, 1:32 a.m. UTC | #3
On 11/02/2016 01:52 AM, Eric Blake wrote:
> On 11/01/2016 12:19 PM, Stefan Weil wrote:
>> Fix also some indefinite articles.
>>
>> Signed-off-by: Stefan Weil <sw@weilnetz.de>
>> ---
>>
>> I still don't understand the comment in docs/colo-proxy.txt.
> Me neither.
>
>

Which part of the docs/colo-proxy.txt?
Perhaps I can explain it more clearly and make the doc better.

>> +++ b/docs/colo-proxy.txt
>> @@ -158,7 +158,7 @@ secondary.
>>   
>>   == Usage ==
>>   
>> -Here, we use demo ip and port discribe more clearly.
>> +Here, we use demo ip and port describe more clearly.
>>   Primary(ip:3.3.3.3):
>>   -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
>>   -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
> Maybe:
>
> Here is an example using demonstration IP and port addresses to more
> clearly describe the usage.
>
> The remaining hunks are clear improvements, so:
> Reviewed-by: Eric Blake <eblake@redhat.com>

It's easier to understand.

Reviewed-by: Zhang Chen <zhangchen.fnst@cn.fujitsu.com>
Eric Blake Nov. 2, 2016, 1:29 p.m. UTC | #4
On 11/01/2016 08:32 PM, Zhang Chen wrote:

>>> I still don't understand the comment in docs/colo-proxy.txt.
>> Me neither.
>>
>>
> 
> Which part of the docs/colo-proxy.txt?

The one quoted below.

> Perhaps I can explain it more clearly and make the doc better.
> 
>>> +++ b/docs/colo-proxy.txt
>>> @@ -158,7 +158,7 @@ secondary.
>>>     == Usage ==
>>>   -Here, we use demo ip and port discribe more clearly.
>>> +Here, we use demo ip and port describe more clearly.
>>>   Primary(ip:3.3.3.3):
>>>   -netdev
>>> tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
>>>   -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
>> Maybe:
>>
>> Here is an example using demonstration IP and port addresses to more
>> clearly describe the usage.
>>
>> The remaining hunks are clear improvements, so:
>> Reviewed-by: Eric Blake <eblake@redhat.com>
> 
> It's easier to understand.

Okay, so you like my proposal for a potential reword.  Now, who should
submit it as a patch? Stefan (since he found the confusing sentence in
the first place), you (since you wrote most of the document to begin
with), or me (since I proposed wording that you like)?
Zhang Chen Nov. 3, 2016, 1:44 a.m. UTC | #5
On 11/02/2016 09:29 PM, Eric Blake wrote:
> On 11/01/2016 08:32 PM, Zhang Chen wrote:
>
>>>> I still don't understand the comment in docs/colo-proxy.txt.
>>> Me neither.
>>>
>>>
>> Which part of the docs/colo-proxy.txt?
> The one quoted below.
>
>> Perhaps I can explain it more clearly and make the doc better.
>>
>>>> +++ b/docs/colo-proxy.txt
>>>> @@ -158,7 +158,7 @@ secondary.
>>>>      == Usage ==
>>>>    -Here, we use demo ip and port discribe more clearly.
>>>> +Here, we use demo ip and port describe more clearly.
>>>>    Primary(ip:3.3.3.3):
>>>>    -netdev
>>>> tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
>>>>    -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
>>> Maybe:
>>>
>>> Here is an example using demonstration IP and port addresses to more
>>> clearly describe the usage.
>>>
>>> The remaining hunks are clear improvements, so:
>>> Reviewed-by: Eric Blake <eblake@redhat.com>
>> It's easier to understand.
> Okay, so you like my proposal for a potential reword.  Now, who should
> submit it as a patch? Stefan (since he found the confusing sentence in
> the first place), you (since you wrote most of the document to begin
> with), or me (since I proposed wording that you like)?
>

I will submit the patch later, if you think that's OK.
diff mbox

Patch

diff --git a/docs/COLO-FT.txt b/docs/COLO-FT.txt
index 6282938..043b14a 100644
--- a/docs/COLO-FT.txt
+++ b/docs/COLO-FT.txt
@@ -102,7 +102,7 @@  Primary side.
 COLO Proxy:
 Delivers packets to Primary and Seconday, and then compare the responses from
 both side. Then decide whether to start a checkpoint according to some rules.
-Please refer to docs/colo-proxy.txt for more informations.
+Please refer to docs/colo-proxy.txt for more information.
 
 Note:
 HeartBeat has not been implemented yet, so you need to trigger failover process
diff --git a/docs/colo-proxy.txt b/docs/colo-proxy.txt
index 76767cb..6c8cca5 100644
--- a/docs/colo-proxy.txt
+++ b/docs/colo-proxy.txt
@@ -158,7 +158,7 @@  secondary.
 
 == Usage ==
 
-Here, we use demo ip and port discribe more clearly.
+Here, we use demo ip and port describe more clearly.
 Primary(ip:3.3.3.3):
 -netdev tap,id=hn0,vhost=off,script=/etc/qemu-ifup,downscript=/etc/qemu-ifdown
 -device e1000,id=e0,netdev=hn0,mac=52:a4:00:12:78:66
diff --git a/qemu-doc.texi b/qemu-doc.texi
index 023c140..691acf9 100644
--- a/qemu-doc.texi
+++ b/qemu-doc.texi
@@ -1037,7 +1037,7 @@  qemu-system-i386 -iscsi initiator-name=iqn.qemu.test:my-initiator \
 @node disk_images_gluster
 @subsection GlusterFS disk images
 
-GlusterFS is an user space distributed file system.
+GlusterFS is a user space distributed file system.
 
 You can boot from the GlusterFS disk image with the command:
 @example
diff --git a/qemu-options.hx b/qemu-options.hx
index 95332cc..df5e4e7 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -2589,7 +2589,7 @@  qemu-system-i386 --drive file=sheepdog://192.0.2.1:30000/MyVirtualMachine
 See also @url{http://http://www.osrg.net/sheepdog/}.
 
 @item GlusterFS
-GlusterFS is an user space distributed file system.
+GlusterFS is a user space distributed file system.
 QEMU supports the use of GlusterFS volumes for hosting VM disk images using
 TCP, Unix Domain Sockets and RDMA transport protocols.