|author||Christian Grothoff <email@example.com>||2015-03-27 19:58:40 +0100|
|committer||Christian Grothoff <firstname.lastname@example.org>||2015-03-27 19:58:40 +0100|
major rename-fest for more constent symbol names
Diffstat (limited to 'doc')
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/coding-style.txt b/doc/coding-style.txt
index e9c3a313..093e14d3 100644
@@ -43,13 +43,17 @@ Naming conventions:
+ must start with TALER_[SUBSYSTEMNAME]_ where SUBSYSTEMNAME
MUST match the subdirectory of src/ in which the symbol is defined
+ from libtalerutil start just with TALER_, without subsystemname
+ + if scope is ONE binary and symbols are not in a shared library,
+ use binary-specific prefix (such as TMH = taler-mint-httpd) for
+ globals, possibly followed by the subsystem (TMH_DB_xxx).
+ structs that are 'packed' and do not contain pointers and are
thus suitable for hashing or similar operations are distinguished
by adding a "P" at the end of the name. (NEW) Note that this
convention does not hold for the GNUnet-structs (yet).
+ + structs that are used with a purpose for signatures, additionally
+ get an "S" at the end of the name.
* private (library-internal) symbols (including structs and macros)
+ must not start with TALER_ or any other prefix