[Qemu-trivial] [PATCH] *-user: Improve documentation for lock_user function

[Qemu-trivial] [PATCH] *-user: Improve documentation for lock_user function

[Stefan Weil]

Add a missing "function" and replace "and" by "any".
BSD und Linux use the same documentation here, so fix both.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
---
 bsd-user/qemu.h   |    4 ++--
 linux-user/qemu.h |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/bsd-user/qemu.h b/bsd-user/qemu.h
index 325f564..1998af6 100644
--- a/bsd-user/qemu.h
+++ b/bsd-user/qemu.h
@@ -323,9 +323,9 @@ abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
 
 /* Functions for accessing guest memory.  The tget and tput functions
-   read/write single values, byteswapping as necessary.  The lock_user
+   read/write single values, byteswapping as necessary.  The lock_user function
    gets a pointer to a contiguous area of guest memory, but does not perform
-   and byteswapping.  lock_user may return either a pointer to the guest
+   any byteswapping.  lock_user may return either a pointer to the guest
    memory, or a temporary buffer.  */
 
 /* Lock an area of guest memory into the host.  If copy is true then the
diff --git a/linux-user/qemu.h b/linux-user/qemu.h
index 6ffe5a2..974c239 100644
--- a/linux-user/qemu.h
+++ b/linux-user/qemu.h
@@ -380,9 +380,9 @@ abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
 
 /* Functions for accessing guest memory.  The tget and tput functions
-   read/write single values, byteswapping as necessary.  The lock_user
+   read/write single values, byteswapping as necessary.  The lock_user function
    gets a pointer to a contiguous area of guest memory, but does not perform
-   and byteswapping.  lock_user may return either a pointer to the guest
+   any byteswapping.  lock_user may return either a pointer to the guest
    memory, or a temporary buffer.  */
 
 /* Lock an area of guest memory into the host.  If copy is true then the
-- 
1.7.9.5

[Qemu-devel] [PATCH] *-user: Improve documentation for lock_user function

[Stefan Weil]

Add a missing "function" and replace "and" by "any".
BSD und Linux use the same documentation here, so fix both.

Signed-off-by: Stefan Weil <sw@weilnetz.de>
---
 bsd-user/qemu.h   |    4 ++--
 linux-user/qemu.h |    4 ++--
 2 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/bsd-user/qemu.h b/bsd-user/qemu.h
index 325f564..1998af6 100644
--- a/bsd-user/qemu.h
+++ b/bsd-user/qemu.h
@@ -323,9 +323,9 @@ abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
 
 /* Functions for accessing guest memory.  The tget and tput functions
-   read/write single values, byteswapping as necessary.  The lock_user
+   read/write single values, byteswapping as necessary.  The lock_user function
    gets a pointer to a contiguous area of guest memory, but does not perform
-   and byteswapping.  lock_user may return either a pointer to the guest
+   any byteswapping.  lock_user may return either a pointer to the guest
    memory, or a temporary buffer.  */
 
 /* Lock an area of guest memory into the host.  If copy is true then the
diff --git a/linux-user/qemu.h b/linux-user/qemu.h
index 6ffe5a2..974c239 100644
--- a/linux-user/qemu.h
+++ b/linux-user/qemu.h
@@ -380,9 +380,9 @@ abi_long copy_from_user(void *hptr, abi_ulong gaddr, size_t len);
 abi_long copy_to_user(abi_ulong gaddr, void *hptr, size_t len);
 
 /* Functions for accessing guest memory.  The tget and tput functions
-   read/write single values, byteswapping as necessary.  The lock_user
+   read/write single values, byteswapping as necessary.  The lock_user function
    gets a pointer to a contiguous area of guest memory, but does not perform
-   and byteswapping.  lock_user may return either a pointer to the guest
+   any byteswapping.  lock_user may return either a pointer to the guest
    memory, or a temporary buffer.  */
 
 /* Lock an area of guest memory into the host.  If copy is true then the
-- 
1.7.9.5

Re: [Qemu-trivial] [Qemu-devel] [PATCH] *-user: Improve documentation for lock_user function

[Peter Maydell]

On 12 September 2013 18:57, Stefan Weil <sw@weilnetz.de> wrote:
> Add a missing "function" and replace "and" by "any".
> BSD und Linux use the same documentation here, so fix both.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

-- PMM

Re: [Qemu-devel] [PATCH] *-user: Improve documentation for lock_user function

[Peter Maydell]

On 12 September 2013 18:57, Stefan Weil <sw@weilnetz.de> wrote:
> Add a missing "function" and replace "and" by "any".
> BSD und Linux use the same documentation here, so fix both.
>
> Signed-off-by: Stefan Weil <sw@weilnetz.de>

Reviewed-by: Peter Maydell <peter.maydell@linaro.org>

-- PMM

Re: [Qemu-devel] [PATCH] *-user: Improve documentation for lock_user function

[Eric Blake]

[-- Attachment #1: Type: text/plain, Size: 288 bytes --]

On 09/12/2013 11:57 AM, Stefan Weil wrote:
> Add a missing "function" and replace "and" by "any".
> BSD und Linux use the same documentation here, so fix both.

s/und/and/

-- 
Eric Blake   eblake redhat com    +1-919-301-3266
Libvirt virtualization library http://libvirt.org


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 621 bytes --]

Re: [Qemu-trivial] [Qemu-devel] [PATCH] *-user: Improve documentation for lock_user function

[Stefan Weil]

Am 12.09.2013 20:26, schrieb Eric Blake:
> On 09/12/2013 11:57 AM, Stefan Weil wrote:
>> Add a missing "function" and replace "and" by "any".
>> BSD und Linux use the same documentation here, so fix both.
>
> s/und/and/

Indeed, thanks. Well, I am German, so I may write "und". :-)

Perhaps this can be fixed when the patch is added to qemu-trivial,
or I send an update, or we leave it as it is to document that I not
only fix typos, but also add new ones. ;-)

Stefan

Re: [Qemu-devel] [PATCH] *-user: Improve documentation for lock_user function

[Stefan Weil]

Am 12.09.2013 20:26, schrieb Eric Blake:
> On 09/12/2013 11:57 AM, Stefan Weil wrote:
>> Add a missing "function" and replace "and" by "any".
>> BSD und Linux use the same documentation here, so fix both.
>
> s/und/and/

Indeed, thanks. Well, I am German, so I may write "und". :-)

Perhaps this can be fixed when the patch is added to qemu-trivial,
or I send an update, or we leave it as it is to document that I not
only fix typos, but also add new ones. ;-)

Stefan

Re: [Qemu-trivial] [PATCH] *-user: Improve documentation for lock_user function

[Michael Tokarev]

12.09.2013 21:57, Stefan Weil wrote:
> Add a missing "function" and replace "and" by "any".
> BSD und Linux use the same documentation here, so fix both.

Thanks, applied to the trivial-patches queue (with the commit
comment fixup).

/mjt

Re: [Qemu-devel] [Qemu-trivial] [PATCH] *-user: Improve documentation for lock_user function

[Michael Tokarev]

12.09.2013 21:57, Stefan Weil wrote:
> Add a missing "function" and replace "and" by "any".
> BSD und Linux use the same documentation here, so fix both.

Thanks, applied to the trivial-patches queue (with the commit
comment fixup).

/mjt