mantis #1844

[oweals/gnunet.git] / HACKING

diff --git a/HACKING b/HACKING
index bdbfd96bdfe01c5c9d2b3ebe6e9c663f1a514723..6e7a3e50edd85ef03c800bfb5fd6b4d52c06cca6 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -22,6 +22,7 @@ binaries:
 - libgnunet_plugin_xxx_yyy.so: plugin for API xxx
 - 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'.
@@ -32,6 +33,11 @@ logging:
 - 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: