From: Florian Forster <octo@collectd.org>
Date: Mon, 18 Dec 2023 14:01:38 +0000 (+0100)
Subject: src/daemon/metric.h: Add doc comment for the `unit` field.
X-Git-Tag: 6.0.0-rc0~21^2~4
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=0d8bbb51c3efe7335e0f05ba61e6ec4ea10748e6;p=thirdparty%2Fcollectd.git

src/daemon/metric.h: Add doc comment for the `unit` field.
---

diff --git a/src/daemon/metric.h b/src/daemon/metric.h
index 69d890a60..e789650ff 100644
--- a/src/daemon/metric.h
+++ b/src/daemon/metric.h
@@ -166,6 +166,9 @@ typedef struct {
 struct metric_family_s {
   char *name;
   char *help;
+  /* unit is a case sensitive "Unified Code for Units of Measure" (UCUM)
+   * denoting the unit of the metric, e.g. "By" for bytes, and "1" for
+   * dimensionless metrics, such as "utilization". */
   char *unit;
   metric_type_t type;