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 branch from our Git repository.
  16 Your patch should then be sent to workgroup@netsniff-ng.org or
  17 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
  22 The src/s/ directory contains a number of SmPL (Semantic Patch Language)
  23 scripts that can be used together with Coccinelle's spatch tool. In order
  24 to install spatch from the official tarballs, you might need to install
  25 the following packages on Debian:
  26  - ocaml-native-compilers (or alternatively ocaml)
  27  - ocaml-findlib
  28  - libpycaml-ocaml-dev
  29  - libsexplib-camlp4-dev
  30  - menhir and libmenhir-ocaml-dev
  31 Afterwards, you can build and install Coccinelle with:
  32    wget http://coccinelle.lip6.fr/distrib/coccinelle-1.0.0-rc7.tgz
  33    tar xvf coccinelle-1.0.0-rc7.tgz
  34    cd coccinelle-1.0.0-rc7/
  35    ./configure --prefix=/usr/
  36    make depend
  37    make all
  38    make install
  39 To check netsniff-ng against scripts from src/s/, do:
  40    cd src/
  41    make check
  42
  43 Well, I guess most has been said ... so happy packet hacking! We're looking
  44 forward for your patches, ideas and improvements!
  45