unexpected indentation warning in Documentation/ABI/testing/sysfs-*

unexpected indentation warning in Documentation/ABI/testing/sysfs-*

[Bagas Sanjaya]

Hi,

Doing "make htmldocs" for Linux v5.18-rc1, I get new warnings:

<path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
<path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
<path/to/linux>/Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-fs-erofs:10: WARNING: Unexpected indentation.
<path/to/linux>/Documentation/ABI/testing/sysfs-fs-erofs:10: WARNING: Block quote ends without a blank line; unexpected unindent.

Introduced by 2546c60004309e (platform/x86: Add Intel Software Defined
Silicon driver, 2022-02-11), 2bec6d9aa89cbe (docs: ABI: sysfs-bus-nvdimm:
Document sysfs event format entries for nvdimm pmu, 2022-02-25),
e8a60aa7404bfe (platform/x86: Introduce support for Systems Management
Driver over WMI for Dell Systems), 40452ffca3c1a0 (erofs: add sysfs
node to control sync decompression strategy, 2021-12-06), and
4c18a890dff8d9 (iio:proximity:sx9324: Add SX9324 support, 2022-01-01).

Presumably because Sphinx mistakes these documentation files without
extensions for .rst files? I dunno.

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

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

Re: unexpected indentation warning in Documentation/ABI/testing/sysfs-*

[Greg Kroah-Hartman]

On Mon, Apr 04, 2022 at 06:58:16PM +0700, Bagas Sanjaya wrote:
> Hi,
> 
> Doing "make htmldocs" for Linux v5.18-rc1, I get new warnings:
> 
> <path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
> <path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
> <path/to/linux>/Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-fs-erofs:10: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-fs-erofs:10: WARNING: Block quote ends without a blank line; unexpected unindent.
> 
> Introduced by 2546c60004309e (platform/x86: Add Intel Software Defined
> Silicon driver, 2022-02-11), 2bec6d9aa89cbe (docs: ABI: sysfs-bus-nvdimm:
> Document sysfs event format entries for nvdimm pmu, 2022-02-25),
> e8a60aa7404bfe (platform/x86: Introduce support for Systems Management
> Driver over WMI for Dell Systems), 40452ffca3c1a0 (erofs: add sysfs
> node to control sync decompression strategy, 2021-12-06), and
> 4c18a890dff8d9 (iio:proximity:sx9324: Add SX9324 support, 2022-01-01).
> 
> Presumably because Sphinx mistakes these documentation files without
> extensions for .rst files? I dunno.
> 
> Reported-by: Bagas Sanjaya <bagasdotme@gmail.com>

Care to send patches to fix these up?

thanks,

greg k-h

Re: unexpected indentation warning in Documentation/ABI/testing/sysfs-*

[Bagas Sanjaya]

On 04/04/22 19.02, Greg Kroah-Hartman wrote:
>> Presumably because Sphinx mistakes these documentation files without
>> extensions for .rst files? I dunno.
>>
>> Reported-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 
> Care to send patches to fix these up?
> 
> thanks,
> 
> greg k-h

Hi Greg,

I'm sorry I couldn't do any fixes for now. I'm just reporting.

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

Re: unexpected indentation warning in Documentation/ABI/testing/sysfs-*

[Hans de Goede]

Hi,

On 4/4/22 13:58, Bagas Sanjaya wrote:
> Hi,
> 
> Doing "make htmldocs" for Linux v5.18-rc1, I get new warnings:
> 
> <path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Block quote ends without a blank line; unexpected unindent.
> <path/to/linux>/Documentation/ABI/testing/sysfs-driver-intel_sdsi:2: WARNING: Definition list ends without a blank line; unexpected unindent.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.

These 6 are all fixed in this series:

> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-class-firmware-attributes:130: WARNING: Unexpected indentation.

https://lore.kernel.org/platform-driver-x86/20220324164737.21765-1-hdegoede@redhat.com/T/#t

Which will be included in my next fixes pull-req to Linus.

> <path/to/linux>/Documentation/ABI/testing/sysfs-fs-erofs:10: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-fs-erofs:10: WARNING: Block quote ends without a blank line; unexpected unindent.

These 2 are fixed by this (pending) patch:
https://lore.kernel.org/linux-kernel/20220324165918.22005-4-hdegoede@redhat.com/

And I also have this pending patch for a pre-existing warning:
https://lore.kernel.org/linux-kernel/20220324165918.22005-3-hdegoede@redhat.com/

I'm not sure who should pick these 2 up ?

> <path/to/linux>/Documentation/ABI/testing/sysfs-bus-iio-sx9324:2: WARNING: Unexpected indentation.
> <path/to/linux>/Documentation/ABI/testing/sysfs-bus-nvdimm:11: WARNING: Unexpected indentation.

These 2 warnings are new to me (I tested with pdx86/for-next, so they probably
came in through another tree).

Regards,

HaNS





> 
> Introduced by 2546c60004309e (platform/x86: Add Intel Software Defined
> Silicon driver, 2022-02-11), 2bec6d9aa89cbe (docs: ABI: sysfs-bus-nvdimm:
> Document sysfs event format entries for nvdimm pmu, 2022-02-25),
> e8a60aa7404bfe (platform/x86: Introduce support for Systems Management
> Driver over WMI for Dell Systems), 40452ffca3c1a0 (erofs: add sysfs
> node to control sync decompression strategy, 2021-12-06), and
> 4c18a890dff8d9 (iio:proximity:sx9324: Add SX9324 support, 2022-01-01).
> 
> Presumably because Sphinx mistakes these documentation files without
> extensions for .rst files? I dunno.
> 
> Reported-by: Bagas Sanjaya <bagasdotme@gmail.com>
> 

Re: unexpected indentation warning in Documentation/ABI/testing/sysfs-*

[Bagas Sanjaya]

On 04/04/22 19.54, Hans de Goede wrote:
> 
> These 2 are fixed by this (pending) patch:
> https://lore.kernel.org/linux-kernel/20220324165918.22005-4-hdegoede@redhat.com/
> 
> And I also have this pending patch for a pre-existing warning:
> https://lore.kernel.org/linux-kernel/20220324165918.22005-3-hdegoede@redhat.com/
> 
> I'm not sure who should pick these 2 up ?
> 

I think linux-doc can pick them, if no subsystems do it.

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

Re: unexpected indentation warning in Documentation/ABI/testing/sysfs-*

[Gao Xiang]

Hi,

On Tue, Apr 05, 2022 at 02:52:18PM +0700, Bagas Sanjaya wrote:
> On 04/04/22 19.54, Hans de Goede wrote:
> > 
> > These 2 are fixed by this (pending) patch:
> > https://lore.kernel.org/linux-kernel/20220324165918.22005-4-hdegoede@redhat.com/
> > 
> > And I also have this pending patch for a pre-existing warning:
> > https://lore.kernel.org/linux-kernel/20220324165918.22005-3-hdegoede@redhat.com/
> > 
> > I'm not sure who should pick these 2 up ?
> > 
> 
> I think linux-doc can pick them, if no subsystems do it.
> 

btw, I can pick the erofs one up though, but since it's a doc-specific
series, I think it can go with linux-doc too.

Thanks,
Gao Xiang

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