[Spice-devel] [spice-common v1 2/4] messages: document limitation of id in StreamCreate

[Victor Toso]

From: Victor Toso <me at victortoso.com>

Note that the ID limitation always existed but now we have the
limitation in the protocol itself with SPICE_MAX_NUM_STREAMS

Signed-off-by: Victor Toso <victortoso at redhat.com>
---
 common/messages.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/common/messages.h b/common/messages.h
index b838881..4fc03d4 100644
--- a/common/messages.h
+++ b/common/messages.h
@@ -327,7 +327,7 @@ typedef struct SpiceMsgDisplayInvalOne {
 
 typedef struct SpiceMsgDisplayStreamCreate {
     uint32_t surface_id;
-    uint32_t id;
+    uint32_t id; /* Any number from 0 to SPICE_MAX_NUM_STREAMS - 1 */
     uint32_t flags;
     uint32_t codec_type;
     uint64_t stamp;
-- 
2.16.2