doc: Include scatterlist APIs in htmldocs
authorMatthew Wilcox (Oracle) <willy@infradead.org>
Wed, 4 Jun 2025 19:57:51 +0000 (20:57 +0100)
committerJonathan Corbet <corbet@lwn.net>
Mon, 9 Jun 2025 20:24:29 +0000 (14:24 -0600)
We have all this fine kernel-doc written, and it's not published
anywhere.  Expose it to public view.

Signed-off-by: Matthew Wilcox (Oracle) <willy@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>
Acked-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20250604195753.823742-1-willy@infradead.org
Documentation/core-api/dma-api.rst

index 2ad08517e626e6d9925ac5068289d580e1d64f41..190ed8fe55ba206679cd8448b902d0e7f6001034 100644 (file)
@@ -915,3 +915,9 @@ the driver. When driver does unmap, debug_dma_unmap() checks the flag and if
 this flag is still set, prints warning message that includes call trace that
 leads up to the unmap. This interface can be called from dma_mapping_error()
 routines to enable DMA mapping error check debugging.
+
+Functions and structures
+========================
+
+.. kernel-doc:: include/linux/scatterlist.h
+.. kernel-doc:: lib/scatterlist.c