pxcloud/spice-common
5
0
Fork 0
mirror of https://gitlab.uni-freiburg.de/opensourcevdi/spice-common synced 2026-01-07 11:32:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix BNF notation in documentation

Browse Source 
Definition names have no angular brackets.

Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
This commit is contained in:
Frediano Ziglio 2016-10-18 10:20:00 +01:00
parent 4673a61cce
commit ced5c55925
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/spice_protocol.txt
View File

@ -176,9 +176,9 @@ Structures
The simpler coumpound type is the structure. As in C is defined as a list of fields (any variable or swicth).
But as a protocol definition there are no alignment or padding and every field (beside pointer values) follow each other.
<struct> ::= "struct" <identifier> "{" [ <fields> ] "}" <attributes> ";" ;
<fields> ::= <field>|<fields><field> ;
<field> ::= <variable>|<switch>
struct ::= "struct" <identifier> "{" [ <fields> ] "}" <attributes> ";" ;
fields ::= <field>|<fields><field> ;
field ::= <variable>|<switch>
Example:
@ -193,7 +193,7 @@ Messages
Messages have the same syntax of structure (beside `message`) with the different that they can
be used directly inside channels.
<message> ::= "message" <identifier> "{" [ <fields> ] "}" <attributes> ";" ;
message ::= "message" <identifier> "{" [ <fields> ] "}" <attributes> ";" ;
Switches
--------
@ -205,7 +205,7 @@ Type definitions
Like C type definition allow to short types defining new ones.
<typedef> ::= "typedef" <identifier> <type>`<attributes> ;
typedef ::= "typedef" <identifier> <type> <attributes> ;
note that unlike C name came before the type.