]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs: provide "RETURN VALUE" section for more func manpages
authorDaniel Stenberg <daniel@haxx.se>
Mon, 25 Oct 2021 05:50:25 +0000 (07:50 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Mon, 25 Oct 2021 08:19:38 +0000 (10:19 +0200)
Three were missing, one used a non-standard name for the header.

Closes #7902

docs/libcurl/curl_free.3
docs/libcurl/curl_global_cleanup.3
docs/libcurl/curl_global_init_mem.3
docs/libcurl/curl_multi_setopt.3

index 96e26239a20017ed44358606d9d5379437d52064..68298d4824827b8ac05818f87d9b06fefbbafcd4 100644 (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
@@ -34,5 +34,7 @@ differences in memory management between your application and libcurl.
 
 Passing in a NULL pointer in \fIptr\fP will make this function return
 immediately with no action.
+.SH RETURN VALUE
+None
 .SH "SEE ALSO"
 .BR curl_easy_unescape "(3), " curl_easy_escape "(3) "
index a87b557c4a0170f986858deabd720ffe5f5c4e24..9426bec058056552e7c9b3a49d06fc89f1084612 100644 (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
@@ -49,6 +49,8 @@ containing libcurl is dynamically unloaded while libcurl-created threads are
 still running then your program may crash or other corruption may occur. We
 recommend you do not run libcurl from any module that may be unloaded
 dynamically. This behavior may be addressed in the future.
+.SH RETURN VALUE
+None
 .SH "SEE ALSO"
 .BR curl_global_init "(3), "
 .BR libcurl "(3), "
index 167ccd38c65fcd218ec73e16144a892171e0c111..d9e758f698393f6c43e8b9a1c7f29ed061d809fe 100644 (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
@@ -59,6 +59,9 @@ to that man page for documentation.
 .SH "CAUTION"
 Manipulating these gives considerable powers to the application to severely
 screw things up for libcurl. Take care!
+.SH RETURN VALUE
+CURLE_OK (0) means everything was ok, non-zero means an error occurred as
+\fI<curl/curl.h>\fP defines - see \fIlibcurl-errors(3)\fP.
 .SH AVAILABILITY
 Added in 7.12.0
 .SH "SEE ALSO"
index c3f0cbe7920033a11d51dc01c4c56247e63d7ed1..fc3526f3afd633a22f3aa3e4a3176f08517ed774 100644 (file)
@@ -69,7 +69,7 @@ See \fICURLMOPT_TIMERFUNCTION(3)\fP
 See \fICURLMOPT_TIMERDATA(3)\fP
 .IP CURLMOPT_MAX_CONCURRENT_STREAMS
 See \fICURLMOPT_MAX_CONCURRENT_STREAMS(3)\fP
-.SH RETURNS
+.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
 doesn't know of.