[Spice-devel] [PATCH spice-common] protocol: Add some documentation for inval_all_pixmaps message

[Frediano Ziglio]

> 
> This message is not straight forward to grasp.
> Not clear by the name why we need to wait other channels messages
> before resetting the image cache.
> 
> Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> ---
>  spice.proto | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/spice.proto b/spice.proto
> index 76cfef2..8ce2654 100644
> --- a/spice.proto
> +++ b/spice.proto
> @@ -736,6 +736,13 @@ channel DisplayChannel : BaseChannel {
>  	ResourceID resources[count] @end;
>      } @ctype(SpiceResourceList) inval_list;
>  
> +    /* This message is used to invalidate the complete image cache
> +     * on the client.
> +     * Due to sunchronization for GLZ images we must make sure

typo: sunchronization -> synchronization

> +     * that messages related to cached images on other channels
> +     * are processed so we send a list of channels with respective
> +     * message serial to wait for.
> +     */
>      message {
>  	uint8 wait_count;
>  	WaitForChannel wait_list[wait_count] @end;

Frediano