[gtk/debug-envvars-cleanup: 16/16] docs: Some updates
- From: Matthias Clasen <matthiasc src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk/debug-envvars-cleanup: 16/16] docs: Some updates
- Date: Thu, 22 Sep 2022 02:01:57 +0000 (UTC)
commit 6c95547c3fa0ae66356c6a849041e863b09e8c40
Author: Matthias Clasen <mclasen redhat com>
Date: Wed Sep 21 21:59:33 2022 -0400
docs: Some updates
Make the section about environment variables match
current code.
Add a warning about env vars not being stable and
only for debugging.
docs/reference/gtk/running.md | 28 ++++++++++++++++++++++------
1 file changed, 22 insertions(+), 6 deletions(-)
---
diff --git a/docs/reference/gtk/running.md b/docs/reference/gtk/running.md
index fd6f3d235d..01a53f5ce4 100644
--- a/docs/reference/gtk/running.md
+++ b/docs/reference/gtk/running.md
@@ -10,6 +10,10 @@ to determine paths to look for certain files. The [X11](#x11-envar),
[Broadway](#broadway-envar) GDK backends use some additional
environment variables.
+Note that environment variables are generally used for debugging
+purposes. They are not guaranteed to be API stable, and should not
+be used for end-user configuration and customization.
+
### `GTK_DEBUG`
This variable can be set to a list of debug options, which cause GTK to
@@ -75,6 +79,9 @@ A number of keys are influencing behavior instead of just logging:
`snapshot`
: Include debug render nodes in the generated snapshots
+`invert-text-dir`
+: Invert the text direction, compared to the locale
+
The special value `all` can be used to turn on all debug options.
The special value `help` can be used to obtain a list of all
supported debug options.
@@ -205,24 +212,33 @@ A number of options affect behavior instead of logging:
`gl-disable`
: Disable OpenGL support
-`gl-software`
-: Force OpenGL software rendering
-
-`gl-texture-rect`
-: Use the OpenGL texture rectangle extension, if available
-
`gl-legacy`
: Use a legacy OpenGL context
`gl-gles`
: Use a GLES OpenGL context
+`gl-egl`
+: Use an EGL context on X11 or Windows
+
+`gl-glx`
+: Use GLX on X11
+
+`gl-wgl`
+: Use WGL on Windows
+
`vulkan-disable`
: Disable Vulkan support
`vulkan-validate`
: Load the Vulkan validation layer, if available
+`default-settings`
+: Force default values for xsettings
+
+`high-depth`
+: Use high bit depth rendering if possible
+
The special value `all` can be used to turn on all debug options. The special
value `help` can be used to obtain a list of all supported debug options.
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]