summaryrefslogtreecommitdiff
path: root/docs/debugging.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/debugging.rst')
-rw-r--r--docs/debugging.rst17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/debugging.rst b/docs/debugging.rst
new file mode 100644
index 00000000000..1e90c52a9cf
--- /dev/null
+++ b/docs/debugging.rst
@@ -0,0 +1,17 @@
+Debugging Tips
+==============
+
+Normally Mesa (and OpenGL) records but does not notify the user of
+errors. It is up to the application to call ``glGetError`` to check for
+errors. Mesa supports an environment variable, ``MESA_DEBUG``, to help
+with debugging. If ``MESA_DEBUG`` is defined, a message will be printed
+to stdout whenever an error occurs.
+
+More extensive error checking is done in DEBUG builds
+(``--buildtype debug`` for meson, ``build=debug`` for scons).
+
+In your debugger you can set a breakpoint in ``_mesa_error()`` to trap
+Mesa errors.
+
+There is a display list printing/debugging facility. See the end of
+``src/dlist.c`` for details.