diff options
| author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2018-11-28 20:08:29 +0100 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2018-11-28 20:09:44 +0100 |
| commit | 374e08805076f3054e77f648c041446bf0eb548d (patch) | |
| tree | 2171af91292913fc7124e88eca572653e7216094 | |
| parent | 25176917235c1988ef46dd2ec70c1b82a2d59e4e (diff) | |
| download | gnutls-tmp-comment-style.tar.gz | |
CONTRIBUTING.md: specify rules for static/inline functions [ci skip]tmp-comment-style
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aa1a6b9644..482dded5d7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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. |