]> git.ipfire.org Git - thirdparty/kernel/stable.git/commitdiff
dma-mapping: fix the kerneldoc for dma_map_sgtable()
authorLogan Gunthorpe <logang@deltatee.com>
Tue, 5 Oct 2021 16:48:12 +0000 (10:48 -0600)
committerChristoph Hellwig <hch@lst.de>
Mon, 11 Oct 2021 11:43:04 +0000 (13:43 +0200)
htmldocs began producing the following warnings:

  kernel/dma/mapping.c:256: WARNING: Definition list ends without a
             blank line; unexpected unindent.
  kernel/dma/mapping.c:257: WARNING: Bullet list ends without a blank
             line; unexpected unindent.

Reformatting the list without hyphens fixes the warnings and produces
both a readable text and HTML output.

Fixes: fffe3cc8c219 ("dma-mapping: allow map_sg() ops to return negative error code")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Logan Gunthorpe <logang@deltatee.com>
Signed-off-by: Christoph Hellwig <hch@lst.de>
kernel/dma/mapping.c

index 06fec5547e7c790a58ab02183d31228cb94d5f09..49885023c2237cfcbcf57dac317b184c007f3a12 100644 (file)
@@ -249,12 +249,12 @@ EXPORT_SYMBOL(dma_map_sg_attrs);
  * Returns 0 on success or a negative error code on error. The following
  * error codes are supported with the given meaning:
  *
- *   -EINVAL - An invalid argument, unaligned access or other error
- *            in usage. Will not succeed if retried.
- *   -ENOMEM - Insufficient resources (like memory or IOVA space) to
- *            complete the mapping. Should succeed if retried later.
- *   -EIO    - Legacy error code with an unknown meaning. eg. this is
- *            returned if a lower level call returned DMA_MAPPING_ERROR.
+ *   -EINVAL   An invalid argument, unaligned access or other error
+ *             in usage. Will not succeed if retried.
+ *   -ENOMEM   Insufficient resources (like memory or IOVA space) to
+ *             complete the mapping. Should succeed if retried later.
+ *   -EIO      Legacy error code with an unknown meaning. eg. this is
+ *             returned if a lower level call returned DMA_MAPPING_ERROR.
  */
 int dma_map_sgtable(struct device *dev, struct sg_table *sgt,
                    enum dma_data_direction dir, unsigned long attrs)