/gpump/trunk

                           THE HACKING DOCUMENT

                    What to know when hacking on GPump

1) It is written in C/GLib

2) Use "1TBS" brace stryle.

3) Use two spaces for indentation

4) Use a spacious coding style. Put room between things as much as you can.

Examples:

Naming:

Files should be capitalised if, and only if they represent a type and or class.

files that only contain helper functions should not be capitalised.

Types should be capitalised but not variable or function names, this is to

comply with other GLib/GObject/GTK+ project naming conventions.

Pointers:

MyType * my_valiable;

MyType * my_function ();

Code example:

typedef struct Foo Foo;

struct Foo {

  gint some_int;

  GString * some_gstring;

  GIOStream * some_io_stream;

};

Foo * foo_new () {

  /* code goes here */

}