[PATCH 1/1] doc: coninfo man-page

[PATCH 1/1] doc: coninfo man-page

[Heinrich Schuchardt]

Provide a man-page for the coninfo command.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
 doc/usage/cmd/coninfo.rst | 55 +++++++++++++++++++++++++++++++++++++++
 doc/usage/index.rst       |  1 +
 2 files changed, 56 insertions(+)
 create mode 100644 doc/usage/cmd/coninfo.rst

diff --git a/doc/usage/cmd/coninfo.rst b/doc/usage/cmd/coninfo.rst
new file mode 100644
index 0000000000..f913148c44
--- /dev/null
+++ b/doc/usage/cmd/coninfo.rst
@@ -0,0 +1,55 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+coninfo command
+===============
+
+Synopsis
+--------
+
+::
+
+    coninfo
+
+Description
+-----------
+
+The coninfo command provides a list of available console input and output
+devices and their assignment as stdin, stdout, stderr console devices.
+
+If CONFIG_SYS_CONSOLE_IS_IN_ENV=y, the assignment is controlled by the
+environment variables stdin, stdout, stderr which contain a comma separated
+list of device names.
+
+Example
+--------
+
+.. code-block:: console
+
+    => coninfo
+    List of available devices
+    |-- pl011@9000000 (IO)
+    |   |-- stdin
+    |   |-- stdout
+    |   |-- stderr
+    |-- serial (IO)
+    |-- usbkbd (I)
+    => setenv stdin pl011@9000000,usbkbd
+    => coninfo
+    List of available devices
+    |-- pl011@9000000 (IO)
+    |   |-- stdin
+    |   |-- stdout
+    |   |-- stderr
+    |-- serial (IO)
+    |-- usbkbd (I)
+    |   |-- stdin
+
+Configuration
+-------------
+
+The coninfo command is only available if CONFIG_CMD_CONSOLE=y.
+
+Return value
+------------
+
+The return value $? is always 0 (true).
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index ebf5eea9f8..3de137590e 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -38,6 +38,7 @@ Shell commands
    cmd/cbsysinfo
    cmd/cls
    cmd/cmp
+   cmd/coninfo
    cmd/conitrace
    cmd/cyclic
    cmd/dm
-- 
2.39.2

Re: [PATCH 1/1] doc: coninfo man-page

[Simon Glass]

On Sat, 1 Apr 2023 at 23:35, Heinrich Schuchardt <
heinrich.schuchardt@canonical.com> wrote:
>
> Provide a man-page for the coninfo command.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
>  doc/usage/cmd/coninfo.rst | 55 +++++++++++++++++++++++++++++++++++++++
>  doc/usage/index.rst       |  1 +
>  2 files changed, 56 insertions(+)
>  create mode 100644 doc/usage/cmd/coninfo.rst
>

Reviewed-by: Simon Glass <sjg@chromium.org>