X-Git-Url: http://git.lttng.org./?a=blobdiff_plain;f=genevent-new%2FREADME;h=d38633d35cd22797ed87e03abb8d44e2daf45b65;hb=ba899d3dc9f7c730c8bf699617d5f7a22d196f37;hp=951f146cc556c6bad382207aaf45b982abb146bf;hpb=be97b9537557ac5ed4b010dbacb26be3452f6035;p=lttv.git
diff --git a/genevent-new/README b/genevent-new/README
index 951f146c..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 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 :
-
+
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 :