From 6d8691adaf1b7f1ec3f443ebb5cf494f5981b235 Mon Sep 17 00:00:00 2001 From: Antonio Ospite Date: Tue, 24 Jan 2012 14:55:54 +0100 Subject: [PATCH 1/1] Add a HACKING.asciidoc file Give some info about how to make a debug build and mention the coding style used in the project, so new contributors know how to behave. --- HACKING.asciidoc | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 HACKING.asciidoc diff --git a/HACKING.asciidoc b/HACKING.asciidoc new file mode 100644 index 0000000..5b2937d --- /dev/null +++ b/HACKING.asciidoc @@ -0,0 +1,24 @@ +== Hacking libam7xxx + +=== Coding style + +libam7xxx uses the linux kernel coding style: +http://kernel.org/doc/Documentation/CodingStyle + +=== Debug builds + +The suggested way to hack on the project is: + + $ mkdir build + $ cd build + $ cmake ../ -DCMAKE_BUILD_TYPE=debug + $ make + +If you want to check the code with the ''sparse'' static analysis tool you +can run: + + $ mkdir build + $ cd build + $ cmake ../ -DCMAKE_C_COMPILER=cgcc + $ make + -- 2.1.4