Re: [PATCH 3/4] Documentation: ABI: Document SteelSeries headset sysfs attributes

[Bagas Sanjaya]

On Sun, Dec 28, 2025 at 07:20:24AM -0500, Sriman Achanta wrote:
> +What:		/sys/class/hid/drivers/steelseries/<dev>/chatmix_level
> +Date:		January 2025
> +KernelVersion:	6.19
> +Contact:	Sriman Achanta <srimanachanta@xxxxxxxxx>
> +Description:
> +		Reports the current balance between Game and Chat audio channels
> +		(ChatMix). This value changes when the physical ChatMix dial
> +		on the headset is adjusted.
> +
> +		Range: 0-128
> +		       0   = 100% Chat / 0% Game
> +		       64  = 50% Chat / 50% Game (Balanced)
> +		       128 = 0% Chat / 100% Game
> +		Access: Read

Sphinx reports htmldocs warnings:

Documentation/ABI/testing/sysfs-driver-hid-steelseries:47: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
Documentation/ABI/testing/sysfs-driver-hid-steelseries:35: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
Documentation/ABI/testing/sysfs-driver-hid-steelseries:62: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]

I have to fix up the bullet lists:

---- >8 ----
diff --git a/Documentation/ABI/testing/sysfs-driver-hid-steelseries b/Documentation/ABI/testing/sysfs-driver-hid-steelseries
index 3066dbb486d363..5f6c703d40892a 100644
--- a/Documentation/ABI/testing/sysfs-driver-hid-steelseries
+++ b/Documentation/ABI/testing/sysfs-driver-hid-steelseries
@@ -30,6 +30,7 @@ Description:
 		the headset speakers.
 
 		Range: 0-128 (mapped internally to device-specific values).
+
 		Access: Write
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/inactive_time
@@ -42,6 +43,7 @@ Description:
 
 		Range: 0-90 (minutes).
 		       Some devices (e.g., Arctis 1/7X) map this to specific presets.
+
 		Access: Write
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/chatmix_level
@@ -53,10 +55,12 @@ Description:
 		(ChatMix). This value changes when the physical ChatMix dial
 		on the headset is adjusted.
 
-		Range: 0-128
-		       0   = 100% Chat / 0% Game
-		       64  = 50% Chat / 50% Game (Balanced)
-		       128 = 0% Chat / 100% Game
+		Range: 0-128, where:
+
+		- 0   = 100% Chat / 0% Game
+		- 64  = 50% Chat / 50% Game (Balanced)
+		- 128 = 0% Chat / 100% Game
+
 		Access: Read
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/mic_mute_led_brightness
@@ -67,8 +71,11 @@ Description:
 		Controls the brightness of the LED on the microphone boom that
 		indicates when the microphone is muted.
 
-		Range: 0-3 (off, low, medium, high) for most devices.
-		       0-10 for newer Nova series devices.
+		Range:
+
+		- 0-3 (off, low, medium, high) for most devices.
+		- 0-10 for newer Nova series devices.
+
 		Access: Write
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/mic_volume
@@ -80,6 +87,7 @@ Description:
 		This is distinct from the OS input volume.
 
 		Range: 0-128 (mapped internally to device-specific values).
+
 		Access: Write
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/volume_limiter
@@ -91,8 +99,10 @@ Description:
 		When enabled, the maximum output volume is capped.
 
 		Values:
-		0 = Disabled
-		1 = Enabled
+
+		- 0 = Disabled
+		- 1 = Enabled
+
 		Access: Write
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/bluetooth_on_power
@@ -104,8 +114,10 @@ Description:
 		when the headset is powered on.
 
 		Values:
-		0 = Bluetooth must be turned on manually
-		1 = Bluetooth turns on automatically with headset
+
+		- 0 = Bluetooth must be turned on manually
+		- 1 = Bluetooth turns on automatically with headset
+
 		Access: Write
 
 What:		/sys/class/hid/drivers/steelseries/<dev>/bluetooth_call_vol
@@ -117,7 +129,9 @@ Description:
 		a Bluetooth call is active.
 
 		Values:
-		0 = No attenuation (mix both equally)
-		1 = Attenuate Game audio by -12dB
-		2 = Mute Game audio completely
+
+		- 0 = No attenuation (mix both equally)
+		- 1 = Attenuate Game audio by -12dB
+		- 2 = Mute Game audio completely
+
 		Access: Write

Thanks.

-- 
An old man doll... just what I always wanted! - Clara

Attachment: signature.asc
Description: PGP signature