From: Tom Hromatka <tom.hromatka@oracle.com>
Date: Thu, 27 Mar 2025 14:20:10 +0000 (-0600)
Subject: doc: Add documentation for cgrules' options
X-Git-Tag: v3.2.0~9
X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4ce8819b606fa8f2a3a35063143eee63016e5a71;p=thirdparty%2Flibcgroup.git

doc: Add documentation for cgrules' options

Add man page documentation for the options field in cgrules
configuration files.  Currently only "ignore" and "ignore_rt" are
supported.

Signed-off-by: Tom Hromatka <tom.hromatka@oracle.com>
Acked-by: Kamalesh Babulal <kamalesh.babulal@oracle.com>
---

diff --git a/doc/man/cgrules.conf.5 b/doc/man/cgrules.conf.5
index 434be500..762a5331 100644
--- a/doc/man/cgrules.conf.5
+++ b/doc/man/cgrules.conf.5
@@ -18,10 +18,10 @@ Rules have two formats:
 
 .in +4n
 .nf
-<user>               	<controllers>		<destination>
+<user>               	<controllers>	<destination>	<options>
 .fi
 .nf
-<user>:<process name>	<controllers>		<destination>
+<user>:<process name>	<controllers>	<destination>	<options>
 .fi
 .in
 
@@ -70,6 +70,18 @@ can be:
     - quotation marks '"' can be used for names and/or paths with spaces
 .fi
 
+.I options
+is optional and it can be:
+.nf
+    - "ignore" - if a process matches a rule with the "ignore" option, then
+      it will be ignored by cgrulesengd and will not be moved.  cgrulesengd
+      processing will stop for this process, and all rules below this rule
+      will not affect this process.
+    - "ignore_rt" - if a process is scheduled as SCHED_RR or SCHED_FF and
+      matches this rule, it will be ignored by cgrulesengd and will not be
+      moved.
+.fi
+
 First rule which matches the criteria will be executed.
 
 Any text starting with '#' is considered as a start of comment line and is