Skip site navigation (1)Skip section navigation (2)
Date:      Fri, 24 Mar 2023 18:47:08 GMT
From:      Joseph Koshy <jkoshy@FreeBSD.org>
To:        src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-main@FreeBSD.org
Subject:   git: 047ce3db9776 - main - pmcstat: Warn about text output format stability.
Message-ID:  <202303241847.32OIl8WP074463@gitrepo.freebsd.org>

next in thread | raw e-mail | index | archive | help
The branch main has been updated by jkoshy:

URL: https://cgit.FreeBSD.org/src/commit/?id=047ce3db97769968f6777be456cbf196c65eb455

commit 047ce3db97769968f6777be456cbf196c65eb455
Author:     Joseph Koshy <jkoshy@FreeBSD.org>
AuthorDate: 2023-03-24 09:39:08 +0000
Commit:     Joseph Koshy <jkoshy@FreeBSD.org>
CommitDate: 2023-03-24 18:46:22 +0000

    pmcstat: Warn about text output format stability.
    
    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
---
 usr.sbin/pmcstat/pmcstat.8 | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/usr.sbin/pmcstat/pmcstat.8 b/usr.sbin/pmcstat/pmcstat.8
index b0dae2449cfe..dade290c21b1 100644
--- a/usr.sbin/pmcstat/pmcstat.8
+++ b/usr.sbin/pmcstat/pmcstat.8
@@ -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.



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?202303241847.32OIl8WP074463>