linux-kernel - [PATCH] Documentation: ad4130: format list of in_voltage-voltage_filter_mode

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite for Android: free password hash cracker in your pocket

[<prev] [next>] [thread-next>] [day] [month] [year] [list]

Message-Id: <20221106140233.74112-1-bagasdotme@gmail.com>
Date:   Sun,  6 Nov 2022 21:02:33 +0700
From:   Bagas Sanjaya <bagasdotme@...il.com>
To:     linux-iio@...r.kernel.org, linux-kernel@...r.kernel.org,
        linux-doc@...r.kernel.org
Cc:     Jonathan Cameron <jic23@...nel.org>,
        Lars-Peter Clausen <lars@...afoo.de>,
        Cosmin Tanislav <cosmin.tanislav@...log.com>,
        Andy Shevchenko <andy.shevchenko@...il.com>,
        Bagas Sanjaya <bagasdotme@...il.com>
Subject: [PATCH] Documentation: ad4130: format list of in_voltage-voltage_filter_mode_available modes

Sphinx reports two warnings on sysfs documentation for AD4130 driver:

Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130:2: WARNING: Unexpected indentation.
Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130:2: WARNING: Block quote ends without a blank line; unexpected unindent.

These are due to misformatting of sinc* modes list. Format it with bullet
list. Since each entry spans multiple lines, separate each with a blank
line.

Fixes: 5bdef39c5c6e1a ("iio: adc: ad4130: add AD4130 driver")
Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>
---
 .../ABI/testing/sysfs-bus-iio-adc-ad4130      | 48 +++++++++++--------
 1 file changed, 29 insertions(+), 19 deletions(-)

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130 b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
index d9555751d21ce2..f24ed6687e900e 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
+++ b/Documentation/ABI/testing/sysfs-bus-iio-adc-ad4130
@@ -3,25 +3,35 @@ KernelVersion:  6.2
 Contact:	linux-iio@...r.kernel.org
 Description:
 		Reading returns a list with the possible filter modes.
-		"sinc4"       - Sinc 4. Excellent noise performance. Long 1st
-				conversion time. No natural 50/60Hz rejection.
-		"sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion time.
-		"sinc3"	      - Sinc3. Moderate 1st conversion time. Good noise
-				performance.
-		"sinc3+rej60" - Sinc3 + 60Hz rejection. At a sampling frequency
-				of 50Hz, achieves simultaneous 50Hz and 60Hz
-				rejection.
-		"sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion time.
-				Best used with a sampling frequency of at least
-				216.19Hz.
-		"sinc3+pf1"   - Sinc3 + Post Filter 1.
-				53dB rejection @ 50Hz, 58dB rejection @ 60Hz.
-		"sinc3+pf2"   - Sinc3 + Post Filter 2.
-				70dB rejection @ 50Hz, 70dB rejection @ 60Hz.
-		"sinc3+pf3"   - Sinc3 + Post Filter 3.
-				99dB rejection @ 50Hz, 103dB rejection @ 60Hz.
-		"sinc3+pf4"   - Sinc3 + Post Filter 4.
-				103dB rejection @ 50Hz, 109dB rejection @ 60Hz.
+
+		  * "sinc4"       - Sinc 4. Excellent noise performance. Long
+                    1st conversion time. No natural 50/60Hz rejection.
+
+		  * "sinc4+sinc1" - Sinc4 + averaging by 8. Low 1st conversion
+		    time.
+
+		  * "sinc3"	      - Sinc3. Moderate 1st conversion time.
+		    Good noise performance.
+
+		  * "sinc3+rej60" - Sinc3 + 60Hz rejection. At a sampling
+		    frequency of 50Hz, achieves simultaneous 50Hz and 60Hz
+		    rejection.
+
+		  * "sinc3+sinc1" - Sinc3 + averaging by 8. Low 1st conversion
+		    time. Best used with a sampling frequency of at least
+		    216.19Hz.
+
+		  * "sinc3+pf1"   - Sinc3 + Post Filter 1. 53dB rejection @
+		    50Hz, 58dB rejection @ 60Hz.
+
+		  * "sinc3+pf2"   - Sinc3 + Post Filter 2. 70dB rejection @
+		    50Hz, 70dB rejection @ 60Hz.
+
+		  * "sinc3+pf3"   - Sinc3 + Post Filter 3. 99dB rejection @
+		    50Hz, 103dB rejection @ 60Hz.
+
+		  * "sinc3+pf4"   - Sinc3 + Post Filter 4. 103dB rejection @
+		    50Hz, 109dB rejection @ 60Hz.
 
 What:		/sys/bus/iio/devices/iio:deviceX/in_voltageY-voltageZ_filter_mode
 KernelVersion:  6.2

base-commit: b8bee0f98634cc1ce8cc8bf0e1db025734ee0c2b
-- 
An old man doll... just what I always wanted! - Clara