diff mbox series

[v3,2/4] doc: cmd: temperature: add documentation

Message ID 20220906113036.1768055-2-robert.marko@sartura.hr
State Accepted
Delegated to: Tom Rini
Headers show
Series [v3,1/4] cmd: add temperature command | expand

Commit Message

Robert Marko Sept. 6, 2022, 11:30 a.m. UTC 
Add documentation for the temperature command.

Signed-off-by: Robert Marko <robert.marko@sartura.hr>
Reviewed-by: Simon Glass <sjg@chromium.org>
---
 doc/usage/cmd/temperature.rst | 50 +++++++++++++++++++++++++++++++++++
 doc/usage/index.rst           |  1 +
 2 files changed, 51 insertions(+)
 create mode 100644 doc/usage/cmd/temperature.rst

Comments

Tom Rini Oct. 11, 2022, 9:37 p.m. UTC | #1 
On Tue, Sep 06, 2022 at 01:30:34PM +0200, Robert Marko wrote:

> Add documentation for the temperature command.
> 
> Signed-off-by: Robert Marko <robert.marko@sartura.hr>
> Reviewed-by: Simon Glass <sjg@chromium.org>

Applied to u-boot/master, thanks!
diff mbox series

Patch

diff --git a/doc/usage/cmd/temperature.rst b/doc/usage/cmd/temperature.rst
new file mode 100644
index 0000000000..a5144ec50f
--- /dev/null
+++ b/doc/usage/cmd/temperature.rst
@@ -0,0 +1,50 @@ 
+.. SPDX-License-Identifier: GPL-2.0-or-later
+
+temperature command
+===================
+
+Synopsis
+--------
+
+::
+
+    temperature list
+    temperature get [thermal device name]
+
+Description
+-----------
+
+The *temperature* command is used to list thermal sensors and get their
+readings.
+
+The 'temperature list' command diplays the available thermal devices.
+
+The 'temperature get' command is used to get the reading in degrees C from
+the desired device which is selected by passing its device name.
+
+    thermal device name
+        device name of thermal sensor to select
+
+Example
+-------
+
+::
+
+
+    => temperature list
+    | Device                        | Driver                        | Parent
+    | tmon@610508110                | sparx5-temp                   | axi@600000000
+    =>
+    => temperature get tmon@610508110
+    tmon@610508110: 42 C
+
+Configuration
+-------------
+
+The *temperature* command is only available if CONFIG_CMD_TEMPERATURE=y.
+
+Return value
+------------
+
+The return value $? is set to 0 (true) if the command succeeded and to 1 (false)
+otherwise.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 28f9683a3e..92967efdd2 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -63,6 +63,7 @@  Shell commands
    cmd/scp03
    cmd/setexpr
    cmd/size
+   cmd/temperature
    cmd/true
    cmd/ums
    cmd/wdt