doc: added clarifications on documentation for dane_state_t

diff --git a/doc/cha-gtls-app.texi b/doc/cha-gtls-app.texi
index 995abdff6088f0d96e7f21aeda561d7c35f41a66..8ec6b6adad8b79226b416e41dafa18af7604a771 100644 (file)
--- a/doc/cha-gtls-app.texi
+++ b/doc/cha-gtls-app.texi
@@ -1562,7 +1562,9 @@ The high level functionality provided by the DANE library is shown below.
 
 Note that the @code{dane_state_t} structure that is accepted by both
 verification functions is optional. It is required when many queries
-are performed to facilitate caching.
+are performed to optimize against multiple re-initializations of the
+resolving back-end and loading of DNSSEC keys.
+
 The following flags are returned by the verify functions to
 indicate the status of the verification.
 

diff --git a/libdane/dane.c b/libdane/dane.c
index 42233504970e2c93e061b63b278d5262a58c814b..dd5378ef413134f2092840454ffc9951a3ba7dc0 100644 (file)
--- a/libdane/dane.c
+++ b/libdane/dane.c
@@ -223,7 +223,9 @@ dane_query_to_raw_tlsa(dane_query_t q, unsigned int *data_entries,
  * @s: The structure to be initialized
  * @flags: flags from the %dane_state_flags enumeration
  *
- * This function will initialize a DANE query structure.
+ * This function will initialize the backend resolver. It is
+ * intended to be used in scenarios where multiple resolvings
+ * occur, to optimize against multiple re-initializations.
  *
  * Returns: On success, %DANE_E_SUCCESS (0) is returned, otherwise a
  *   negative error value.
@@ -303,7 +305,7 @@ void dane_state_deinit(dane_state_t s)
  * @file: The file holding the DLV keys.
  *
  * This function will set a file with trusted keys
- * for DLV  (DNSSEC  Lookaside  Validation).
+ * for DLV (DNSSEC Lookaside Validation).
  *
  **/
 int dane_state_set_dlv_file(dane_state_t s, const char *file)