From 1f25978eb4bcd36a75c0d0e03f427c7b4bf9ba24 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Thu, 22 Dec 2022 11:46:00 +0100
Subject: [PATCH] module/cpu: cleanup poll-interval
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* man page: spell out ‘milliseconds’
* use a ‘static const’ variable for min_poll_interval, instead of a
  macro
---
 doc/yambar-modules-cpu.5.scd |  4 ++--
 modules/cpu.c                | 15 ++++++++-------
 2 files changed, 10 insertions(+), 9 deletions(-)

diff --git a/doc/yambar-modules-cpu.5.scd b/doc/yambar-modules-cpu.5.scd
index bfd9357..400b2dd 100644
--- a/doc/yambar-modules-cpu.5.scd
+++ b/doc/yambar-modules-cpu.5.scd
@@ -31,8 +31,8 @@ total CPU usage.
 |  poll-interval
 :  int
 :  no
-:  Refresh interval of the CPU usage stats in ms (default=500). Cannot
-   be less then 500 ms
+:  Refresh interval of the CPU usage stats in milliseconds
+   (default=500). Cannot be less then 500ms.
 
 # EXAMPLES
 
diff --git a/modules/cpu.c b/modules/cpu.c
index b63e926..a18cc9b 100644
--- a/modules/cpu.c
+++ b/modules/cpu.c
@@ -13,7 +13,6 @@
 
 #define LOG_MODULE "cpu"
 #define LOG_ENABLE_DBG 0
-#define SMALLEST_INTERVAL 500
 #include "../log.h"
 
 #include "../bar/bar.h"
@@ -22,6 +21,8 @@
 #include "../particles/dynlist.h"
 #include "../plugin.h"
 
+static const long min_poll_interval = 500;
+
 struct cpu_stats {
     uint32_t *prev_cores_idle;
     uint32_t *prev_cores_nidle;
@@ -276,19 +277,19 @@ from_conf(const struct yml_node *node, struct conf_inherit inherited)
     const struct yml_node *c = yml_get_value(node, "content");
 
     return cpu_new(
-        interval == NULL ? SMALLEST_INTERVAL : yml_value_as_int(interval),
+        interval == NULL ? min_poll_interval : yml_value_as_int(interval),
         conf_to_particle(c, inherited));
 }
 
 static bool
-conf_verify_interval(keychain_t *chain, const struct yml_node *node)
+conf_verify_poll_interval(keychain_t *chain, const struct yml_node *node)
 {
     if (!conf_verify_unsigned(chain, node))
         return false;
 
-    if (yml_value_as_int(node) < SMALLEST_INTERVAL) {
-        LOG_ERR("%s: interval value cannot be less than %d ms",
-                conf_err_prefix(chain, node), SMALLEST_INTERVAL);
+    if (yml_value_as_int(node) < min_poll_interval) {
+        LOG_ERR("%s: interval value cannot be less than %ldms",
+                conf_err_prefix(chain, node), min_poll_interval);
         return false;
     }
 
@@ -299,7 +300,7 @@ static bool
 verify_conf(keychain_t *chain, const struct yml_node *node)
 {
     static const struct attr_info attrs[] = {
-        {"poll-interval", false, &conf_verify_interval},
+        {"poll-interval", false, &conf_verify_poll_interval},
         MODULE_COMMON_ATTRS,
     };