trace: Update README
authorJakob Bornecrantz <jakob@vmware.com>
Wed, 12 May 2010 22:07:17 +0000 (23:07 +0100)
committerJakob Bornecrantz <jakob@vmware.com>
Wed, 12 May 2010 22:07:17 +0000 (23:07 +0100)
src/gallium/drivers/trace/README

index 203c3851bc3ccf779ab2ccb25be6238a216e4bbc..cdcd8d2b4be9b8ee5eb6508433ee74e34aa75de0 100644 (file)
@@ -3,15 +3,15 @@
 
 = About =
 
-This directory contains a Gallium3D debugger pipe driver.
-It can traces all incoming calls and/or provide remote debugging functionality.
+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 =
@@ -36,40 +36,27 @@ Firefox or Internet Explorer.
 
 == Remote debugging ==
 
-For remote debugging
+For remote debugging see:
 
- export XMESA_TRACE=y
- GALLIUM_RBUG=true progs/trivial/tri
-
-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.
+  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.
 
 
 --