Merged -correctxpath branch

[SXSI/xpathcomp.git] / HACKING

diff --git a/HACKING b/HACKING
index 92af1c6..06b4b21 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -17,6 +17,18 @@ make
 compile xpathcomp/
 make
 
+
+Building xpathcomp requires:
+
+libxml2.6++-dev 
+ocaml-findlib
+ocaml-ulex
+ocaml-nox
+camlp4
+
+and their dependencies
+
+
 you can compile with make DEBUG=true to get more statistics the overall programm is slower
 but you get precise timing for each individual function calls to the XMLTree interface.
 
@@ -26,6 +38,8 @@ Usage :
 
 file.xml is the input file. There are some in the tests subdirectory. At the moment you can mainly test
 with base.xml and tiny.xml. Any file bigger than this will take too much time to load.
+If the file ends with the .srx extensions then it is considered to be a serialized output saved to disk
+with the -s flag (see bellow).
 
 
 output is optional. If specified, it is the name of a file to which the result of the query is serialized.
@@ -33,14 +47,17 @@ If output is not given, the the result of the query is kept as a set of identifi
 the string collection is made.
 
 
-There are a few flags:
 
--f sample factor [default=64]
--i index empty texts [default=false]
--d Disable text collection[default=false]
--help  Display this list of options
---help  Display this list of options
 
+There are a few flags:
+
+./main <input.xml> 'query' [output]
+  -f sample factor [default=64]
+  -i index empty texts [default=false]
+  -d Disable text collection[default=false]
+  -s Save the intermediate representation into file.srx
+  -help  Display this list of options
+  --help  Display this list of options
 
 for instance:
 ./main -f 29 -d tests/tiny.xml '//para'