[Mesa-dev] [PATCH 09/14] mesa_glinterop: fix GL interop *_VERSION comments

[Emil Velikov]

From: Emil Velikov <emil.velikov at collabora.com>

Using the macro to set the version is wrong and ill-advised. Please don't
do it.

Cc: Marek Olšák <marek.olsak at amd.com>
Signed-off-by: Emil Velikov <emil.velikov at collabora.com>
---
Marek, now things start to unravel as to why you were not too excited on
the idea. Hopefully this comment makes things clearer/more descriptive.
If not please let me know how we can improve it.
---
 include/GL/mesa_glinterop.h | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/include/GL/mesa_glinterop.h b/include/GL/mesa_glinterop.h
index 5c172c6..f637409 100644
--- a/include/GL/mesa_glinterop.h
+++ b/include/GL/mesa_glinterop.h
@@ -93,7 +93,8 @@ enum {
  * Device information returned by Mesa.
  */
 typedef struct _mesa_glinterop_device_info {
-   /* The caller should set this to: MESA_GLINTEROP_DEVICE_INFO_VERSION */
+   /* The caller should set this to the version of the struct they support */
+   /* NOTE: Do not use the MESA_GLINTEROP_DEVICE_INFO_VERSION macro */
    uint32_t struct_version;
 
    /* PCI location */
@@ -124,7 +125,8 @@ typedef struct _mesa_glinterop_device_info {
  * Input parameters to Mesa interop export functions.
  */
 typedef struct _mesa_glinterop_export_in {
-   /* The caller should set this to: MESA_GLINTEROP_EXPORT_IN_VERSION */
+   /* The caller should set this to the version of the struct they support */
+   /* NOTE: Do not use the MESA_GLINTEROP_EXPORT_IN_VERSION macro */
    uint32_t struct_version;
 
    /* One of the following:
@@ -183,7 +185,8 @@ typedef struct _mesa_glinterop_export_in {
  * Outputs of Mesa interop export functions.
  */
 typedef struct _mesa_glinterop_export_out {
-   /* The caller should set this to: MESA_GLINTEROP_EXPORT_OUT_VERSION */
+   /* The caller should set this to the version of the struct they support */
+   /* NOTE: Do not use the MESA_GLINTEROP_EXPORT_OUT_VERSION macro */
    uint32_t struct_version;
 
    /* The DMABUF handle. It must be closed by the caller using the POSIX
-- 
2.8.2