From 4bfc3d836166ad1ccfa864d18b1a467065f43dc0 Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Mon, 11 Jul 2016 17:44:28 +0200 Subject: doc: updated contribution guide --- CONTRIBUTING.md | 20 ++++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5372c54444..7a0a44c9ec 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -55,16 +55,16 @@ functions like ```gnutlsDoThat``` are not used. The exported function names usually start with the ```gnutls_``` prefix, and the words that follow specify the exact subsystem of gnutls that this function refers to. E.g. ```gnutls_x509_crt_get_dn```, refers to the X.509 -certificate parsing part of gnutls. Currently used prefixes are: -```gnutls_x509_crt_``` for the X.509 certificate part -```gnutls_openpgp_key_``` for the openpgp key part -```gnutls_session_``` for the TLS session part (but this may be omited) -```gnutls_handshake_``` for the TLS handshake part -```gnutls_record_``` for the TLS record protocol part -```gnutls_alert_``` for the TLS alert protocol part -```gnutls_credentials_``` for the credentials structures -```gnutls_global_``` for the global structures handling -and probably more. +certificate parsing part of gnutls. Some of the used prefixes are the +following. + * ```gnutls_x509_crt_``` for the X.509 certificate part + * ```gnutls_openpgp_key_``` for the openpgp key part + * ```gnutls_session_``` for the TLS session part (but this may be omited) + * ```gnutls_handshake_``` for the TLS handshake part + * ```gnutls_record_``` for the TLS record protocol part + * ```gnutls_alert_``` for the TLS alert protocol part + * ```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()``` -- cgit v1.2.1