ata: libata-scsi: fix ata_dsm_trim_pages() kernel-doc
Niklas Cassel
maintainerPATCH 1/1 ata: libata-scsi: fix ata_dsm_trim_pages() kernel-doc
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.
--- drivers/ata/libata-scsi.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)
drivers/ata/libata-scsi.c +3 -4
@@ -2297,10 +2297,9 @@ static unsigned int ata_scsiop_inq_89(struct ata_device *dev,* logical block, so it can hold at most sector_size / 512 pages. * * Return: the maximum number of 512-byte pages a single translated WRITE SAME -* command may send to @dev (never less than one), that is the smaller of: -* - MAX PAGES PER DSM COMMAND (IDENTIFY DEVICE word 105), when the device -* reports a non-zero limit; and -* - the logical sector size expressed in 512-byte pages (see above). +* command may send to @dev, that is the smaller of MAX PAGES PER DSM COMMAND +* (IDENTIFY DEVICE word 105, when the device reports a non-zero limit) and +* the logical sector size expressed in 512-byte pages; never less than one. */ static unsigned int ata_dsm_trim_pages (struct ata_device *dev) {
Signature · 1 line
2.55.0
Quoted 15 lines · Niklas Cassel
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.
Quoted 6 lines
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 <[email protected]>
Signature · 2 lines
Damien Le Moal Western Digital Research
Quoted 34 lines · Niklas Cassel
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 <[email protected]>Signed-off-by Niklas Cassel <[email protected]>--- drivers/ata/libata-scsi.c | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-)drivers/ata/libata-scsi.c +0
-0@@ -2297,10 +2297,9 @@ static unsigned int ata_scsiop_inq_89(struct ata_device *dev,* logical block, so it can hold at most sector_size / 512 pages. * * Return: the maximum number of 512-byte pages a single translated WRITE SAME
drivers/ata/libata-scsi.c static unsigned int ata_scsiop_inq_89(struct ata_device *dev, · line 2305
Quoted 10 lines
drivers/ata/libata-scsi.c +3
-4-* command may send to @dev (never less than one), that is the smaller of: -* - MAX PAGES PER DSM COMMAND (IDENTIFY DEVICE word 105), when the device -* reports a non-zero limit; and -* - the logical sector size expressed in 512-byte pages (see above). +* command may send to @dev, that is the smaller of MAX PAGES PER DSM COMMAND +* (IDENTIFY DEVICE word 105, when the device reports a non-zero limit) and +* the logical sector size expressed in 512-byte pages; never less than one. */ static unsigned int ata_dsm_trim_pages (struct ata_device *dev) {
Thanks for the speedy fix!
Quoted 11 lines · Niklas Cassel
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.[...]
Applied to libata/linux.git (for-7.3-fixes), thanks!
[1/1] ata: libata-scsi: fix ata_dsm_trim_pages() kernel-doc
https://git.kernel.org/libata/linux/c/8d836581
Kind regards,
Niklas