X-Git-Url: https://git.dogcows.com/gitweb?a=blobdiff_plain;f=HACKING;h=3433ad67f608c15451ae84d9ffbc41b79df94931;hb=277db2822d79a6000d31b93ec963ae87286d6ade;hp=45104201d31c86c516f662e2d4e07e0c7443a2bf;hpb=f26f23de50cb7941a7702198e3b4d1b2f9de062e;p=chaz%2Fopenbox diff --git a/HACKING b/HACKING index 45104201..3433ad67 100644 --- a/HACKING +++ b/HACKING @@ -3,10 +3,7 @@ Woop, a HACKING document for openbox at last! dirs: kernel - core of the WM render - librender, rendering routines for the WM and for apps - cwmcc - client-wm-client communication. netwm/icccm helper routines - for the WM and apps - obcf - openbox config format, generic parser for config files - plugins - various plugins + parser - libparser, for parsing config files Beware the Client.transient_for. It can be set to a !NULL value of TRAN_GROUP, which is not a valid pointer. You must ALWAYS check for TRAN_GROUP before @@ -25,3 +22,19 @@ translate it into what you see. The Client.frame.area is the actual position and size of the entire frame. This is usually the value you want to use, unless you are in client.c (probably) and adjusting/using the position or size from the client's perspective. + +Indentation +----------- +For openbox, we aim to have consistent coding style. Some, but surely +not all, guidelines: + * use 4 space indents + * tabs should not appear in source files + * functions should have the opening and closing braces on their own + lines + * most other constructs should have braces on the same line as the + statement + * when in doubt look at the rest of the source + * vim users can use "set expandtab tabstop=4 shiftwidth=4 + softtabstop=4" for some of this + +