CONTRIBUTING.md: specify rules for static/inline functions [ci skip]
authorNikos Mavrogiannopoulos <nmav@gnutls.org>
Wed, 28 Nov 2018 19:08:29 +0000 (20:08 +0100)
committerNikos Mavrogiannopoulos <nmav@gnutls.org>
Wed, 28 Nov 2018 19:09:44 +0000 (20:09 +0100)
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
CONTRIBUTING.md

index aa1a6b9644cee50afcf45ef7db5abfbbffce748b..482dded5d7aa6088df1a8577cdeb552b42df221a 100644 (file)
@@ -99,8 +99,12 @@ following.
  * ```gnutls_credentials_``` for the credentials structures
  * ```gnutls_global_``` for the global structures handling
 
-Internal functions -- that are not exported in the API -- should
-be prefixed with an underscore. E.g. ```_gnutls_handshake_begin()```
+Internal functions, i.e, functions that are not exported in the API but
+are used internally by multiple files, should be prefixed with an underscore.
+For example `_gnutls_handshake_begin()`.
+
+Internal functions restricted to a file (static), or inline functions, should
+not use the `_gnutls` prefix for simplicity, e.g., `get_version()`.
 
 Internal structures should not be exported. Especially pointers to
 internal data. Doing so harms future reorganization/rewrite of subsystems.