* [PATCH 1/1] doc: man-page for the sound command
@ 2022-12-04 15:22 Heinrich Schuchardt
2022-12-04 21:16 ` Simon Glass
0 siblings, 1 reply; 2+ messages in thread
From: Heinrich Schuchardt @ 2022-12-04 15:22 UTC (permalink / raw)
To: u-boot; +Cc: Simon Glass, Rajeshwari Shinde, Minkyu Kang, Heinrich Schuchardt
Provide a man-page for the sound command.
Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
---
doc/usage/cmd/sound.rst | 41 +++++++++++++++++++++++++++++++++++++++++
doc/usage/index.rst | 1 +
2 files changed, 42 insertions(+)
create mode 100644 doc/usage/cmd/sound.rst
diff --git a/doc/usage/cmd/sound.rst b/doc/usage/cmd/sound.rst
new file mode 100644
index 0000000000..bfde3ff6ee
--- /dev/null
+++ b/doc/usage/cmd/sound.rst
@@ -0,0 +1,41 @@
+.. SPDX-License-Identifier: GPL-2.0+
+.. Copyright 2022, Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
+
+sound command
+=============
+
+Synopsis
+--------
+
+::
+
+ sound init
+ sound play [len] [freq]
+
+Description
+-----------
+
+The *sound* command is used to play a beep sound.
+
+sound init
+ initializes the sound driver.
+
+sound play
+ plays a square wave sound. It does not depend on previously calling
+ *sound init*.
+
+len
+ duration of the sound in ms
+
+freq
+ frequency of the sound in Hz
+
+Configuration
+-------------
+
+The sound command is enabled by CONFIG_CMD_SOUND=y.
+
+Return value
+------------
+
+The return value $? is 0 (true) if the command succeeds, 1 (false) otherwise.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 0bc82887e9..bbd40a6e18 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -73,6 +73,7 @@ Shell commands
cmd/scp03
cmd/setexpr
cmd/size
+ cmd/sound
cmd/temperature
cmd/tftpput
cmd/true
--
2.37.2
^ permalink raw reply related [flat|nested] 2+ messages in thread
* Re: [PATCH 1/1] doc: man-page for the sound command
2022-12-04 15:22 [PATCH 1/1] doc: man-page for the sound command Heinrich Schuchardt
@ 2022-12-04 21:16 ` Simon Glass
0 siblings, 0 replies; 2+ messages in thread
From: Simon Glass @ 2022-12-04 21:16 UTC (permalink / raw)
To: Heinrich Schuchardt; +Cc: u-boot, Rajeshwari Shinde, Minkyu Kang
On Mon, 5 Dec 2022 at 04:23, Heinrich Schuchardt
<heinrich.schuchardt@canonical.com> wrote:
>
> Provide a man-page for the sound command.
>
> Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
> ---
> doc/usage/cmd/sound.rst | 41 +++++++++++++++++++++++++++++++++++++++++
> doc/usage/index.rst | 1 +
> 2 files changed, 42 insertions(+)
> create mode 100644 doc/usage/cmd/sound.rst
Reviewed-by: Simon Glass <sjg@chromium.org>
^ permalink raw reply [flat|nested] 2+ messages in thread
end of thread, other threads:[~2022-12-04 21:18 UTC | newest]
Thread overview: 2+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2022-12-04 15:22 [PATCH 1/1] doc: man-page for the sound command Heinrich Schuchardt
2022-12-04 21:16 ` Simon Glass
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.