summaryrefslogtreecommitdiff
path: root/HACKING
diff options
context:
space:
mode:
authorChristian Grothoff <christian@grothoff.org>2011-06-10 10:45:33 +0000
committerChristian Grothoff <christian@grothoff.org>2011-06-10 10:45:33 +0000
commitf7b5b476ba55ee45fefff22777f525cc81b4cae8 (patch)
treea33e5983ab6c8b0e35c1055cb7503ec4fac90041 /HACKING
parent0ac9a4984e1e551293ea8ea00f3c8ea2c5460d91 (diff)
adding configure code for --enable-benchmarks, --enable-expensive-tests, some clean up
Diffstat (limited to 'HACKING')
-rw-r--r--HACKING40
1 files changed, 21 insertions, 19 deletions
diff --git a/HACKING b/HACKING
index 511a88060..535d4498f 100644
--- a/HACKING
+++ b/HACKING
@@ -13,6 +13,7 @@ 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!)
@@ -22,11 +23,11 @@ configuration:
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
@@ -43,7 +44,7 @@ testcases:
performance tests:
- must be called "perf_module-under-test_case-description.c"
- "case-description" maybe omitted if there is only one performance test
-
+- Must only be run if HAVE_BENCHMARKS is satisfied
src/ directories:
@@ -54,22 +55,6 @@ src/ directories:
- libgnunet_plugin_DIR_NAME: loadable plugins (i.e., libgnunet_plugin_transport_tcp)
-
-Minimum file-sharing system (in order of dependency):
-gnunet-service-arm
-gnunet-service-transport
-gnunet-service-core
-gnunet-daemon-hostlist
-gnunet-daemon-topology
-gnunet-service-statistics
-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
@@ -82,7 +67,6 @@ Coding style:
int i,j;
-
Build-system:
If you have code that is likely not to compile or build rules you might want to not
@@ -92,6 +76,24 @@ 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 run all testcases, including those that take a while, run configure with the
+--enable-expensive-testcases option.
+
+If you want to compile and run benchmarks, run configure with the
+--enable-benchmarks option.
+
If you want to obtain code coverage results, run configure with the
--enable-coverage option and run the coverage.sh script in contrib/.
+
+Minimum file-sharing system (in order of dependency):
+gnunet-service-arm
+gnunet-service-transport
+gnunet-service-core
+gnunet-daemon-hostlist
+gnunet-daemon-topology
+gnunet-service-statistics
+gnunet-service-datastore
+gnunet-service-datacache
+gnunet-service-dht
+gnunet-service-fs