Re: [Spice-devel] [PATCH spice-common 2/2] Add protocol documentation for "channel" and "protocol"

[Victor Toso]

Hi,

On Tue, Oct 18, 2016 at 10:20:44AM +0100, Frediano Ziglio wrote:
> Signed-off-by: Frediano Ziglio 

Acked-by: Victor Toso 
both patches

> ---
>  docs/spice_protocol.txt | 46 +-
>  1 file changed, 45 insertions(+), 1 deletion(-)
> 
> diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt
> index 892872d..e982d26 100644
> --- a/docs/spice_protocol.txt
> +++ b/docs/spice_protocol.txt
> @@ -220,7 +220,51 @@ Example:
>  Channels
>  
>  
> -TODO
> +channel ::= "channel"  [ ":"  ] "{" 
>  "}"  ";" ;
> +channel_messages ::= 
> | ;
> +channel_message ::= "server:" | "client:" | "message"  [ "=" 
>  ] ;
> +
> +Example:
> +
> +channel ExampleChannel {
> +server:
> +   message {
> +  uint32 dummy;
> +   } Dummy;
> +};
> +
> +Note that every message is associated with a number which is used in the 
> protocol.
> +The assignment work in a similar way to enumeration in C beside first 
> message is
> +assigned 1 value and not 0. So first message (if no integer is specified) is 
> assigned
> +1, second 2 and so on.
> +
> +`server:` or `client:` specify the direction of messages following, `server` 
> specify
> +messages from server while `client` from client. If not specified is assumed 
> from
> +server.
> +
> +For each channel you can specify a parent channel. Derived channel inherite 
> all
> +messages specified in the parent.
> +Note that messages from parent can be overrided by derived channels.
> +
> +Protocol
> +
> +
> +protocol ::= "protocol"  "{"  "}" ";" ;
> +protocol_channels ::= 
> | ;
> +protocol_channel ::=   [ "="  ] ";" ;
> +
> +Example:
> +
> +protocol Example {
> +ExampleChannel first = 1001;
> +};
> +
> +Protocol specify the list of channel supported. Channel have an associated 
> number
> +assigned in a similar way of channels (incremented from one to the next with
> +first starting from 0 if not specified).
> +
> +*NOTE*: Due to the way currently code is generate you should use
> +small numbers.
>  
>  Attributes
>  --
> -- 
> 2.7.4
> 
> ___
> Spice-devel mailing list
> Spice-devel@lists.freedesktop.org
> https://lists.freedesktop.org/mailman/listinfo/spice-devel


signature.asc
Description: PGP signature
___
Spice-devel mailing list
Spice-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/spice-devel

[Spice-devel] [PATCH spice-common 2/2] Add protocol documentation for "channel" and "protocol"

[Frediano Ziglio]

Signed-off-by: Frediano Ziglio 
---
 docs/spice_protocol.txt | 46 +-
 1 file changed, 45 insertions(+), 1 deletion(-)

diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt
index 892872d..e982d26 100644
--- a/docs/spice_protocol.txt
+++ b/docs/spice_protocol.txt
@@ -220,7 +220,51 @@ Example:
 Channels
 
 
-TODO
+channel ::= "channel"  [ ":"  ] "{" 
 "}"  ";" ;
+channel_messages ::= | 
;
+channel_message ::= "server:" | "client:" | "message"  [ "=" 
 ] ;
+
+Example:
+
+channel ExampleChannel {
+server:
+   message {
+  uint32 dummy;
+   } Dummy;
+};
+
+Note that every message is associated with a number which is used in the 
protocol.
+The assignment work in a similar way to enumeration in C beside first message 
is
+assigned 1 value and not 0. So first message (if no integer is specified) is 
assigned
+1, second 2 and so on.
+
+`server:` or `client:` specify the direction of messages following, `server` 
specify
+messages from server while `client` from client. If not specified is assumed 
from
+server.
+
+For each channel you can specify a parent channel. Derived channel inherite all
+messages specified in the parent.
+Note that messages from parent can be overrided by derived channels.
+
+Protocol
+
+
+protocol ::= "protocol"  "{"  "}" ";" ;
+protocol_channels ::= 
| ;
+protocol_channel ::=   [ "="  ] ";" ;
+
+Example:
+
+protocol Example {
+ExampleChannel first = 1001;
+};
+
+Protocol specify the list of channel supported. Channel have an associated 
number
+assigned in a similar way of channels (incremented from one to the next with
+first starting from 0 if not specified).
+
+*NOTE*: Due to the way currently code is generate you should use
+small numbers.
 
 Attributes
 --
-- 
2.7.4

___
Spice-devel mailing list
Spice-devel@lists.freedesktop.org
https://lists.freedesktop.org/mailman/listinfo/spice-devel