protocol: add a comment about the wl_shm.format script
authorSimon Ser <contact@emersion.fr>
Mon, 2 Sep 2019 17:57:08 +0000 (20:57 +0300)
committerPekka Paalanen <pq@iki.fi>
Fri, 6 Sep 2019 12:09:22 +0000 (12:09 +0000)
Add a comment to wl_shm.format to advise contributors to use the automated
script (generate-shm-formats.py) instead of updating the list manually.

Signed-off-by: Simon Ser <contact@emersion.fr>
protocol/wayland.xml

index 94d4222..0833e2e 100644 (file)
        formats are optional and may not be supported by the particular
        renderer in use.
 
-       The drm format codes match the macros defined in drm_fourcc.h.
-       The formats actually supported by the compositor will be
-       reported by the format event.
+       The drm format codes match the macros defined in drm_fourcc.h, except
+       argb8888 and xrgb8888. The formats actually supported by the compositor
+       will be reported by the format event.
       </description>
+      <!-- Note to protocol writers: don't update this list manually, instead
+           run the automated script that keeps it in sync with drm_fourcc.h. -->
       <entry name="argb8888" value="0" summary="32-bit ARGB format, [31:0] A:R:G:B 8:8:8:8 little endian"/>
       <entry name="xrgb8888" value="1" summary="32-bit RGB format, [31:0] x:R:G:B 8:8:8:8 little endian"/>
       <entry name="c8" value="0x20203843" summary="8-bit color index format, [7:0] C"/>