From ca1d1efdf6767a00ccefd4e0c7d573d27e563592 Mon Sep 17 00:00:00 2001 From: Nikos Mavrogiannopoulos Date: Wed, 22 Oct 2014 16:35:42 +0200 Subject: document gnutls_fd_in_use() --- doc/cha-gtls-app.texi | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) (limited to 'doc/cha-gtls-app.texi') diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi index 2dd5c853a0..55d0879d51 100644 --- a/doc/cha-gtls-app.texi +++ b/doc/cha-gtls-app.texi @@ -271,8 +271,7 @@ library. @node Initialization @subsection Initialization -GnuTLS must be initialized before it can be used. The library is -initialized on load; prior to 3.3.0 was initialized by calling @funcref{gnutls_global_init}. +The GnuTLS library is initialized on load; prior to 3.3.0 was initialized by calling @funcref{gnutls_global_init}. The initialization typically enables CPU-specific acceleration, performs any required precalculations needed, opens any required system devices (e.g., /dev/urandom on Linux) and initializes subsystems that could be used later. @@ -280,6 +279,11 @@ and initializes subsystems that could be used later. The resources allocated by the initialization process will be released on library deinitialization, or explictly by calling @funcref{gnutls_global_deinit}. +Note that during initialization file descriptors may be kept open by +GnuTLS (e.g. /dev/urandom). The helper function @funcref{gnutls_fd_in_use} +is given to assist applications closing all unknown file descriptors +on initialization. + @c In order to take advantage of the internationalization features in @c GnuTLS, such as translated error messages, the application must set @c the current locale using @code{setlocale} before initializing GnuTLS. -- cgit v1.2.1