X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=genevent-new%2FREADME;h=d38633d35cd22797ed87e03abb8d44e2daf45b65;hb=ba899d3dc9f7c730c8bf699617d5f7a22d196f37;hp=ad31d648e4d39986cd3d84184b5c765eca7532bc;hpb=af530af44a375e95f5d0ffcf8da4daa0b05584fb;p=lttv.git

diff --git a/genevent-new/README b/genevent-new/README
index ad31d648..d38633d3 100644
--- 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,11 +50,11 @@ 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 :
-	<sequence lengthtype=<uint>/><char></sequence>
+	<sequence><uint><char></sequence>
 		
 3 - The C code presents a \0 terminated string.