doc: make sure docs have been generated when installing

[libam7xxx.git] / HACKING.asciidoc

diff --git a/HACKING.asciidoc b/HACKING.asciidoc
index 5b2937d..99dc15e 100644 (file)
--- a/HACKING.asciidoc
+++ b/HACKING.asciidoc
@@ -11,7 +11,7 @@ The suggested way to hack on the project is:
 
   $ mkdir build
   $ cd build
 
   $ mkdir build
   $ cd build

-  $ cmake ../ -DCMAKE_BUILD_TYPE=debug
+  $ cmake ../ -DCMAKE_BUILD_TYPE=debug -DSTRICT_COMPILATION_CHECKS=ON

   $ make
 
 If you want to check the code with the ''sparse'' static analysis tool you
   $ make
 
 If you want to check the code with the ''sparse'' static analysis tool you


@@ -22,3 +22,10 @@ can run:
   $ cmake ../ -DCMAKE_C_COMPILER=cgcc
   $ make
 
   $ cmake ../ -DCMAKE_C_COMPILER=cgcc
   $ make
 

+=== Valgrind
+
+You can run the test program under the http://valgrind.org/[valgrind]
+dynamic analyzer by using a command like:
+
+  $ valgrind --leak-check=full --show-reachable=yes --track-origins=yes \
+    ./bin/picoproj -W 800 -H 480 -f my_image.jpg