[Spice-devel] [PATCH spice-common] proto: Improve documentation for stream_report::num_drops

[Frediano Ziglio]

> 
> Hi,
> 
> On Wed, Jul 04, 2018 at 06:57:17PM +0100, Frediano Ziglio wrote:
> > Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> > ---
> >  spice.proto | 6 ++++--
> >  1 file changed, 4 insertions(+), 2 deletions(-)
> > 
> > diff --git a/spice.proto b/spice.proto
> > index e678ef8..3084c2b 100644
> > --- a/spice.proto
> > +++ b/spice.proto
> > @@ -1005,8 +1005,10 @@ channel DisplayChannel : BaseChannel {
> >          // the stream is not supported or that the client was not able
> >          // to decode it
> >          uint32 num_frames;
> > -        // the part of the above frames that were dropped by the client
> > due
> > -        // to late arrival time
> > +        // the number of the above frames that were dropped by the client
> > due
> > +        // to late arrival time (with latency < 0).
> > +        // This field set to UINT32_MAX and num_frames set to 0 indicate
> > stream
> > +        // not supported by client.
> 
> What is missing on the doc above where it says:
> 
>  |  // A special case is when num_frames == 0 and num_drops ==
>  |  // 0xffffffffu, this is used in the client to communicate that
>  |  // the stream is not supported or that the client was not able
>  |  // to decode it
> 

Nothing, missed that, nacked

> 
> >          uint32 num_drops;
> >          // end_frame_mm_time - client_mm_time
> >          int32 last_frame_delay;

Frediano