HACKING.asciidoc: add commands to compile with clang

[libam7xxx.git] / HACKING.asciidoc

diff --git a/HACKING.asciidoc b/HACKING.asciidoc
index 3c1bc74..20c4aa2 100644 (file)
--- a/HACKING.asciidoc
+++ b/HACKING.asciidoc
@@ -19,6 +19,9 @@ On a Debian based system, the dependencies can be installed with this command:
                           libavdevice-dev \
                           libswscale-dev
 
                           libavdevice-dev \
                           libswscale-dev
 

+With libav/ffmpeg version previous than 0.9 this patch is needed:
+http://git.ao2.it/libam7xxx.git/blob_plain/refs/heads/debian:/debian/patches/0002-Revert-am7xxx-play-switch-to-avcodec_encode_video2.patch
+

 The library and the example programs can be compiled following these steps:
 
   $ git clone git://git.ao2.it/libam7xxx.git
 The library and the example programs can be compiled following these steps:
 
   $ git clone git://git.ao2.it/libam7xxx.git


@@ -47,6 +50,13 @@ can run:
   $ cmake -D CMAKE_C_COMPILER=cgcc ../
   $ make
 
   $ cmake -D CMAKE_C_COMPILER=cgcc ../
   $ make
 

+And for a pre-release check with a different compiler, which never hurts:
+
+  $ mkdir build
+  $ cd build
+  $ cmake -D CMAKE_C_COMPILER=clang -D CMAKE_BUILD_TYPE=debug -D STRICT_COMPILATION_CHECKS=ON ../
+  $ make
+

 === Cross Builds
 
 If you want to build for MS Windows:
 === Cross Builds
 
 If you want to build for MS Windows:


@@ -78,3 +88,8 @@ 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
 
   $ valgrind --leak-check=full --show-reachable=yes --track-origins=yes \
     ./bin/picoproj -W 800 -H 480 -f my_image.jpg

+
+or, for am7xxx-play:
+
+  $ valgrind --leak-check=full --show-reachable=yes --track-origins=yes \
+    ./bin/am7xxx-play -f x11grab -i :0