[PATCH v3 7/8] docs: add DisableTurboboostMixin documentation

[Jan Tluka]

Signed-off-by: Jan Tluka <jtluka(a)redhat.com&gt;
---
 .../disable_turboboost_mixin.rst                |  6 ++++++
 docs/source/config_mixins.rst                   |  1 +
 .../ENRT/ConfigMixins/DisableTurboboostMixin.py | 17 +++++++++++++++++
 3 files changed, 24 insertions(+)
 create mode 100644 docs/source/config_mixin_classes/disable_turboboost_mixin.rst

diff --git a/docs/source/config_mixin_classes/disable_turboboost_mixin.rst
b/docs/source/config_mixin_classes/disable_turboboost_mixin.rst
new file mode 100644
index 00000000..4ddfc99f
--- /dev/null
+++ b/docs/source/config_mixin_classes/disable_turboboost_mixin.rst
@@ -0,0 +1,6 @@
+DisableTurboboostMixin
+======================
+
+.. autoclass::
lnst.Recipes.ENRT.ConfigMixins.DisableTurboboostMixin.DisableTurboboostMixin
+    :members:
+    :show-inheritance:
diff --git a/docs/source/config_mixins.rst b/docs/source/config_mixins.rst
index b766a0cf..53451190 100644
--- a/docs/source/config_mixins.rst
+++ b/docs/source/config_mixins.rst
@@ -13,3 +13,4 @@ ENRT Config Mixins
     config_mixin_classes/parallel_stream_qdisc_mixin
     config_mixin_classes/pause_frames_mixin
     config_mixin_classes/perf_reverse_mixin.rst
+    config_mixin_classes/disable_turboboost_mixin.rst
diff --git a/lnst/Recipes/ENRT/ConfigMixins/DisableTurboboostMixin.py
b/lnst/Recipes/ENRT/ConfigMixins/DisableTurboboostMixin.py
index dc3c0d62..ed8cf2cc 100644
--- a/lnst/Recipes/ENRT/ConfigMixins/DisableTurboboostMixin.py
+++ b/lnst/Recipes/ENRT/ConfigMixins/DisableTurboboostMixin.py
@@ -3,6 +3,23 @@ from lnst.Controller.RecipeResults import ResultLevel
 from lnst.Recipes.ENRT.ConfigMixins import BaseSubConfigMixin
 
 class DisableTurboboostMixin(BaseSubConfigMixin):
+    """
+    This mixin class is an extension to the :any:`BaseEnrtRecipe` class that can
+    be used to disable CPU turboboost on hosts before running the tests.
+
+    Any recipe that wants to use the mixin must define the
+    :attr:`disable_turboboost_host_list` property first.
+
+    Note: The mixin uses intel_pstate sysfs interface to disable the CPU feature
+    and so it is usable only by systems with Intel CPUs.
+
+    :param disable_turboost:
+        (optional test parameter) boolean to control the CPU turboboost. When
+        the parameter is set to **True** the CPU turboboost is disabled on all
+        hosts defined by :attr:`disable_turboboost_host_list` property. Otherwise
+        this mixin has no effect.
+    """
+
     disable_turboboost = BoolParam(default=False)
 
     @property
-- 
2.21.3