[Spice-devel] [PATCH spice-common] proto: Add some documentation to stream_report message

[Christophe Fergeau]

On Tue, Nov 28, 2017 at 10:43:33AM +0000, Frediano Ziglio wrote:
> Most of the documentation is extracted from notes in spice-server
> code and comments.
> 
> Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
> ---
>  spice.proto | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/spice.proto b/spice.proto
> index ea37225..c1e7b95 100644
> --- a/spice.proto
> +++ b/spice.proto
> @@ -991,11 +991,23 @@ channel DisplayChannel : BaseChannel {
>      message {
>          uint32 stream_id;
>          uint32 unique_id;
> +        // the mm_time of the first frame included in the report
>          uint32 start_frame_mm_time;
> +        // the mm_time of the last_frame included in the report

"last frame"? (no underscore)

>          uint32 end_frame_mm_time;
> +        // the number of frames that reached the client during the time the
> +        // report is referring to
> +        // A special case is when num_frames == 0 and num_drops ==
> +        // 0xffffffffu, this is used in the client to communicate that
> +        // specific stream is not supported

"a specific stream"?

>          uint32 num_frames;
> +        // the part of the above frames that was dropped by the client due
> +        // to late arrival time

"that were dropped"

Acked-by: Christophe Fergeau <cfergeau at redhat.com>
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 833 bytes
Desc: not available
URL: <https://lists.freedesktop.org/archives/spice-devel/attachments/20171129/e2eee5b5/attachment.sig>