From: Tom Hromatka <tom.hromatka@oracle.com>
Date: Wed, 10 Mar 2021 18:54:29 +0000 (+0000)
Subject: ftests: Add pydoc documentation to Cgroup.set()
X-Git-Tag: v2.0.3~11^2^2~22^2
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=f5cd7eb43a679c532b123e65aab231d07beb44de;p=thirdparty%2Flibcgroup.git

ftests: Add pydoc documentation to Cgroup.set()

Add pydoc documentation for the Cgroup.set() method and reference
the automated tests that exercise various cgset commands.

The pydoc for Cgroup.set() is available by running:
	$ python -c "from cgroup import Cgroup;help(Cgroup.set)"

Signed-off-by: Tom Hromatka <tom.hromatka@oracle.com>
---

diff --git a/ftests/cgroup.py b/ftests/cgroup.py
index 6458c005..f5ec2471 100644
--- a/ftests/cgroup.py
+++ b/ftests/cgroup.py
@@ -143,6 +143,21 @@ class Cgroup(object):
     @staticmethod
     def set(config, cgname=None, setting=None, value=None, copy_from=None,
             cghelp=False):
+        """cgset equivalent method
+
+        The following variants of cgset are being tested by the
+        automated functional tests:
+
+        Command                                          Test Number
+        cgset -r setting=value cgname                        various
+        cgset -r setting1=val1 -r setting2=val2
+              -r setting3=val2 cgname                            022
+        cgset --copy_from foo bar                                023
+        cgset --copy_from foo bar1 bar2                          024
+        cgset -r setting=value foo bar                           025
+        cgset -r setting1=value1 setting2=value2 foo bar         026
+        various invalid flag combinations                        027
+        """
         cmd = list()
 
         if not config.args.container: