summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorPatrick Monnerat <patrick@monnerat.net>2017-09-03 16:10:55 +0100
committerPatrick Monnerat <patrick@monnerat.net>2017-09-03 16:10:55 +0100
commitefd93014260e8a7e36e12c1e9c5e4296dd5c5a9e (patch)
tree6d8f375f3d9a15eea59a4362cb966ec360a416a9 /docs
parent1a3f4c19919b09ff0fd0ba228b06a217d85d4265 (diff)
downloadcurl-efd93014260e8a7e36e12c1e9c5e4296dd5c5a9e.tar.gz
mime: use size_t instead of ssize_t in public API interface.
To support telling a string is nul-terminated, symbol CURL_ZERO_TERMINATED has been introduced. Documentation updated accordingly. symbols in versions updated. Added form API symbols deprecation info.
Diffstat (limited to 'docs')
-rw-r--r--docs/libcurl/curl_mime_data.37
-rw-r--r--docs/libcurl/curl_mime_name.36
-rw-r--r--docs/libcurl/symbols-in-versions57
3 files changed, 36 insertions, 34 deletions
diff --git a/docs/libcurl/curl_mime_data.3 b/docs/libcurl/curl_mime_data.3
index 4ce41c38a..85aee65e4 100644
--- a/docs/libcurl/curl_mime_data.3
+++ b/docs/libcurl/curl_mime_data.3
@@ -26,15 +26,16 @@ curl_mime_data - set a mime part's body data from memory
.B #include <curl/curl.h>
.sp
.BI "CURLcode curl_mime_data(curl_mimepart * " part ", const char * " data
-.BI ", ssize_t " datasize ");"
+.BI ", size_t " datasize ");"
.ad
.SH DESCRIPTION
curl_mime_data() sets a mime part's body content from memory data.
\fIdata\fP points to the data bytes: those are copied to the part and their
storage may safely be reused after call.
-\fIdatasize\fP is the number of data bytes: it can be set to -1 to indicate
-\fIdata\fP is a nul-terminated character string.
+\fIdatasize\fP is the number of data bytes: it can be set to
+\fICURL_ZERO_TERMINATED\fP to indicate \fIdata\fP is a nul-terminated
+character string.
\fIpart\fP is the part's to assign contents to.
Setting a part's contents twice is valid: only the value set by the last call
diff --git a/docs/libcurl/curl_mime_name.3 b/docs/libcurl/curl_mime_name.3
index 5ef7c887f..25b4b35c6 100644
--- a/docs/libcurl/curl_mime_name.3
+++ b/docs/libcurl/curl_mime_name.3
@@ -26,7 +26,7 @@ curl_mime_name - set a mime part's name
.B #include <curl/curl.h>
.sp
.BI "CURLcode curl_mime_name(curl_mimepart * " part ", const char * " name
-.BI ", ssize_t " namesize ");"
+.BI ", size_t " namesize ");"
.ad
.SH DESCRIPTION
curl_mime_name() sets a mime part's name. This is the way HTTP form fields are
@@ -34,8 +34,8 @@ named.
\fIname\fP points to the name byte string; the string may contain nul bytes
unless \fInamesize\fP is -1.
-\fInamesize\fP is the name length: it can be set to -1 to indicate
-\fIname\fP is a nul-terminated string.
+\fInamesize\fP is the name length: it can be set to \fICURL_ZERO_TERMINATED\fP
+to indicate \fIname\fP is a nul-terminated string.
\fIpart\fP is the part's handle to assign a name to.
The name string is copied into the part, thus the associated storage may safely
diff --git a/docs/libcurl/symbols-in-versions b/docs/libcurl/symbols-in-versions
index 9ef7148c8..9302353d6 100644
--- a/docs/libcurl/symbols-in-versions
+++ b/docs/libcurl/symbols-in-versions
@@ -160,27 +160,27 @@ CURLFINFOFLAG_KNOWN_PERM 7.21.0
CURLFINFOFLAG_KNOWN_SIZE 7.21.0
CURLFINFOFLAG_KNOWN_TIME 7.21.0
CURLFINFOFLAG_KNOWN_UID 7.21.0
-CURLFORM_ARRAY 7.9.1
+CURLFORM_ARRAY 7.9.1 7.56.0
CURLFORM_ARRAY_END 7.9.1 7.9.5 7.9.6
CURLFORM_ARRAY_START 7.9.1 7.9.5 7.9.6
-CURLFORM_BUFFER 7.9.8
-CURLFORM_BUFFERLENGTH 7.9.8
-CURLFORM_BUFFERPTR 7.9.8
-CURLFORM_CONTENTHEADER 7.9.3
-CURLFORM_CONTENTLEN 7.46.0
-CURLFORM_CONTENTSLENGTH 7.9
-CURLFORM_CONTENTTYPE 7.9
-CURLFORM_COPYCONTENTS 7.9
-CURLFORM_COPYNAME 7.9
-CURLFORM_END 7.9
-CURLFORM_FILE 7.9
-CURLFORM_FILECONTENT 7.9.1
-CURLFORM_FILENAME 7.9.6
-CURLFORM_NAMELENGTH 7.9
-CURLFORM_NOTHING 7.9
-CURLFORM_PTRCONTENTS 7.9
-CURLFORM_PTRNAME 7.9
-CURLFORM_STREAM 7.18.2
+CURLFORM_BUFFER 7.9.8 7.56.0
+CURLFORM_BUFFERLENGTH 7.9.8 7.56.0
+CURLFORM_BUFFERPTR 7.9.8 7.56.0
+CURLFORM_CONTENTHEADER 7.9.3 7.56.0
+CURLFORM_CONTENTLEN 7.46.0 7.56.0
+CURLFORM_CONTENTSLENGTH 7.9 7.56.0
+CURLFORM_CONTENTTYPE 7.9 7.56.0
+CURLFORM_COPYCONTENTS 7.9 7.56.0
+CURLFORM_COPYNAME 7.9 7.56.0
+CURLFORM_END 7.9 7.56.0
+CURLFORM_FILE 7.9 7.56.0
+CURLFORM_FILECONTENT 7.9.1 7.56.0
+CURLFORM_FILENAME 7.9.6 7.56.0
+CURLFORM_NAMELENGTH 7.9 7.56.0
+CURLFORM_NOTHING 7.9 7.56.0
+CURLFORM_PTRCONTENTS 7.9 7.56.0
+CURLFORM_PTRNAME 7.9 7.56.0
+CURLFORM_STREAM 7.18.2 7.56.0
CURLFTPAUTH_DEFAULT 7.12.2
CURLFTPAUTH_SSL 7.12.2
CURLFTPAUTH_TLS 7.12.2
@@ -406,7 +406,7 @@ CURLOPT_HTTP200ALIASES 7.10.3
CURLOPT_HTTPAUTH 7.10.6
CURLOPT_HTTPGET 7.8.1
CURLOPT_HTTPHEADER 7.1
-CURLOPT_HTTPPOST 7.1
+CURLOPT_HTTPPOST 7.1 7.56.0
CURLOPT_HTTPPROXYTUNNEL 7.3
CURLOPT_HTTPREQUEST 7.1 - 7.15.5
CURLOPT_HTTP_CONTENT_DECODING 7.16.2
@@ -718,14 +718,14 @@ CURL_ERROR_SIZE 7.1
CURL_FNMATCHFUNC_FAIL 7.21.0
CURL_FNMATCHFUNC_MATCH 7.21.0
CURL_FNMATCHFUNC_NOMATCH 7.21.0
-CURL_FORMADD_DISABLED 7.12.1
-CURL_FORMADD_ILLEGAL_ARRAY 7.9.8
-CURL_FORMADD_INCOMPLETE 7.9.8
-CURL_FORMADD_MEMORY 7.9.8
-CURL_FORMADD_NULL 7.9.8
-CURL_FORMADD_OK 7.9.8
-CURL_FORMADD_OPTION_TWICE 7.9.8
-CURL_FORMADD_UNKNOWN_OPTION 7.9.8
+CURL_FORMADD_DISABLED 7.12.1 7.56.0
+CURL_FORMADD_ILLEGAL_ARRAY 7.9.8 7.56.0
+CURL_FORMADD_INCOMPLETE 7.9.8 7.56.0
+CURL_FORMADD_MEMORY 7.9.8 7.56.0
+CURL_FORMADD_NULL 7.9.8 7.56.0
+CURL_FORMADD_OK 7.9.8 7.56.0
+CURL_FORMADD_OPTION_TWICE 7.9.8 7.56.0
+CURL_FORMADD_UNKNOWN_OPTION 7.9.8 7.56.0
CURL_GLOBAL_ACK_EINTR 7.30.0
CURL_GLOBAL_ALL 7.8
CURL_GLOBAL_DEFAULT 7.8
@@ -854,3 +854,4 @@ CURL_WAIT_POLLIN 7.28.0
CURL_WAIT_POLLOUT 7.28.0
CURL_WAIT_POLLPRI 7.28.0
CURL_WRITEFUNC_PAUSE 7.18.0
+CURL_ZERO_TERMINATED 7.56.0