speakup: Document bleeps parameter values

[PATCH] speakup: Document bleeps parameter values

Posted by Henry Zhang 1 week, 3 days ago

The speakup documentation had a TODO about accepted values for the
bleeps parameter. drivers/accessibility/speakup/main.c indicates
that it's a bitmasked param where bit 0 controls beeping and bit 1
controls announcements.

Signed-off-by: Henry Zhang <zeri@umich.edu>
---
 Documentation/ABI/stable/sysfs-driver-speakup | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/Documentation/ABI/stable/sysfs-driver-speakup b/Documentation/ABI/stable/sysfs-driver-speakup
index bcb6831aa114..7ead6cb79ca5 100644
--- a/Documentation/ABI/stable/sysfs-driver-speakup
+++ b/Documentation/ABI/stable/sysfs-driver-speakup
@@ -16,8 +16,8 @@ What:		/sys/accessibility/speakup/bleeps
 KernelVersion:	2.6
 Contact:	speakup@linux-speakup.org
 Description:	This controls whether one hears beeps through the PC speaker
-		when using speakup's review commands.
-		TODO: what values does it accept?
+		when using speakup's review commands. Range: 0-3. 0 = off, 1 = beeps
+		only, 2 = announcements only, 3 = beeps and announcements (default).
 
 What:		/sys/accessibility/speakup/bleep_time
 KernelVersion:	2.6
-- 
2.34.1

Re: [PATCH] speakup: Document bleeps parameter values

Posted by Samuel Thibault 1 week, 3 days ago

Henry Zhang, le mar. 27 janv. 2026 20:45:01 -0500, a ecrit:
> The speakup documentation had a TODO about accepted values for the
> bleeps parameter. drivers/accessibility/speakup/main.c indicates
> that it's a bitmasked param where bit 0 controls beeping and bit 1
> controls announcements.
> 
> Signed-off-by: Henry Zhang <zeri@umich.edu>

Reviewed-by: Samuel Thibault <samuel.thibault@ens-lyon.org>

Thanks!

> ---
>  Documentation/ABI/stable/sysfs-driver-speakup | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/ABI/stable/sysfs-driver-speakup b/Documentation/ABI/stable/sysfs-driver-speakup
> index bcb6831aa114..7ead6cb79ca5 100644
> --- a/Documentation/ABI/stable/sysfs-driver-speakup
> +++ b/Documentation/ABI/stable/sysfs-driver-speakup
> @@ -16,8 +16,8 @@ What:		/sys/accessibility/speakup/bleeps
>  KernelVersion:	2.6
>  Contact:	speakup@linux-speakup.org
>  Description:	This controls whether one hears beeps through the PC speaker
> -		when using speakup's review commands.
> -		TODO: what values does it accept?
> +		when using speakup's review commands. Range: 0-3. 0 = off, 1 = beeps
> +		only, 2 = announcements only, 3 = beeps and announcements (default).
>  
>  What:		/sys/accessibility/speakup/bleep_time
>  KernelVersion:	2.6
> -- 
> 2.34.1
>