diff options
author | Erik Faye-Lund <[email protected]> | 2019-06-06 10:16:36 +0200 |
---|---|---|
committer | Erik Faye-Lund <[email protected]> | 2019-06-06 17:51:45 +0000 |
commit | 205f960e08d7b13ea529782e0e744c657bf1771f (patch) | |
tree | 6d114398ef8018c184a08a91f077d756c9df635a /docs | |
parent | 54b7a1f17599883c6a2aa78b9d6669c3b00ec55b (diff) |
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 <[email protected]>
Reviewed-by: Eric Engestrom <[email protected]>
Diffstat (limited to 'docs')
-rw-r--r-- | docs/devinfo.html | 12 | ||||
-rw-r--r-- | docs/envvars.html | 29 | ||||
-rw-r--r-- | docs/faq.html | 15 |
3 files changed, 30 insertions, 26 deletions
diff --git a/docs/devinfo.html b/docs/devinfo.html index a636e37ad35..0f1d5ac612b 100644 --- a/docs/devinfo.html +++ b/docs/devinfo.html @@ -60,8 +60,9 @@ To add a new GL extension to Mesa you have to do at least the following. as an example. </li> <li> - If the new extension adds new GL state, the functions in get.c, enable.c - and attrib.c will most likely require new code. + If the new extension adds new GL state, the functions in + <code>get.c</code>, <code>enable.c</code> and <code>attrib.c</code> + will most likely require new code. </li> <li> 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>. </li> <li> - The dispatch tests check_table.cpp and <code>dispatch_sanity.cpp</code> - should be updated with details about the new extensions functions. These - tests are run using <code>meson test</code>. + The dispatch tests <code>check_table.cpp</code> and + <code>dispatch_sanity.cpp</code> should be updated with details about + the new extensions functions. These tests are run using + <code>meson test</code>. </li> </ul> diff --git a/docs/envvars.html b/docs/envvars.html index c41820b8d39..ce3be81e754 100644 --- a/docs/envvars.html +++ b/docs/envvars.html @@ -133,13 +133,14 @@ sometimes be useful for debugging end-user issues. <dt><code>3.0FC</code></dt> <dd>select a Core+Forward Compatible profile with GL version 3.0.</dd> <dt><code>3.1</code></dt> - <dd>select GL version 3.1 with GL_ARB_compatibility enabled per the - driver default.</dd> + <dd>select GL version 3.1 with <code>GL_ARB_compatibility</code> + enabled per the driver default.</dd> <dt><code>3.1FC</code></dt> <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> - <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> <dd>override GL version to X.Y without changing the profile.</dd> <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> <dd>changes the value returned by <code>glGetString(GL_SHADING_LANGUAGE_VERSION)</code>. - Valid values are integers, such as "130". Mesa will not really implement - all the features of the given language version if it's higher than what's - normally reported. (for developers only) + Valid values are integers, such as <code>130</code>. Mesa will not + really implement all the features of the given language version if + it's higher than what's normally reported. (for developers only) </dd> <dt><code>MESA_GLSL_CACHE_DISABLE</code></dt> <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> <dd>draws various information on the screen, like framerate, cpu load, driver statistics, performance counters, etc. - Set <code>GALLIUM_HUD=help</code> and run e.g. glxgears for more - info.</dd> + Set <code>GALLIUM_HUD=help</code> and run e.g. + <code>glxgears</code> for more info.</dd> <dt><code>GALLIUM_HUD_PERIOD</code></dt> <dd>sets the hud update rate in seconds (float). Use zero 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 details.</dd> <dt><code>SVGA_EXTRA_LOGGING</code></dt> -<dd>if set, enables extra logging to the vmware.log file, such as the - OpenGL program's name and command line arguments.</dd> +<dd>if set, enables extra logging to the <code>vmware.log</code> file, + such as the OpenGL program's name and command line arguments.</dd> <dt><code>SVGA_NO_LOGGING</code></dt> -<dd>if set, disables logging to the vmware.log file. This is useful when - using Valgrind because it otherwise crashes when initializing the host - log feature.</dd> +<dd>if set, disables logging to the <code>vmware.log</code> file. This is + useful when using Valgrind because it otherwise crashes when + initializing the host log feature.</dd> </dl> <p>See the driver code for other, lesser-used variables.</p> diff --git a/docs/faq.html b/docs/faq.html index 67eda94c10a..00c17ea840a 100644 --- a/docs/faq.html +++ b/docs/faq.html @@ -96,17 +96,17 @@ the Xlib API: <li>The GLX wire protocol is not supported and there's no OpenGL extension loaded by the X server. <li>There is no hardware acceleration. -<li>The OpenGL library, libGL.so, contains everything (the programming API, - the GLX functions and all the rendering code). +<li>The OpenGL library, <code>libGL.so</code>, contains everything (the + programming API, the GLX functions and all the rendering code). </ul> <p> Alternately, Mesa acts as the core for a number of OpenGL hardware drivers within the DRI (Direct Rendering Infrastructure): <ul> -<li>The libGL.so library provides the GL and GLX API functions, a GLX - protocol encoder, and a device driver loader. -<li>The device driver modules (such as r200_dri.so) contain a built-in - copy of the core Mesa code. +<li>The <code>libGL.so</code> library provides the GL and GLX API functions, + a GLX protocol encoder, and a device driver loader. +<li>The device driver modules (such as <code>r200_dri.so</code>) contain + a built-in copy of the core Mesa code. <li>The X server loads the GLX module. The GLX module decodes incoming GLX protocol and dispatches the commands to a rendering module. @@ -189,7 +189,8 @@ Mesa's not the solution. <h3>2.3 Where is the GLUT library?</h3> <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 <a href="http://freeglut.sourceforge.net/">freeglut</a>. </p> |