From 28d621d917856827666556277fa787f9fbab4944 Mon Sep 17 00:00:00 2001 From: vboxuser Date: Fri, 10 Nov 2023 14:44:53 +0300 Subject: [PATCH] Documentation fixes for the reviewed changes: shorten confusing parts and fix uncorrent AC-safety documentation --- include/private/entry.h | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/include/private/entry.h b/include/private/entry.h index e2eec675b..c03bfa9b4 100644 --- a/include/private/entry.h +++ b/include/private/entry.h @@ -42,8 +42,6 @@ * This function is not safe to call from threads that may be asynchronously * cancelled, due to leaving memory in an undefined state. * - * @since release v1.6.0 - * */ void entry_free_all( void ); @@ -86,8 +84,7 @@ get_prival( enum stumpless_facility facility, * * **Async Signal Safety: AS-Unsafe ** * This function is not safe to call from signal handlers due to the use of - * function 'pthread_mutex_lock()' from that is not guarenteed to - * be async signal safe. + * mutexes that are not guarenteed to be async signal safe. * * **Async Cancel Safety: AC-Unsafe** * This function is not safe to call from threads that may be asynchronously @@ -137,12 +134,14 @@ locked_add_element( struct stumpless_entry *entry, * This function is not thread safe as it doesn't use any synchronization * or locking mechanisms while accessing shared resources. * - * **Async Signal Safety: AS-Safe** - * This function is safe to call from signal handlers. + * **Async Signal Safety: AS-Unsafe** + * This function is not safe to call from signal handlers due to use of + * thread global structrues. * - * **Async Cancel Safety: AC-Safe** - * This function is safe to call from threads that may be asynchronously - * canceled. + * **Async Cancel Safety: AC-Unsafe** + * This function is not safe to call from threads that may be asynchronously + * canceled due to use of thread-global structure that may left in a + * undefined state when cancelled * * @since release v2.0.0 * @@ -157,7 +156,6 @@ struct stumpless_element * locked_get_element_by_index( const struct stumpless_entry *entry, size_t index ); - struct stumpless_element * locked_get_element_by_name( const struct stumpless_entry *entry, const char *name );