[Spice-devel] [PATCH spice-common 2/2] docs: Document to_ptr protocol attribute

[Snir Sheriber]

Hi


On 11/21/2018 11:14 AM, Frediano Ziglio wrote:
> Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> ---
>   docs/spice_protocol.txt | 25 ++++++++++++++++++++++++-
>   1 file changed, 24 insertions(+), 1 deletion(-)
>
> diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt
> index 5e13c93..0ef2800 100644
> --- a/docs/spice_protocol.txt
> +++ b/docs/spice_protocol.txt
> @@ -365,7 +365,30 @@ the attribute was attached to a `len`-sized array).
>   to_ptr
>   ~~~~~~
>   
> -TODO
> +This specifies that the corresponding C structure field contains a pointer to
> +the data. On marshalling the pointer is used, on demarshalling the data is
> +allocated in the memory block that holds the returned structure.
> +The type of this field must be a structure.
> +
> +Example:
> +
> +    struct test {
> +        uint16 num;
> +    };
> +
> +    struct msg {
> +        test ptr @to_ptr;
> +    };
> +
> +Output C structure:
> +
> +    struct test {
> +        uint16_t num;
> +    };
> +
> +    struct msg {
> +        struct test *ptr;
> +    };
>   

Looks good to me
ack
>   nocopy
>   ~~~~~~