log local operations

[oweals/gnunet.git] / HACKING

diff --git a/HACKING b/HACKING
index ecd9e6adb1b8769c3eea63d570173eb234dd7edb..6e7a3e50edd85ef03c800bfb5fd6b4d52c06cca6 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -23,6 +23,23 @@ binaries:
 - libgnunetxxx.so: library for API xxx
 
 
+logging:
+- services and daemons use their directory name in GNUNET_log_setup (i.e. 'core')
+  and log using plain 'GNUNET_log'.
+- command-line tools use their full name in GNUNET_log_setup (i.e. 'gnunet-publish')
+  and log using plain 'GNUNET_log'.
+- service access libraries log using 'GNUNET_log_from' and use 
+  'DIRNAME-api' for the component (i.e. 'core-api')
+- pure libraries (without associated service) use 'GNUNET_log_from' with
+  the component set to their library name (without lib
+  or '.so'), which should also be their directory name (i.e. 'nat')
+- plugins should use 'GNUNET_log_from' with the directory name
+  and the plugin name combined to produce the component name (i.e. 'transport-tcp').
+- logging should be unified per-file by defining a LOG macro with the
+  appropriate arguments, along these lines:
+  #define LOG(kind,...) GNUNET_log_from (kind, "example-api",__VA_ARGS__)
+
+
 configuration:
 - paths (that are substituted in all filenames) are in PATHS (have as few as possible)
 - globals for the daemon are in [gnunetd] (for now, have as few as possible!)
@@ -65,7 +82,7 @@ src/ directories:
 
 
 Coding style:
-- GNU guidelines apply
+- GNU guidelines generally apply
 - declare only one variable per line, so 
 
   int i;
@@ -74,6 +91,9 @@ Coding style:
   instead of
 
   int i,j;
+- Indentation should be done using the 'pre-commit' script in the top-level
+  directory using the patched (!) GNU indent.  See also the posting at
+  https://gnunet.org/gnunetindentation
 
 
 Build-system: