From: Aurelien DARRAGON <adarragon@haproxy.com>
Date: Tue, 4 Apr 2023 19:43:31 +0000 (+0200)
Subject: CLEANUP: event_hdl: fix comment typo about _sync assertion
X-Git-Tag: v2.8-dev8~64
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=147691fd83b8565a2e16bcaec188ddd3b6c423a7;p=thirdparty%2Fhaproxy.git

CLEANUP: event_hdl: fix comment typo about _sync assertion

Fixing a comment relative to EVENT_HDL_ASSERT_SYNC macro where a
typo was made and the comment was lacking some context.
---

diff --git a/include/haproxy/event_hdl-t.h b/include/haproxy/event_hdl-t.h
index b8ef61a102..9efb548efb 100644
--- a/include/haproxy/event_hdl-t.h
+++ b/include/haproxy/event_hdl-t.h
@@ -141,11 +141,12 @@ struct event_hdl_cb
 	/* manage the subscription responsible for handing the event to us */
 	const struct event_hdl_sub_mgmt	*sub_mgmt;
 
-	/* used for the function wants to make sure
+	/* may be used by sync event handler to ensure
 	 * it runs in sync mode, and thus is eligible to access unsafe data.
 	 * This could save the day when users are copy-pasting function
 	 * logic from a sync handler to an async handler without
 	 * taking appropriate precautions and unsafe accesses are performed.
+	 * (See EVENT_HDL_ASSERT_SYNC macro API helper)
 	 */
 	uint8_t				_sync;
 };