HACKING

   1 Some information about potential netsniff-ng hackers can be found here!
   2 First of all, you might want to clone our git repository before you start
   3 hacking on anything:
   4
   5  $ git clone git://repo.or.cz/netsniff-ng.git
   6
   7 The best way to propose your ideas is to outline them in a short mail to
   8 workgroup@netsniff-ng.org or to our public mailing list address
   9 netsniff-ng@googlegroups.com. We are looking forward for your proposals!
  10 Of course, keep in mind that you can mail smaller portions of code like
  11 bug fixes immediately.
  12
  13 The best way to make a contribution to netsniff-ng is to send us your
  14 code in the form of a unified diff against the latest released or
  15 development version and, preferably, the master branch from our Git
  16 repository. Your patch should then be sent to workgroup@netsniff-ng.org
  17 or bugs@netsniff-ng.org.
  18
  19 Before submitting your patch make sure to indent your code appropriate.
  20 For this, have a look at our coding conventions within the CODING file.
  21 Note: avoid tools like indent for automatic code formatting, since they
  22 can screw up the format in some cases by not recognizing everything!
  23 Further, this is only for lazy people that do not stick to the kernel
  24 coding conventions anyway. We won't accept patches if they don't comply
  25 to these conventions, so get your act together.
  26
  27 The src/s/ directory contains a number of SmPL (Semantic Patch Language)
  28 scripts that can be used together with Coccinelle's spatch tool. In order
  29 to install spatch from the official tarballs, you might need to install
  30 the following packages on Debian:
  31  - ocaml-native-compilers (or alternatively ocaml)
  32  - ocaml-findlib
  33  - libpycaml-ocaml-dev
  34  - libsexplib-camlp4-dev
  35  - menhir and libmenhir-ocaml-dev
  36 Afterwards, you can build and install Coccinelle with:
  37    wget http://coccinelle.lip6.fr/distrib/coccinelle-1.0.0-rc7.tgz
  38    tar xvf coccinelle-1.0.0-rc7.tgz
  39    cd coccinelle-1.0.0-rc7/
  40    ./configure --prefix=/usr/
  41    make depend
  42    make all
  43    make install
  44 To check netsniff-ng against scripts from src/s/, do:
  45    cd src/
  46    make check
  47
  48 Well, I guess most has been said ... so happy packet hacking! We're looking
  49 forward for your patches, ideas and improvements!
  50