rename

[oweals/gnunet.git] / HACKING

diff --git a/HACKING b/HACKING
index 73eda98e6b7742bee5320b57af8342cbf8a484c7..5008b49ce2507502015486837f61517d4504094c 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -13,11 +13,27 @@ include files:
   * gnunet_directories.h --- generated
   * gettext.h            --- external library
 
+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!)
+- all options for a particular module (src/MODULE) are under [MODULE]
+- options for a plugin of a module are under [MODULE-PLUGINNAME]
+- options only for debugging / testing / profiling are under [TESTING],
+  together with the options for the testing module itself
+
+
 
 exported symbols:
 - must start with "GNUNET_modulename_" and be defined in "modulename.c"
 - exceptions: those defined in gnunet_common.h
 
+private (library-internal) symbols (including structs & macros):
+- must NOT start with any prefix
+- must not be exported in a way that linkers could use them or
+  other libraries might see them via headers; they must be either
+  declared/defined in C source files or in headers that are in 
+  the respective directory under src/modulename/ and NEVER be
+  declared in src/include/.
 
 testcases:
 - must be called "test_module-under-test_case-description.c"
@@ -26,7 +42,7 @@ testcases:
 
 performance tests:
 - must be called "perf_module-under-test_case-description.c"
-- "case-description" maybe omitted if there is only one test
+- "case-description" maybe omitted if there is only one performance test