From 73178bb3b7848b904f55f88fd8c6e2087e078bbf Mon Sep 17 00:00:00 2001 From: =?utf8?q?Nicol=C3=A1s=20Ojeda=20B=C3=A4r?= Date: Mon, 16 Jul 2018 12:29:42 +0200 Subject: [PATCH] Doc --- curl.mli | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/curl.mli b/curl.mli index 21b3fd7..d5433c4 100644 --- a/curl.mli +++ b/curl.mli @@ -275,7 +275,9 @@ type curlMIMEPart = type curlKHMatch = | CURLKHMATCH_OK - | CURLKHMATCH_MISMATCH of string (* Base64-encoded *) + | CURLKHMATCH_MISMATCH of string + (** Argument consists of the base64-encoded public key of the remote host as + as found in the "known hosts" file **) | CURLKHMATCH_MISSING type curlKHStat = @@ -465,7 +467,10 @@ type curlOption = | CURLOPT_POSTREDIR of curlPostRedir list | CURLOPT_MIMEPOST of curlMIMEPart list (* @since libcurl 7.56.0 *) | CURLOPT_SSHKNOWNHOSTS of string - | CURLOPT_SSHKEYFUNCTION of (curlKHMatch -> string (* raw *) -> curlKHStat) + | CURLOPT_SSHKEYFUNCTION of (curlKHMatch -> string -> curlKHStat) + (** The second argument to the passed function consists of the raw bytes of + the public key sent by the remote host. If the function raises an + exception the key will be rejected, and the connection will fail.**) type initOption = | CURLINIT_GLOBALALL -- 2.11.4.GIT