Documentation/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://github.com/gnumaniacs/netsniff-ng.git
   6
   7 (Or fork it into your local repository on Github:
   8  https://github.com/gnumaniacs/netsniff-ng)
   9
  10 The best way to propose your ideas is to outline them in a short mail to
  11 workgroup@netsniff-ng.org or to our public mailing list address
  12 netsniff-ng@googlegroups.com. We are looking forward for your proposals!
  13 Of course, keep in mind that you can mail smaller portions of code like
  14 bug fixes immediately.
  15
  16 The best way to make a contribution to netsniff-ng is to send us your
  17 code in the form of a unified diff against the latest released or
  18 development version and, preferably, the master branch from our Git
  19 repository. Your patch should then be sent to workgroup@netsniff-ng.org
  20 or bugs@netsniff-ng.org. Don't forget to add a signed-off-by line (see
  21 also http://linux.yyz.us/patch-format.html).
  22
  23 Before submitting your patch make sure to indent your code appropriate.
  24 For this, have a look at our coding conventions within the CODING file.
  25 Note: avoid tools like indent for automatic code formatting, since they
  26 can screw up the format in some cases by not recognizing everything!
  27 Further, this is only for lazy people that do not stick to the kernel
  28 coding conventions anyway. We won't accept patches if they don't comply
  29 to these conventions, so get your act together.
  30
  31 There are so few source comments?! Yes, there are and this is intended!
  32 Some people think that lots of source comments means good quality of the
  33 source repository, or some smililar crude thoughts. Well, read the books.
  34 Source comments are code smells, except in a few cases. The few cases are
  35 that you explain why something is done in this way and why not in another.
  36 Somehow, people tend to explain what the sources itself does, which is
  37 just wrong. The source itself must be self-descriptive and readable without
  38 any comments. Keep that in mind while hacking on the toolkit. ;-)
  39
  40 The src/s/ directory contains a number of SmPL (Semantic Patch Language)
  41 scripts that can be used together with Coccinelle's spatch tool. In order
  42 to install spatch from the official tarballs, you might need to install
  43 the following packages on Debian:
  44  - ocaml-native-compilers (or alternatively ocaml)
  45  - ocaml-findlib
  46  - libpycaml-ocaml-dev
  47  - libsexplib-camlp4-dev
  48  - menhir and libmenhir-ocaml-dev
  49 Afterwards, you can build and install Coccinelle with:
  50    wget http://coccinelle.lip6.fr/distrib/coccinelle-1.0.0-rc7.tgz
  51    tar xvf coccinelle-1.0.0-rc7.tgz
  52    cd coccinelle-1.0.0-rc7/
  53    ./configure --prefix=/usr/
  54    make depend
  55    make all
  56    make install
  57 To check netsniff-ng against scripts from src/s/, do:
  58    cd src/
  59    make check
  60
  61 Well, I guess most has been said ... so happy packet hacking! We're looking
  62 forward for your patches, ideas and improvements!
  63