]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
tls: Remove EXAMPLEs from deprecated options
authorDaniel Gustafsson <daniel@yesql.se>
Mon, 6 May 2024 18:55:27 +0000 (20:55 +0200)
committerDaniel Gustafsson <daniel@yesql.se>
Mon, 6 May 2024 18:55:27 +0000 (20:55 +0200)
CURLOPT_EGDSOCKET and CURLOPT_RANDOM_FILE are both completely dead
so remove their example sections since the code there is useless.
There is still a way to inject a random file for OpenSSL older than
1.1.0 but it's not what the example showed (and it's not even done
with this option) so we refrain from documenting it here.

Closes: #13540
Reviewed-by: Daniel Stenberg <daniel@haxx.se>
docs/libcurl/opts/CURLOPT_EGDSOCKET.md
docs/libcurl/opts/CURLOPT_RANDOM_FILE.md
tests/test1173.pl

index 32ae012e56cbcd03d12a783f3ac8c59b77944181..f24da8619e3315ca1bc16e4267c1efa1b82d8302 100644 (file)
@@ -28,39 +28,14 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_EGDSOCKET, char *path);
 
 Deprecated option. It serves no purpose anymore.
 
-Pass a char pointer to the null-terminated path name to the Entropy Gathering
-Daemon socket. It is used to seed the random engine for TLS.
-
-The application does not have to keep the string around after setting this
-option.
-
 # DEFAULT
 
 NULL
 
-# EXAMPLE
-
-~~~c
-int main(void)
-{
-  CURL *curl = curl_easy_init();
-  if(curl) {
-    CURLcode res;
-    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
-    curl_easy_setopt(curl, CURLOPT_EGDSOCKET, "/var/egd.socket");
-    res = curl_easy_perform(curl);
-    curl_easy_cleanup(curl);
-  }
-}
-~~~
-
 # AVAILABILITY
 
-Only with OpenSSL versions before 1.1.0.
-
 This option was deprecated in 7.84.0.
 
 # RETURN VALUE
 
-Returns CURLE_OK if TLS is supported, CURLE_UNKNOWN_OPTION if not, or
-CURLE_OUT_OF_MEMORY if there was insufficient heap space.
+Returns CURLE_OK.
index 6840fbc29fd4e4ea944542748288e4a121398f54..83a983172c9bbcd085768c3c6420bb84ea9a77b7 100644 (file)
@@ -28,39 +28,14 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_RANDOM_FILE, char *path);
 
 Deprecated option. It serves no purpose anymore.
 
-Pass a char pointer to a null-terminated filename. The file might be used to
-read from to seed the random engine for SSL and more.
-
-The application does not have to keep the string around after setting this
-option.
-
 # DEFAULT
 
 NULL, not used
 
-# EXAMPLE
-
-~~~c
-int main(void)
-{
-  CURL *curl = curl_easy_init();
-  if(curl) {
-    CURLcode res;
-    curl_easy_setopt(curl, CURLOPT_URL, "https://example.com/");
-    curl_easy_setopt(curl, CURLOPT_RANDOM_FILE, "junk.txt");
-    res = curl_easy_perform(curl);
-    curl_easy_cleanup(curl);
-  }
-}
-~~~
-
 # AVAILABILITY
 
-Only with OpenSSL versions before 1.1.0.
-
 This option was deprecated in 7.84.0.
 
 # RETURN VALUE
 
-Returns CURLE_OK on success or
-CURLE_OUT_OF_MEMORY if there was insufficient heap space.
+Returns CURLE_OK.
index e7126a120d126e682693ee7acaa31694260d7fda..c09490ef960d635af7674bf65230e3cfbc100205 100755 (executable)
@@ -75,6 +75,8 @@ my %deprecated = (
     CURLINFO_DATA_OUT => 1,
     CURLINFO_SSL_DATA_IN => 1,
     CURLINFO_SSL_DATA_OUT => 1,
+    CURLOPT_EGDSOCKET => 1,
+    CURLOPT_RANDOM_FILE => 1,
     );
 sub allsymbols {
     open(my $f, "<", "$symbolsinversions") ||