docs: add missing code-tags

Looks like I missed a few cases when I recently added more code-tags
here. So let's add these cases as well.

Signed-off-by: Erik Faye-Lund <erik.faye-lund@collabora.com>
Reviewed-by: Eric Engestrom <eric.engestrom@intel.com>
This commit is contained in:
Erik Faye-Lund
2019-06-06 10:16:36 +02:00
parent 54b7a1f175
commit 205f960e08
3 changed files with 30 additions and 26 deletions

View File

@@ -60,8 +60,9 @@ To add a new GL extension to Mesa you have to do at least the following.
as an example. as an example.
</li> </li>
<li> <li>
If the new extension adds new GL state, the functions in get.c, enable.c If the new extension adds new GL state, the functions in
and attrib.c will most likely require new code. <code>get.c</code>, <code>enable.c</code> and <code>attrib.c</code>
will most likely require new code.
</li> </li>
<li> <li>
To determine if the new extension is active in the current context, To determine if the new extension is active in the current context,
@@ -69,9 +70,10 @@ To add a new GL extension to Mesa you have to do at least the following.
defined in <code>src/mesa/main/extensions.h</code>. defined in <code>src/mesa/main/extensions.h</code>.
</li> </li>
<li> <li>
The dispatch tests check_table.cpp and <code>dispatch_sanity.cpp</code> The dispatch tests <code>check_table.cpp</code> and
should be updated with details about the new extensions functions. These <code>dispatch_sanity.cpp</code> should be updated with details about
tests are run using <code>meson test</code>. the new extensions functions. These tests are run using
<code>meson test</code>.
</li> </li>
</ul> </ul>

View File

@@ -133,13 +133,14 @@ sometimes be useful for debugging end-user issues.
<dt><code>3.0FC</code></dt> <dt><code>3.0FC</code></dt>
<dd>select a Core+Forward Compatible profile with GL version 3.0.</dd> <dd>select a Core+Forward Compatible profile with GL version 3.0.</dd>
<dt><code>3.1</code></dt> <dt><code>3.1</code></dt>
<dd>select GL version 3.1 with GL_ARB_compatibility enabled per the <dd>select GL version 3.1 with <code>GL_ARB_compatibility</code>
driver default.</dd> enabled per the driver default.</dd>
<dt><code>3.1FC</code></dt> <dt><code>3.1FC</code></dt>
<dd>select GL version 3.1 with forward compatibility and <dd>select GL version 3.1 with forward compatibility and
GL_ARB_compatibility disabled.</dd> <code>GL_ARB_compatibility</code> disabled.</dd>
<dt><code>3.1COMPAT</code></dt> <dt><code>3.1COMPAT</code></dt>
<dd>select GL version 3.1 with GL_ARB_compatibility enabled.</dd> <dd>select GL version 3.1 with <code>GL_ARB_compatibility</code>
enabled.</dd>
<dt><code>X.Y</code></dt> <dt><code>X.Y</code></dt>
<dd>override GL version to X.Y without changing the profile.</dd> <dd>override GL version to X.Y without changing the profile.</dd>
<dt><code>X.YFC</code></dt> <dt><code>X.YFC</code></dt>
@@ -164,9 +165,9 @@ sometimes be useful for debugging end-user issues.
<dt><code>MESA_GLSL_VERSION_OVERRIDE</code></dt> <dt><code>MESA_GLSL_VERSION_OVERRIDE</code></dt>
<dd>changes the value returned by <dd>changes the value returned by
<code>glGetString(GL_SHADING_LANGUAGE_VERSION)</code>. <code>glGetString(GL_SHADING_LANGUAGE_VERSION)</code>.
Valid values are integers, such as "130". Mesa will not really implement Valid values are integers, such as <code>130</code>. Mesa will not
all the features of the given language version if it's higher than what's really implement all the features of the given language version if
normally reported. (for developers only) it's higher than what's normally reported. (for developers only)
</dd> </dd>
<dt><code>MESA_GLSL_CACHE_DISABLE</code></dt> <dt><code>MESA_GLSL_CACHE_DISABLE</code></dt>
<dd>if set to <code>true</code>, disables the GLSL shader cache</dd> <dd>if set to <code>true</code>, disables the GLSL shader cache</dd>
@@ -362,8 +363,8 @@ Mesa EGL supports different sets of environment variables. See the
<dt><code>GALLIUM_HUD</code></dt> <dt><code>GALLIUM_HUD</code></dt>
<dd>draws various information on the screen, like framerate, <dd>draws various information on the screen, like framerate,
cpu load, driver statistics, performance counters, etc. cpu load, driver statistics, performance counters, etc.
Set <code>GALLIUM_HUD=help</code> and run e.g. glxgears for more Set <code>GALLIUM_HUD=help</code> and run e.g.
info.</dd> <code>glxgears</code> for more info.</dd>
<dt><code>GALLIUM_HUD_PERIOD</code></dt> <dt><code>GALLIUM_HUD_PERIOD</code></dt>
<dd>sets the hud update rate in seconds (float). Use zero <dd>sets the hud update rate in seconds (float). Use zero
to update every frame. The default period is 1/2 second.</dd> to update every frame. The default period is 1/2 second.</dd>
@@ -467,12 +468,12 @@ Mesa EGL supports different sets of environment variables. See the
<dd>for dumping shaders, constant buffers, etc. See the code for <dd>for dumping shaders, constant buffers, etc. See the code for
details.</dd> details.</dd>
<dt><code>SVGA_EXTRA_LOGGING</code></dt> <dt><code>SVGA_EXTRA_LOGGING</code></dt>
<dd>if set, enables extra logging to the vmware.log file, such as the <dd>if set, enables extra logging to the <code>vmware.log</code> file,
OpenGL program's name and command line arguments.</dd> such as the OpenGL program's name and command line arguments.</dd>
<dt><code>SVGA_NO_LOGGING</code></dt> <dt><code>SVGA_NO_LOGGING</code></dt>
<dd>if set, disables logging to the vmware.log file. This is useful when <dd>if set, disables logging to the <code>vmware.log</code> file. This is
using Valgrind because it otherwise crashes when initializing the host useful when using Valgrind because it otherwise crashes when
log feature.</dd> initializing the host log feature.</dd>
</dl> </dl>
<p>See the driver code for other, lesser-used variables.</p> <p>See the driver code for other, lesser-used variables.</p>

