[PATCH] iio: proximity: sx9324: add empty line in front of bullet list

[PATCH] iio: proximity: sx9324: add empty line in front of bullet list

[Akira Yokosawa]

"make htmldocs" emits a warning of:

    Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.

This is due to a missing empty line in front of the bullet list.
Fix it.

Note: The line count of 2 in the warning is not exact in this case.

Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
Fixes: 4c18a890dff8 ("iio:proximity:sx9324: Add SX9324 support")
Link: https://lore.kernel.org/r/202207021703.lEW6FLT1-lkp@intel.com/
Reported-by: kernel test robot <lkp@intel.com>
Cc: Gwendal Grignou <gwendal@chromium.org>
Cc: Stephen Boyd <swboyd@chromium.org>
Cc: Jonathan Cameron <Jonathan.Cameron@huawei.com>
---
 Documentation/ABI/testing/sysfs-bus-iio-sx9324 | 1 +
 1 file changed, 1 insertion(+)

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
-- 
2.25.1

Re: [PATCH] iio: proximity: sx9324: add empty line in front of bullet list

[Bagas Sanjaya]

On Sun, Jul 03, 2022 at 01:27:47PM +0900, Akira Yokosawa wrote:
> "make htmldocs" emits a warning of:
> 
>     Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
> 
> This is due to a missing empty line in front of the bullet list.
> Fix it.
> 
> Note: The line count of 2 in the warning is not exact in this case.
> 
> Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> Fixes: 4c18a890dff8 ("iio:proximity:sx9324: Add SX9324 support")
> Link: https://lore.kernel.org/r/202207021703.lEW6FLT1-lkp@intel.com/
> Reported-by: kernel test robot <lkp@intel.com>
> Cc: Gwendal Grignou <gwendal@chromium.org>
> Cc: Stephen Boyd <swboyd@chromium.org>
> Cc: Jonathan Cameron <Jonathan.Cameron@huawei.com>

Applying this on top of Mauro's fixes [1], no warnings. Thanks.

So I think Sphinx was pointing the culprit at the wrong location, since
the problem isn't lie on the field, but rather on the list.

Mauro, can you please pick this up?

[1]: https://lore.kernel.org/linux-doc/cover.1656759988.git.mchehab@kernel.org/

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

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

Re: [PATCH] iio: proximity: sx9324: add empty line in front of bullet list

[Jonathan Cameron]

On Sun, 3 Jul 2022 16:48:37 +0700
Bagas Sanjaya <bagasdotme@gmail.com> wrote:

> On Sun, Jul 03, 2022 at 01:27:47PM +0900, Akira Yokosawa wrote:
> > "make htmldocs" emits a warning of:
> > 
> >     Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
> > 
> > This is due to a missing empty line in front of the bullet list.
> > Fix it.
> > 
> > Note: The line count of 2 in the warning is not exact in this case.
> > 
> > Signed-off-by: Akira Yokosawa <akiyks@gmail.com>
> > Fixes: 4c18a890dff8 ("iio:proximity:sx9324: Add SX9324 support")
> > Link: https://lore.kernel.org/r/202207021703.lEW6FLT1-lkp@intel.com/
> > Reported-by: kernel test robot <lkp@intel.com>
> > Cc: Gwendal Grignou <gwendal@chromium.org>
> > Cc: Stephen Boyd <swboyd@chromium.org>
> > Cc: Jonathan Cameron <Jonathan.Cameron@huawei.com>  
> 
> Applying this on top of Mauro's fixes [1], no warnings. Thanks.
> 
> So I think Sphinx was pointing the culprit at the wrong location, since
> the problem isn't lie on the field, but rather on the list.
> 
> Mauro, can you please pick this up?
> 
> [1]: https://lore.kernel.org/linux-doc/cover.1656759988.git.mchehab@kernel.org/
> 
> Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 

I've picked it up via the iio tree.  If Mauro has it as well, git will
sort it out for us.

Thanks,

Jonathan