[PATCH v2 4/4] More work on attribute protocol documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



Signed-off-by: Frediano Ziglio <fziglio@xxxxxxxxxx>
---
 docs/spice_protocol.txt | 21 +++++++++++++++++----
 1 file changed, 17 insertions(+), 4 deletions(-)

diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt
index 832ea73..13506f1 100644
--- a/docs/spice_protocol.txt
+++ b/docs/spice_protocol.txt
@@ -336,12 +336,21 @@ TODO
 nomarshal
 ~~~~~~~~~
 
-TODO
+Do not generate code for marshalling this variable.
+Usually used on last array element to make possible to manually feed data.
+
+Example:
+    struct Data {
+        uint32 data_size;
+        uint8 data[data_size] @nomarshal;
+    };
 
 zero_terminated
 ~~~~~~~~~~~~~~~
 
-TODO
+The field should terminated by zero.
+Actually it's not used by python code so it's not enforced and no
+code is generated.
 
 marshall
 ~~~~~~~~
@@ -351,12 +360,16 @@ TODO
 nonnull
 ~~~~~~~
 
-TODO
+This pointer field cannot be NULL. This means that marshaller assume C structure
+contain not NULL pointer and demarshaller will fail to demarshall message if offset
+is 0.
 
 unique_flag
 ~~~~~~~~~~~
 
-TODO
+This flag field should contain just a single flag.
+Actually it's not used by python code so it's not enforced and no
+code is generated.
 
 ptr_array
 ~~~~~~~~~
-- 
2.7.4

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




[Index of Archives]     [Linux ARM Kernel]     [Linux ARM]     [Linux Omap]     [Fedora ARM]     [IETF Annouce]     [Security]     [Bugtraq]     [Linux]     [Linux OMAP]     [Linux MIPS]     [ECOS]     [Asterisk Internet PBX]     [Linux API]     [Monitors]