View File

@@ -96,17 +96,17 @@ the Xlib API:
<li>The GLX wire protocol is not supported and there's no OpenGL extension <li>The GLX wire protocol is not supported and there's no OpenGL extension
loaded by the X server. loaded by the X server.
<li>There is no hardware acceleration. <li>There is no hardware acceleration.
<li>The OpenGL library, libGL.so, contains everything (the programming API, <li>The OpenGL library, <code>libGL.so</code>, contains everything (the
the GLX functions and all the rendering code). programming API, the GLX functions and all the rendering code).
</ul> </ul>
<p> <p>
Alternately, Mesa acts as the core for a number of OpenGL hardware drivers Alternately, Mesa acts as the core for a number of OpenGL hardware drivers
within the DRI (Direct Rendering Infrastructure): within the DRI (Direct Rendering Infrastructure):
<ul> <ul>
<li>The libGL.so library provides the GL and GLX API functions, a GLX <li>The <code>libGL.so</code> library provides the GL and GLX API functions,
protocol encoder, and a device driver loader. a GLX protocol encoder, and a device driver loader.
<li>The device driver modules (such as r200_dri.so) contain a built-in <li>The device driver modules (such as <code>r200_dri.so</code>) contain
copy of the core Mesa code. a built-in copy of the core Mesa code.
<li>The X server loads the GLX module. <li>The X server loads the GLX module.
The GLX module decodes incoming GLX protocol and dispatches the commands The GLX module decodes incoming GLX protocol and dispatches the commands
to a rendering module. to a rendering module.
@@ -189,7 +189,8 @@ Mesa's not the solution.
<h3>2.3 Where is the GLUT library?</h3> <h3>2.3 Where is the GLUT library?</h3>
<p> <p>
GLUT (OpenGL Utility Toolkit) is no longer in the separate MesaGLUT-x.y.z.tar.gz file. GLUT (OpenGL Utility Toolkit) is no longer in the separate
<code>MesaGLUT-x.y.z.tar.gz</code> file.
If you don't already have GLUT installed, you should grab If you don't already have GLUT installed, you should grab
<a href="http://freeglut.sourceforge.net/">freeglut</a>. <a href="http://freeglut.sourceforge.net/">freeglut</a>.
</p> </p>