[Spice-devel] [PATCH spice-common 1/2] Fix BNF notation in documentation
Frediano Ziglio
fziglio at redhat.com
Tue Oct 18 09:20:43 UTC 2016
Definition names have no angular brackets.
Signed-off-by: Frediano Ziglio <fziglio at redhat.com>
---
docs/spice_protocol.txt | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt
index 1d45b34..892872d 100644
--- a/docs/spice_protocol.txt
+++ b/docs/spice_protocol.txt
@@ -180,9 +180,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:
@@ -197,7 +197,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
--------
@@ -209,7 +209,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.
--
2.7.4
More information about the Spice-devel
mailing list