From 66ff33813a8cd9d4cba96280bb613762fb0c2ce2 Mon Sep 17 00:00:00 2001
From: Garrett D'Amore <garrett@damore.org>
Date: Wed, 11 Nov 2020 21:29:54 -0800
Subject: fixes #1323 stats framework is *way* to heavy

This should reduce the amount of copying, and the overall size
used by pipes and other objects quite a bit.  (On my system, the
sizeof nni_pipe shrank by 400 bytes, for example.)
---
 docs/man/nng_stat_string.3.adoc | 5 ++++-
 1 file changed, 4 insertions(+), 1 deletion(-)

(limited to 'docs/man/nng_stat_string.3.adoc')

diff --git a/docs/man/nng_stat_string.3.adoc b/docs/man/nng_stat_string.3.adoc
index 3323fef3..4c65fb1a 100644
--- a/docs/man/nng_stat_string.3.adoc
+++ b/docs/man/nng_stat_string.3.adoc
@@ -1,6 +1,6 @@
 = nng_stat_string(3)
 //
-// Copyright 2018 Staysail Systems, Inc. <info@staysail.tech>
+// Copyright 2020 Staysail Systems, Inc. <info@staysail.tech>
 // Copyright 2018 Capitar IT Group BV <info@capitar.com>
 //
 // This document is supplied under the terms of the MIT License, a
@@ -31,6 +31,9 @@ which must be of type `NNG_STAT_STRING` (see xref:nng_stat_type.3.adoc[`nng_stat
 
 If the statistic is not of type `NNG_STAT_STRING`, then `NULL` will be returned.
 
+NOTE: The returned string is valid until xref:nng_stats_free.3.adoc[`nng_stats_free()`] is called to
+free the memory for the snapshot.
+
 == RETURN VALUES
 
 The string value associated with _stat_, or `NULL` if the statistic is not
-- 
cgit v1.2.3-70-g09d2

