mirror of
https://github.com/curl/curl.git
synced 2026-07-23 00:57:24 +03:00
docs/libcurl: use lowercase must
To shout less. Use bold in some places. Closes #18570
This commit is contained in:
parent
22ac7f30ad
commit
3053a3e90f
16 changed files with 46 additions and 47 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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%
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
|
|
@ -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.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue