diff options
author | Erik Faye-Lund <[email protected]> | 2020-06-12 20:09:42 +0200 |
---|---|---|
committer | Marge Bot <[email protected]> | 2020-06-13 10:42:00 +0000 |
commit | 4d066836e3cf307431a74eafcc8a404ce5ccea69 (patch) | |
tree | b0e3c39a971a564126b70368ae139a6e613d183f /docs/debugging.rst | |
parent | 1df5dbf51659000f74ca9511a211a7b026bfa936 (diff) |
docs: convert articles to reructuredtext
This uses the previously added scripts to convert the documentation to
reStructuredText, which is both easier to read offline, and can be used
to generate modern HTML for online documentation.
No modification to the generated results have been done.
Acked-by: Eric Engestrom <[email protected]>
Part-of: <https://gitlab.freedesktop.org/mesa/mesa/-/merge_requests/4630>
Diffstat (limited to 'docs/debugging.rst')
-rw-r--r-- | docs/debugging.rst | 17 |
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. |