Add pydoc documentation for the Cgroup.get() method and reference
the automated test that exercise various cgget commands.
The pydoc for Cgroup.get() is available by running:
$ python -c "from cgroup import Cgroup;help(Cgroup.get)"
Signed-off-by: Tom Hromatka <tom.hroma...@oracle.com>
---
ftests/cgroup.py | 36 ++++++++++++++++++++----------------
1 file changed, 20 insertions(+), 16 deletions(-)
diff --git a/ftests/cgroup.py b/ftests/cgroup.py
index ba01bd22662f..3c69befeedfb 100644
--- a/ftests/cgroup.py
+++ b/ftests/cgroup.py
@@ -167,25 +167,29 @@ class Cgroup(object):
Run.run(cmd)
@staticmethod
- # valid cpuset commands:
- # Read one setting:
- # cgget -r cpuset.cpus tomcpuset
- # Read two settings:
- # cgget -r cpuset.cpus -r cpuset.cpu_exclusive tomcpuset
- # Read one setting from two cgroups:
- # cgget -r cpuset.cpu_exclusive tomcgroup1 tomcgroup2
- # Read two settings from two cgroups:
- # cgget -r cpuset.cpu_exclusive -r cpuset.cpu_exclusive tomcgroup1
tomcgroup2
- #
- # Read all of the settings in a cgroup
- # cgget -g cpuset tomcpuset
- # Read all of the settings in multiple controllers
- # cgget -g cpuset -g cpu -g memory tomcgroup
- # Read all of the settings from a cgroup at a specific path
- # cgget -g memory:tomcgroup/tomcgroup
def get(config, controller=None, cgname=None, setting=None,
print_headers=True, values_only=False,
all_controllers=False, cghelp=False):
+ """cgget equivalent method
+
+ Returns:
+ str: The stdout result of cgget
+
+ The following variants of cgget() are being tested by the
+ automated functional tests:
+
+ Command Test Number
+ cgget -r cpuset.cpus mycg 001
+ cgget -r cpuset.cpus -r cpuset.mems mycg 008
+ cgget -g cpu mycg 009
+ cgget -g cpu:mycg 010
+ cgget -r cpuset.cpus mycg1 mycg2 011
+ cgget -r cpuset.cpus -r cpuset.mems mycg1 mycg2 012
+ cgget -g cpu -g freezer mycg 013
+ cgget -a mycg 014
+ cgget -r memory.stat mycg (multiline value read) 015
+ various invalid flag combinations 016
+ """
cmd = list()
cmd.append(Cgroup.build_cmd_path('cgget'))
--
2.26.2
_______________________________________________
Libcg-devel mailing list
Libcg-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/libcg-devel
