curl/curl
1
1
Fork 0
mirror of https://github.com/curl/curl.git synced 2025-09-18 10:02:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

docs: consistent use of "Added in"

Browse Source 
Make them all say "Added in [version]" without using 'curl' or 'libcurl'
in that phrase.
This commit is contained in:
Daniel Stenberg 2021-10-25 11:45:09 +02:00
parent 24155569d8
commit 16a6b02df2
No known key found for this signature in database
GPG Key ID: 5CC908FDB71E12C2
28 changed files with 41 additions and 41 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/libcurl/curl_easy_cleanup.3
View File

@ -60,7 +60,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.1
Added in 7.1
.SH RETURN VALUE
None
.SH "SEE ALSO"

2
docs/libcurl/curl_easy_duphandle.3
View File

@ -59,7 +59,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.9
Added in 7.9
.SH RETURN VALUE
If this function returns NULL, something went wrong and no valid handle was
returned.

2
docs/libcurl/curl_easy_getinfo.3
View File

@ -303,7 +303,7 @@ transaction was started. So, this is zero if no redirection took place.
}
.fi
.SH AVAILABILITY
Added in libcurl 7.4.1
Added in 7.4.1
.SH RETURN VALUE
If the operation was successful, CURLE_OK is returned. Otherwise an
appropriate error code will be returned.

2
docs/libcurl/curl_easy_pause.3
View File

@ -103,7 +103,7 @@ in a very large data amount needing to be allocated to save the data during
the pause. This said, you should probably consider not using paused receiving
if you allow libcurl to uncompress data automatically.
.SH AVAILABILITY
Added in libcurl 7.18.0.
Added in 7.18.0.
.SH RETURN VALUE
CURLE_OK (zero) means that the option was set properly, and a non-zero return
code means something wrong occurred after the new state was set. See the

2
docs/libcurl/curl_multi_poll.3
View File

@ -108,7 +108,7 @@ do {
curl_multi_remove_handle(multi_handle, easy_handle);
.fi
.SH AVAILABILITY
Added in libcurl 7.66.0.
Added in 7.66.0.
.SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code. See
\fIlibcurl-errors(3)\fP

2
docs/libcurl/curl_multi_setopt.3
View File

@ -75,7 +75,7 @@ See \fICURLMOPT_MAX_CONCURRENT_STREAMS(3)\fP
curl_multi_setopt(handle, CURLMOPT_MAXCONNECTS, (long)MAX_PARALLEL);
.nf
.SH AVAILABILITY
Added in libcurl 7.15.4.
Added in 7.15.4
.SH RETURN VALUE
The standard CURLMcode for multi interface error codes. Note that it returns a
CURLM_UNKNOWN_OPTION if you try setting an option that this version of libcurl

2
docs/libcurl/curl_share_cleanup.3
View File

@ -42,7 +42,7 @@ immediately with no action.
curl_share_cleanup(share);
.fi
.SH AVAILABILITY
Added in libcurl 7.10
Added in 7.10
.SH RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP

2
docs/libcurl/curl_share_init.3
View File

@ -45,7 +45,7 @@ specific curl handle use the data in this share.
printf("Error: %s\n", curl_share_strerror(sh));
.fi
.SH AVAILABILITY
Added in libcurl 7.10
Added in 7.10
.SH RETURN VALUE
If this function returns NULL, something went wrong (out of memory, etc.)
and therefore the share object was not created.

2
docs/libcurl/curl_share_setopt.3
View File

@ -115,7 +115,7 @@ to the lock_function and unlock_function each time it is called.
printf("Error: %s\n", curl_share_strerror(sh));
.fi
.SH AVAILABILITY
Added in libcurl 7.10
Added in 7.10
.SH RETURN VALUE
CURLSHE_OK (zero) means that the option was set properly, non-zero means an
error occurred as \fI<curl/curl.h>\fP defines. See the \fIlibcurl-errors.3\fP

2
docs/libcurl/curl_url.3
View File

@ -45,7 +45,7 @@ be used for further use of the URL API.
}
.fi
.SH AVAILABILITY
Added in curl 7.62.0
Added in 7.62.0
.SH RETURN VALUE
Returns a \fBCURLU *\fP if successful, or NULL if out of memory.
.SH "SEE ALSO"

2
docs/libcurl/curl_url_cleanup.3
View File

@ -36,7 +36,7 @@ Frees all the resources associated with the given CURLU handle!
curl_url_cleanup(url);
.fi
.SH AVAILABILITY
Added in curl 7.62.0
Added in 7.62.0
.SH RETURN VALUE
none
.SH "SEE ALSO"

2
docs/libcurl/curl_url_dup.3
View File

@ -44,7 +44,7 @@ pointer to a new CURLU handle. The new handle also needs to be freed with
curl_url_cleanup(url);
.fi
.SH AVAILABILITY
Added in curl 7.62.0
Added in 7.62.0
.SH RETURN VALUE
Returns a new handle or NULL if out of memory.
.SH "SEE ALSO"

2
docs/libcurl/curl_url_get.3
View File

@ -121,7 +121,7 @@ decode on get with the CURLU_URLDECODE bit.
}
.fi
.SH AVAILABILITY
Added in curl 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
Added in 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
.SH RETURN VALUE
Returns a CURLUcode error value, which is CURLUE_OK (0) if everything went
fine. See the \fIlibcurl-errors(3)\fP man page for the full list with

2
docs/libcurl/curl_url_set.3
View File

@ -147,7 +147,7 @@ individual parts.
curl_url_cleanup(url);
.fi
.SH AVAILABILITY
Added in curl 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
Added in 7.62.0. CURLUPART_ZONEID was added in 7.65.0.
.SH RETURN VALUE
Returns a CURLUcode error value, which is CURLUE_OK (0) if everything went
fine. See the \fIlibcurl-errors(3)\fP man page for the full list with

2
docs/libcurl/curl_url_strerror.3
View File

@ -40,7 +40,7 @@ error code passed in the argument \fIerrornum\fP.
.fi
.SH AVAILABILITY
Added in libcurl 7.80.0
Added in 7.80.0
.SH RETURN VALUE
A pointer to a null-terminated string.
.SH "SEE ALSO"

2
docs/libcurl/curl_version_info.3
View File

@ -232,7 +232,7 @@ printf("libcurl version %u.%u.%u\n",
ver->version_num & 0xff,
.fi
.SH AVAILABILITY
Added in libcurl 7.10
Added in 7.10
.SH RETURN VALUE
A pointer to a curl_version_info_data struct.
.SH "SEE ALSO"

4
docs/libcurl/opts/CURLINFO_RETRY_AFTER.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -56,7 +56,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in curl 7.66.0
Added in 7.66.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
.SH "SEE ALSO"

4
docs/libcurl/opts/CURLMOPT_PUSHFUNCTION.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -88,7 +88,7 @@ The callback denies the stream and no data for this will reach the
application, the easy handle will be destroyed by libcurl.
.IP "CURL_PUSH_ERROROUT (2)"
Returning this will reject the pushed stream and return an error back on the
parent stream making it get closed with an error. (Added in curl 7.72.0)
parent stream making it get closed with an error. (Added in 7.72.0)
.IP *
All other return codes are reserved for future use.
.SH DEFAULT

4
docs/libcurl/opts/CURLOPT_DISALLOW_USERNAME_IN_URL.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -46,7 +46,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.61.0
Added in 7.61.0
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.

4
docs/libcurl/opts/CURLOPT_ISSUERCERT_BLOB.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -70,7 +70,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL backends.
Added in 7.71.0. This option is supported by the OpenSSL backends.
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

4
docs/libcurl/opts/CURLOPT_MAXAGE_CONN.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 2019, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 2019 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -57,7 +57,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.65.0
Added in 7.65.0
.SH RETURN VALUE
Returns CURLE_OK.
.SH "SEE ALSO"

2
docs/libcurl/opts/CURLOPT_MAXLIFETIME_CONN.3
View File

@ -58,7 +58,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.80.0
Added in 7.80.0
.SH RETURN VALUE
Returns CURLE_OK.
.SH "SEE ALSO"

4
docs/libcurl/opts/CURLOPT_PROXY_ISSUERCERT.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -64,7 +64,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL backends.
Added in 7.71.0. This option is supported by the OpenSSL backends.
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

4
docs/libcurl/opts/CURLOPT_PROXY_ISSUERCERT_BLOB.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -76,7 +76,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL backends.
Added in 7.71.0. This option is supported by the OpenSSL backends.
.SH RETURN VALUE
Returns CURLE_OK if the option is supported, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

6
docs/libcurl/opts/CURLOPT_PROXY_SSLCERT_BLOB.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -62,8 +62,8 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL, Secure
Transport and Schannel backends.
Added in 7.71.0. This option is supported by the OpenSSL, Secure Transport and
Schannel backends.
.SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

4
docs/libcurl/opts/CURLOPT_PROXY_SSLKEY_BLOB.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -65,7 +65,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL backends.
Added in 7.71.0. This option is supported by the OpenSSL backends.
.SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

6
docs/libcurl/opts/CURLOPT_SSLCERT_BLOB.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -60,8 +60,8 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL, Secure
Transport and Schannel backends.
Added in 7.71.0. This option is supported by the OpenSSL, Secure Transport and
Schannel backends.
.SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.

4
docs/libcurl/opts/CURLOPT_SSLKEY_BLOB.3
View File

@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, <daniel@haxx.se>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@ -67,7 +67,7 @@ if(curl) {
}
.fi
.SH AVAILABILITY
Added in libcurl 7.71.0. This option is supported by the OpenSSL backends.
Added in 7.71.0. This option is supported by the OpenSSL backends.
.SH RETURN VALUE
Returns CURLE_OK if TLS enabled, CURLE_UNKNOWN_OPTION if not, or
CURLE_OUT_OF_MEMORY if there was insufficient heap space.