[GNUnet-SVN] [gnurl] 196/256: docs: clarify the CURLOPT_INTERLEAVE* options behavior

[gnunet]

This is an automated email from the git hooks/post-receive script.

ng0 pushed a commit to branch master
in repository gnurl.

commit 50b208e23ea2c851c7a4f83bc8cafe0d97a41732
Author: Daniel Stenberg <address@hidden>
AuthorDate: Fri Sep 15 15:47:56 2017 +0200

    docs: clarify the CURLOPT_INTERLEAVE* options behavior
---
 docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.3     | 7 ++++---
 docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.3 | 8 ++++++--
 2 files changed, 10 insertions(+), 5 deletions(-)

diff --git a/docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.3 
b/docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.3
index b11b6cd25..59d36a1be 100644
--- a/docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.3
+++ b/docs/libcurl/opts/CURLOPT_INTERLEAVEDATA.3
@@ -22,15 +22,16 @@
 .\"
 .TH CURLOPT_INTERLEAVEDATA 3 "19 Jun 2014" "libcurl 7.37.0" "curl_easy_setopt 
options"
 .SH NAME
-CURLOPT_INTERLEAVEDATA \- custom pointer to RTSP interleave callback
+CURLOPT_INTERLEAVEDATA \- custom pointer passed to RTSP interleave callback
 .SH SYNOPSIS
 #include <curl/curl.h>
 
 CURLcode curl_easy_setopt(CURL *handle, CURLOPT_INTERLEAVEDATA, void *pointer);
 .SH DESCRIPTION
 This is the userdata \fIpointer\fP that will be passed to
-\fICURLOPT_INTERLEAVEFUNCTION(3)\fP when interleaved RTP data is
-received.
+\fICURLOPT_INTERLEAVEFUNCTION(3)\fP when interleaved RTP data is received. If
+the interleave function callback is not set, this pointer is not used
+anywhere.
 .SH DEFAULT
 NULL
 .SH PROTOCOLS
diff --git a/docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.3 
b/docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.3
index 522f4579e..20f1c218d 100644
--- a/docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.3
+++ b/docs/libcurl/opts/CURLOPT_INTERLEAVEFUNCTION.3
@@ -54,8 +54,12 @@ connection may close. The application may use 
\fICURL_RTSPREQ_RECEIVE\fP to
 service RTP data when no requests are desired. If the application makes a
 request, (e.g.  \fICURL_RTSPREQ_PAUSE\fP) then the response handler will
 process any pending RTP data before marking the request as finished.
+
+The \fICURLOPT_WRITEDATA(3)\fP is passed in the \fIuserdata\fP argument in the
+callback.
 .SH DEFAULT
-NULL
+NULL, the interleave data is then passed to the regular write function:
+\fICURLOPT_WRITEFUNCTION(3)\fP.
 .SH PROTOCOLS
 RTSP
 .SH EXAMPLE
@@ -77,4 +81,4 @@ Added in 7.20.0
 .SH RETURN VALUE
 Returns CURLE_OK if the option is supported, and CURLE_UNKNOWN_OPTION if not.
 .SH "SEE ALSO"
-.BR CURLOPT_INTERLEAVEFUNCTION "(3), " CURLOPT_RTSP_REQUEST "(3), "
+.BR CURLOPT_INTERLEAVEDATA "(3), " CURLOPT_RTSP_REQUEST "(3), "

-- 
To stop receiving notification emails like this one, please contact
address@hidden