upstream/opnsense-src
1
0
Fork 0
mirror of https://github.com/opnsense/src.git synced 2026-06-08 16:22:46 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

pmcstat: Warn about text output format stability.

Browse source 
The formats for pmcstat(8)'s human-readable output are not part of its
user interface definition, and may change in the future.  Highlight
this in its manual page.

Approved by:	gnn (mentor)
Differential Revision: https://reviews.freebsd.org/D39249
This commit is contained in:
Joseph Koshy 2023-03-24 09:39:08 +00:00
parent 13262b07a0
commit 047ce3db97
No known key found for this signature in database
GPG key ID: 3304E1EA21BF01DF
1 changed files with 5 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
usr.sbin/pmcstat/pmcstat.8
View file

@ -25,7 +25,7 @@
.\"
.\" $FreeBSD$
.\"
.Dd August 17, 2020
.Dd March 24, 2023
.Dt PMCSTAT 8
.Os
.Sh NAME
@ -107,6 +107,10 @@ counting and sampling flavors.
The values of all counting PMCs are printed in human readable form
at regular intervals by
.Nm .
The format of
.Nm Ns 's
human-readable textual output is not stable, and could change
in the future.
The output of sampling PMCs may be configured to go to a log file for
subsequent offline analysis, or, at the expense of greater
overhead, may be configured to be printed in text form on the fly.