[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[GNUnet-SVN] [gnurl] 73/153: docs: mention NULL is fine input to several
From: |
gnunet |
Subject: |
[GNUnet-SVN] [gnurl] 73/153: docs: mention NULL is fine input to several functions |
Date: |
Tue, 11 Sep 2018 12:52:24 +0200 |
This is an automated email from the git hooks/post-receive script.
ng0 pushed a commit to branch master
in repository gnurl.
commit 6fac5a3e65217f1686927ecc8eda567888b29d4f
Author: Daniel Stenberg <address@hidden>
AuthorDate: Thu Aug 9 16:37:39 2018 +0200
docs: mention NULL is fine input to several functions
Fixes #2837
Closes #2858
Reported-by: Markus Elfring
---
docs/libcurl/curl_easy_cleanup.3 | 5 ++++-
docs/libcurl/curl_formfree.3 | 5 ++++-
docs/libcurl/curl_free.3 | 5 ++++-
docs/libcurl/curl_mime_free.3 | 4 +++-
docs/libcurl/curl_multi_cleanup.3 | 5 ++++-
docs/libcurl/curl_share_cleanup.3 | 4 +++-
docs/libcurl/curl_slist_free_all.3 | 5 ++++-
7 files changed, 26 insertions(+), 7 deletions(-)
diff --git a/docs/libcurl/curl_easy_cleanup.3 b/docs/libcurl/curl_easy_cleanup.3
index a6969a026..626d98c51 100644
--- a/docs/libcurl/curl_easy_cleanup.3
+++ b/docs/libcurl/curl_easy_cleanup.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2015, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -47,6 +47,9 @@ Any use of the \fBhandle\fP after this function has been
called and have
returned, is illegal. \fIcurl_easy_cleanup(3)\fP kills the handle and all
memory associated with it!
+Passing in a NULL pointer in \fIhandle\fP will make this function return
+immediately with no action.
+.SH "OLD TIMES"
For libcurl versions before 7.17,: after you've called this function, you can
safely remove all the strings you've previously told libcurl to use, as it
won't use them anymore now.
diff --git a/docs/libcurl/curl_formfree.3 b/docs/libcurl/curl_formfree.3
index dd00494be..6e0e95f57 100644
--- a/docs/libcurl/curl_formfree.3
+++ b/docs/libcurl/curl_formfree.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -40,6 +40,9 @@ the \fIcurl_formadd(3)\fP invoke(s).
\fBform\fP is the pointer as returned from a previous call to
\fIcurl_formadd(3)\fP and may be NULL.
+
+Passing in a NULL pointer in \fIform\fP will make this function return
+immediately with no action.
.SH AVAILABILITY
Deprecated in 7.56.0.
.SH RETURN VALUE
diff --git a/docs/libcurl/curl_free.3 b/docs/libcurl/curl_free.3
index 5bbf74535..e2cf890f0 100644
--- a/docs/libcurl/curl_free.3
+++ b/docs/libcurl/curl_free.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2014, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -31,5 +31,8 @@ curl_free - reclaim memory that has been obtained through a
libcurl call
curl_free reclaims memory that has been obtained through a libcurl call. Use
\fIcurl_free(3)\fP instead of free() to avoid anomalies that can result from
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 "SEE ALSO"
.BR curl_easy_unescape "(3), " curl_easy_escape "(3) "
diff --git a/docs/libcurl/curl_mime_free.3 b/docs/libcurl/curl_mime_free.3
index 9394b5748..80a95486e 100644
--- a/docs/libcurl/curl_mime_free.3
+++ b/docs/libcurl/curl_mime_free.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -40,6 +40,8 @@ not be explicitly freed as they are by the top structure
freeing.
\fBmime\fP is the handle as returned from a previous call to
\fIcurl_mime_init(3)\fP and may be NULL.
+Passing in a NULL pointer in \fImime\fP will make this function return
+immediately with no action.
.SH AVAILABILITY
As long as at least one of HTTP, SMTP or IMAP is enabled. Added in 7.56.0.
.SH RETURN VALUE
diff --git a/docs/libcurl/curl_multi_cleanup.3
b/docs/libcurl/curl_multi_cleanup.3
index 07d921605..a945fd698 100644
--- a/docs/libcurl/curl_multi_cleanup.3
+++ b/docs/libcurl/curl_multi_cleanup.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -40,6 +40,9 @@ handle is no longer connected to the multi handle
3 - \fIcurl_multi_cleanup(3)\fP should be called when all easy handles are
removed
+
+Passing in a NULL pointer in \fImulti_handle\fP will make this function return
+CURLM_BAD_HANDLE immediately with no other action.
.SH RETURN VALUE
CURLMcode type, general libcurl multi interface error code. On success,
CURLM_OK is returned.
diff --git a/docs/libcurl/curl_share_cleanup.3
b/docs/libcurl/curl_share_cleanup.3
index 0b265e86e..d74ef91d2 100644
--- a/docs/libcurl/curl_share_cleanup.3
+++ b/docs/libcurl/curl_share_cleanup.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2011, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -31,6 +31,8 @@ curl_share_cleanup - Clean up a shared object
This function deletes a shared object. The share handle cannot be used anymore
when this function has been called.
+Passing in a NULL pointer in \fIshare_handle\fP will make this function return
+immediately with no action.
.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
diff --git a/docs/libcurl/curl_slist_free_all.3
b/docs/libcurl/curl_slist_free_all.3
index 895524914..82cb80ff2 100644
--- a/docs/libcurl/curl_slist_free_all.3
+++ b/docs/libcurl/curl_slist_free_all.3
@@ -5,7 +5,7 @@
.\" * | (__| |_| | _ <| |___
.\" * \___|\___/|_| \_\_____|
.\" *
-.\" * Copyright (C) 1998 - 2017, Daniel Stenberg, <address@hidden>, et al.
+.\" * Copyright (C) 1998 - 2018, Daniel Stenberg, <address@hidden>, et al.
.\" *
.\" * This software is licensed as described in the file COPYING, which
.\" * you should have received as part of this distribution. The terms
@@ -30,6 +30,9 @@ curl_slist_free_all - free an entire curl_slist list
.SH DESCRIPTION
curl_slist_free_all() removes all traces of a previously built curl_slist
linked list.
+
+Passing in a NULL pointer in \fIlist\fP will make this function return
+immediately with no action.
.SH RETURN VALUE
Nothing.
.SH EXAMPLE
--
To stop receiving notification emails like this one, please contact
address@hidden
- [GNUnet-SVN] [gnurl] 82/153: docs: Improve the manual pages of some callbacks, (continued)
- [GNUnet-SVN] [gnurl] 82/153: docs: Improve the manual pages of some callbacks, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 81/153: GCC: silence -Wcast-function-type uniformly, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 52/153: test1307: disabled, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 76/153: openssl: fix potential NULL pointer deref in is_pkcs11_uri, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 67/153: formdata: Remove unused macro HTTPPOST_CONTENTTYPE_DEFAULT, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 49/153: RELEASE-NOTES: synced, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 50/153: general: fix printf specifiers, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 60/153: ssl: set engine implicitly when a PKCS#11 URI is provided, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 74/153: lib1502: fix memory leak in torture test, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 75/153: travis: execute "set -eo pipefail" for coverage build, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 73/153: docs: mention NULL is fine input to several functions,
gnunet <=
- [GNUnet-SVN] [gnurl] 66/153: telnet: Remove unused macros TELOPTS and TELCMDS, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 69/153: asyn-thread: Remove unused macro, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 70/153: test1540: Remove unused macro TEST_HANG_TIMEOUT, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 64/153: configure: fix for -lpthread detection with OpenSSL and pkg-config, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 65/153: openssl: fix debug messages, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 36/153: conn_free: updated comment to clarify, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 41/153: examples/ephiperfifo: checksrc compliance, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 62/153: windows: follow up to the buffer-tuning 1ba1dba7, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 59/153: CMake: Respect BUILD_SHARED_LIBS, gnunet, 2018/09/11
- [GNUnet-SVN] [gnurl] 33/153: mime: check Curl_rand_hex's return code, gnunet, 2018/09/11