From: Kentaro Hayashi <hayashi@clear-code.com>
Date: Sat, 13 Jan 2024 11:37:43 +0000 (+0900)
Subject: lua: update explanation about register_notification callback
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=refs%2Fpull%2F4235%2Fhead;p=thirdparty%2Fcollectd.git

lua: update explanation about register_notification callback

Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
---

diff --git a/src/collectd-lua.pod b/src/collectd-lua.pod
index 88aeda9d6..272eb5f0a 100644
--- a/src/collectd-lua.pod
+++ b/src/collectd-lua.pod
@@ -111,6 +111,11 @@ once for every after B<init functions>.
 These are used to clean-up the internal state. They are called once for
  every shutting down phase.
 
+=item notification functions
+
+These are used to receive a PUTNOTIF event. They are called once for
+ every notification phase.
+
 =back
 
 =head1 FUNCTIONS
@@ -150,6 +155,12 @@ table of values.
 Function to register shutdown callbacks.
 The callback function will be called without arguments.
 
+=item register_notification(callback)
+
+Function to register notification callbacks.
+The callback function will be called with one argument passed, which will be a
+table of values.
+
 =item log_error, log_warning, log_notice, log_info, log_debug(I<message>)
 
 Log a message with the specified severity.