From: Eero Tamminen <eero.t.tamminen@intel.com>
Date: Fri, 15 Dec 2023 18:53:21 +0000 (+0100)
Subject: format_json: Improve the doc comment for `irq_strsplit`.
X-Git-Tag: 6.0.0-rc0~36^2~1
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cca99600e6f2d07a498a07f9eb206ebf4aae2ab8;p=thirdparty%2Fcollectd.git

format_json: Improve the doc comment for `irq_strsplit`.

Contrast the behavior to `strsplit`.

Co-authored-by: Florian Forster <octo@collectd.org>
---

diff --git a/src/irq.c b/src/irq.c
index ed381f8d6..d7bfbc3ce 100644
--- a/src/irq.c
+++ b/src/irq.c
@@ -70,8 +70,8 @@ static int irq_config(const char *key, const char *value) {
 
 #if KERNEL_LINUX
 /* irq_strsplit is a special split function for Linux' /proc/interrupts file.
- * It uses two or more spaces to separate fields. Returns number of parsed
- * fields. */
+ * It uses two or more spaces to separate fields, in contrast to strsplit()
+ * which splits on individual spaces. Returns number of parsed fields. */
 static int irq_strsplit(char *string, char **fields, size_t fields_num) {
   for (size_t i = 0; i < fields_num; i++) {
     while (string[0] != 0 && isspace(string[0])) {