scons: Remove debug print statement.
[mesa.git] / src / gallium / drivers / trace / README
index 73dce20372e25e5dcfd121bb65de23e6862c49f1..cdcd8d2b4be9b8ee5eb6508433ee74e34aa75de0 100644 (file)
@@ -3,14 +3,15 @@
 
 = About =
 
-This directory contains a Gallium3D pipe driver which traces all incoming calls.
+This directory contains a Gallium3D trace debugger pipe driver.
+It can traces all incoming calls.
 
 
 = Build Instructions =
 
 To build, invoke scons on the top dir as
  
- scons dri=no statetrackers=mesa drivers=softpipe,i965simple,trace winsys=xlib
+ scons dri=no statetrackers=mesa winsys=xlib
 
 
 = Usage =
@@ -23,42 +24,41 @@ ensure the right libGL.so is being picked by doing
 
  ldd progs/trivial/tri 
 
-and then try running
+== Tracing ==
+
+For tracing then do
 
- export XMESA_TRACE=y
  GALLIUM_TRACE=tri.trace progs/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.
 
+== Remote debugging ==
+
+For remote debugging see:
+
+  src/gallium/drivers/rbug/README
 
 = 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>
+Jakob Bornecrantz <jakob@vmware.com>