From 252d1b61ed9bb0fcfede27e53b2954f4e970b6d3 Mon Sep 17 00:00:00 2001 From: Frediano Ziglio Date: Fri, 22 Jun 2018 21:31:51 +0100 Subject: [PATCH] ptypes: Improve some attribute documentation Signed-off-by: Frediano Ziglio Acked-by: Jonathon Jongsma --- 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..91c185d 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 allocates space for 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 stores a reference to the original message buffer so + # you should keep a reference to the original message to avoid a dangling + # pointer + # Is useful for large buffers to avoid extra memory allocation and copying 'as_ptr', # do not generate marshall code # used for last members to be able to marshall them manually