Fixed failing on sparcbot:

[oweals/gnunet.git] / HACKING

diff --git a/HACKING b/HACKING
index aa44285785dfe61f824ead0f1ad84c75324b01d3..511a88060b25376e5422a9fb0d6c7e3a724080f1 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -6,18 +6,34 @@ include files:
 - _plugin: plugin definition
 - _protocol: structs used in network protocol
 - exceptions:
-  * GNUNET_config.h      --- generated // FIXME: decapitalize
+  * gnunet_config.h      --- generated
   * platform.h           --- first included
   * plibc.h              --- external library
   * gnunet_common.h      --- fundamental routines
   * 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"
@@ -45,8 +61,37 @@ gnunet-service-transport
 gnunet-service-core
 gnunet-daemon-hostlist
 gnunet-daemon-topology
-gnunet-service-datastore
 gnunet-service-statistics
-gnunet-service-dv
+gnunet-service-datastore
+gnunet-service-datacache
 gnunet-service-dht
 gnunet-service-fs (or just lib?)
+
+
+
+
+Coding style:
+- GNU guidelines apply
+- declare only one variable per line, so 
+
+  int i;
+  int j;
+
+  instead of
+
+  int i,j;
+
+
+
+Build-system:
+
+If you have code that is likely not to compile or build rules you might want to not
+trigger for most developers, use "if HAVE_EXPERIMENTAL" in your Makefile.am.  Then
+it is OK to (temporarily) add non-compiling (or known-to-not-port) code.
+
+If you want to compile all testcases but NOT run them, run configure with the
+--enable-test-suppression option.
+
+If you want to obtain code coverage results, run configure with the
+--enable-coverage option and run the coverage.sh script in contrib/.
+