On 6/4/25 12:57 PM, Matthew Wilcox (Oracle) wrote: > We have all this fine kernel-doc written, and it's not published > anywhere. Expose it to public view. Good idea. > > Signed-off-by: Matthew Wilcox (Oracle) <willy@xxxxxxxxxxxxx> > --- > Documentation/core-api/dma-api.rst | 6 ++++++ > 1 file changed, 6 insertions(+) > > diff --git a/Documentation/core-api/dma-api.rst b/Documentation/core-api/dma-api.rst > index 2ad08517e626..190ed8fe55ba 100644 > --- a/Documentation/core-api/dma-api.rst > +++ b/Documentation/core-api/dma-api.rst > @@ -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 <linux/scatterlist.h> contains this line (#102): * Usually the next entry will be @sg@ + 1, but if this sg element is part Those @ signs make that line not render correctly: Usually the next entry will be sg**** + 1, but if this sg element is part of a chained scatterlist, it could jump to the start of a new scatterlist array. Similarly for the sg_chain() function: * Links @prv@ and @sgl@ together, to form a longer scatterlist. and sg_last() in lib/scatterlist.c: (3 instances) * Note that the @sgl@ pointer passed in need not be the first one, * the important bit is that @nents@ denotes the number of entries that * exist from @sgl@. Do you want to send a patch for these? or I could do it... -- ~Randy
