From: Kamalesh Babulal <kamalesh.babulal@oracle.com>
Date: Thu, 16 Feb 2023 12:05:02 +0000 (+0530)
Subject: man: document cgget's -m option
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=fc7d5aa5f6503cb46ef5fc2eef1207795c1094c8;p=thirdparty%2Flibcgroup.git

man: document cgget's -m option

Add documentation about the -m option in the cgget's man page. This
option prints the current cgroup setup mode.

Signed-off-by: Kamalesh Babulal <kamalesh.babulal@oracle.com>
Signed-off-by: Tom Hromatka <tom.hromatka@oracle.com>
(cherry picked from commit 625e35fb05dcc898e32687026454146f03df4807)
---

diff --git a/doc/man/cgget.1 b/doc/man/cgget.1
index 744a3296..11f947be 100644
--- a/doc/man/cgget.1
+++ b/doc/man/cgget.1
@@ -7,10 +7,10 @@
 cgget \- print parameter(s) of given group(s)
 
 .SH SYNOPSIS
-\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>]
+\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-m\fR] [\fB-r\fR <\fIname\fR>]
 [\fB-g\fR <\fIcontroller\fR>] [\fB-a\fR] <\fBpath\fR> ...
 .br
-\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-r\fR <\fIname\fR>]
+\fBcgget\fR [\fB-n\fR] [\fB-v\fR] [\fB-m\fR] [\fB-r\fR <\fIname\fR>]
 \fB-g\fR <\fIcontroller\fR>:<\fBpath\fR> ...
 
 .SH DESCRIPTION
@@ -41,6 +41,11 @@ This option can be used multiple times.
 .B -h, --help
 display help and exit
 
+.TP
+.B -m
+displays the current control groups setup mode. The control groups can be set up in one of three modes,
+legacy (cgroup v1 only), unified (cgroup v2 only) or hybrid (cgroup v1/v2).
+
 .TP
 .B -n
 do not print headers, i.e. names of groups.
@@ -83,6 +88,9 @@ cpu.rt_period_us=1000000
 cpu.rt_runtime_us=950000
 cpu.shares=1024
 
+$ cgget -m
+Unified Mode (Cgroup v2 only).
+
 .fi
 
 .SH ENVIRONMENT VARIABLES