cgroup.py: Add pydoc documentation to Cgroup.configparser()

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

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

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

diff --git a/ftests/cgroup.py b/ftests/cgroup.py
index ae96f20250a6c75e6ce47c218fccef6004fa2044..c7213077c44433ffca4a37b1f7659dee2d0f210f 100644 (file)
--- a/ftests/cgroup.py
+++ b/ftests/cgroup.py
@@ -496,6 +496,22 @@ class Cgroup(object):
     def configparser(config, load_file=None, load_dir=None, dflt_usr=None,
                      dflt_grp=None, dperm=None, fperm=None, cghelp=False,
                      tperm=None, tasks_usr=None, tasks_grp=None):
+        """cgconfigparser equivalent method
+
+        Returns:
+        str: The stdout result of cgconfigparser
+
+        The following variants of cgconfigparser are being tested by the
+        automated functional tests:
+
+        Command                                          Test Number
+        cgconfigparser -l conf_file                              017
+        cgconfigparser -L conf_dir                               018
+        cgconfigparser -l conf_file -a usr:grp -d mode -f mode   019
+        cgconfigparser -l conf_file -s mode -t usr:grp           020
+        cgconfigparser -h                                        021
+        cgconfigparser -l improper_conf_file                     021
+        """
         cmd = list()
 
         if not config.args.container: