diff mbox series

[4/4] iio: ABI: sx9324: Squash some formatting to keep scripting happy.

Message ID 20220626165511.602202-5-jic23@kernel.org (mailing list archive)
State Rejected
Headers show
Series IIO: Some documentation error and warning fixes. | expand

Commit Message

Jonathan Cameron June 26, 2022, 4:55 p.m. UTC
From: Jonathan Cameron <Jonathan.Cameron@huawei.com>

The indenting added in here to give bullet points is nice to read
but unfortunately our docs building scripts trip up on it.

make htmldocs gives
../iio/Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: ERROR: Unexpected indentation.

So drop the pretty indenting to avoid that error message.

Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
Cc: Gwendal Grignou <gwendal@chromium.org>
---
 Documentation/ABI/testing/sysfs-bus-iio-sx9324 | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Mauro Carvalho Chehab June 26, 2022, 10:44 p.m. UTC | #1
Em Sun, 26 Jun 2022 17:55:11 +0100
Jonathan Cameron <jic23@kernel.org> escreveu:

> From: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> 
> The indenting added in here to give bullet points is nice to read
> but unfortunately our docs building scripts trip up on it.
> 
> make htmldocs gives
> ../iio/Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: ERROR: Unexpected indentation.
> 
> So drop the pretty indenting to avoid that error message.
> 
> Signed-off-by: Jonathan Cameron <Jonathan.Cameron@huawei.com>
> Cc: Gwendal Grignou <gwendal@chromium.org>
> ---
>  Documentation/ABI/testing/sysfs-bus-iio-sx9324 | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/Documentation/ABI/testing/sysfs-bus-iio-sx9324 b/Documentation/ABI/testing/sysfs-bus-iio-sx9324
> index 632e3321f5a3..9c1e8884a738 100644
> --- a/Documentation/ABI/testing/sysfs-bus-iio-sx9324
> +++ b/Documentation/ABI/testing/sysfs-bus-iio-sx9324
> @@ -8,7 +8,7 @@ Description:
>  		+ not connected (HZ),
>  		+ grounded (GD),
>  		+ connected to an antenna where it can act as a base
> -		  (DS - data shield), or measured input (MI).
> +		(DS - data shield), or measured input (MI).


Actually, the fix would be to simply add a blank line before the list,
e. g.:

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-sx9324 b/Documentation/ABI/testing/sysfs-bus-iio-sx9324
index 632e3321f5a3..a8342770e7cb 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-sx9324
+++ b/Documentation/ABI/testing/sysfs-bus-iio-sx9324
@@ -5,6 +5,7 @@ Contact:	Gwendal Grignou <gwendal@chromium.org>
 Description:
 		SX9324 has 3 inputs, CS0, CS1 and CS2. Hardware layout
 		defines if the input is
+
 		+ not connected (HZ),
 		+ grounded (GD),
 		+ connected to an antenna where it can act as a base


Regards,
Mauro
diff mbox series

Patch

diff --git a/Documentation/ABI/testing/sysfs-bus-iio-sx9324 b/Documentation/ABI/testing/sysfs-bus-iio-sx9324
index 632e3321f5a3..9c1e8884a738 100644
--- a/Documentation/ABI/testing/sysfs-bus-iio-sx9324
+++ b/Documentation/ABI/testing/sysfs-bus-iio-sx9324
@@ -8,7 +8,7 @@  Description:
 		+ not connected (HZ),
 		+ grounded (GD),
 		+ connected to an antenna where it can act as a base
-		  (DS - data shield), or measured input (MI).
+		(DS - data shield), or measured input (MI).
 
 		The sensor rotates measurement across 4 phases
 		(PH0, PH1, PH2, PH3), where the inputs are configured