X-Git-Url: http://git.meshlink.io/?a=blobdiff_plain;f=docs%2FHACKING;h=94a8366ab8f03d124be31023bc52b2a9150fe11e;hb=473963ea000bfe23a0d4754988223e4e6e2fb3f2;hp=46504da55ab58f4163be78e5064f58c4e6ee73c5;hpb=aa458a0a13d18882354f33c07b0a4e8e82e7a424;p=catta diff --git a/docs/HACKING b/docs/HACKING index 46504da..94a8366 100644 --- a/docs/HACKING +++ b/docs/HACKING @@ -1,19 +1,14 @@ Please comply with the following rules when hacking on Avahi: - * When you add a new textual file to the repository please enable SVN - keyword expansion for it: - - svn ps svn:keywords Id foo.c + * Before commiting check with "git st" that all built files are ignored + by git. To change the list of ignored files use - * Before commiting check with "svn st" that all built files are ignored - by svn. To change the list of ignored files use - - svn pe svn:ignore . + $VISUAL .gitignore This is similar to the ".cvsignore" file in CVS times. * Don't forget to add the autoconf config.h inclusion to all C source files: - + #ifdef HAVE_CONFIG_H #include #endif @@ -36,42 +31,12 @@ Please comply with the following rules when hacking on Avahi: your code thrice with your brain before committing. Valgrind is only a final check. - * 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 - * 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: For Makefile.am, python and shell code: -# $Id$ - # This file is part of avahi. # # avahi is free software; you can redistribute it and/or modify it @@ -93,8 +58,6 @@ Please comply with the following rules when hacking on Avahi: For C source code: -/* $Id$ */ - /*** This file is part of avahi. @@ -114,6 +77,3 @@ Please comply with the following rules when hacking on Avahi: USA. ***/ - - -$Id$