add scripts

[lttv.git] / genevent-new / README

diff --git a/genevent-new/README b/genevent-new/README
index 951f146cc556c6bad382207aaf45b982abb146bf..d38633d35cd22797ed87e03abb8d44e2daf45b65 100644 (file)
--- a/genevent-new/README
+++ b/genevent-new/README
@@ -12,6 +12,12 @@ There are several files in the directory:
 In fact, crc32.tab, parser.c and parser.h are the same files as  
 those in LTT library.
 
+Important notes : 
+       * Do not put "-" symbols in facilities name.
+       * Use the exact same name for facility xml file and for facility name.
+       * As from genevent 0.17, a standard XML 1.0 description is "required". It must
+               begin with the <?xml version="1.0"?> header.
+
 Note about strings :
 There are three methods to write strings in genevent, each suitable and
 efficient for a particular case. They are explained here from the fastest
@@ -22,7 +28,7 @@ to the slowest.
        as string definition.
 
        you must then define it as an array of char :
-       <array size=10/><char></array>
+       <array size="10"><char></array>
 
        Note, however, that you might not want to declare a fixed size for trace size
        and unnecessary copy matters.
@@ -44,7 +50,7 @@ to the slowest.
                size.
 
        A typical use for this case is filenames in the Linux kernel. The
-       dentry strucure has a d_name members, which is a struct qstr containing
+       dentry strucure has a d_name member, which is a struct qstr containing
        a unsigned int len and const unsigned char *name.
 
        you must use a sequence to declare this efficiently :