diff options
| author | Frediano Ziglio <fziglio@redhat.com> | 2016-09-19 14:11:51 +0100 |
|---|---|---|
| committer | Frediano Ziglio <fziglio@redhat.com> | 2016-10-17 11:43:49 +0100 |
| commit | 4673a61cce1c81da7b4f5e2239484b57c1a4be8a (patch) | |
| tree | 6a5e34495b5d84fc8ab451a5c8b58142f2bf4c15 | |
| parent | 7773c0d59b0384237b549484da9cc8cac274cf58 (diff) | |
More work on attribute protocol documentation
Signed-off-by: Frediano Ziglio <fziglio@redhat.com>
Acked-by: Victor Toso <victortoso@redhat.com>
| -rw-r--r-- | docs/spice_protocol.txt | 21 |
1 files 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 ~~~~~~~~~ |