From 412570d7c409bbfce723dc8bf4903c286e728bc8 Mon Sep 17 00:00:00 2001 From: Daniel Stenberg Date: Mon, 25 Oct 2021 07:50:25 +0200 Subject: [PATCH] docs: provide "RETURN VALUE" section for more func manpages Three were missing, one used a non-standard name for the header. Closes #7902 --- docs/libcurl/curl_free.3 | 4 +++- docs/libcurl/curl_global_cleanup.3 | 4 +++- docs/libcurl/curl_global_init_mem.3 | 5 ++++- docs/libcurl/curl_multi_setopt.3 | 2 +- 4 files changed, 11 insertions(+), 4 deletions(-) diff --git a/docs/libcurl/curl_free.3 b/docs/libcurl/curl_free.3 index 96e26239a2..68298d4824 100644 --- a/docs/libcurl/curl_free.3 +++ b/docs/libcurl/curl_free.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , 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) " diff --git a/docs/libcurl/curl_global_cleanup.3 b/docs/libcurl/curl_global_cleanup.3 index a87b557c4a..9426bec058 100644 --- a/docs/libcurl/curl_global_cleanup.3 +++ b/docs/libcurl/curl_global_cleanup.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , 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), " diff --git a/docs/libcurl/curl_global_init_mem.3 b/docs/libcurl/curl_global_init_mem.3 index 167ccd38c6..d9e758f698 100644 --- a/docs/libcurl/curl_global_init_mem.3 +++ b/docs/libcurl/curl_global_init_mem.3 @@ -5,7 +5,7 @@ .\" * | (__| |_| | _ <| |___ .\" * \___|\___/|_| \_\_____| .\" * -.\" * Copyright (C) 1998 - 2020, Daniel Stenberg, , et al. +.\" * Copyright (C) 1998 - 2021, Daniel Stenberg, , 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\fP defines - see \fIlibcurl-errors(3)\fP. .SH AVAILABILITY Added in 7.12.0 .SH "SEE ALSO" diff --git a/docs/libcurl/curl_multi_setopt.3 b/docs/libcurl/curl_multi_setopt.3 index c3f0cbe792..fc3526f3af 100644 --- a/docs/libcurl/curl_multi_setopt.3 +++ b/docs/libcurl/curl_multi_setopt.3 @@ -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. -- 2.47.3