[src/trunk]: src/usr.sbin/envstat Add a BUGS section to point out that the st...

[pgoyette <pgoyette%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/599a328cef2a
branches:  trunk
changeset: 765843:599a328cef2a
user:      pgoyette <pgoyette%NetBSD.org@localhost>
date:      Tue Jun 07 17:28:59 2011 +0000

description:
Add a BUGS section to point out that the statistic "average" is an
average only of the current, minimum, and maximum values, and not a
running average of all displayed current values.

diffstat:

 usr.sbin/envstat/envstat.8 |  10 ++++++++--
 1 files changed, 8 insertions(+), 2 deletions(-)

diffs (31 lines):

diff -r 5950c24f5979 -r 599a328cef2a usr.sbin/envstat/envstat.8
--- a/usr.sbin/envstat/envstat.8        Tue Jun 07 17:24:32 2011 +0000
+++ b/usr.sbin/envstat/envstat.8        Tue Jun 07 17:28:59 2011 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: envstat.8,v 1.58 2010/10/05 10:03:53 njoly Exp $
+.\"    $NetBSD: envstat.8,v 1.59 2011/06/07 17:28:59 pgoyette Exp $
 .\"
 .\" Copyright (c) 2000, 2007, 2008, 2009 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -27,7 +27,7 @@
 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 .\" POSSIBILITY OF SUCH DAMAGE.
 .\"
-.Dd October 5, 2010
+.Dd June 7, 2011
 .Dt ENVSTAT 8
 .Os
 .Sh NAME
@@ -231,6 +231,12 @@
 .Xr ug 4 ,
 .Xr viaenv 4 ,
 .Xr envsys.conf 5
+.Sh BUGS
+When displaying statistics using the
+.Fl T
+option, the average value is an average of the minimum, maximum, and
+current sensor values.
+It is not an average of all current values displayed during the session.
 .Sh HISTORY
 .Nm
 appeared in