X-Git-Url: https://git.librecmc.org/?a=blobdiff_plain;f=HACKING;h=142f83315bfd9be45683f575ad07820672887e89;hb=9ff5a5b4713dfefc3b42b66fb3865b1435667a77;hp=3c50af952cbf58312705520b814f0abdfe99dfa5;hpb=0a217a8df1657b4334b55b0e4a6c7837a8dbcfd9;p=oweals%2Fgnunet.git diff --git a/HACKING b/HACKING index 3c50af952..142f83315 100644 --- a/HACKING +++ b/HACKING @@ -13,6 +13,15 @@ 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" @@ -26,32 +35,27 @@ 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 src/ directories: -- apps: end-user applications (i.e., gnunet-search) -- connectors: libraries requiring services (i.e., libgnunetstatistics) -- libs: standalone libraries (i.e., libgnunetecrs, etc.) -- plugins: loadable plugins (i.e., TCP transport, MySQL backend) - * transports: udp/tcp/http/dv??? -- services: arm-controlled applications (i.e., gnunet-service-statistics) -- util: library for everyone - -For each directory in services, there should be one -in connectors and vice-versa. - -For each entry in apps, there should be one in libs. +- gnunet-NAME: end-user applications (i.e., gnunet-search, gnunet-arm) +- gnunet-service-NAME: service processes with accessor library (i.e., gnunet-service-arm) +- libgnunetNAME: accessor library (_service.h-header) or standalone library (_lib.h-header) +- gnunet-daemon-NAME: daemon process without accessor library (i.e., gnunet-daemon-hostlist) and no GNUnet management port +- libgnunet_plugin_DIR_NAME: loadable plugins (i.e., libgnunet_plugin_transport_tcp) Minimum file-sharing system (in order of dependency): -gnunet-arm -gnunet-transport (name?) -gnunet-core (name?) -gnunet-datastore -gnunet-statistics (integrate traffic?) -gnunet-dv -gnunet-dht -gnunet-fs +gnunet-service-arm +gnunet-service-transport +gnunet-service-core +gnunet-daemon-hostlist +gnunet-daemon-topology +gnunet-service-datastore +gnunet-service-statistics +gnunet-service-dv +gnunet-service-dht +gnunet-service-fs (or just lib?)