]> git.ipfire.org Git - thirdparty/curl.git/commitdiff
docs/libcurl: add to cleanup docs that their inputs go invalid
authorDaniel Stenberg <daniel@haxx.se>
Mon, 22 Jul 2024 17:04:12 +0000 (19:04 +0200)
committerDaniel Stenberg <daniel@haxx.se>
Tue, 23 Jul 2024 09:18:46 +0000 (11:18 +0200)
Reported-by: icy17 on github
Fixes #14248
Closes #14258

docs/libcurl/curl_multi_cleanup.md
docs/libcurl/curl_share_cleanup.md
docs/libcurl/curl_slist_free_all.md
docs/libcurl/curl_url_cleanup.md

index 1c08c679b925d309626d35948f0a13024b1a96bb..fb56e6468f5a9c1363b459377d8c5e868bc148b9 100644 (file)
@@ -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
index 85176066a5649a16251fb713eac2e247beb62b02..afb06d008c8aff1a7d029e7b81c4c3cf86aaef99 100644 (file)
@@ -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
index 116ebbecdb6edb837cd575caed947e943b290580..91491aa6c0a7fea213f71e57e0fe2df200f85bd1 100644 (file)
@@ -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
index 0684f478f019383fd8d8a93bd227ae30075c4be0..80eff3590fa24f4986564e9a36da790c4b6c698e 100644 (file)
@@ -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