From 8d836581f9b1f57ceaa2b47654754ef1260b410b Mon Sep 17 00:00:00 2001
From: Niklas Cassel <cassel@kernel.org>
Date: Wed, 16 Sep 2026 15:00:32 +0200
Subject: 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.

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>
Reviewed-by: Thomas Huth <thuth@redhat.com>
Link: https://lore.kernel.org/r/20260916130031.29990-2-cassel@kernel.org
Signed-off-by: Niklas Cassel <cassel@kernel.org>
---
 Documentation/driver-api/index.rst | 152 +++++++++++++++++++++++++++++++++++++
 1 file changed, 152 insertions(+)
 create mode 100644 Documentation/driver-api/index.rst

(limited to 'Documentation/driver-api/index.rst')

diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
new file mode 100644
index 000000000..6601a2586
--- /dev/null
+++ b/Documentation/driver-api/index.rst
@@ -0,0 +1,152 @@
+.. SPDX-License-Identifier: GPL-2.0
+
+==============================
+Driver implementer's API guide
+==============================
+
+The kernel offers a wide variety of interfaces to support the development
+of device drivers.  This document is an only somewhat organized collection
+of some of those interfaces — it will hopefully get better over time!  The
+available subsections can be seen below.
+
+
+General information for driver authors
+======================================
+
+This section contains documentation that should, at some point or other, be
+of interest to most developers working on device drivers.
+
+.. toctree::
+   :maxdepth: 1
+
+   basics
+   driver-model/index
+   device_link
+   infrastructure
+   ioctl
+   pm/index
+
+Useful support libraries
+========================
+
+This section contains documentation that should, at some point or other, be
+of interest to most developers working on device drivers.
+
+.. toctree::
+   :maxdepth: 1
+
+   early-userspace/index
+   connector
+   device-io
+   devfreq
+   dma-buf
+   component
+   io-mapping
+   io_ordering
+   uio-howto
+   vfio-mediated-device
+   vfio
+   vfio-pci-device-specific-driver-acceptance
+
+Bus-level documentation
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   auxiliary_bus
+   cxl/index
+   eisa
+   firewire
+   i3c/index
+   isa
+   men-chameleon-bus
+   pci/index
+   rapidio/index
+   slimbus
+   usb/index
+   virtio/index
+   vme
+   w1
+   xillybus
+
+
+Subsystem-specific APIs
+=======================
+
+.. toctree::
+   :maxdepth: 1
+
+   80211/index
+   acpi/index
+   backlight/lp855x-driver.rst
+   clk
+   coco/index
+   console
+   crypto/index
+   dmaengine/index
+   dpll
+   edac
+   extcon
+   firmware/index
+   fpga/index
+   frame-buffer
+   aperture
+   generic-counter
+   generic_pt
+   gpio/index
+   hsi
+   hte/index
+   hw-recoverable-errors
+   i2c
+   iio/index
+   infiniband
+   input
+   interconnect
+   ipmb
+   ipmi
+   issei/index
+   libata
+   mailbox
+   md/index
+   media/index
+   mei/index
+   memory-devices/index
+   message-based
+   misc_devices
+   miscellaneous
+   mmc/index
+   mtd/index
+   mtdnand
+   nfc/index
+   ntb
+   nvdimm/index
+   nvmem
+   parport-lowlevel
+   phy/index
+   pin-control
+   pldmfw/index
+   pps
+   ptp
+   pwm
+   pwrseq
+   regulator
+   reset
+   rfkill
+   s390-drivers
+   scsi
+   serial/index
+   sm501
+   soundwire/index
+   spi
+   surface_aggregator/index
+   switchtec
+   sync_file
+   target
+   tee
+   thermal/index
+   tty/index
+   wbrf
+   wmi
+   xilinx/index
+   zorro
-- 
cgit v1.3.1