Re: [PATCH] ata: libata-scsi: fix ata_dsm_trim_pages() kernel-doc

[Damien Le Moal <dlemoal@kernel.org>]

On 2026/09/16 20:00, Niklas Cassel wrote:
> make htmldocs fails with:
> 
>   Documentation/driver-api/libata:604: ./drivers/ata/libata-scsi.c:2301:
>   ERROR: Unexpected indentation. [docutils]
> 
> The Return: section of ata_dsm_trim_pages() ends its first sentence with
> a colon and continues with an indented bullet list. reStructuredText
> requires a blank line before an indented block, so docutils chokes on
> the list.
> 
> Simply adding the missing blank line does not work either: Return: is a
> kernel-doc "special section", which is terminated by the first blank
> line, so the bullet list would end up in the Description section,
> detached from the sentence introducing it.
> 
> Spell the two bounds out as prose instead, so that the Return: section
> stays self-contained. Documentation-only change.
> 
> Fixes: e64e6b5dc867 ("ata: libata-scsi: scale DSM TRIM payload by MAX PAGES PER DSM COMMAND")
> Reported-by: Thomas Huth <thuth@redhat.com>
> Closes: https://lore.kernel.org/linux-ide/b0a0b8e8-cc4f-4c7b-8bc5-fee0712d405a@redhat.com/

Reviewed-by: Damien Le Moal <dlemoal@kernel.org>


-- 
Damien Le Moal
Western Digital Research