diff options
| author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2019-04-07 13:03:20 +0200 |
|---|---|---|
| committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2019-04-07 18:17:28 +0200 |
| commit | f4cfc7bad85b256c8b23e99f235096b9f611e06c (patch) | |
| tree | 11912539e0d13ec49d7f6a24880fa9c980257e6e | |
| parent | d5f5b6a200c815245853e7a47a1ea666217473b7 (diff) | |
| download | gnutls-f4cfc7bad85b256c8b23e99f235096b9f611e06c.tar.gz | |
CONTRIBUTING.md: document unit testing method of internal functions [ci skip]
Resolves: #749
Signed-off-by: Nikos Mavrogiannopoulos <nmav@gnutls.org>
| -rw-r--r-- | CONTRIBUTING.md | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 201efd133b..e38bba321e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -99,6 +99,9 @@ following. * ```gnutls_credentials_``` for the credentials structures * ```gnutls_global_``` for the global structures handling +All exported API functions must be listed in libgnutls.map +in order to be exported. + 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()`. @@ -108,9 +111,8 @@ 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. - -All exported functions must be listed in libgnutls.map.in, -in order to be exported. +They can however be used by unit tests in tests/ directory; in that +case they should be part of the GNUTLS_PRIVATE_3_4 tag in libgnutls.map. # Introducing new functions / API |