chore(userspace/plugin): improved docs in plugin api

Signed-off-by: Gianmatteo Palmieri <[email protected]> Co-authored-by: Jason Dellaluce <[email protected]>
falcosecurity · Jan 24, 2024 · 516755c · 516755c
1 parent 523edf3
commit 516755c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 3 deletions.
diff --git a/userspace/plugin/plugin_api.h b/userspace/plugin/plugin_api.h
@@ -269,8 +269,8 @@ typedef struct
 
 // Function used by plugin for sending messages to the framework-provided logger
 // Arguments:
-//  - component: name of the component that is logging (e.g. plugin name)
-//  - msg: message to log
+//  - component: name of the component that is logging
+//  - msg: message to log (it doesn't have to be '\n' terminated)
 //  - sev: message severity as defined in ss_plugin_log_severity
 typedef void (*ss_plugin_log_fn_t)(const char* component, const char* msg, ss_plugin_log_severity sev);
 

diff --git a/userspace/plugin/plugin_types.h b/userspace/plugin/plugin_types.h
@@ -280,7 +280,7 @@ typedef void ss_plugin_t;
 typedef void ss_instance_t;
 
 //
-// Libsinsp logger severities
+// Severity available in the logging facility provided by the framework
 typedef enum ss_plugin_log_severity
 {
 	SS_PLUGIN_LOG_SEV_FATAL = 1,