2022-07-02 09:32:51

by kernel test robot

[permalink] [raw]
Subject: htmldocs: Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.

tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
head: 089866061428ec9bf67221247c936792078c41a4
commit: 4c18a890dff8d95ca234d184773910383a978d45 iio:proximity:sx9324: Add SX9324 support
date: 5 months ago
reproduce: make htmldocs

If you fix the issue, kindly add following tag where applicable
Reported-by: kernel test robot <[email protected]>

All warnings (new ones prefixed by >>):

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

vim +2 Documentation/ABI/testing/sysfs-bus-iio-sx9324

> 2 Date: November 2021

--
0-DAY CI Kernel Test Service
https://01.org/lkp


2022-07-03 03:42:51

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: htmldocs: Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.

On 7/2/22 16:23, kernel test robot wrote:
> tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> head: 089866061428ec9bf67221247c936792078c41a4
> commit: 4c18a890dff8d95ca234d184773910383a978d45 iio:proximity:sx9324: Add SX9324 support
> date: 5 months ago
> reproduce: make htmldocs
>
> If you fix the issue, kindly add following tag where applicable
> Reported-by: kernel test robot <[email protected]>
>
> All warnings (new ones prefixed by >>):
>
>>> Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
>
> vim +2 Documentation/ABI/testing/sysfs-bus-iio-sx9324
>
> > 2 Date: November 2021
>

I'm not sure how to fix above, since the Date: field looks OK to me.

CC'ing Akira and Mauro.

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

2022-07-03 04:55:40

by Akira Yokosawa

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

"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 <[email protected]>
Fixes: 4c18a890dff8 ("iio:proximity:sx9324: Add SX9324 support")
Link: https://lore.kernel.org/r/[email protected]/
Reported-by: kernel test robot <[email protected]>
Cc: Gwendal Grignou <[email protected]>
Cc: Stephen Boyd <[email protected]>
Cc: Jonathan Cameron <[email protected]>
---
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 <[email protected]>
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


2022-07-03 09:58:29

by Bagas Sanjaya

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

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 <[email protected]>
> Fixes: 4c18a890dff8 ("iio:proximity:sx9324: Add SX9324 support")
> Link: https://lore.kernel.org/r/[email protected]/
> Reported-by: kernel test robot <[email protected]>
> Cc: Gwendal Grignou <[email protected]>
> Cc: Stephen Boyd <[email protected]>
> Cc: Jonathan Cameron <[email protected]>

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/[email protected]/

Reviewed-by: Bagas Sanjaya <[email protected]>

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

2022-07-03 10:29:43

by Mauro Carvalho Chehab

[permalink] [raw]
Subject: Re: htmldocs: Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.

Em Sun, 3 Jul 2022 10:29:44 +0700
Bagas Sanjaya <[email protected]> escreveu:

> On 7/2/22 16:23, kernel test robot wrote:
> > tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
> > head: 089866061428ec9bf67221247c936792078c41a4
> > commit: 4c18a890dff8d95ca234d184773910383a978d45 iio:proximity:sx9324: Add SX9324 support
> > date: 5 months ago
> > reproduce: make htmldocs
> >
> > If you fix the issue, kindly add following tag where applicable
> > Reported-by: kernel test robot <[email protected]>
> >
> > All warnings (new ones prefixed by >>):
> >
> >>> Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
> >
> > vim +2 Documentation/ABI/testing/sysfs-bus-iio-sx9324
> >
> > > 2 Date: November 2021
> >
>
> I'm not sure how to fix above, since the Date: field looks OK to me.

This one is trivial: just add a blank line. I already provided
Jonathan a feedback about that:

https://lore.kernel.org/all/[email protected]/

Regards,
Mauro

2022-07-04 01:34:13

by Bagas Sanjaya

[permalink] [raw]
Subject: Re: htmldocs: Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.

On 7/3/22 16:57, Mauro Carvalho Chehab wrote:
> Em Sun, 3 Jul 2022 10:29:44 +0700
> Bagas Sanjaya <[email protected]> escreveu:
>
>> On 7/2/22 16:23, kernel test robot wrote:
>>> tree: https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git master
>>> head: 089866061428ec9bf67221247c936792078c41a4
>>> commit: 4c18a890dff8d95ca234d184773910383a978d45 iio:proximity:sx9324: Add SX9324 support
>>> date: 5 months ago
>>> reproduce: make htmldocs
>>>
>>> If you fix the issue, kindly add following tag where applicable
>>> Reported-by: kernel test robot <[email protected]>
>>>
>>> All warnings (new ones prefixed by >>):
>>>
>>>>> Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
>>>
>>> vim +2 Documentation/ABI/testing/sysfs-bus-iio-sx9324
>>>
>>> > 2 Date: November 2021
>>>
>>
>> I'm not sure how to fix above, since the Date: field looks OK to me.
>
> This one is trivial: just add a blank line. I already provided
> Jonathan a feedback about that:
>
> https://lore.kernel.org/all/[email protected]/
>
> Regards,
> Mauro

Ah! I don't see that.

In mean time, Akira has sent the same fix at [1] and I gave the
Reviewed-by: tag

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Thanks.

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

2022-07-18 18:01:10

by Jonathan Cameron

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

On Sun, 3 Jul 2022 16:48:37 +0700
Bagas Sanjaya <[email protected]> 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 <[email protected]>
> > Fixes: 4c18a890dff8 ("iio:proximity:sx9324: Add SX9324 support")
> > Link: https://lore.kernel.org/r/[email protected]/
> > Reported-by: kernel test robot <[email protected]>
> > Cc: Gwendal Grignou <[email protected]>
> > Cc: Stephen Boyd <[email protected]>
> > Cc: Jonathan Cameron <[email protected]>
>
> 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/[email protected]/
>
> Reviewed-by: Bagas Sanjaya <[email protected]>
>

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

Thanks,

Jonathan