Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
Cosmetics on bar for doc
[simgrid.git] / README.coding
index 1faa329..791d365 100644 (file)
@@ -64,7 +64,13 @@ The tree is not splited on projects, but on file finality:
 *****************************************************
 
 Most files use the Kernighan & Ritchie coding style with 2 spaces of
-indentation. The indent program can help you to stick to it. :)
+indentation. The indent program can help you to stick to it:
+
+indent -kr -l80 -nut -i2 -lps -npcs -br -brs -ce -cdw -bbo -npsl <myfile>
+
+The script ./tools/indent runs indent with the appropriate options.
+
+FIXME: this list of arguments is still to be discussed, maybe
 
 **
 ** Type naming standard
@@ -177,3 +183,14 @@ Since there is almost nothing in xbt_rl_module.c and xbt_sg_module.c,
 it'd be better to use symbol aliasing here (to declare in the object
 code that the same function have two names), but I'm still
 investigating the portability of the thing to windows.
+
+
+*
+* SimGrid Hacker Survival Guide (FIXME: should be betterly placed)
+********************************
+
+* If you break the logs (for example while hacking in the dynars), you
+  want to define XBT_LOG_MAYDAY at the beginning of log.h. It will
+  desactivate the whole logging mecanism, switching to printfs
+  instead. SimGrid becomes incredibly verbose when doing so, but it
+  you let you fixing the dynars.
\ No newline at end of file