HACKING

   1 Naming conventions:
   2
   3 include files:
   4 - _lib: library without need for a process
   5 - _service: library that needs a service process
   6 - _plugin: plugin definition
   7 - _protocol: structs used in network protocol
   8 - exceptions:
   9   * GNUNET_config.h      --- generated // FIXME: decapitalize
  10   * platform.h           --- first included
  11   * plibc.h              --- external library
  12   * gnunet_common.h      --- fundamental routines
  13   * gnunet_directories.h --- generated
  14   * gettext.h            --- external library
  15
  16
  17 exported symbols:
  18 - must start with "GNUNET_modulename_" and be defined in "modulename.c"
  19 - exceptions: those defined in gnunet_common.h
  20
  21
  22 testcases:
  23 - must be called "test_module-under-test_case-description.c"
  24 - "case-description" maybe omitted if there is only one test
  25
  26
  27 performance tests:
  28 - must be called "perf_module-under-test_case-description.c"
  29 - "case-description" maybe omitted if there is only one performance test
  30
  31
  32
  33 src/ directories:
  34 - gnunet-NAME: end-user applications (i.e., gnunet-search, gnunet-arm)
  35 - gnunet-service-NAME: service processes with accessor library (i.e., gnunet-service-arm)
  36 - libgnunetNAME: accessor library (_service.h-header) or standalone library (_lib.h-header)
  37 - gnunet-daemon-NAME: daemon process without accessor library (i.e., gnunet-daemon-hostlist) and no GNUnet management port
  38 - libgnunet_plugin_DIR_NAME: loadable plugins (i.e., libgnunet_plugin_transport_tcp)
  39
  40
  41
  42 Minimum file-sharing system (in order of dependency):
  43 gnunet-service-arm
  44 gnunet-service-transport
  45 gnunet-service-core
  46 gnunet-daemon-hostlist
  47 gnunet-daemon-topology
  48 gnunet-service-datastore
  49 gnunet-service-statistics
  50 gnunet-service-dv
  51 gnunet-service-dht
  52 gnunet-service-fs (or just lib?)