romenskiy2012/curl
1
0
Fork 0
mirror of https://github.com/curl/curl.git synced 2026-04-14 22:11:45 +03:00
Code Issues Projects Releases Packages Wiki Activity

include: drop 'will' from public headers

Browse source 
Closes #21005
This commit is contained in:
Viktor Szakats 2026-03-19 02:59:42 +01:00
parent 387efe3d28
commit ce51fb493c
No known key found for this signature in database
8 changed files with 76 additions and 77 deletions
Download patch file Download diff file Expand all files Collapse all files

104
include/curl/curl.h
View file

@ -220,8 +220,8 @@ struct curl_httppost {
#define CURL_HTTPPOST_LARGE (1 << 7)
char *showfilename; /* The filename to show. If not set, the
actual filename will be used (if this
is a file part) */
actual filename is used (if this is
a file part) */
void *userp; /* custom pointer used for
HTTPPOST_CALLBACK posts */
curl_off_t contentlen; /* alternative length of contents
@ -229,8 +229,8 @@ struct curl_httppost {
set. Added in 7.46.0 */
};
/* This is a return code for the progress callback that, when returned, will
signal libcurl to continue executing the default progress function */
/* This is a return code for the progress callback that, when returned,
signals libcurl to continue executing the default progress function */
#define CURL_PROGRESSFUNC_CONTINUE 0x10000001
/* This is the CURLOPT_PROGRESSFUNCTION callback prototype. It is now
@ -267,17 +267,17 @@ typedef int (*curl_xferinfo_callback)(void *clientp,
#ifndef CURL_MAX_HTTP_HEADER
/* The only reason to have a max limit for this is to avoid the risk of a bad
server feeding libcurl with a never-ending header that will cause reallocs
server feeding libcurl with a never-ending header that causes reallocs
infinitely */
#define CURL_MAX_HTTP_HEADER (100*1024)
#endif
/* This is a magic return code for the write callback that, when returned,
will signal libcurl to pause receiving on the current transfer. */
signals libcurl to pause receiving on the current transfer. */
#define CURL_WRITEFUNC_PAUSE 0x10000001
/* This is a magic return code for the write callback that, when returned,
will signal an error from the callback. */
signals an error from the callback. */
#define CURL_WRITEFUNC_ERROR 0xFFFFFFFF
typedef size_t (*curl_write_callback)(char *buffer,
@ -285,7 +285,7 @@ typedef size_t (*curl_write_callback)(char *buffer,
size_t nitems,
void *outstream);
/* This callback will be called when a new resolver request is made */
/* This callback is called when a new resolver request is made */
typedef int (*curl_resolver_start_callback)(void *resolver_state,
void *reserved, void *userdata);
@ -385,11 +385,11 @@ typedef int (*curl_seek_callback)(void *instream,
curl_off_t offset,
int origin); /* 'whence' */
/* This is a return code for the read callback that, when returned, will
signal libcurl to immediately abort the current transfer. */
/* This is a return code for the read callback that, when returned,
signals libcurl to immediately abort the current transfer. */
#define CURL_READFUNC_ABORT 0x10000000
/* This is a return code for the read callback that, when returned, will
signal libcurl to pause sending data on the current transfer. */
/* This is a return code for the read callback that, when returned,
signals libcurl to pause sending data on the current transfer. */
#define CURL_READFUNC_PAUSE 0x10000001
/* Return code for when the trailing headers' callback has terminated
@ -609,7 +609,7 @@ typedef enum {
or wrong format */
CURLE_REMOTE_FILE_NOT_FOUND, /* 78 - remote file not found */
CURLE_SSH, /* 79 - error from the SSH layer, somewhat
generic so the error message will be of
generic so the error message is of
interest when this has happened */
CURLE_SSL_SHUTDOWN_FAILED, /* 80 - Failed to shut down the SSL
@ -627,7 +627,7 @@ typedef enum {
CURLE_FTP_BAD_FILE_LIST, /* 87 - unable to parse FTP file list */
CURLE_CHUNK_FAILED, /* 88 - chunk callback reported error */
CURLE_NO_CONNECTION_AVAILABLE, /* 89 - No connection available, the
session will be queued */
session is queued */
CURLE_SSL_PINNEDPUBKEYNOTMATCH, /* 90 - specified pinned public key did not
match */
CURLE_SSL_INVALIDCERTSTATUS, /* 91 - invalid certificate status */
@ -888,7 +888,7 @@ enum curl_khstat {
CURLKHSTAT_REJECT, /* reject the connection, return an error */
CURLKHSTAT_DEFER, /* do not accept it, but we cannot answer right now.
Causes a CURLE_PEER_FAILED_VERIFICATION error but the
connection will be left intact etc */
connection is left intact etc */
CURLKHSTAT_FINE_REPLACE, /* accept and replace the wrong key */
CURLKHSTAT_LAST /* not for use, only a marker for last-in-list */
};
@ -1170,12 +1170,12 @@ typedef enum {
* bytes big. */
CURLOPT(CURLOPT_ERRORBUFFER, CURLOPTTYPE_OBJECTPOINT, 10),
/* Function that will be called to store the output (instead of fwrite). The
* parameters will use fwrite() syntax, make sure to follow them. */
/* Function that is called to store the output (instead of fwrite). The
* parameters use fwrite() syntax, make sure to follow them. */
CURLOPT(CURLOPT_WRITEFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 11),
/* Function that will be called to read the input (instead of fread). The
* parameters will use fread() syntax, make sure to follow them. */
/* Function that is called to read the input (instead of fread). The
* parameters use fread() syntax, make sure to follow them. */
CURLOPT(CURLOPT_READFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 12),
/* Time-out the read operation after this amount of seconds */
@ -1329,7 +1329,7 @@ typedef enum {
/* 55 = OBSOLETE */
/* DEPRECATED
* Function that will be called instead of the internal progress display
* Function that is called instead of the internal progress display
* function. This function should be defined as the curl_progress_callback
* prototype defines. */
CURLOPTDEPRECATED(CURLOPT_PROGRESSFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 56,
@ -1358,7 +1358,7 @@ typedef enum {
/* Set the krb4/5 security level, this also enables krb4/5 awareness. This
* is a string, 'clear', 'safe', 'confidential' or 'private'. If the string
* is set but does not match one of these, 'private' will be used. */
* is set but does not match one of these, 'private' is used. */
CURLOPTDEPRECATED(CURLOPT_KRBLEVEL, CURLOPTTYPE_STRINGPOINT, 63,
8.17.0, "removed"),
@ -1411,8 +1411,8 @@ typedef enum {
OK within this time, then fine... This only aborts the connect phase. */
CURLOPT(CURLOPT_CONNECTTIMEOUT, CURLOPTTYPE_LONG, 78),
/* Function that will be called to store headers (instead of fwrite). The
* parameters will use fwrite() syntax, make sure to follow them. */
/* Function that is called to store headers (instead of fwrite). The
* parameters use fwrite() syntax, make sure to follow them. */
CURLOPT(CURLOPT_HEADERFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 79),
/* Set this to force the HTTP request to get back to GET. Only really usable
@ -1437,7 +1437,7 @@ typedef enum {
CURLOPT(CURLOPT_HTTP_VERSION, CURLOPTTYPE_VALUES, 84),
/* Specifically switch on or off the FTP engine's use of the EPSV command. By
default, that one will always be attempted before the more traditional
default, that one is always attempted before the more traditional
PASV command. */
CURLOPT(CURLOPT_FTP_USE_EPSV, CURLOPTTYPE_LONG, 85),
@ -1515,7 +1515,7 @@ typedef enum {
CURLOPT(CURLOPT_UNRESTRICTED_AUTH, CURLOPTTYPE_LONG, 105),
/* Specifically switch on or off the FTP engine's use of the EPRT command (
it also disables the LPRT attempt). By default, those ones will always be
it also disables the LPRT attempt). By default, those ones are always
attempted before the good old traditional PORT command. */
CURLOPT(CURLOPT_FTP_USE_EPRT, CURLOPTTYPE_LONG, 106),
@ -1555,7 +1555,7 @@ typedef enum {
systems with support for more than one, i.e IPv4 _and_ IPv6. */
CURLOPT(CURLOPT_IPRESOLVE, CURLOPTTYPE_VALUES, 113),
/* Set this option to limit the size of a file that will be downloaded from
/* Set this option to limit the size of a file that is to be downloaded from
an HTTP or FTP server.
Note there is also _LARGE version which adds large file support for
@ -1572,13 +1572,13 @@ typedef enum {
*/
CURLOPT(CURLOPT_RESUME_FROM_LARGE, CURLOPTTYPE_OFF_T, 116),
/* Sets the maximum size of data that will be downloaded from
/* Sets the maximum size of data that is to be downloaded from
* an HTTP or FTP server. See MAXFILESIZE above for the LONG version.
*/
CURLOPT(CURLOPT_MAXFILESIZE_LARGE, CURLOPTTYPE_OFF_T, 117),
/* Set this option to the filename of your .netrc file you want libcurl
to parse (using the CURLOPT_NETRC option). If not set, libcurl will do
to parse (using the CURLOPT_NETRC option). If not set, libcurl does
a poor attempt to find the user's home directory and check for a .netrc
file in there. */
CURLOPT(CURLOPT_NETRC_FILE, CURLOPTTYPE_STRINGPOINT, 118),
@ -1636,7 +1636,7 @@ typedef enum {
/* Set to non-zero to skip the IP address received in a 227 PASV FTP server
response. Typically used for FTP-SSL purposes but is not restricted to
that. libcurl will then instead use the same IP address it used for the
that. libcurl is then instead using the same IP address it used for the
control connection. */
CURLOPT(CURLOPT_FTP_SKIP_PASV_IP, CURLOPTTYPE_LONG, 137),
@ -1648,7 +1648,7 @@ typedef enum {
CURLOPT(CURLOPT_LOCALPORT, CURLOPTTYPE_LONG, 139),
/* Number of ports to try, including the first one set with LOCALPORT.
Thus, setting it to 1 will make no additional attempts but the first.
Thus, setting it to 1 makes no additional attempts but the first.
*/
CURLOPT(CURLOPT_LOCALPORTRANGE, CURLOPTTYPE_LONG, 140),
@ -1656,19 +1656,19 @@ typedef enum {
extracting it with CURLINFO_LASTSOCKET */
CURLOPT(CURLOPT_CONNECT_ONLY, CURLOPTTYPE_LONG, 141),
/* Function that will be called to convert from the
/* Function that is called to convert from the
network encoding (instead of using the iconv calls in libcurl) */
CURLOPTDEPRECATED(CURLOPT_CONV_FROM_NETWORK_FUNCTION,
CURLOPTTYPE_FUNCTIONPOINT, 142,
7.82.0, "Serves no purpose anymore"),
/* Function that will be called to convert to the
/* Function that is called to convert to the
network encoding (instead of using the iconv calls in libcurl) */
CURLOPTDEPRECATED(CURLOPT_CONV_TO_NETWORK_FUNCTION,
CURLOPTTYPE_FUNCTIONPOINT, 143,
7.82.0, "Serves no purpose anymore"),
/* Function that will be called to convert from UTF8
/* Function that is called to convert from UTF8
(instead of using the iconv calls in libcurl)
Note that this is used only for SSL certificate processing */
CURLOPTDEPRECATED(CURLOPT_CONV_FROM_UTF8_FUNCTION,
@ -1762,9 +1762,9 @@ typedef enum {
/* Comma separated list of hostnames defining no-proxy zones. These should
match both hostnames directly, and hostnames within a domain. For
example, local.com will match local.com and www.local.com, but NOT
example, local.com matches local.com and www.local.com, but NOT
notlocal.com or www.notlocal.com. For compatibility with other
implementations of this, .local.com will be considered to be the same as
implementations of this, .local.com is considered to be the same as
local.com. A single * is the only valid wildcard, and effectively
disables the use of proxy. */
CURLOPT(CURLOPT_NOPROXY, CURLOPTTYPE_STRINGPOINT, 177),
@ -1874,8 +1874,8 @@ typedef enum {
in outgoing requests. The current default is 0, but it might change in a
future libcurl release.
libcurl will ask for the compressed methods it knows of, and if that
is not any, it will not ask for transfer-encoding at all even if this
libcurl asks for the compressed methods it knows of, and if that
is not any, it does not ask for transfer-encoding at all even if this
option is set to 1. */
CURLOPT(CURLOPT_TRANSFER_ENCODING, CURLOPTTYPE_LONG, 207),
@ -1911,7 +1911,7 @@ typedef enum {
/* Enable/disable SASL initial response */
CURLOPT(CURLOPT_SASL_IR, CURLOPTTYPE_LONG, 218),
/* Function that will be called instead of the internal progress display
/* Function that is called instead of the internal progress display
* function. This function should be defined as the curl_xferinfo_callback
* prototype defines. (Deprecates CURLOPT_PROGRESSFUNCTION) */
CURLOPT(CURLOPT_XFERINFOFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 219),
@ -2093,7 +2093,7 @@ typedef enum {
/* Head start in milliseconds to give happy eyeballs. */
CURLOPT(CURLOPT_HAPPY_EYEBALLS_TIMEOUT_MS, CURLOPTTYPE_LONG, 271),
/* Function that will be called before a resolver request is made */
/* Function that is called before a resolver request is made */
CURLOPT(CURLOPT_RESOLVER_START_FUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 272),
/* User data to pass to the resolver start callback. */
@ -2202,7 +2202,7 @@ typedef enum {
/* used by scp/sftp to verify the host's public key */
CURLOPT(CURLOPT_SSH_HOST_PUBLIC_KEY_SHA256, CURLOPTTYPE_STRINGPOINT, 311),
/* Function that will be called immediately before the initial request
/* Function that is called immediately before the initial request
is made on a connection (after any protocol negotiation step). */
CURLOPT(CURLOPT_PREREQFUNCTION, CURLOPTTYPE_FUNCTIONPOINT, 312),
@ -2348,13 +2348,13 @@ typedef enum {
#define CURL_RTSPREQ_LAST 12L /* not used */
/* These enums are for use with the CURLOPT_NETRC option. */
#define CURL_NETRC_IGNORED 0L /* The .netrc will never be read.
#define CURL_NETRC_IGNORED 0L /* The .netrc is never read.
This is the default. */
#define CURL_NETRC_OPTIONAL 1L /* A user:password in the URL will be preferred
#define CURL_NETRC_OPTIONAL 1L /* A user:password in the URL is preferred
to one in the .netrc. */
#define CURL_NETRC_REQUIRED 2L /* A user:password in the URL will be ignored.
#define CURL_NETRC_REQUIRED 2L /* A user:password in the URL is ignored.
Unless one is set programmatically, the
.netrc will be queried. */
.netrc is queried. */
enum CURL_NETRC_OPTION {
/* we set a single member here, to make sure we still provide the enum, but
the values to use are defined above with L suffixes */
@ -2635,7 +2635,7 @@ curl_formadd(struct curl_httppost **httppost,
/*
* callback function for curl_formget()
* The void *arg pointer will be the one passed as second argument to
* The void *arg pointer is the one passed as second argument to
* curl_formget().
* The character buffer passed to it must not be freed.
* Should return the buffer length passed to it as the argument "len" on
@ -2650,7 +2650,7 @@ typedef size_t (*curl_formget_callback)(void *arg, const char *buf,
* DESCRIPTION
*
* Serialize a curl_httppost struct built with curl_formadd().
* Accepts a void pointer as second argument which will be passed to
* Accepts a void pointer as second argument which is passed to
* the curl_formget_callback function.
* Returns 0 on success.
*/
@ -2756,7 +2756,7 @@ CURL_EXTERN CURLcode curl_global_init(long flags);
* initialize libcurl and set user defined memory management callback
* functions. Users can implement memory management routines to check for
* memory leaks, check for misuse of the curl library etc. User registered
* callback routines will be invoked by this library instead of the system
* callback routines is invoked by this library instead of the system
* memory management routines like malloc, free etc.
*/
CURL_EXTERN CURLcode curl_global_init_mem(long flags,
@ -2806,8 +2806,8 @@ struct curl_slist {
*
* The backend can be identified by the id (e.g. CURLSSLBACKEND_OPENSSL). The
* backend can also be specified via the name parameter (passing -1 as id). If
* both id and name are specified, the name will be ignored. If neither id nor
* name are specified, the function will fail with CURLSSLSET_UNKNOWN_BACKEND
* both id and name are specified, the name is ignored. If neither id nor
* name are specified, the function fails with CURLSSLSET_UNKNOWN_BACKEND
* and set the "avail" pointer to the NULL-terminated list of available
* backends.
*
@ -2818,7 +2818,7 @@ struct curl_slist {
* NULL-terminated list of available SSL backends.
*
* The SSL backend can be set only once. If it has already been set, a
* subsequent attempt to change it will result in a CURLSSLSET_TOO_LATE.
* subsequent attempt to change it results in a CURLSSLSET_TOO_LATE.
*/
struct curl_ssl_backend {
@ -2842,8 +2842,8 @@ CURL_EXTERN CURLsslset curl_global_sslset(curl_sslbackend id, const char *name,
*
* DESCRIPTION
*
* Appends a string to a linked list. If no list exists, it will be created
* first. Returns the new list, after appending.
* Appends a string to a linked list. If no list exists, it is created first.
* Returns the new list, after appending.
*/
CURL_EXTERN struct curl_slist *curl_slist_append(struct curl_slist *list,
const char *data);

4
include/curl/curlver.h
View file

@ -40,8 +40,8 @@
#define LIBCURL_VERSION_MINOR 19
#define LIBCURL_VERSION_PATCH 1
/* This is the numeric version of the libcurl version number, meant for easier
parsing and comparisons by programs. The LIBCURL_VERSION_NUM define will
always follow this syntax:
parsing and comparisons by programs. The LIBCURL_VERSION_NUM define always
follows this syntax:
0xXXYYZZ

2
include/curl/easy.h
View file

@ -51,7 +51,7 @@ CURL_EXTERN void curl_easy_cleanup(CURL *curl);
* Request internal information from the curl session with this function.
* The third argument MUST be pointing to the specific type of the used option
* which is documented in each man page of the option. The data pointed to
* will be filled in accordingly and can be relied upon only if the function
* is filled in accordingly and can be relied upon only if the function
* returns CURLE_OK. This function is intended to get used *AFTER* a performed
* transfer, all results from this function are undefined until the transfer
* is completed.

30
include/curl/multi.h
View file

@ -221,8 +221,8 @@ CURL_EXTERN CURLMcode curl_multi_perform(CURLM *multi_handle,
*
* Desc: Cleans up and removes a whole multi stack. It does not free or
* touch any individual easy handles in any way. We need to define
* in what state those handles will be if this function is called
* in the middle of a transfer.
* in what state those handles are going to be if this function is
* called in the middle of a transfer.
*
* Returns: CURLMcode type, general multi error code.
*/
@ -236,19 +236,19 @@ CURL_EXTERN CURLMcode curl_multi_cleanup(CURLM *multi_handle);
* error code from the transfer or the fact that a transfer is
* completed. More details on these should be written down as well.
*
* Repeated calls to this function will return a new struct each
* time, until a special "end of msgs" struct is returned as a signal
* that there is no more to get at this point.
* Repeated calls to this function return a new struct each time,
* until a special "end of msgs" struct is returned as a signal that
* there is no more to get at this point.
*
* The data the returned pointer points to will not survive calling
* The data the returned pointer points to does not survive calling
* curl_multi_cleanup().
*
* The 'CURLMsg' struct is meant to be simple and only contain basic
* information. If more involved information is wanted, we will
* provide the particular "transfer handle" in that struct and that
* information. If more involved information is wanted, we provide
* the particular "transfer handle" in that struct and that
* should/could/would be used in subsequent curl_easy_getinfo() calls
* (or similar). The point being that we must never expose complex
* structs to applications, as then we will undoubtably get backwards
* structs to applications, as then we undoubtably get backwards
* compatibility problems in the future.
*
* Returns: A pointer to a filled-in struct, or NULL if it failed or ran out
@ -369,11 +369,11 @@ typedef enum {
CURLOPT(CURLMOPT_MAX_PIPELINE_LENGTH, CURLOPTTYPE_LONG, 8),
/* a connection with a content-length longer than this
will not be considered for pipelining */
is not considered for pipelining */
CURLOPT(CURLMOPT_CONTENT_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 9),
/* a connection with a chunk length longer than this
will not be considered for pipelining */
is not considered for pipelining */
CURLOPT(CURLMOPT_CHUNK_LENGTH_PENALTY_SIZE, CURLOPTTYPE_OFF_T, 10),
/* a list of site names(+port) that are blocked from pipelining */
@ -409,13 +409,13 @@ typedef enum {
/* Definition of bits for the CURLMOPT_NETWORK_CHANGED argument: */
/* - CURLMNWC_CLEAR_CONNS tells libcurl to prevent further reuse of existing
connections. Connections that are idle will be closed. Ongoing transfers
will continue with the connection they have. */
connections. Connections that are idle are closed. Ongoing transfers
do continue with the connection they have. */
#define CURLMNWC_CLEAR_CONNS (1L << 0)
/* - CURLMNWC_CLEAR_DNS tells libcurl to prevent further reuse of existing
connections. Connections that are idle will be closed. Ongoing transfers
will continue with the connection they have. */
connections. Connections that are idle are closed. Ongoing transfers
do continue with the connection they have. */
#define CURLMNWC_CLEAR_DNS (1L << 0)
/*

2
include/curl/system.h
View file

@ -45,7 +45,7 @@
* size of off_t is independent of large file support settings. Keep your
* build on the safe side avoiding an off_t gating. If you have a 64-bit
* off_t then take for sure that another 64-bit data type exists, dig deeper
* and you will find it.
* to find it.
*
*/

6
include/curl/typecheck-gcc.h
View file

@ -37,8 +37,8 @@
* order to work around gcc bug #32061. It affects only gcc 4.3.x/4.4.x
* when compiling with -Wlogical-op.
*
* To add an option that uses the same type as an existing option, you will
* need to extend the appropriate _curl_*_option macro
* To add an option that uses the same type as an existing option, you need
* to extend the appropriate _curl_*_option macro
*/
#define curl_easy_setopt(handle, option, value) \
@ -856,7 +856,7 @@ typedef CURLcode (*Wcurl_ssl_ctx_callback4)(CURL *, const void *,
const void *);
#ifdef HEADER_SSL_H
/* hack: if we included OpenSSL's ssl.h, we know about SSL_CTX
* this will of course break if we are included before OpenSSL headers...
* this of course breaks if we are included before OpenSSL headers...
*/
typedef CURLcode (*Wcurl_ssl_ctx_callback5)(CURL *, SSL_CTX *, void *);
typedef CURLcode (*Wcurl_ssl_ctx_callback6)(CURL *, SSL_CTX *, const void *);

4
include/curl/urlapi.h
View file

@ -114,7 +114,7 @@ CURL_EXTERN CURLU *curl_url(void);
/*
* curl_url_cleanup() frees the CURLU handle and related resources used for
* the URL parsing. It will not free strings previously returned with the URL
* the URL parsing. It does not free strings previously returned with the URL
* API.
*/
CURL_EXTERN void curl_url_cleanup(CURLU *handle);
@ -135,7 +135,7 @@ CURL_EXTERN CURLUcode curl_url_get(const CURLU *handle, CURLUPart what,
/*
* curl_url_set() sets a specific part of the URL in a CURLU handle. Returns
* error code. The passed in string will be copied. Passing a NULL instead of
* error code. The passed in string is copied. Passing a NULL instead of
* a part string, clears that part.
*/
CURL_EXTERN CURLUcode curl_url_set(CURLU *handle, CURLUPart what,