diff options
author | Snir Sheriber <ssheribe@redhat.com> | 2019-12-08 14:16:45 +0200 |
---|---|---|
committer | Frediano Ziglio <fziglio@redhat.com> | 2019-12-16 08:59:04 +0000 |
commit | afa5e52f77638e41db879ca8a34b54363718ada2 (patch) | |
tree | 94e98ac8416d83edd5be900cb75ffaf12c3474f3 /docs | |
parent | 5f02dff835385d56d43b2dccd209918ebdeb80df (diff) |
docs: make spice_protocol.txt comply with asciidoctor syntax check
Source code cannot be added in the middle of a table as is, place inside
the a cell.
https://asciidoctor.org/docs/user-manual/#pipe-in-table-cell
Signed-off-by: Snir Sheriber <ssheribe@redhat.com>
Acked-by: Frediano Ziglio <fziglio@redhat.com>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/spice_protocol.txt | 40 |
1 files changed, 15 insertions, 25 deletions
diff --git a/docs/spice_protocol.txt b/docs/spice_protocol.txt index a6f0b01c..27e2d655 100644 --- a/docs/spice_protocol.txt +++ b/docs/spice_protocol.txt @@ -193,15 +193,11 @@ and ensure it was received within the allowed time-frame. + .. SpiceLinkMess definition. + -[source,c] ----- -UINT32 magic ----- -+ -value of this fields must be equal to SPICE_MAGIC -+ [cols="2*"] |=== +|UINT32 magic +|value of this fields must be equal to SPICE_MAGIC + |UINT32 major_version | value of this fields must be equal to SPICE_VERSION_MAJOR @@ -1413,20 +1409,16 @@ Pixmap lines are ordered from top to bottom (i.e., line 0 is the highest line). |UINT32 stride |number of bytes to add for moving from the beginning of line n to the beginning of line n+1 -|=== -+ + +a| [source,c] ---- union { - SPICE_ADDRESS palette; /* address of the color palette. Must be zero if no -color table is required for format */ + SPICE_ADDRESS palette; + UINT64 palette_id; } ---- -+ -[cols="2*"] -|=== -|UINT64 palette_id -|id of the palette, valid if FLAG_PAL_FROM_CACHE is set +|address of the color palette (must be zero if no color table is required for format) *or* id of the palette (valid if FLAG_PAL_FROM_CACHE is set). |SPICE_ADDRESS data |address of line 0 of the pixmap. @@ -1471,20 +1463,18 @@ pixmap lines are ordered from top to bottom (i.e. line 0 is the highest line). |UINT32 data_size |size of compressed data -|=== -+ + +a| [source,c] ---- union { - SPICE_ADDRESS palette; /* address of the color palette (see SpicePalette section -in “Raw raster image”). Zero value is disallowed. */ - UINT64 palette_id; /* id of the palette, valid if FLAG_PAL_FROM_CACHE -is set. */ + SPICE_ADDRESS palette; + UINT64 palette_id; } ---- -+ -[cols="2*"] -|=== +|address of the color palette (see SpicePalette section in “Raw raster image”)[zero value +is disallowed] *or* id of the palette (valid if FLAG_PAL_FROM_CACHE). + |UINT8[] data |compressed pixmap |=== |