Re: [PATCH RFC 02/12] Documentation: thermal docbook: add glossary
From: Javi Merino
Date: Wed Feb 18 2015 - 06:52:41 EST
On Mon, Feb 09, 2015 at 09:34:03PM +0000, Eduardo Valentin wrote:
> This change introduces a section in the Introduction Chapter to
> list concepts used by the Thermal Framework.
> Signed-off-by: Eduardo Valentin <edubezval@xxxxxxxxx>
> Documentation/DocBook/thermal.tmpl | 129 ++++++++++++++++++++++++++++++++++++-
> 1 file changed, 128 insertions(+), 1 deletion(-)
> diff --git a/Documentation/DocBook/thermal.tmpl b/Documentation/DocBook/thermal.tmpl
> index f8fb8a2..66efed3 100644
> --- a/Documentation/DocBook/thermal.tmpl
> +++ b/Documentation/DocBook/thermal.tmpl
> @@ -84,5 +84,132 @@
> - </chapter>
> + <sect1 id="glossary">
> + <title>Glossary</title>
> + <para>The Linux Kernel Thermal Framework uses a
> + specific terminology to represent the entities involved
> + in thermal constrained environments. This section
> + summaries the terminology as dictionary. These terms are
> + in use within the present document and in the source
> + code of the Linux Kernel Thermal Framework.
> + </para>
> + <glossary>
> + <glossentry>
> + <glossterm>Thermal Zone</glossterm>
> + <glossdef>
> + <para>Thermal zones represent
> + what is the current status of a
> + thermal constrained zone in the
> + hardware. The zone usually is a
> + device or component. The status
> + of a thermal zone is mainly with
> + respect to temperature.
> + Currently, the Linux Kernel
> + Thermal Framework represents
> + temperature in miliCelsius. The
> + current abstraction covers for
> + non negative temperatures and
> + constraints.
> + </para>
Shall we point out that a thermal zone doesn't necessarily imply a
thermal sensor? I find it very common to assume that if you have 10
sensors, you should have 10 thermal zones. From my point of view, a
thermal zone is an area that has similar thermal characteristics.
Therefore, the temperature of the thermal zone doesn't necessarily
have to come from on sensor, and can be defined as a combination of
the input from multiple thermal sensors.
I don't know how to put this in proper words for the documentation,
but I think it's worth hinting it here.
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/