]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs/libcurl: use lowercase must
authorDaniel Stenberg <daniel@haxx.se>
Tue, 16 Sep 2025 14:49:54 +0000 (16:49 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 16 Sep 2025 15:12:26 +0000 (17:12 +0200)
To shout less. Use bold in some places.

Closes #18570

16 files changed:
docs/libcurl/opts/CURLINFO_CONTENT_TYPE.md
docs/libcurl/opts/CURLINFO_EFFECTIVE_METHOD.md
docs/libcurl/opts/CURLINFO_EFFECTIVE_URL.md
docs/libcurl/opts/CURLINFO_FTP_ENTRY_PATH.md
docs/libcurl/opts/CURLINFO_LOCAL_IP.md
docs/libcurl/opts/CURLINFO_PRIMARY_IP.md
docs/libcurl/opts/CURLINFO_REFERER.md
docs/libcurl/opts/CURLINFO_RTSP_SESSION_ID.md
docs/libcurl/opts/CURLINFO_SCHEME.md
docs/libcurl/opts/CURLOPT_HEADERDATA.md
docs/libcurl/opts/CURLOPT_IOCTLFUNCTION.md
docs/libcurl/opts/CURLOPT_SHARE.md
docs/libcurl/opts/CURLOPT_SSH_HOSTKEYFUNCTION.md
docs/libcurl/opts/CURLOPT_SSH_KEYFUNCTION.md
docs/libcurl/opts/CURLOPT_TRANSFER_ENCODING.md
docs/libcurl/opts/CURLOPT_WRITEDATA.md

index 71e9c5122cf7c7c7cbb35125b6e3529e20fe6d74..8a9093ced2ff59acc48a1a16f4b32ad66c684638 100644 (file)
@@ -33,8 +33,8 @@ object. This is the value read from the Content-Type: field. If you get NULL,
 it means that the server did not send a valid Content-Type header or that the
 protocol used does not support this.
 
-The **ct** pointer is set to NULL or pointing to private memory. You MUST
-NOT free it - it gets freed when you call curl_easy_cleanup(3) on the
+The **ct** pointer is NULL or points to private memory. You **must not** free
+it. It gets freed automatically when you call curl_easy_cleanup(3) on the
 corresponding curl handle.
 
 The modern way to get this header from a response is to instead use the
index 0a748063c6421ea9fa193246b1f08d81873a4c54..5299dab8c16e459caaecdc4ed0448d95b0c3c3aa 100644 (file)
@@ -35,9 +35,9 @@ method.
 In cases when you have asked libcurl to follow redirects, the method may not be
 the same method the first request would use.
 
-The **methodp** pointer is NULL or points to private memory. You MUST NOT
-free - it gets freed when you call curl_easy_cleanup(3) on the
-corresponding curl handle.
+The **methodp** pointer is NULL or points to private memory. You
+**must not** free it. The memory gets freed automatically when you call
+curl_easy_cleanup(3) on the corresponding curl handle.
 
 # %PROTOCOLS%
 
index aa509018346415d923a8c3416f0481886f8d6a12..172f6de3d46b04b839d8d29c9e362afdea49ff3e 100644 (file)
@@ -32,9 +32,9 @@ Pass in a pointer to a char pointer and get the last used effective URL.
 In cases when you have asked libcurl to follow redirects, it may not be the same
 value you set with CURLOPT_URL(3).
 
-The **urlp** pointer is NULL or points to private memory. You MUST NOT free
-- it gets freed when you call curl_easy_cleanup(3) on the corresponding curl
-handle.
+The **urlp** pointer is NULL or points to private memory. You **must not**
+free it. It memory gets freed automatically when you call curl_easy_cleanup(3)
+on the corresponding curl handle.
 
 # %PROTOCOLS%
 
index 08b5a6d336ba49c3cd02fdd68442b5da6fea73a0..db053e311e7559ae3da5934c4832738ad90d4be2 100644 (file)
@@ -32,9 +32,9 @@ path of the entry path. That is the initial path libcurl ended up in when
 logging on to the remote FTP or SFTP server. This stores a NULL as pointer if
 something is wrong.
 
-The **path** pointer is NULL or points to private memory. You MUST NOT free
-- it gets freed when you call curl_easy_cleanup(3) on the corresponding curl
-handle.
+The **path** pointer is NULL or points to private memory. You **must not**
+free it. The memory gets freed automatically when you call
+curl_easy_cleanup(3) on the corresponding curl handle.
 
 # %PROTOCOLS%
 
index a8b89914a0bc4e9b2b1328c0279e119b7f7ef278..c626815c90035f0a155be8de53626f9729843fa6 100644 (file)
@@ -35,9 +35,9 @@ with this **curl** handle. This string may be IPv6 when that is enabled. Note
 that you get a pointer to a memory area that is reused at next request so you
 need to copy the string if you want to keep the information.
 
-The **ip** pointer is NULL or points to private memory. You MUST NOT free - it
-gets freed when you call curl_easy_cleanup(3) on the corresponding CURL
-handle.
+The **ip** pointer is NULL or points to private memory. You **must not** free
+it. The memory gets freed automatically when you call curl_easy_cleanup(3) on
+the corresponding curl handle.
 
 # %PROTOCOLS%
 
index e87be53e3c735fffd8dad1d2bf2f74eaec8a3eb8..1fdb130711e4d47e6d7dd9b1c64314bf1e2c92ea 100644 (file)
@@ -35,9 +35,9 @@ string holding the IP address of the most recent connection done with this
 get a pointer to a memory area that is reused at next request so you need to
 copy the string if you want to keep the information.
 
-The **ip** pointer is NULL or points to private memory. You MUST NOT free - it
-gets freed when you call curl_easy_cleanup(3) on the corresponding curl
-handle.
+The **ip** pointer is NULL or points to private memory. You **must not** free
+it. The memory gets freed automatically when you call curl_easy_cleanup(3) on
+the corresponding curl handle.
 
 # %PROTOCOLS%
 
index bd278dd60348adc84196a1dc2f9ee731c30867b7..17b9db1a18a3ca1d83e197a7320e705f79216345 100644 (file)
@@ -31,9 +31,9 @@ CURLcode curl_easy_getinfo(CURL *handle, CURLINFO_REFERER, char **hdrp);
 Pass in a pointer to a char pointer and get the referrer header used in the
 most recent request.
 
-The **hdrp** pointer is NULL or points to private memory you MUST NOT free -
-it gets freed when you call curl_easy_cleanup(3) on the corresponding curl
-handle.
+The **hdrp** pointer is NULL or points to private memory. You **must not**
+free it. The memory gets freed automatically when you call
+curl_easy_cleanup(3) on the corresponding curl handle.
 
 # %PROTOCOLS%
 
index c24f42b24d13acb65afbd8e82c6c978907bcf944..121642677b78fd07461b3d93787d9cd0ea55779f 100644 (file)
@@ -33,9 +33,9 @@ most recent RTSP Session ID.
 Applications wishing to resume an RTSP session on another connection should
 retrieve this info before closing the active connection.
 
-The **id** pointer is NULL or points to private memory. You MUST NOT free - it
-gets freed when you call curl_easy_cleanup(3) on the corresponding curl
-handle.
+The **id** pointer is NULL or points to private memory. You **must not** free
+it. The memory gets freed automatically when you call curl_easy_cleanup(3) on
+the corresponding curl handle.
 
 # %PROTOCOLS%
 
index 0089531d012bf3b272b3ed3946aff406ee7e66f2..1c61849829af6ffa67be4a659af5f2f40746df69 100644 (file)
@@ -33,9 +33,9 @@ Pass a pointer to a char pointer to receive the pointer to a null-terminated
 string holding the URL scheme used for the most recent connection done with
 this CURL **handle**.
 
-The **scheme** pointer is NULL or points to private memory. You MUST NOT
-free - it gets freed when you call curl_easy_cleanup(3) on the corresponding
-curl handle.
+The **scheme** pointer is NULL or points to private memory. You **must not**
+free it. The memory gets freed automatically when you call
+curl_easy_cleanup(3) on the corresponding curl handle.
 
 The returned scheme might be upper or lowercase. Do comparisons case
 insensitively.
index bb3f2ed834740e187a23725f0b10bfd72e6c6f8f..f767961cdc37d909fbdf753e2850dac4b3078dbe 100644 (file)
@@ -36,9 +36,9 @@ If CURLOPT_WRITEFUNCTION(3) or CURLOPT_HEADERFUNCTION(3) is used,
 If neither of those options are set, *pointer* must be a valid FILE * and
 it is used by a plain fwrite() to write headers to.
 
-If you are using libcurl as a Windows DLL, you **MUST** use a
-CURLOPT_WRITEFUNCTION(3) or CURLOPT_HEADERFUNCTION(3) if you set
-this option or you might experience crashes.
+If you are using libcurl as a Windows DLL, you **must** use a
+CURLOPT_WRITEFUNCTION(3) or CURLOPT_HEADERFUNCTION(3) if you set this option
+or you might experience crashes.
 
 # DEFAULT
 
index 29dc8bb4ff75be4ebc7c13feca7cfe97ff3ca9fd..d2dda82dd8e3bac639903c67aa591b2a328d6fc0 100644 (file)
@@ -50,15 +50,15 @@ rewinding the read data stream is the only action it can request. The
 rewinding of the read data stream may be necessary when doing an HTTP PUT or
 POST with a multi-pass authentication method.
 
-The callback MUST return *CURLIOE_UNKNOWNCMD* if the input *cmd* is
-not *CURLIOCMD_RESTARTREAD*.
+The callback **must** return *CURLIOE_UNKNOWNCMD* if the input *cmd* is not
+*CURLIOCMD_RESTARTREAD*.
 
-The *clientp* argument to the callback is set with the
-CURLOPT_IOCTLDATA(3) option.
+The *clientp* argument to the callback is set with the CURLOPT_IOCTLDATA(3)
+option.
 
 **This option is deprecated**. Do not use it. Use CURLOPT_SEEKFUNCTION(3)
-instead to provide seeking. If CURLOPT_SEEKFUNCTION(3) is set, this
-parameter is ignored when seeking.
+instead to provide seeking. If CURLOPT_SEEKFUNCTION(3) is set, this parameter
+is ignored when seeking.
 
 # DEFAULT
 
index c4488086a7e50508d042a62f2f2ef038d213e079..9b9a281e00be4959f7d28391a3b42d47bbcbf631 100644 (file)
@@ -26,13 +26,12 @@ CURLcode curl_easy_setopt(CURL *handle, CURLOPT_SHARE, CURLSH *share);
 
 # DESCRIPTION
 
-Pass a *share* handle as a parameter. The share handle must have been
-created by a previous call to curl_share_init(3). Setting this option,
-makes this curl handle use the data from the shared handle instead of keeping
-the data to itself. This enables several curl handles to share data. If the
-curl handles are used simultaneously in multiple threads, you **MUST** use
-the locking methods in the share handle. See curl_share_setopt(3) for
-details.
+Pass a *share* handle as a parameter. The share handle must have been created
+by a previous call to curl_share_init(3). Setting this option, makes this curl
+handle use the data from the shared handle instead of keeping the data to
+itself. This enables several curl handles to share data. If the curl handles
+are used simultaneously in multiple threads, you **must** use the locking
+methods in the share handle. See curl_share_setopt(3) for details.
 
 If you add a share that is set to share cookies, your easy handle uses that
 cookie cache and get the cookie engine enabled. If you stop sharing an object
index 89422e4ef65d55a27f2ad931d71fa2abc9e0730e..0f7e9996bd573e407f49f28b24d4b1b79b7ad2f4 100644 (file)
@@ -44,7 +44,7 @@ says what type it is, from the **CURLKHTYPE_*** series in the
 
 **clientp** is a custom pointer set with CURLOPT_SSH_HOSTKEYDATA(3).
 
-The callback MUST return one of the following return codes to tell libcurl how
+The callback must return one of the following return codes to tell libcurl how
 to act:
 
 ## CURLKHMATCH_OK
index 636b7a3609cccc936e6a7e6ed6a11f5072abc0cc..1e21b614f1361ba07da767a6e1813826679026c0 100644 (file)
@@ -68,7 +68,7 @@ called if CURLOPT_SSH_KNOWNHOSTS(3) is also set.
 This callback function gets passed the curl handle, the key from the
 known_hosts file *knownkey*, the key from the remote site *foundkey*, info
 from libcurl on the matching status and a custom pointer (set with
-CURLOPT_SSH_KEYDATA(3)). It MUST return one of the following return codes to
+CURLOPT_SSH_KEYDATA(3)). It must return one of the following return codes to
 tell libcurl how to act:
 
 ## CURLKHSTAT_FINE_REPLACE
index 262c0897942ef09bcad72dbe3d1cd2ca0a803496..07e7266da5c7fd73016aa869eabeecf7a245fac9 100644 (file)
@@ -35,8 +35,8 @@ HTTP response sent using a compressed Transfer-Encoding that is automatically
 uncompressed by libcurl on reception.
 
 Transfer-Encoding differs slightly from the Content-Encoding you ask for with
-CURLOPT_ACCEPT_ENCODING(3) in that a Transfer-Encoding is strictly meant
-to be for the transfer and thus MUST be decoded before the data arrives in the
+CURLOPT_ACCEPT_ENCODING(3) in that a Transfer-Encoding is strictly meant to be
+for the transfer and thus must be decoded before the data arrives in the
 client. Traditionally, Transfer-Encoding has been much less used and supported
 by both HTTP clients and HTTP servers.
 
index 5983de5d27fc6f361d92bf572e5a233ae757c608..f6c6a2eeb9f1e7286295ab207f7451726afb95de 100644 (file)
@@ -36,7 +36,7 @@ to *fwrite(3)* when writing data.
 The internal CURLOPT_WRITEFUNCTION(3) writes the data to the FILE *
 given with this option, or to stdout if this option has not been set.
 
-If you are using libcurl as a Windows DLL, you **MUST** use a
+If you are using libcurl as a Windows DLL, you must also use
 CURLOPT_WRITEFUNCTION(3) if you set this option or you might experience
 crashes.