From: Daniel Stenberg Date: Mon, 22 Jul 2024 17:04:12 +0000 (+0200) Subject: docs/libcurl: add to cleanup docs that their inputs go invalid X-Git-Tag: curl-8_9_0~3 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=1e769526b4d71e949e856186333838eeb7191d18;p=thirdparty%2Fcurl.git docs/libcurl: add to cleanup docs that their inputs go invalid Reported-by: icy17 on github Fixes #14248 Closes #14258 --- diff --git a/docs/libcurl/curl_multi_cleanup.md b/docs/libcurl/curl_multi_cleanup.md index 1c08c679b9..fb56e6468f 100644 --- a/docs/libcurl/curl_multi_cleanup.md +++ b/docs/libcurl/curl_multi_cleanup.md @@ -28,10 +28,10 @@ CURLMcode curl_multi_cleanup(CURLM *multi_handle); # DESCRIPTION -Cleans up and removes a whole multi stack. It does not free or touch any -individual easy handles in any way - they still need to be closed -individually, using the usual curl_easy_cleanup(3) way. The order of -cleaning up should be: +This function is the opposite of curl_multi_init(3). Cleans up and removes a +whole multi stack. It does not free or touch any individual easy handles in +any way - they still need to be closed individually, using the usual +curl_easy_cleanup(3) way. The order of cleaning up should be: 1 - curl_multi_remove_handle(3) before any easy handles are cleaned up @@ -44,6 +44,8 @@ removed Passing in a NULL pointer in *multi_handle* makes this function return CURLM_BAD_HANDLE immediately with no other action. +Any use of the **multi_handle** after this function has been called and have +returned, is illegal. # %PROTOCOLS% # EXAMPLE diff --git a/docs/libcurl/curl_share_cleanup.md b/docs/libcurl/curl_share_cleanup.md index 85176066a5..afb06d008c 100644 --- a/docs/libcurl/curl_share_cleanup.md +++ b/docs/libcurl/curl_share_cleanup.md @@ -32,6 +32,9 @@ when this function has been called. Passing in a NULL pointer in *share_handle* makes this function return immediately with no action. +Any use of the **share_handle** after this function has been called and have +returned, is illegal. + # %PROTOCOLS% # EXAMPLE diff --git a/docs/libcurl/curl_slist_free_all.md b/docs/libcurl/curl_slist_free_all.md index 116ebbecdb..91491aa6c0 100644 --- a/docs/libcurl/curl_slist_free_all.md +++ b/docs/libcurl/curl_slist_free_all.md @@ -31,6 +31,9 @@ linked list. Passing in a NULL pointer in *list* makes this function return immediately with no action. +Any use of the **list** after this function has been called and have returned, +is illegal. + # %PROTOCOLS% # EXAMPLE diff --git a/docs/libcurl/curl_url_cleanup.md b/docs/libcurl/curl_url_cleanup.md index 0684f478f0..80eff3590f 100644 --- a/docs/libcurl/curl_url_cleanup.md +++ b/docs/libcurl/curl_url_cleanup.md @@ -34,6 +34,9 @@ Frees all the resources associated with the given *CURLU* handle! Passing in a NULL pointer in *handle* makes this function return immediately with no action. +Any use of the **handle** after this function has been called and have +returned, is illegal. + # %PROTOCOLS% # EXAMPLE