From ca49f9ef704717d416a5d5890a20ab9ee80ff2c2 Mon Sep 17 00:00:00 2001 From: Quincey Koziol Date: Tue, 24 Sep 2024 13:49:02 -0500 Subject: [PATCH] Add note to H5F_clear_stack() to dissuade use Signed-off-by: Quincey Koziol --- src/H5Eint.c | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/src/H5Eint.c b/src/H5Eint.c index d01668e731d..8db9d5fdff7 100644 --- a/src/H5Eint.c +++ b/src/H5Eint.c @@ -1673,6 +1673,15 @@ H5E__clear_entries(H5E_stack_t *estack, size_t nentries) * * Purpose: Clear the default error stack * + * Note: This routine should _not_ be used inside general library + * code in general. It creates complex locking issues for + * threadsafe code. Generally, using a 'try' parameter or + * an 'exists' parameter should be used if an operation is + * being used to probe for information. Remember: failing + * to locate a record is not an error for a data structure, + * although it could be an error for the user of the data + * structure. + * * Return: SUCCEED/FAIL * *-------------------------------------------------------------------------