]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: fix documentation of connect_only 2
authorStefan Eissing <stefan@eissing.org>
Mon, 16 Jun 2025 07:54:20 +0000 (09:54 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Fri, 20 Jun 2025 21:24:37 +0000 (23:24 +0200)
Setting CURLOPT_CONNECT_ONLY with value 2 is only defined
for WebSocket and the effect on other protocols is undetermined.
That includes the HTTP urls.

Fixes #17621
Reported-by: Kirill Obukhov
Closes #17635

docs/libcurl/opts/CURLOPT_CONNECT_ONLY.md

index 61cf2b802cd7aac6663e6430dfba94dc8bc6cb8f..0515a8ae35ca61634f65d8179beacddbd70ce621 100644 (file)
@@ -38,9 +38,10 @@ curl_easy_getinfo(3) as the library can set up the connection and then
 the application can obtain the most recently used socket for special data
 transfers.
 
-Since 7.86.0, this option can be set to '2' and if HTTP or WebSocket are used,
+Since 7.86.0, this option can be set to '2' and if WebSocket is used,
 libcurl performs the request and reads all response headers before handing
-over control to the application.
+over control to the application. For other protocols the behavior of '2'
+is undefined.
 
 Transfers marked connect only do not reuse any existing connections and
 connections marked connect only are not allowed to get reused.