[Spice-devel] [PATCH spice-common] ptypes: Improve some attribute documentation
Jonathon Jongsma
jjongsma at redhat.com
Wed Jun 27 19:57:31 UTC 2018
A couple minor language suggestions:
On Wed, 2018-06-27 at 17:47 +0100, Frediano Ziglio wrote:
> Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> ---
> python_modules/ptypes.py | 9 +++++++--
> 1 file changed, 7 insertions(+), 2 deletions(-)
>
> diff --git a/python_modules/ptypes.py b/python_modules/ptypes.py
> index 056e984..22a6f7b 100644
> --- a/python_modules/ptypes.py
> +++ b/python_modules/ptypes.py
> @@ -67,6 +67,7 @@ valid_attributes=set([
> 'end',
> # the C structure contains a pointer to data
> # for instance we want to write an array to an allocated array
> + # The demarshaller allocate space for data pointed by this
> pointer.
allocate -> allocates
data pointed by this pointer -> either:
A) data pointed to by this pointer
B) data that this pointer points to
> 'to_ptr',
> # write output to this C structure
> 'ctype',
> @@ -75,8 +76,12 @@ valid_attributes=set([
> # used in demarshaller to use directly data from message without
> a copy
> 'nocopy',
> # store member array in a pointer
> - # similar to to_ptr but has an additional argument which is the
> name of a C
> - # field which will store the array length
> + # Has an argument which is the name of a C field which will
> store the
> + # array length
> + # The demarshaller store a reference to the original message
> buffer so
store -> stores
> + # you should keep a reference to the original message to avoid a
> dandling
dandling -> dangling
> + # pointer
> + # Is useful for large buffers to avoid extra memory allocation
> and copy
copy -> copying
> 'as_ptr',
> # do not generate marshall code
> # used for last members to be able to marshall them manually
Acked-by: Jonathon Jongsma <jjongsma at redhat.com>
More information about the Spice-devel
mailing list