diff options
author | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2011-02-02 10:35:46 +0100 |
---|---|---|
committer | Nikos Mavrogiannopoulos <nmav@gnutls.org> | 2011-02-02 10:35:46 +0100 |
commit | 825c616997bde56eafe4642d43f89b7efc495ad1 (patch) | |
tree | fc71dea2b1d3137d1743980ce32cbdd959ee8969 /doc/README.CODING_STYLE | |
parent | d09eaa578c979a2844e5ad36b0fc0c897be026c5 (diff) | |
download | gnutls-825c616997bde56eafe4642d43f89b7efc495ad1.tar.gz |
updated coding style.
Diffstat (limited to 'doc/README.CODING_STYLE')
-rw-r--r-- | doc/README.CODING_STYLE | 22 |
1 files changed, 9 insertions, 13 deletions
diff --git a/doc/README.CODING_STYLE b/doc/README.CODING_STYLE index 0f0ffd08e4..98c0260c85 100644 --- a/doc/README.CODING_STYLE +++ b/doc/README.CODING_STYLE @@ -3,17 +3,10 @@ The rules here are not always used, although we try to stick to them. *** File names: - All file names are usually prefixed with "gnutls_", "auth_", or - "x509_", or something else that indicates the part of gnutls - where this file refers to. The suffix should be more - specific. I.e., "gnutls_record.c" refers to the TLS library - and, more specifically, to the TLS record protocol. "auth_rsa.c" - is the implementation of the RSA certificate authentication - method. - - Another way to distinguish files might be using different - subdirectories. Use the lib/x509/ directory, which contains - all the X.509 certificate and crl stuff. + Files are split to directories according to the subsystem + they belong to. Examples are x509/, minitasn1/, openpgp/, + opencdk/ etc. The files in the root directory are of concern + to the main TLS protocol implementation. *** Function names: @@ -36,8 +29,11 @@ The rules here are not always used, although we try to stick to them. Internal functions -- that are not exported in the API -- should be prefixed with an underscore. E.g. _gnutls_handshake_begin() - All exported functions must be listed in gnutls.sym and gnutls-extra.sym - in order to be exported. [this is not true for now] + 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 and libgnutls-extra.map + in order to be exported. *** Constructed types: The constructed types in gnutls always have the "gnutls_" prefix. |