summaryrefslogtreecommitdiffstats
path: root/lib/librte_metrics/rte_metrics.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/librte_metrics/rte_metrics.h')
-rw-r--r--lib/librte_metrics/rte_metrics.h3
1 files changed, 2 insertions, 1 deletions
diff --git a/lib/librte_metrics/rte_metrics.h b/lib/librte_metrics/rte_metrics.h
index 0fa3104e..297300ad 100644
--- a/lib/librte_metrics/rte_metrics.h
+++ b/lib/librte_metrics/rte_metrics.h
@@ -118,7 +118,8 @@ void rte_metrics_init(int socket_id);
* is required for updating said metric's value.
*
* @param name
- * Metric name
+ * Metric name. If this exceeds RTE_METRICS_MAX_NAME_LEN (including
+ * the NULL terminator), it is truncated.
*
* @return
* - Zero or positive: Success (index key of new metric)