[Mesa-dev] [PATCH 3/3] mesa: add documentation for COMPAT suffix for MESA_GL_VERSION_OVERRIDE

[Andres Gomez]

Fixes: 2599b92eb97 ("mesa: allow forcing >=3.1 compatibility contexts
with MESA_GL_VERSION_OVERRIDE")

Cc: Marek Olšák <marek.olsak at amd.com>
Cc: Jordan Justen <jordan.l.justen at intel.com>
Cc: Ian Romanick <ian.d.romanick at intel.com>
Cc: Eric Engestrom <eric.engestrom at imgtec.com>
Cc: Emil Velikov <emil.velikov at collabora.com>
Signed-off-by: Andres Gomez <agomez at igalia.com>
---
 docs/envvars.html       | 6 ++++--
 src/mesa/main/version.c | 1 +
 2 files changed, 5 insertions(+), 2 deletions(-)

diff --git a/docs/envvars.html b/docs/envvars.html
index 4ea5670b78d..7306d9136ef 100644
--- a/docs/envvars.html
+++ b/docs/envvars.html
@@ -88,12 +88,13 @@ This is a work-around for that.
 <li>MESA_GL_VERSION_OVERRIDE - changes the value returned by
 glGetString(GL_VERSION) and possibly the GL API type.
 <ul>
-<li> The format should be MAJOR.MINOR[FC]
+<li> The format should be MAJOR.MINOR[FC|COMPAT]
 <li> FC is an optional suffix that indicates a forward compatible context.
 This is only valid for versions >= 3.0.
+<li> COMPAT is an optional suffix that indicates a compatibility context.
 <li> GL versions <= 3.1 are set to a compatibility (non-Core) profile
 <li> GL versions > 3.1 are set to a Core profile
-<li> Examples: 2.1, 3.0, 3.1, 3.1FC, 3.2, 3.2FC
+<li> Examples: 2.1, 3.0, 3.1, 3.1FC, 3.2, 3.2FC, 3.2COMPAT
 <ul>
 <li> 2.1 - select a compatibility (non-Core) profile with GL version 2.1
 <li> 3.0 - select a compatibility (non-Core) profile with GL version 3.0
@@ -101,6 +102,7 @@ This is only valid for versions >= 3.0.
 <li> 3.1FC - select a Core+Forward Compatible profile with GL version 3.1
 <li> 3.2 - select a Core profile with GL version 3.2
 <li> 3.2FC - select a Core+Forward Compatible profile with GL version 3.2
+<li> 3.2COMPAT - select a compatibility (non-Core) profile with GL version 3.2
 </ul>
 <li> Mesa may not really implement all the features of the given version.
 (for developers only)
diff --git a/src/mesa/main/version.c b/src/mesa/main/version.c
index 6a0894f5155..6aeb9a4348a 100644
--- a/src/mesa/main/version.c
+++ b/src/mesa/main/version.c
@@ -145,6 +145,7 @@ create_version_string(struct gl_context *ctx, const char *prefix)
  * 3.1FC: select a Core+Forward Compatible profile with GL version 3.1
  * 3.2: select a Core profile with GL version 3.2
  * 3.2FC: select a Core+Forward Compatible profile with GL version 3.2
+ * 3.2COMPAT: select a compatibility (non-Core) profile with GL version 3.2
  *
  * Example uses of MESA_GL_VERSION_OVERRIDE:
  *
-- 
2.15.1