Merge remote-tracking branch 'public/master' into vulkan

[mesa.git] / src / gallium / drivers / trace / README

diff --git a/src/gallium/drivers/trace/README b/src/gallium/drivers/trace/README
index 1000c31e49aa9da084d0b354066ec8b79e22fd7c..cacd2e17498d16c7aa3a2d59e821210aa959242a 100644 (file)
--- a/src/gallium/drivers/trace/README
+++ b/src/gallium/drivers/trace/README
@@ -3,76 +3,53 @@
 
 = About =
 
-This directory contains a Gallium3D debugger pipe driver.
-It can traces all incoming calls and/or provide remote debugging functionality.
-
-
-= Build Instructions =
-
-To build, invoke scons on the top dir as
- 
- scons dri=no statetrackers=mesa drivers=softpipe,i965simple,trace winsys=xlib
+This directory contains a Gallium3D trace debugger pipe driver.
+It can traces all incoming calls.
 
 
 = Usage =
 
-To use do
-
- export LD_LIBRARY_PATH=$PWD/build/linux-x86-debug/lib
-
-ensure the right libGL.so is being picked by doing
-
- ldd progs/trivial/tri 
-
-== Traceing ==
+== Tracing ==
 
-For traceing then do
+For tracing then do
 
- export XMESA_TRACE=y
- GALLIUM_TRACE=tri.trace progs/trivial/tri
+ GALLIUM_TRACE=tri.trace trivial/tri
 
 which should create a tri.trace file, which is an XML file. You can view copying 
 trace.xsl to the same directory, and opening with a XSLT capable browser such as 
 Firefox or Internet Explorer.
 
+For long traces you can use the
+
+  src/gallium/tools/trace/dump.py tri.trace | less -R
+
+
 == Remote debugging ==
 
-For remote debugging
+For remote debugging see:
 
- export XMESA_TRACE=y
- GALLIUM_RBUG=true progs/trivial/tri
+  src/gallium/drivers/rbug/README
 
-which should open gallium remote debugging session. While the program is running
-you can launch the small remote debugging application from progs/rbug. More
-information is in that directory.
 
 = Integrating =
 
 You can integrate the trace pipe driver either inside the state tracker or the 
-winsys. The procedure on both cases is the same. Let's assume you have a 
-pipe_screen and a pipe_context pair obtained by the usual means (variable and 
-function names are just for illustration purposes):
+target. The procedure on both cases is the same. Let's assume you have a 
+pipe_screen obtained by the usual means (variable and function names are just
+for illustration purposes):
 
   real_screen = real_screen_create(...);
   
-  real_context = real_context_create(...);
-  
-The trace screen and pipe_context is then created by doing
+The trace screen is then created by doing
 
   trace_screen = trace_screen_create(real_screen);
-  
-  trace_context = trace_context_create(trace_screen, real_context);
-  
-You can then simply use trace_screen and trace_context instead of real_screen
-and real_context.
 
-Do not call trace_winsys_create. Simply pass trace_screen->winsys or 
-trace_context->winsys in places you would pass winsys.
+You can then simply use trace_screen instead of real_screen.
 
-You can create as many contexts you wish. Just ensure that you don't mistake 
-trace_screen with real_screen when creating them.
+You can create as many contexts you wish from trace_screen::context_create they
+are automatically wrapped by trace_screen.
 
 
 --
-Jose Fonseca <jrfonseca@tungstengraphics.com>
+Jose Fonseca <jfonseca@vmware.com>
 Jakob Bornecrantz <jakob@vmware.com>