From: Daniel Stenberg <daniel@haxx.se>
Date: Sun, 12 Jun 2022 10:53:54 +0000 (+0200)
Subject: curl_url_set.3: clarify by default using known schemes only
X-Git-Tag: curl-7_84_0~56
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=965119855d74c918372099bdcf81efa76b7a6988;p=thirdparty%2Fcurl.git

curl_url_set.3: clarify by default using known schemes only

Closes #8994
---

diff --git a/docs/libcurl/curl_url_set.3 b/docs/libcurl/curl_url_set.3
index 68b1456548..bbea5de4b1 100644
--- a/docs/libcurl/curl_url_set.3
+++ b/docs/libcurl/curl_url_set.3
@@ -18,6 +18,8 @@
 .\" * This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
 .\" * KIND, either express or implied.
 .\" *
+.\" * SPDX-License-Identifier: curl
+.\" *
 .\" **************************************************************************
 .TH curl_url_set 3 "6 Aug 2018" "libcurl" "libcurl Manual"
 .SH NAME
@@ -46,6 +48,12 @@ call.
 Setting a part to a NULL pointer will effectively remove that part's contents
 from the CURLU handle.
 
+By default, this API only accepts URLs using schemes for protocols that are
+supported built-in. To make libcurl parse URLs generically even for schemes it
+does not know about, the \fBCURLU_NON_SUPPORT_SCHEME\fP flags bit must be
+set. Otherwise, this function returns \fICURLUE_UNSUPPORTED_SCHEME\fP on URL
+schemes it does not recognize.
+
 The \fIflags\fP argument is a bitmask with independent features.
 .SH PARTS
 .IP CURLUPART_URL