X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=genevent%2FREADME;h=182fbf057e1abfadda646a0c49944c5d9e76c908;hb=6a2c1aedca34471f2023e033ae7190bbaa7c0b0a;hp=9b34bf42245a2cad534ebb227f6c4c27b4acf6b9;hpb=3888436ce256d6b48f9354006a2acc8a25fb6889;p=lttv.git

diff --git a/genevent/README b/genevent/README
index 9b34bf42..182fbf05 100644
--- a/genevent/README
+++ b/genevent/README
@@ -1,3 +1,6 @@
+
+Mathieu Desnoyers -- September 2005
+
 The 'genevent' program parses event descriptions and generates 
 the inline functions to record events in the kernel.
 
@@ -12,3 +15,28 @@ those in LTT library.
 
 'core.xml' is an example event description file.
 
+Here is a brief description of how to use genevent.
+
+make
+make install
+
+
+* Add new events to the kernel with genevent
+
+su -
+cd /usr/local/share/LinuxTraceToolkitViewer/facilities
+cp process.xml yourfacility.xml
+  * edit yourfacility.xml to fit your needs.
+cd /tmp
+/usr/local/bin/genevent /usr/local/share/LinuxTraceToolkitViewer/yourfacility.xml
+cp ltt-facility-yourfacility.h ltt-facility-id-yourfacility.h \
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/include/linux/ltt
+cp ltt-facility-loader-yourfacility.c ltt-facility-loader-yourfacility.h \
+         /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/ltt
+  * edit the kernel file you want to instrument
+    - Add #include <linux/ltt/ltt-facility-yourfacility.h> at the beginning
+      of the file.
+    - Add a call to the tracing functions. See their names and parameters in
+      /usr/src/linux-2.6.12-rc4-mm2-lttng-0.2/include/linux/ltt/ltt-facility-yourfacility.h
+
+