* gettext.h --- external library
+binaries:
+- gnunet-service-xxx: service process (has listen socket)
+- gnunet-daemon-xxx: daemon process (no listen socket)
+- gnunet-helper-xxx[-yyy]: SUID helper for module xxx
+- gnunet-yyy: command-line tool for end-users
+- libgnunet_plugin_xxx_yyy.so: plugin for API xxx
+- libgnunetxxx.so: library for API xxx
+
+
+logging:
+- services and daemons use their directory name in GNUNET_log_setup (i.e. 'core')
+ and log using plain 'GNUNET_log'.
+- command-line tools use their full name in GNUNET_log_setup (i.e. 'gnunet-publish')
+ and log using plain 'GNUNET_log'.
+- service access libraries log using 'GNUNET_log_from' and use
+ 'DIRNAME-api' for the component (i.e. 'core-api')
+- pure libraries (without associated service) use 'GNUNET_log_from' with
+ the component set to their library name (without lib
+ or '.so'), which should also be their directory name (i.e. 'nat')
+- plugins should use 'GNUNET_log_from' with the directory name
+ and the plugin name combined to produce the component name (i.e. 'transport-tcp').
+- logging should be unified per-file by defining a LOG macro with the
+ appropriate arguments, along these lines:
+ #define LOG(kind,...) GNUNET_log_from (kind, "example-api",__VA_ARGS__)
+
+
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!)
Coding style:
-- GNU guidelines apply
+- GNU guidelines generally apply
- declare only one variable per line, so
int i;
instead of
int i,j;
+- Indentation should be done using the 'pre-commit' script in the top-level
+ directory using the patched (!) GNU indent. See also the posting at
+ https://gnunet.org/gnunetindentation
Build-system:
projects / oweals / gnunet.git / blobdiff