]> git.meshlink.io Git - catta/blobdiff - docs/HACKING
update TODO
[catta] / docs / HACKING
index a31878d0d498f4a8af04c53cf5edb16a7b2db9b8..eec7eb7eef884f5d80ac3203f02804966a636610 100644 (file)
@@ -25,33 +25,16 @@ Please comply with the following rules when hacking on Avahi:
 
  * Never forget that Avahi should be buildable without DBUS, GTK or python!
 
- * When you code in C, please compile with the following gcc options from time
-   to time:
-  
-   -Wextra
-   -Wfloat-equal 
-   -Wmissing-declarations
-   -Wmissing-prototypes
-   -Wstrict-prototypes
-   -Wredundant-decls
-   -Wold-style-definition
-   -Wmissing-noreturn
-   -Wdeclaration-after-statement
-   -Wshadow
-   -Wendif-labels
-   -Wlarger-than-4000
-   -Wpointer-arith
-   -Wbad-function-cast
-   -Wcast-qual
-   -Wcast-align
-   -Wwrite-strings
-   -Winline
-
-   This will show you a bunch of issues which might be problems in your source
-   code.  Not all options are available on all GCC versions. Just pass these
-   options in $CFLAGS when running bootstrap.sh:
-
-   CFLAGS="-Wextra ..." ./bootstrap.sh
+ * Before commiting, test your code! In case of C consider running it
+   a few times through valgrind, to make sure that you got everything
+   right.  You have to call libtool explicitly when running valgrind
+   on binaries that depend on shared objects. e.g:
+
+       libtool --mode=execute valgrind ./avahi-daemon
+
+   Please note that valgrind can't find you all bugs. Please check
+   your code thrice with your brain before committing. Valgrind is
+   only a final check.
 
  * Whenever you add a new Makefile.am, C (.c or .h) source file, shell or
    python script please add this legal blurb to its header: